GS2-Inbox トランザクションアクション

ConsumeAction

Gs2Inbox:OpenMessageByUserId

ユーザーIDを指定してメッセージを開封

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

型説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
messageNamestringメッセージ名
{
    "action": "Gs2Inbox:OpenMessageByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "messageName": "[string]メッセージ名"
    }
}
action: Gs2Inbox:OpenMessageByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  messageName: "[string]メッセージ名"

Gs2Inbox:DeleteMessageByUserId

ユーザーIDを指定してメッセージを削除

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

型説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
messageNamestringメッセージ名
{
    "action": "Gs2Inbox:DeleteMessageByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "messageName": "[string]メッセージ名"
    }
}
action: Gs2Inbox:DeleteMessageByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  messageName: "[string]メッセージ名"

AcquireAction

Gs2Inbox:SendMessageByUserId

メッセージを新規作成

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

型説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
metadatastringメッセージの内容に相当するメタデータ
readAcquireActionsAcquireAction[]開封時に実行する入手アクション
expiresAtlong有効期限日時
expiresTimeSpanTimeSpan_メッセージの有効期限までの差分
{
    "action": "Gs2Inbox:SendMessageByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "metadata": "[string]メッセージの内容に相当するメタデータ",
        "readAcquireActions": [
            {
                "action": "[string]スタンプシートを使用して実行するアクションの種類",
                "request": "[string]リクエストのJSON"
            }
        ],
        "expiresAt": "[long]有効期限日時",
        "expiresTimeSpan": {
            "days": "[int]現在時刻からの日数",
            "hours": "[int]現在時刻からの時間",
            "minutes": "[int]現在時刻からの分"
        }
    }
}
action: Gs2Inbox:SendMessageByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  metadata: "[string]メッセージの内容に相当するメタデータ"
  readAcquireActions: 
    - action: "[string]スタンプシートを使用して実行するアクションの種類"
      request: "[string]リクエストのJSON"
  expiresAt: "[long]有効期限日時"
  expiresTimeSpan: 
    days: "[int]現在時刻からの日数"
    hours: "[int]現在時刻からの時間"
    minutes: "[int]現在時刻からの分"