> For the complete documentation index, see [llms.txt](/llms.txt) # GS2-Inbox SDK API リファレンス 各種プログラミング言語向け GS2-Inbox SDK の モデルの仕様 と API のリファレンス ## モデル ### Namespace ネームスペース
ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceId | string | | ※ | | ~ 1024文字 | ネームスペースGRN
※ サーバーが自動で設定 | | name | string | | ✓ | | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | isAutomaticDeletingEnabled | bool | | | false | | 自動削除
有効にすると、メッセージが開封（既読）された後にユーザーのメッセージ一覧から自動的に削除されます。クライアントからの明示的な削除操作なしに受け取り済みメッセージを削除し、受信ボックスを整理します。無効の場合、開封済みメッセージは手動で削除されるまで一覧に残ります。 | | transactionSetting | [TransactionSetting](#transactionsetting) | | | | | トランザクション設定
メッセージに添付された報酬を付与する際に使用される分散トランザクション処理の設定です。readAcquireActions を持つメッセージが開封されると、入手アクションが生成・実行されて報酬が配布されます。自動実行、アトミックコミット、非同期処理をサポートします。 | | receiveMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを受信したときに実行するスクリプトの設定
Script トリガーリファレンス - [`receiveMessage`](../script/#receivemessage) | | readMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを開封したときに実行するスクリプトの設定
Script トリガーリファレンス - [`readMessage`](../script/#readmessage) | | deleteMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを削除したときに実行するスクリプトの設定
Script トリガーリファレンス - [`deleteMessage`](../script/#deletemessage) | | receiveNotification | [NotificationSetting](#notificationsetting) | | | | | 受信通知
ユーザーの受信ボックスに新しいメッセージが配信されたときにトリガーされるプッシュ通知設定です。GS2-Gatewayを使用してゲームクライアントにリアルタイム通知を送信し、ポーリングなしで新着メッセージインジケーターの表示や受信ボックスの更新をUIで行えるようにします。 | | logSetting | [LogSetting](#logsetting) | | | | | ログの出力設定
メッセージ操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。監査やデバッグ目的でメッセージの配信、開封、報酬受け取り、削除を追跡するのに役立ちます。 | | createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | updatedAt | long | | ※ | 現在時刻 | | 最終更新日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン | **関連するメソッド:** describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 --- ### TransactionSetting トランザクション設定
トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | enableAutoRun | bool | | | false | | 発行したトランザクションをサーバーサイドで自動的に実行するか | | enableAtomicCommit | bool | {enableAutoRun} == true | | false | | トランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 有効 | | transactionUseDistributor | bool | {enableAtomicCommit} == true | | false | | トランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 有効 | | commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | | false | | スクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 有効 | | acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | | false | | 入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 有効 | | distributorNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:distributor:default" | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN | | queueNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:queue:default" | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペースGRN | **関連するメソッド:** createNamespace - ネームスペースを新規作成 updateNamespace - ネームスペースを更新 **関連するモデル:** Namespace - ネームスペース --- ### ScriptSetting スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。
一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | triggerScriptId | string | | | | ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 | | doneTriggerTargetType | 文字列列挙型
enum {
  "none",
  "gs2_script",
  "aws"
}
| | | "none" | | 非同期スクリプトの実行方法
非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。"none": なし / "gs2_script": GS2-Script / "aws": Amazon EventBridge / | | doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
※ doneTriggerTargetType が "gs2_script" であれば 有効 | | doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN
非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。
GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。
※ doneTriggerTargetType が "gs2_script" であれば 有効 | **関連するメソッド:** createNamespace - ネームスペースを新規作成 updateNamespace - ネームスペースを更新 **関連するモデル:** Namespace - ネームスペース --- ### NotificationSetting プッシュ通知に関する設定
GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。
GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | gatewayNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:gateway:default" | ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース
「grn:gs2:」から始まる GRN 形式で GS2-Gateway のネームスペースIDを指定します。 | | enableTransferMobileNotification | bool? | | | false | | モバイルプッシュ通知へ転送するか
この通知を送信しようとした時、通知先のデバイスがオフラインだった場合、モバイルプッシュ通知へ転送するかどうかを指定します。 | | sound | string | {enableTransferMobileNotification} == true | | | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名
ここで指定したサウンドファイル名は、モバイルプッシュ通知を送信する際に使用され、特別なサウンドで通知を出すことができます。
※ enableTransferMobileNotification が true であれば 有効 | | enable | 文字列列挙型
enum {
  "Enabled",
  "Disabled"
}
| | | "Enabled" | | プッシュ通知を有効にするか"Enabled": 有効 / "Disabled": 無効 / | **関連するメソッド:** createNamespace - ネームスペースを新規作成 updateNamespace - ネームスペースを更新 **関連するモデル:** Namespace - ネームスペース --- ### LogSetting ログの出力設定
ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | loggingNamespaceId | string | | ✓ | | ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 | **関連するメソッド:** createNamespace - ネームスペースを新規作成 updateNamespace - ネームスペースを更新 **関連するモデル:** Namespace - ネームスペース --- ### GitHubCheckoutSetting GitHubからマスターデータをチェックアウトする設定 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | apiKeyId | string | | ✓ | | ~ 1024文字 | GitHub APIキーのGRN | | repositoryName | string | | ✓ | | ~ 1024文字 | リポジトリ名 | | sourcePath | string | | ✓ | | ~ 1024文字 | マスターデータ（JSON）ファイルのパス | | referenceType | 文字列列挙型
enum {
  "commit_hash",
  "branch",
  "tag"
}
| | ✓ | | | コードの取得元"commit_hash": コミットハッシュ / "branch": ブランチ / "tag": タグ / | | commitHash | string | {referenceType} == "commit_hash" | ✓※ | | ~ 1024文字 | コミットハッシュ
※ referenceType が "commit_hash" であれば 必須 | | branchName | string | {referenceType} == "branch" | ✓※ | | ~ 1024文字 | ブランチ名
※ referenceType が "branch" であれば 必須 | | tagName | string | {referenceType} == "tag" | ✓※ | | ~ 1024文字 | タグ名
※ referenceType が "tag" であれば 必須 | **関連するメソッド:** updateCurrentMessageMasterFromGitHub - 現在アクティブなグローバルメッセージのマスターデータをGitHubから更新 --- ### Message メッセージ
ゲームプレイヤー毎に用意されるメッセージボックスに届けられたメッセージデータ。
メッセージには開封状態がある他、開封時に実行する入手アクションを設定することができます。
メッセージには有効期限を設定でき、有効期限が切れたメッセージは、未読状態、開封後の既読状態にかかわらず、自動的に削除されます。
添付された報酬を受け取っていない場合でも削除されます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | messageId | string | | ※ | | ~ 1024文字 | メッセージGRN
※ サーバーが自動で設定 | | name | string | | ✓ | UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | | userId | string | | ✓ | | ~ 128文字 | ユーザーID | | metadata | string | | ✓ | | ~ 4096文字 | メタデータ
メッセージのタイトル、本文、送信者情報、表示パラメータなどを含むJSON文字列など、メッセージの内容を表す任意のデータです。GS2はこの値を解釈せず、メッセージUIの描画のためにゲームクライアントにそのまま渡されます。最大4096文字です。 | | isRead | bool | | | false | | 既読状態
メッセージがユーザーによって開封されたかどうかを示します。メッセージが開封されると、このフラグがtrueに設定され、readAcquireActions が実行されて添付報酬が配布され、readAt タイムスタンプが記録されます。ネームスペースで isAutomaticDeletingEnabled が設定されている場合、既読後にメッセージは削除されます。 | | readAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | 開封時入手アクション
ユーザーがこのメッセージを開封した際に実行される入手アクションのリストです。アイテム、通貨、リソースなどの報酬をメッセージに添付するために使用されます。複数のアクションを組み合わせて異なる種類の報酬を同時に付与できます。メッセージあたり最大100アクションです。 | | receivedAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | readAt | long | | | 0 | | 開封日時
UNIX 時間・ミリ秒 | | expiresAt | long | | | | | 有効期限日時
UNIX 時間・ミリ秒 | | revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン | **関連するメソッド:** describeMessages - メッセージの一覧を取得 describeMessagesByUserId - ユーザーIDを指定してメッセージの一覧を取得 sendMessageByUserId - ユーザーIDを指定してメッセージの送信 getMessage - メッセージを取得 getMessageByUserId - ユーザーIDを指定してメッセージを取得 receiveGlobalMessage - グローバルメッセージのうちまだ受け取っていないメッセージを受信 receiveGlobalMessageByUserId - ユーザーIDを指定してグローバルメッセージのうちまだ受け取っていないメッセージを受信 openMessage - メッセージを開封済み化 openMessageByUserId - ユーザーIDを指定してメッセージを開封済み化 closeMessageByUserId - ユーザーIDを指定してメッセージを未開封化 readMessage - メッセージを開封 readMessageByUserId - ユーザーIDを指定してメッセージを開封 batchReadMessages - メッセージを一括開封 batchReadMessagesByUserId - ユーザーIDを指定してメッセージを一括開封 deleteMessage - メッセージを削除 deleteMessageByUserId - ユーザーIDを指定してメッセージを削除 --- ### GlobalMessage グローバルメッセージ
グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。
グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで
有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | globalMessageId | string | | ※ | | ~ 1024文字 | 全ユーザーに向けたメッセージGRN
※ サーバーが自動で設定 | | name | string | | ✓ | | ~ 128文字 | グローバルメッセージ名
グローバルメッセージ固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | metadata | string | | ✓ | | ~ 4096文字 | メタデータ
メッセージのタイトル、本文、表示パラメータなどを含むJSON文字列など、グローバルメッセージの内容を表す任意のデータです。ユーザーがこのグローバルメッセージを受信すると、メタデータは受信ボックス内の個別メッセージにコピーされます。GS2はこの値を解釈しません。最大4096文字です。 | | readAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | 開封時入手アクション
このグローバルメッセージからコピーされたメッセージをユーザーが開封した際に実行される入手アクションのリストです。これらのアクションはメタデータとともに各ユーザーの個別メッセージにコピーされます。グローバルメッセージあたり最大100アクションです。 | | expiresTimeSpan | [TimeSpan](#timespan) | | | | | 有効期限までの期間
ユーザーがこのグローバルメッセージを受信（コピー）した時刻から、コピーされたメッセージが期限切れとなり受信ボックスから自動削除されるまでの期間です。日、時間、分の組み合わせで指定します。有効期限に達するとメッセージは既読状態に関わらず削除され、未受け取りの添付報酬も含めて削除されます。 | | messageReceptionPeriodEventId | string | | | | ~ 1024文字 | メッセージ受信期間イベントID
このグローバルメッセージを受信（ユーザーの受信ボックスにコピー）できる時間枠を定義するGS2-ScheduleイベントのGRNです。この期間外では、ユーザーがグローバルメッセージの受信操作をトリガーしてもメッセージは配信されません。期間限定のイベント告知や季節キャンペーン報酬に便利です。 | **関連するメソッド:** describeGlobalMessages - 全ユーザーに向けたメッセージの一覧を取得 getGlobalMessage - 全ユーザーに向けたメッセージを取得 --- ### Received 受信済みグローバルメッセージ
重複配信を防止するため、ユーザーが既に受信したグローバルメッセージを追跡します。ユーザーがグローバルメッセージの受信操作をトリガーすると、システムはこのレコードを確認して既に受信済みのメッセージをスキップします。各ユーザーは受信ボックスにコピーしたすべてのグローバルメッセージの名前を蓄積する1つの Received レコードを持ちます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | receivedId | string | | ※ | | ~ 1024文字 | 受信済みグローバルメッセージ名GRN
※ サーバーが自動で設定 | | userId | string | | ✓ | | ~ 128文字 | ユーザーID | | receivedGlobalMessageNames | List<string> | | | [] | 0 ~ 100 items | 受信済みグローバルメッセージ名リスト
ユーザーが既に受信したグローバルメッセージ名のリストです。グローバルメッセージの受信操作が実行されると、このリストに名前が含まれるメッセージはスキップされます。最大100件です。 | | createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | updatedAt | long | | ※ | 現在時刻 | | 最終更新日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン | **関連するメソッド:** getReceivedByUserId - ユーザーIDを指定して受信済みグローバルメッセージを取得 updateReceivedByUserId - ユーザーIDを指定して受信済みグローバルメッセージを更新 deleteReceivedByUserId - ユーザーIDを指定して受信済みグローバルメッセージを削除 --- ### TimeSpan タイムスパン
日、時間、分の組み合わせとして期間を表します。受信時刻を基準としたメッセージの有効期間を定義するために使用されます。例えば、7日、0時間、0分のタイムスパンは、ユーザーが受信してから正確に1週間後にメッセージが期限切れになることを意味します。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | days | int | | | 0 | 0 ~ 365 | 日数
このタイムスパンの日数です。時間と分と組み合わせて合計期間が計算されます。最大365日です。 | | hours | int | | | 0 | 0 ~ 24 | 時間
このタイムスパンの時間数です。日数と分と組み合わせて合計期間が計算されます。最大24時間です。 | | minutes | int | | | 0 | 0 ~ 60 | 分
このタイムスパンの分数です。日数と時間と組み合わせて合計期間が計算されます。最大60分です。 | **関連するメソッド:** sendMessageByUserId - ユーザーIDを指定してメッセージの送信 createGlobalMessageMaster - グローバルメッセージマスターを新規作成 updateGlobalMessageMaster - 全ユーザーに向けたメッセージを更新 **関連するモデル:** GlobalMessage - グローバルメッセージ GlobalMessageMaster - グローバルメッセージマスター --- ### AcquireAction 入手アクション
報酬としてメッセージに添付される単一の入手アクションを表します。アクションタイプ（例：インベントリへのアイテム追加、通貨増加）とそのリクエストパラメータで構成されます。メッセージが開封されると、これらのアクションがトランザクションに組み立てられ、実行されてユーザーに報酬が配布されます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 入手アクションで実行するアクションの種類 | | request | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | **関連するモデル:** Message - メッセージ GlobalMessage - グローバルメッセージ GlobalMessageMaster - グローバルメッセージマスター --- ### Config コンフィグ設定
トランザクションの変数に適用する設定値 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | key | string | | ✓ | | ~ 64文字 | 名前 | | value | string | | | | ~ 51200文字 | 値 | --- ### VerifyActionResult 検証アクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 検証アクションで実行するアクションの種類 | | verifyRequest | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | | statusCode | int | | | | 0 ~ 999 | ステータスコード | | verifyResult | string | | | | ~ 1048576文字 | 結果内容 | **関連するモデル:** TransactionResult - トランザクション実行結果 --- ### ConsumeActionResult 消費アクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 消費アクションで実行するアクションの種類 | | consumeRequest | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | | statusCode | int | | | | 0 ~ 999 | ステータスコード | | consumeResult | string | | | | ~ 1048576文字 | 結果内容 | **関連するモデル:** TransactionResult - トランザクション実行結果 --- ### AcquireActionResult 入手アクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 入手アクションで実行するアクションの種類 | | acquireRequest | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | | statusCode | int | | | | 0 ~ 999 | ステータスコード | | acquireResult | string | | | | ~ 1048576文字 | 結果内容 | **関連するモデル:** TransactionResult - トランザクション実行結果 --- ### TransactionResult トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | transactionId | string | | ✓ | | 36 ~ 36文字 | トランザクションID | | verifyResults | [List<VerifyActionResult>](#verifyactionresult) | | | | 0 ~ 10 items | 検証アクションの実行結果リスト | | consumeResults | [List<ConsumeActionResult>](#consumeactionresult) | | | [] | 0 ~ 10 items | 消費アクションの実行結果リスト | | acquireResults | [List<AcquireActionResult>](#acquireactionresult) | | | [] | 0 ~ 100 items | 入手アクションの実行結果リスト | | hasError | bool | | | false | | トランザクション実行中にエラーが発生したかどうか | **関連するメソッド:** readMessage - メッセージを開封 readMessageByUserId - ユーザーIDを指定してメッセージを開封 batchReadMessages - メッセージを一括開封 batchReadMessagesByUserId - ユーザーIDを指定してメッセージを一括開封 --- ### CurrentMessageMaster 現在アクティブなグローバルメッセージのマスターデータ
現在ネームスペース内で有効な、グローバルメッセージの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。 {{% alert title="Note" color="info" %}} JSONファイルの形式については [GS2-Inbox マスターデータリファレンス](api_reference/inbox/master_data/) をご参照ください。 {{% /alert %}} | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceId | string | | ※ | | ~ 1024文字 | ネームスペースGRN
※ サーバーが自動で設定 | | settings | string | | ✓ | | ~ 5242880 バイト (5MB) | マスターデータ | **関連するメソッド:** exportMaster - グローバルメッセージマスターを有効化可能なマスターデータ形式でエクスポート getCurrentMessageMaster - 現在アクティブなグローバルメッセージのマスターデータを取得 updateCurrentMessageMaster - 現在アクティブなグローバルメッセージのマスターデータを更新 updateCurrentMessageMasterFromGitHub - 現在アクティブなグローバルメッセージのマスターデータをGitHubから更新 --- ### GlobalMessageMaster グローバルメッセージマスター
グローバルメッセージマスターは、ゲーム内で使用されるグローバルメッセージの編集・管理用データで、マネージメントコンソールのマスターデータエディタで一時的に保持されます。
インポート・更新処理を行うことで、実際にゲームから参照されるグローバルメッセージとして反映されます。
グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。
グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで
有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | globalMessageId | string | | ※ | | ~ 1024文字 | 全ユーザーに向けたメッセージGRN
※ サーバーが自動で設定 | | name | string | | ✓ | UUID | ~ 64文字 | グローバルメッセージ名
ネームスペース内でこのグローバルメッセージを一意に識別する名前です。各ユーザーが既に受信したグローバルメッセージを追跡し、重複配信を防止するために使用されます。指定しない場合はUUIDとして自動生成されます。 | | metadata | string | | ✓ | | ~ 4096文字 | メタデータ
メッセージのタイトル、本文、表示パラメータなどを含むJSON文字列など、グローバルメッセージの内容を表す任意のデータです。ユーザーがこのグローバルメッセージを受信すると、メタデータは受信ボックス内の個別メッセージにコピーされます。GS2はこの値を解釈しません。最大4096文字です。 | | readAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | 開封時入手アクション
このグローバルメッセージからコピーされたメッセージをユーザーが開封した際に実行される入手アクションのリストです。これらのアクションはメタデータとともに各ユーザーの個別メッセージにコピーされます。グローバルメッセージあたり最大100アクションです。 | | expiresTimeSpan | [TimeSpan](#timespan) | | | | | 有効期限までの期間
ユーザーがこのグローバルメッセージを受信（コピー）した時刻から、コピーされたメッセージが期限切れとなり受信ボックスから自動削除されるまでの期間です。日、時間、分の組み合わせで指定します。有効期限に達するとメッセージは既読状態に関わらず削除され、未受け取りの添付報酬も含めて削除されます。 | | messageReceptionPeriodEventId | string | | | | ~ 1024文字 | メッセージ受信期間イベントID
このグローバルメッセージを受信（ユーザーの受信ボックスにコピー）できる時間枠を定義するGS2-ScheduleイベントのGRNです。この期間外では、ユーザーがグローバルメッセージの受信操作をトリガーしてもメッセージは配信されません。期間限定のイベント告知や季節キャンペーン報酬に便利です。 | | createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン | **関連するメソッド:** describeGlobalMessageMasters - 全ユーザーに向けたメッセージの一覧を取得 createGlobalMessageMaster - グローバルメッセージマスターを新規作成 getGlobalMessageMaster - 全ユーザーに向けたメッセージを取得 updateGlobalMessageMaster - 全ユーザーに向けたメッセージを更新 deleteGlobalMessageMaster - 全ユーザーに向けたメッセージを削除 --- ## メソッド ### describeNamespaces ネームスペースの一覧を取得
プロジェクト内において、サービス単位で作成されたネームスペースの一覧を取得します。
オプションのページトークンを使用して、リストの特定の位置からデータの取得を開始できます。
また、取得するネームスペースの数を制限することも可能です。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namePrefix | string | | | | ~ 64文字 | ネームスペース名のフィルター接頭辞 | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Namespace>](#namespace) | ネームスペースのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DescribeNamespaces( &inbox.DescribeNamespacesRequest { NamePrefix: nil, PageToken: nil, Limit: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DescribeNamespacesRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->describeNamespaces( (new DescribeNamespacesRequest()) ->withNamePrefix(null) ->withPageToken(null) ->withLimit(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DescribeNamespacesRequest; import io.gs2.inbox.result.DescribeNamespacesResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DescribeNamespacesResult result = client.describeNamespaces( new DescribeNamespacesRequest() .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeNamespaces( new Gs2.Gs2Inbox.Request.DescribeNamespacesRequest() .WithNamePrefix(null) .WithPageToken(null) .WithLimit(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var nextPageToken = result.NextPageToken; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.describeNamespaces( new Gs2Inbox.DescribeNamespacesRequest() .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.describe_namespaces( inbox.DescribeNamespacesRequest() .with_name_prefix(None) .with_page_token(None) .with_limit(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.describe_namespaces({ namePrefix=nil, pageToken=nil, limit=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.describe_namespaces_async({ namePrefix=nil, pageToken=nil, limit=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### createNamespace ネームスペースを新規作成
GS2-Inbox サービスの新しいネームスペースを作成します。
isAutomaticDeletingEnabled（既読メッセージの自動削除）、トランザクション設定、スクリプトコールバック（receiveMessageScript、readMessageScript、deleteMessageScript）、receiveNotification（メッセージ受信イベントのプッシュ通知設定）、およびログ設定を構成できます。
作成後、グローバルメッセージマスターを定義し、マスターデータの更新プロセスを通じて有効化できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | name | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | isAutomaticDeletingEnabled | bool | | | false | | 自動削除
有効にすると、メッセージが開封（既読）された後にユーザーのメッセージ一覧から自動的に削除されます。クライアントからの明示的な削除操作なしに受け取り済みメッセージを削除し、受信ボックスを整理します。無効の場合、開封済みメッセージは手動で削除されるまで一覧に残ります。 | | transactionSetting | [TransactionSetting](#transactionsetting) | | | | | トランザクション設定
メッセージに添付された報酬を付与する際に使用される分散トランザクション処理の設定です。readAcquireActions を持つメッセージが開封されると、入手アクションが生成・実行されて報酬が配布されます。自動実行、アトミックコミット、非同期処理をサポートします。 | | receiveMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを受信したときに実行するスクリプトの設定
Script トリガーリファレンス - [`receiveMessage`](../script/#receivemessage) | | readMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを開封したときに実行するスクリプトの設定
Script トリガーリファレンス - [`readMessage`](../script/#readmessage) | | deleteMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを削除したときに実行するスクリプトの設定
Script トリガーリファレンス - [`deleteMessage`](../script/#deletemessage) | | receiveNotification | [NotificationSetting](#notificationsetting) | | | | | 受信通知
ユーザーの受信ボックスに新しいメッセージが配信されたときにトリガーされるプッシュ通知設定です。GS2-Gatewayを使用してゲームクライアントにリアルタイム通知を送信し、ポーリングなしで新着メッセージインジケーターの表示や受信ボックスの更新をUIで行えるようにします。 | | logSetting | [LogSetting](#logsetting) | | | | | ログの出力設定
メッセージ操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。監査やデバッグ目的でメッセージの配信、開封、報酬受け取り、削除を追跡するのに役立ちます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | 作成したネームスペース | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.CreateNamespace( &inbox.CreateNamespaceRequest { Name: pointy.String("namespace-0001"), Description: nil, IsAutomaticDeletingEnabled: nil, TransactionSetting: &inbox.TransactionSetting{ EnableAutoRun: pointy.Bool(false), QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"), }, ReceiveMessageScript: nil, ReadMessageScript: nil, DeleteMessageScript: nil, ReceiveNotification: nil, LogSetting: &inbox.LogSetting{ LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"), }, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\CreateNamespaceRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->createNamespace( (new CreateNamespaceRequest()) ->withName("namespace-0001") ->withDescription(null) ->withIsAutomaticDeletingEnabled(null) ->withTransactionSetting((new \Gs2\Inbox\Model\TransactionSetting()) ->withEnableAutoRun(false) ->withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) ->withReceiveMessageScript(null) ->withReadMessageScript(null) ->withDeleteMessageScript(null) ->withReceiveNotification(null) ->withLogSetting((new \Gs2\Inbox\Model\LogSetting()) ->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.CreateNamespaceRequest; import io.gs2.inbox.result.CreateNamespaceResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { CreateNamespaceResult result = client.createNamespace( new CreateNamespaceRequest() .withName("namespace-0001") .withDescription(null) .withIsAutomaticDeletingEnabled(null) .withTransactionSetting(new io.gs2.inbox.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) .withReceiveMessageScript(null) .withReadMessageScript(null) .withDeleteMessageScript(null) .withReceiveNotification(null) .withLogSetting(new io.gs2.inbox.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.CreateNamespace( new Gs2.Gs2Inbox.Request.CreateNamespaceRequest() .WithName("namespace-0001") .WithDescription(null) .WithIsAutomaticDeletingEnabled(null) .WithTransactionSetting(new Gs2.Gs2Inbox.Model.TransactionSetting() .WithEnableAutoRun(false) .WithQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) .WithReceiveMessageScript(null) .WithReadMessageScript(null) .WithDeleteMessageScript(null) .WithReceiveNotification(null) .WithLogSetting(new Gs2.Gs2Inbox.Model.LogSetting() .WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.createNamespace( new Gs2Inbox.CreateNamespaceRequest() .withName("namespace-0001") .withDescription(null) .withIsAutomaticDeletingEnabled(null) .withTransactionSetting(new Gs2Inbox.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) .withReceiveMessageScript(null) .withReadMessageScript(null) .withDeleteMessageScript(null) .withReceiveNotification(null) .withLogSetting(new Gs2Inbox.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.create_namespace( inbox.CreateNamespaceRequest() .with_name('namespace-0001') .with_description(None) .with_is_automatic_deleting_enabled(None) .with_transaction_setting( inbox.TransactionSetting() .with_enable_auto_run(False) .with_queue_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001')) .with_receive_message_script(None) .with_read_message_script(None) .with_delete_message_script(None) .with_receive_notification(None) .with_log_setting( inbox.LogSetting() .with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001')) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.create_namespace({ name="namespace-0001", description=nil, isAutomaticDeletingEnabled=nil, transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001", }, receiveMessageScript=nil, readMessageScript=nil, deleteMessageScript=nil, receiveNotification=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.create_namespace_async({ name="namespace-0001", description=nil, isAutomaticDeletingEnabled=nil, transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001", }, receiveMessageScript=nil, readMessageScript=nil, deleteMessageScript=nil, receiveNotification=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getNamespaceStatus ネームスペースの状態を取得
指定されたネームスペースの現在の状態を取得します。
これには、ネームスペースがアクティブか、保留中か、またはその他の状態にあるかが含まれます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | status | string | | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetNamespaceStatus( &inbox.GetNamespaceStatusRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } status := result.Status ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetNamespaceStatusRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getNamespaceStatus( (new GetNamespaceStatusRequest()) ->withNamespaceName("namespace-0001") ); $status = $result->getStatus(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetNamespaceStatusRequest; import io.gs2.inbox.result.GetNamespaceStatusResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetNamespaceStatusResult result = client.getNamespaceStatus( new GetNamespaceStatusRequest() .withNamespaceName("namespace-0001") ); String status = result.getStatus(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetNamespaceStatus( new Gs2.Gs2Inbox.Request.GetNamespaceStatusRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var status = result.Status; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getNamespaceStatus( new Gs2Inbox.GetNamespaceStatusRequest() .withNamespaceName("namespace-0001") ); const status = result.getStatus(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_namespace_status( inbox.GetNamespaceStatusRequest() .with_namespace_name('namespace-0001') ) status = result.status except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_namespace_status({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result status = result.status; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_namespace_status_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result status = result.status; ``` --- ### getNamespace ネームスペースを取得
指定されたネームスペースの詳細情報を取得します。
これには、ネームスペースの名前、説明、およびその他の設定情報が含まれます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | ネームスペース | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetNamespace( &inbox.GetNamespaceRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetNamespaceRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getNamespace( (new GetNamespaceRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetNamespaceRequest; import io.gs2.inbox.result.GetNamespaceResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetNamespaceResult result = client.getNamespace( new GetNamespaceRequest() .withNamespaceName("namespace-0001") ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetNamespace( new Gs2.Gs2Inbox.Request.GetNamespaceRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getNamespace( new Gs2Inbox.GetNamespaceRequest() .withNamespaceName("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_namespace( inbox.GetNamespaceRequest() .with_namespace_name('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_namespace({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_namespace_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### updateNamespace ネームスペースを更新
指定されたネームスペースの設定を更新します。
説明、自動削除設定、トランザクション設定、スクリプトコールバック（receiveMessageScript、readMessageScript、deleteMessageScript）、receiveNotification、およびログ設定を変更できます。
変更は以降の操作に即座に反映されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | isAutomaticDeletingEnabled | bool | | | false | | 自動削除
有効にすると、メッセージが開封（既読）された後にユーザーのメッセージ一覧から自動的に削除されます。クライアントからの明示的な削除操作なしに受け取り済みメッセージを削除し、受信ボックスを整理します。無効の場合、開封済みメッセージは手動で削除されるまで一覧に残ります。 | | transactionSetting | [TransactionSetting](#transactionsetting) | | | | | トランザクション設定
メッセージに添付された報酬を付与する際に使用される分散トランザクション処理の設定です。readAcquireActions を持つメッセージが開封されると、入手アクションが生成・実行されて報酬が配布されます。自動実行、アトミックコミット、非同期処理をサポートします。 | | receiveMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを受信したときに実行するスクリプトの設定
Script トリガーリファレンス - [`receiveMessage`](../script/#receivemessage) | | readMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを開封したときに実行するスクリプトの設定
Script トリガーリファレンス - [`readMessage`](../script/#readmessage) | | deleteMessageScript | [ScriptSetting](#scriptsetting) | | | | | メッセージを削除したときに実行するスクリプトの設定
Script トリガーリファレンス - [`deleteMessage`](../script/#deletemessage) | | receiveNotification | [NotificationSetting](#notificationsetting) | | | | | 受信通知
ユーザーの受信ボックスに新しいメッセージが配信されたときにトリガーされるプッシュ通知設定です。GS2-Gatewayを使用してゲームクライアントにリアルタイム通知を送信し、ポーリングなしで新着メッセージインジケーターの表示や受信ボックスの更新をUIで行えるようにします。 | | logSetting | [LogSetting](#logsetting) | | | | | ログの出力設定
メッセージ操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。監査やデバッグ目的でメッセージの配信、開封、報酬受け取り、削除を追跡するのに役立ちます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | 更新したネームスペース | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.UpdateNamespace( &inbox.UpdateNamespaceRequest { NamespaceName: pointy.String("namespace-0001"), Description: pointy.String("description1"), IsAutomaticDeletingEnabled: pointy.Bool(false), TransactionSetting: &inbox.TransactionSetting{ EnableAutoRun: pointy.Bool(false), QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002"), }, ReceiveMessageScript: &inbox.ScriptSetting{ TriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001"), DoneTriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002"), }, ReadMessageScript: &inbox.ScriptSetting{ TriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003"), DoneTriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004"), }, DeleteMessageScript: &inbox.ScriptSetting{ TriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005"), DoneTriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006"), }, ReceiveNotification: nil, LogSetting: &inbox.LogSetting{ LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"), }, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\UpdateNamespaceRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->updateNamespace( (new UpdateNamespaceRequest()) ->withNamespaceName("namespace-0001") ->withDescription("description1") ->withIsAutomaticDeletingEnabled(false) ->withTransactionSetting((new \Gs2\Inbox\Model\TransactionSetting()) ->withEnableAutoRun(false) ->withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) ->withReceiveMessageScript((new \Gs2\Inbox\Model\ScriptSetting()) ->withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001") ->withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002")) ->withReadMessageScript((new \Gs2\Inbox\Model\ScriptSetting()) ->withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003") ->withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004")) ->withDeleteMessageScript((new \Gs2\Inbox\Model\ScriptSetting()) ->withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005") ->withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006")) ->withReceiveNotification(null) ->withLogSetting((new \Gs2\Inbox\Model\LogSetting()) ->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.UpdateNamespaceRequest; import io.gs2.inbox.result.UpdateNamespaceResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { UpdateNamespaceResult result = client.updateNamespace( new UpdateNamespaceRequest() .withNamespaceName("namespace-0001") .withDescription("description1") .withIsAutomaticDeletingEnabled(false) .withTransactionSetting(new io.gs2.inbox.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) .withReceiveMessageScript(new io.gs2.inbox.model.ScriptSetting() .withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001") .withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002")) .withReadMessageScript(new io.gs2.inbox.model.ScriptSetting() .withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003") .withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004")) .withDeleteMessageScript(new io.gs2.inbox.model.ScriptSetting() .withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005") .withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006")) .withReceiveNotification(null) .withLogSetting(new io.gs2.inbox.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateNamespace( new Gs2.Gs2Inbox.Request.UpdateNamespaceRequest() .WithNamespaceName("namespace-0001") .WithDescription("description1") .WithIsAutomaticDeletingEnabled(false) .WithTransactionSetting(new Gs2.Gs2Inbox.Model.TransactionSetting() .WithEnableAutoRun(false) .WithQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) .WithReceiveMessageScript(new Gs2.Gs2Inbox.Model.ScriptSetting() .WithTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001") .WithDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002")) .WithReadMessageScript(new Gs2.Gs2Inbox.Model.ScriptSetting() .WithTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003") .WithDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004")) .WithDeleteMessageScript(new Gs2.Gs2Inbox.Model.ScriptSetting() .WithTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005") .WithDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006")) .WithReceiveNotification(null) .WithLogSetting(new Gs2.Gs2Inbox.Model.LogSetting() .WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.updateNamespace( new Gs2Inbox.UpdateNamespaceRequest() .withNamespaceName("namespace-0001") .withDescription("description1") .withIsAutomaticDeletingEnabled(false) .withTransactionSetting(new Gs2Inbox.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) .withReceiveMessageScript(new Gs2Inbox.model.ScriptSetting() .withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001") .withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002")) .withReadMessageScript(new Gs2Inbox.model.ScriptSetting() .withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003") .withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004")) .withDeleteMessageScript(new Gs2Inbox.model.ScriptSetting() .withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005") .withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006")) .withReceiveNotification(null) .withLogSetting(new Gs2Inbox.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.update_namespace( inbox.UpdateNamespaceRequest() .with_namespace_name('namespace-0001') .with_description('description1') .with_is_automatic_deleting_enabled(False) .with_transaction_setting( inbox.TransactionSetting() .with_enable_auto_run(False) .with_queue_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002')) .with_receive_message_script( inbox.ScriptSetting() .with_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001') .with_done_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002')) .with_read_message_script( inbox.ScriptSetting() .with_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003') .with_done_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004')) .with_delete_message_script( inbox.ScriptSetting() .with_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005') .with_done_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006')) .with_receive_notification(None) .with_log_setting( inbox.LogSetting() .with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001')) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.update_namespace({ namespaceName="namespace-0001", description="description1", isAutomaticDeletingEnabled=false, transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002", }, receiveMessageScript={ triggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001", doneTriggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002", }, readMessageScript={ triggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003", doneTriggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004", }, deleteMessageScript={ triggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005", doneTriggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006", }, receiveNotification=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.update_namespace_async({ namespaceName="namespace-0001", description="description1", isAutomaticDeletingEnabled=false, transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002", }, receiveMessageScript={ triggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1001", doneTriggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1002", }, readMessageScript={ triggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1003", doneTriggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1004", }, deleteMessageScript={ triggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1005", doneTriggerScriptId="grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script-1006", }, receiveNotification=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### deleteNamespace ネームスペースを削除
指定されたネームスペースを削除します。
この操作は不可逆であり、削除されたネームスペースに関連するすべてのデータは回復不能になります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | 削除したネームスペース | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DeleteNamespace( &inbox.DeleteNamespaceRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DeleteNamespaceRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->deleteNamespace( (new DeleteNamespaceRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DeleteNamespaceRequest; import io.gs2.inbox.result.DeleteNamespaceResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DeleteNamespaceResult result = client.deleteNamespace( new DeleteNamespaceRequest() .withNamespaceName("namespace-0001") ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DeleteNamespace( new Gs2.Gs2Inbox.Request.DeleteNamespaceRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.deleteNamespace( new Gs2Inbox.DeleteNamespaceRequest() .withNamespaceName("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.delete_namespace( inbox.DeleteNamespaceRequest() .with_namespace_name('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.delete_namespace({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.delete_namespace_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getServiceVersion マイクロサービスのバージョンを取得 #### Request リクエストパラメータ: なし #### Result | | 型 | 説明 | | --- | --- | --- | | item | string | バージョン | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetServiceVersion( &inbox.GetServiceVersionRequest { } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetServiceVersionRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getServiceVersion( (new GetServiceVersionRequest()) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetServiceVersionRequest; import io.gs2.inbox.result.GetServiceVersionResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetServiceVersionResult result = client.getServiceVersion( new GetServiceVersionRequest() ); String item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetServiceVersion( new Gs2.Gs2Inbox.Request.GetServiceVersionRequest(), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getServiceVersion( new Gs2Inbox.GetServiceVersionRequest() ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_service_version( inbox.GetServiceVersionRequest() ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_service_version({ }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_service_version_async({ }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### dumpUserDataByUserId 指定したユーザーIDに紐づくデータのダンプを取得
個人情報保護の法的要件を満たすために使用したり、データのバックアップや移行に使用できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DumpUserDataByUserId( &inbox.DumpUserDataByUserIdRequest { UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DumpUserDataByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->dumpUserDataByUserId( (new DumpUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DumpUserDataByUserIdRequest; import io.gs2.inbox.result.DumpUserDataByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DumpUserDataByUserIdResult result = client.dumpUserDataByUserId( new DumpUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DumpUserDataByUserId( new Gs2.Gs2Inbox.Request.DumpUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.dumpUserDataByUserId( new Gs2Inbox.DumpUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.dump_user_data_by_user_id( inbox.DumpUserDataByUserIdRequest() .with_user_id('user-0001') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.dump_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.dump_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### checkDumpUserDataByUserId 指定したユーザーIDに紐づくデータのダンプが完了しているか確認
ダンプが完了している場合、出力データの URL を返します。ダンプがまだ進行中の場合、URL は空になります。
ダンプされたデータには、指定されたユーザーのすべてのメッセージレコードと受信済みグローバルメッセージの追跡データが gzip 形式で圧縮されて含まれます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | url | string | 出力データのURL | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.CheckDumpUserDataByUserId( &inbox.CheckDumpUserDataByUserIdRequest { UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } url := result.Url ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\CheckDumpUserDataByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->checkDumpUserDataByUserId( (new CheckDumpUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); $url = $result->getUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.CheckDumpUserDataByUserIdRequest; import io.gs2.inbox.result.CheckDumpUserDataByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { CheckDumpUserDataByUserIdResult result = client.checkDumpUserDataByUserId( new CheckDumpUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); String url = result.getUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.CheckDumpUserDataByUserId( new Gs2.Gs2Inbox.Request.CheckDumpUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var url = result.Url; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.checkDumpUserDataByUserId( new Gs2Inbox.CheckDumpUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); const url = result.getUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.check_dump_user_data_by_user_id( inbox.CheckDumpUserDataByUserIdRequest() .with_user_id('user-0001') .with_time_offset_token(None) ) url = result.url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.check_dump_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.check_dump_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` --- ### cleanUserDataByUserId ユーザーデータの完全削除
指定されたユーザーIDに紐づくデータのクリーニングを実行します。
これにより、特定のユーザーデータをプロジェクトから安全に削除できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.CleanUserDataByUserId( &inbox.CleanUserDataByUserIdRequest { UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\CleanUserDataByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->cleanUserDataByUserId( (new CleanUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.CleanUserDataByUserIdRequest; import io.gs2.inbox.result.CleanUserDataByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { CleanUserDataByUserIdResult result = client.cleanUserDataByUserId( new CleanUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.CleanUserDataByUserId( new Gs2.Gs2Inbox.Request.CleanUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.cleanUserDataByUserId( new Gs2Inbox.CleanUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.clean_user_data_by_user_id( inbox.CleanUserDataByUserIdRequest() .with_user_id('user-0001') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.clean_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.clean_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### checkCleanUserDataByUserId 指定したユーザーIDのユーザーデータの完全削除が完了しているか確認
クリーン操作の完了状態を返します。クリーン操作は、同じオーナーが所有するすべてのネームスペースにわたって、指定されたユーザーのすべてのメッセージレコードと受信済みグローバルメッセージの追跡データを削除します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.CheckCleanUserDataByUserId( &inbox.CheckCleanUserDataByUserIdRequest { UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\CheckCleanUserDataByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->checkCleanUserDataByUserId( (new CheckCleanUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.CheckCleanUserDataByUserIdRequest; import io.gs2.inbox.result.CheckCleanUserDataByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { CheckCleanUserDataByUserIdResult result = client.checkCleanUserDataByUserId( new CheckCleanUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.CheckCleanUserDataByUserId( new Gs2.Gs2Inbox.Request.CheckCleanUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.checkCleanUserDataByUserId( new Gs2Inbox.CheckCleanUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.check_clean_user_data_by_user_id( inbox.CheckCleanUserDataByUserIdRequest() .with_user_id('user-0001') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.check_clean_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.check_clean_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### prepareImportUserDataByUserId 指定したユーザーIDに紐づくデータのインポートを準備
インポートに使用できるデータは GS2 によってエクスポートして取得したデータに限定され、古いデータはインポートに失敗する可能性があります。
エクスポートしたユーザーIDと異なるユーザーIDでインポートすることができますが、ユーザーデータのペイロード内にユーザーIDが含まれる場合はその限りではありません。
このAPIの戻り値で応答されたURLにエクスポートした zip ファイルをアップロードし、importUserDataByUserId を呼び出すことで実際のインポート処理を開始できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | uploadToken | string | アップロード後に結果を反映する際に使用するトークン | | uploadUrl | string | ユーザーデータアップロード処理の実行に使用するURL | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.PrepareImportUserDataByUserId( &inbox.PrepareImportUserDataByUserIdRequest { UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } uploadToken := result.UploadToken uploadUrl := result.UploadUrl ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\PrepareImportUserDataByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->prepareImportUserDataByUserId( (new PrepareImportUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); $uploadToken = $result->getUploadToken(); $uploadUrl = $result->getUploadUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.PrepareImportUserDataByUserIdRequest; import io.gs2.inbox.result.PrepareImportUserDataByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { PrepareImportUserDataByUserIdResult result = client.prepareImportUserDataByUserId( new PrepareImportUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); String uploadToken = result.getUploadToken(); String uploadUrl = result.getUploadUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.PrepareImportUserDataByUserId( new Gs2.Gs2Inbox.Request.PrepareImportUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var uploadToken = result.UploadToken; var uploadUrl = result.UploadUrl; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.prepareImportUserDataByUserId( new Gs2Inbox.PrepareImportUserDataByUserIdRequest() .withUserId("user-0001") .withTimeOffsetToken(null) ); const uploadToken = result.getUploadToken(); const uploadUrl = result.getUploadUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.prepare_import_user_data_by_user_id( inbox.PrepareImportUserDataByUserIdRequest() .with_user_id('user-0001') .with_time_offset_token(None) ) upload_token = result.upload_token upload_url = result.upload_url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.prepare_import_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.prepare_import_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` --- ### importUserDataByUserId 指定したユーザーIDに紐づくデータのインポートを実行
インポートに使用できるデータは GS2 によってエクスポートして取得したデータに限定され、古いデータはインポートに失敗する可能性があります。
エクスポートしたユーザーIDと異なるユーザーIDでインポートすることができますが、ユーザーデータのペイロード内にユーザーIDが含まれる場合はその限りではありません。
このAPIを呼び出す前に prepareImportUserDataByUserId を呼び出して、アップロード準備を完了させる必要があります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | uploadToken | string | | ✓| | ~ 1024文字 | アップロード準備で受け取ったトークン | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.ImportUserDataByUserId( &inbox.ImportUserDataByUserIdRequest { UserId: pointy.String("user-0001"), UploadToken: pointy.String("upload-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\ImportUserDataByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->importUserDataByUserId( (new ImportUserDataByUserIdRequest()) ->withUserId("user-0001") ->withUploadToken("upload-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.ImportUserDataByUserIdRequest; import io.gs2.inbox.result.ImportUserDataByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { ImportUserDataByUserIdResult result = client.importUserDataByUserId( new ImportUserDataByUserIdRequest() .withUserId("user-0001") .withUploadToken("upload-0001") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.ImportUserDataByUserId( new Gs2.Gs2Inbox.Request.ImportUserDataByUserIdRequest() .WithUserId("user-0001") .WithUploadToken("upload-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.importUserDataByUserId( new Gs2Inbox.ImportUserDataByUserIdRequest() .withUserId("user-0001") .withUploadToken("upload-0001") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.import_user_data_by_user_id( inbox.ImportUserDataByUserIdRequest() .with_user_id('user-0001') .with_upload_token('upload-0001') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.import_user_data_by_user_id({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.import_user_data_by_user_id_async({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### checkImportUserDataByUserId 指定したユーザーIDに紐づくデータのインポートが完了しているか確認
完了状態と、利用可能な場合はインポートログの URL を返します。
インポートは、受信箱データ（inbox.json）を含むアップロードされた ZIP ファイルを処理し、各レコードの構造とデータタイプ（Message または Received）を検証し、指定されたユーザーのレコードを復元します。
データ内のテンプレート変数はインポート中に自動的に置換されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | uploadToken | string | | ✓| | ~ 1024文字 | アップロード準備で受け取ったトークン | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | url | string | 出力ログのURL | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.CheckImportUserDataByUserId( &inbox.CheckImportUserDataByUserIdRequest { UserId: pointy.String("user-0001"), UploadToken: pointy.String("upload-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } url := result.Url ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\CheckImportUserDataByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->checkImportUserDataByUserId( (new CheckImportUserDataByUserIdRequest()) ->withUserId("user-0001") ->withUploadToken("upload-0001") ->withTimeOffsetToken(null) ); $url = $result->getUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.CheckImportUserDataByUserIdRequest; import io.gs2.inbox.result.CheckImportUserDataByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { CheckImportUserDataByUserIdResult result = client.checkImportUserDataByUserId( new CheckImportUserDataByUserIdRequest() .withUserId("user-0001") .withUploadToken("upload-0001") .withTimeOffsetToken(null) ); String url = result.getUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.CheckImportUserDataByUserId( new Gs2.Gs2Inbox.Request.CheckImportUserDataByUserIdRequest() .WithUserId("user-0001") .WithUploadToken("upload-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var url = result.Url; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.checkImportUserDataByUserId( new Gs2Inbox.CheckImportUserDataByUserIdRequest() .withUserId("user-0001") .withUploadToken("upload-0001") .withTimeOffsetToken(null) ); const url = result.getUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.check_import_user_data_by_user_id( inbox.CheckImportUserDataByUserIdRequest() .with_user_id('user-0001') .with_upload_token('upload-0001') .with_time_offset_token(None) ) url = result.url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.check_import_user_data_by_user_id({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.check_import_user_data_by_user_id_async({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` --- ### describeMessages メッセージの一覧を取得
認証済みユーザーの受信箱にあるメッセージのページネーション付きリストを取得します。
isRead パラメータを使用して既読状態でフィルタリングできます。指定しない場合、既読状態に関係なくすべてのメッセージが返されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | isRead | bool? | | | | | 既読状態 | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Message>](#message) | メッセージのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DescribeMessages( &inbox.DescribeMessagesRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), IsRead: nil, PageToken: nil, Limit: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DescribeMessagesRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->describeMessages( (new DescribeMessagesRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withIsRead(null) ->withPageToken(null) ->withLimit(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DescribeMessagesRequest; import io.gs2.inbox.result.DescribeMessagesResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DescribeMessagesResult result = client.describeMessages( new DescribeMessagesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withIsRead(null) .withPageToken(null) .withLimit(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeMessages( new Gs2.Gs2Inbox.Request.DescribeMessagesRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithIsRead(null) .WithPageToken(null) .WithLimit(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var nextPageToken = result.NextPageToken; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.describeMessages( new Gs2Inbox.DescribeMessagesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withIsRead(null) .withPageToken(null) .withLimit(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.describe_messages( inbox.DescribeMessagesRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_is_read(None) .with_page_token(None) .with_limit(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.describe_messages({ namespaceName="namespace-0001", accessToken="accessToken-0001", isRead=nil, pageToken=nil, limit=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.describe_messages_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", isRead=nil, pageToken=nil, limit=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### describeMessagesByUserId ユーザーIDを指定してメッセージの一覧を取得
指定されたユーザーの受信箱にあるメッセージのページネーション付きリストを取得します。
isRead パラメータを使用して既読状態でフィルタリングできます。指定しない場合、既読状態に関係なくすべてのメッセージが返されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | isRead | bool? | | | | | 既読状態 | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Message>](#message) | メッセージのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DescribeMessagesByUserId( &inbox.DescribeMessagesByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), IsRead: nil, PageToken: nil, Limit: nil, TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DescribeMessagesByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->describeMessagesByUserId( (new DescribeMessagesByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withIsRead(null) ->withPageToken(null) ->withLimit(null) ->withTimeOffsetToken(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DescribeMessagesByUserIdRequest; import io.gs2.inbox.result.DescribeMessagesByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DescribeMessagesByUserIdResult result = client.describeMessagesByUserId( new DescribeMessagesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withIsRead(null) .withPageToken(null) .withLimit(null) .withTimeOffsetToken(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeMessagesByUserId( new Gs2.Gs2Inbox.Request.DescribeMessagesByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithIsRead(null) .WithPageToken(null) .WithLimit(null) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var nextPageToken = result.NextPageToken; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.describeMessagesByUserId( new Gs2Inbox.DescribeMessagesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withIsRead(null) .withPageToken(null) .withLimit(null) .withTimeOffsetToken(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.describe_messages_by_user_id( inbox.DescribeMessagesByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_is_read(None) .with_page_token(None) .with_limit(None) .with_time_offset_token(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.describe_messages_by_user_id({ namespaceName="namespace-0001", userId="user-0001", isRead=nil, pageToken=nil, limit=nil, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.describe_messages_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", isRead=nil, pageToken=nil, limit=nil, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### sendMessageByUserId ユーザーIDを指定してメッセージの送信
指定されたユーザーの受信箱に新しいメッセージを作成して配信します。
メッセージにはメタデータ（任意の JSON コンテンツ）と readAcquireActions（メッセージの開封時に付与される報酬）を含めることができます。
メッセージの有効期限は、絶対タイムスタンプ（expiresAt）または配信時点からの相対的な期間（expiresTimeSpan）で設定できます。expiresAt が指定された場合、expiresTimeSpan より優先されます。
メッセージは未読状態（isRead=false）で開始されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | metadata | string | | ✓| | ~ 4096文字 | メタデータ
メッセージのタイトル、本文、送信者情報、表示パラメータなどを含むJSON文字列など、メッセージの内容を表す任意のデータです。GS2はこの値を解釈せず、メッセージUIの描画のためにゲームクライアントにそのまま渡されます。最大4096文字です。 | | readAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | 開封時入手アクション
ユーザーがこのメッセージを開封した際に実行される入手アクションのリストです。アイテム、通貨、リソースなどの報酬をメッセージに添付するために使用されます。複数のアクションを組み合わせて異なる種類の報酬を同時に付与できます。メッセージあたり最大100アクションです。 | | expiresAt | long | | | | | 有効期限日時
UNIX 時間・ミリ秒 | | expiresTimeSpan | [TimeSpan](#timespan) | | | | | メッセージを受信した時刻（基準時刻）からメッセージが削除されるまでの期間 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | 作成したメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.SendMessageByUserId( &inbox.SendMessageByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), Metadata: pointy.String("{\"type\": \"message\", \"body\": \"hello\"}"), ReadAcquireActions: nil, ExpiresAt: nil, ExpiresTimeSpan: nil, TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\SendMessageByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->sendMessageByUserId( (new SendMessageByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withMetadata("{\"type\": \"message\", \"body\": \"hello\"}") ->withReadAcquireActions(null) ->withExpiresAt(null) ->withExpiresTimeSpan(null) ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.SendMessageByUserIdRequest; import io.gs2.inbox.result.SendMessageByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { SendMessageByUserIdResult result = client.sendMessageByUserId( new SendMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMetadata("{\"type\": \"message\", \"body\": \"hello\"}") .withReadAcquireActions(null) .withExpiresAt(null) .withExpiresTimeSpan(null) .withTimeOffsetToken(null) ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.SendMessageByUserId( new Gs2.Gs2Inbox.Request.SendMessageByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithMetadata("{\"type\": \"message\", \"body\": \"hello\"}") .WithReadAcquireActions(null) .WithExpiresAt(null) .WithExpiresTimeSpan(null) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.sendMessageByUserId( new Gs2Inbox.SendMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMetadata("{\"type\": \"message\", \"body\": \"hello\"}") .withReadAcquireActions(null) .withExpiresAt(null) .withExpiresTimeSpan(null) .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.send_message_by_user_id( inbox.SendMessageByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_metadata('{"type": "message", "body": "hello"}') .with_read_acquire_actions(None) .with_expires_at(None) .with_expires_time_span(None) .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.send_message_by_user_id({ namespaceName="namespace-0001", userId="user-0001", metadata="{\"type\": \"message\", \"body\": \"hello\"}", readAcquireActions=nil, expiresAt=nil, expiresTimeSpan=nil, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.send_message_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", metadata="{\"type\": \"message\", \"body\": \"hello\"}", readAcquireActions=nil, expiresAt=nil, expiresTimeSpan=nil, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getMessage メッセージを取得
メタデータ、既読状態、設定された入手アクションを含む、認証済みユーザーの受信箱にある特定のメッセージの詳細を取得します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | メッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetMessage( &inbox.GetMessageRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), MessageName: pointy.String("message-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetMessageRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getMessage( (new GetMessageRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withMessageName("message-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetMessageRequest; import io.gs2.inbox.result.GetMessageResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetMessageResult result = client.getMessage( new GetMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetMessage( new Gs2.Gs2Inbox.Request.GetMessageRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithMessageName("message-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getMessage( new Gs2Inbox.GetMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_message( inbox.GetMessageRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_message_name('message-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_message({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_message_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getMessageByUserId ユーザーIDを指定してメッセージを取得
メタデータ、既読状態、設定された入手アクションを含む、指定されたユーザーの受信箱にある特定のメッセージの詳細を取得します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | メッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetMessageByUserId( &inbox.GetMessageByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), MessageName: pointy.String("message-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetMessageByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getMessageByUserId( (new GetMessageByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withMessageName("message-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetMessageByUserIdRequest; import io.gs2.inbox.result.GetMessageByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetMessageByUserIdResult result = client.getMessageByUserId( new GetMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetMessageByUserId( new Gs2.Gs2Inbox.Request.GetMessageByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithMessageName("message-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getMessageByUserId( new Gs2Inbox.GetMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_message_by_user_id( inbox.GetMessageByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_message_name('message-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_message_by_user_id({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_message_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### receiveGlobalMessage グローバルメッセージのうちまだ受け取っていないメッセージを受信
アクティブなグローバルメッセージを認証済みユーザーの受信箱の個別メッセージに変換します。
アクティブなグローバルメッセージのリストをユーザーの受信追跡レコードと比較して未配信のメッセージを特定し、まだ受信していないメッセージのみ新しいメッセージコピーを作成します。
受信追跡レコードは更新され、以降の呼び出しでの重複配信を防ぎます。
新しく作成されたメッセージのリストを返します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [List<Message>](#message) | 受信したメッセージ一覧 | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.ReceiveGlobalMessage( &inbox.ReceiveGlobalMessageRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\ReceiveGlobalMessageRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->receiveGlobalMessage( (new ReceiveGlobalMessageRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.ReceiveGlobalMessageRequest; import io.gs2.inbox.result.ReceiveGlobalMessageResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { ReceiveGlobalMessageResult result = client.receiveGlobalMessage( new ReceiveGlobalMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") ); List item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.ReceiveGlobalMessage( new Gs2.Gs2Inbox.Request.ReceiveGlobalMessageRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.receiveGlobalMessage( new Gs2Inbox.ReceiveGlobalMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.receive_global_message( inbox.ReceiveGlobalMessageRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.receive_global_message({ namespaceName="namespace-0001", accessToken="accessToken-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.receive_global_message_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### receiveGlobalMessageByUserId ユーザーIDを指定してグローバルメッセージのうちまだ受け取っていないメッセージを受信
アクティブなグローバルメッセージを指定されたユーザーの受信箱の個別メッセージに変換します。
アクティブなグローバルメッセージのリストをユーザーの受信追跡レコードと比較して未配信のメッセージを特定し、まだ受信していないメッセージのみ新しいメッセージコピーを作成します。
受信追跡レコードは更新され、以降の呼び出しでの重複配信を防ぎます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [List<Message>](#message) | 受信したメッセージ一覧 | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.ReceiveGlobalMessageByUserId( &inbox.ReceiveGlobalMessageByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\ReceiveGlobalMessageByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->receiveGlobalMessageByUserId( (new ReceiveGlobalMessageByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.ReceiveGlobalMessageByUserIdRequest; import io.gs2.inbox.result.ReceiveGlobalMessageByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { ReceiveGlobalMessageByUserIdResult result = client.receiveGlobalMessageByUserId( new ReceiveGlobalMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withTimeOffsetToken(null) ); List item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.ReceiveGlobalMessageByUserId( new Gs2.Gs2Inbox.Request.ReceiveGlobalMessageByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.receiveGlobalMessageByUserId( new Gs2Inbox.ReceiveGlobalMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.receive_global_message_by_user_id( inbox.ReceiveGlobalMessageByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.receive_global_message_by_user_id({ namespaceName="namespace-0001", userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.receive_global_message_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### openMessage メッセージを開封済み化
認証済みユーザーの受信箱にある指定されたメッセージを既読（開封済み）としてマークします。
これは入手アクションを実行せずに isRead を true に設定する単純な状態遷移です。
既読にすると同時に関連する報酬を実行するには、代わりに Read API を使用してください。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | メッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.OpenMessage( &inbox.OpenMessageRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), MessageName: pointy.String("message-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\OpenMessageRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->openMessage( (new OpenMessageRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withMessageName("message-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.OpenMessageRequest; import io.gs2.inbox.result.OpenMessageResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { OpenMessageResult result = client.openMessage( new OpenMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.OpenMessage( new Gs2.Gs2Inbox.Request.OpenMessageRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithMessageName("message-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.openMessage( new Gs2Inbox.OpenMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.open_message( inbox.OpenMessageRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_message_name('message-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.open_message({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.open_message_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### openMessageByUserId ユーザーIDを指定してメッセージを開封済み化
指定されたユーザーの受信箱にある指定されたメッセージを既読（開封済み）としてマークします。
これは入手アクションを実行せずに isRead を true に設定する単純な状態遷移です。
既読にすると同時に関連する報酬を実行するには、代わりに Read API を使用してください。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | メッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.OpenMessageByUserId( &inbox.OpenMessageByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), MessageName: pointy.String("message-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\OpenMessageByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->openMessageByUserId( (new OpenMessageByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withMessageName("message-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.OpenMessageByUserIdRequest; import io.gs2.inbox.result.OpenMessageByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { OpenMessageByUserIdResult result = client.openMessageByUserId( new OpenMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.OpenMessageByUserId( new Gs2.Gs2Inbox.Request.OpenMessageByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithMessageName("message-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.openMessageByUserId( new Gs2Inbox.OpenMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.open_message_by_user_id( inbox.OpenMessageByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_message_name('message-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.open_message_by_user_id({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.open_message_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### closeMessageByUserId ユーザーIDを指定してメッセージを未開封化
メッセージの既読状態を未読（isRead=false）に戻します。
これは Open の逆操作であり、メッセージを未読状態に戻すことができます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | メッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.CloseMessageByUserId( &inbox.CloseMessageByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), MessageName: pointy.String("message-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\CloseMessageByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->closeMessageByUserId( (new CloseMessageByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withMessageName("message-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.CloseMessageByUserIdRequest; import io.gs2.inbox.result.CloseMessageByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { CloseMessageByUserIdResult result = client.closeMessageByUserId( new CloseMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.CloseMessageByUserId( new Gs2.Gs2Inbox.Request.CloseMessageByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithMessageName("message-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.closeMessageByUserId( new Gs2Inbox.CloseMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.close_message_by_user_id( inbox.CloseMessageByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_message_name('message-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.close_message_by_user_id({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.close_message_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### readMessage メッセージを開封
メッセージを既読にし、設定された readAcquireActions（報酬）を実行します。
メッセージが既に開封済みの場合、報酬の重複付与を防ぐために「alreadyRead」エラーが返されます。
メッセージに入手アクションがない場合、トランザクションを生成せずに単純に既読としてマークされます。
入手アクションがある場合、報酬トランザクションが返されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | | config | [List<Config>](#config) | | | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | メッセージ | | transactionId | string | 発行されたトランザクションID | | stampSheet | string | スタンプシート | | stampSheetEncryptionKeyId | string | スタンプシートの署名計算に使用した暗号鍵GRN | | autoRunStampSheet | bool? | トランザクションの自動実行が有効か | | atomicCommit | bool? | トランザクションをアトミックにコミットするか | | transaction | string | 発行されたトランザクション | | transactionResult | [TransactionResult](#transactionresult) | トランザクション実行結果 | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.ReadMessage( &inbox.ReadMessageRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), MessageName: pointy.String("message-0001"), Config: nil, } ) if err != nil { panic("error occurred") } item := result.Item transactionId := result.TransactionId stampSheet := result.StampSheet stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId autoRunStampSheet := result.AutoRunStampSheet atomicCommit := result.AtomicCommit transaction := result.Transaction transactionResult := result.TransactionResult ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\ReadMessageRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->readMessage( (new ReadMessageRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withMessageName("message-0001") ->withConfig(null) ); $item = $result->getItem(); $transactionId = $result->getTransactionId(); $stampSheet = $result->getStampSheet(); $stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId(); $autoRunStampSheet = $result->getAutoRunStampSheet(); $atomicCommit = $result->getAtomicCommit(); $transaction = $result->getTransaction(); $transactionResult = $result->getTransactionResult(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.ReadMessageRequest; import io.gs2.inbox.result.ReadMessageResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { ReadMessageResult result = client.readMessage( new ReadMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") .withConfig(null) ); Message item = result.getItem(); String transactionId = result.getTransactionId(); String stampSheet = result.getStampSheet(); String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); boolean autoRunStampSheet = result.getAutoRunStampSheet(); boolean atomicCommit = result.getAtomicCommit(); String transaction = result.getTransaction(); TransactionResult transactionResult = result.getTransactionResult(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.ReadMessage( new Gs2.Gs2Inbox.Request.ReadMessageRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithMessageName("message-0001") .WithConfig(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; var transactionId = result.TransactionId; var stampSheet = result.StampSheet; var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId; var autoRunStampSheet = result.AutoRunStampSheet; var atomicCommit = result.AtomicCommit; var transaction = result.Transaction; var transactionResult = result.TransactionResult; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.readMessage( new Gs2Inbox.ReadMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") .withConfig(null) ); const item = result.getItem(); const transactionId = result.getTransactionId(); const stampSheet = result.getStampSheet(); const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); const autoRunStampSheet = result.getAutoRunStampSheet(); const atomicCommit = result.getAtomicCommit(); const transaction = result.getTransaction(); const transactionResult = result.getTransactionResult(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.read_message( inbox.ReadMessageRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_message_name('message-0001') .with_config(None) ) item = result.item transaction_id = result.transaction_id stamp_sheet = result.stamp_sheet stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id auto_run_stamp_sheet = result.auto_run_stamp_sheet atomic_commit = result.atomic_commit transaction = result.transaction transaction_result = result.transaction_result except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.read_message({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", config=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.read_message_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", config=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` --- ### readMessageByUserId ユーザーIDを指定してメッセージを開封
指定されたユーザーのメッセージを既読にし、設定された readAcquireActions（報酬）を実行します。
メッセージが既に開封済みの場合、報酬の重複付与を防ぐために「alreadyRead」エラーが返されます。
メッセージに入手アクションがない場合、トランザクションを生成せずに単純に既読としてマークされます。
入手アクションがある場合、報酬トランザクションが返されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | | config | [List<Config>](#config) | | | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | メッセージ | | transactionId | string | 発行されたトランザクションID | | stampSheet | string | スタンプシート | | stampSheetEncryptionKeyId | string | スタンプシートの署名計算に使用した暗号鍵GRN | | autoRunStampSheet | bool? | トランザクションの自動実行が有効か | | atomicCommit | bool? | トランザクションをアトミックにコミットするか | | transaction | string | 発行されたトランザクション | | transactionResult | [TransactionResult](#transactionresult) | トランザクション実行結果 | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.ReadMessageByUserId( &inbox.ReadMessageByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), MessageName: pointy.String("message-0001"), Config: nil, TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item transactionId := result.TransactionId stampSheet := result.StampSheet stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId autoRunStampSheet := result.AutoRunStampSheet atomicCommit := result.AtomicCommit transaction := result.Transaction transactionResult := result.TransactionResult ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\ReadMessageByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->readMessageByUserId( (new ReadMessageByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withMessageName("message-0001") ->withConfig(null) ->withTimeOffsetToken(null) ); $item = $result->getItem(); $transactionId = $result->getTransactionId(); $stampSheet = $result->getStampSheet(); $stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId(); $autoRunStampSheet = $result->getAutoRunStampSheet(); $atomicCommit = $result->getAtomicCommit(); $transaction = $result->getTransaction(); $transactionResult = $result->getTransactionResult(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.ReadMessageByUserIdRequest; import io.gs2.inbox.result.ReadMessageByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { ReadMessageByUserIdResult result = client.readMessageByUserId( new ReadMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withConfig(null) .withTimeOffsetToken(null) ); Message item = result.getItem(); String transactionId = result.getTransactionId(); String stampSheet = result.getStampSheet(); String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); boolean autoRunStampSheet = result.getAutoRunStampSheet(); boolean atomicCommit = result.getAtomicCommit(); String transaction = result.getTransaction(); TransactionResult transactionResult = result.getTransactionResult(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.ReadMessageByUserId( new Gs2.Gs2Inbox.Request.ReadMessageByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithMessageName("message-0001") .WithConfig(null) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; var transactionId = result.TransactionId; var stampSheet = result.StampSheet; var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId; var autoRunStampSheet = result.AutoRunStampSheet; var atomicCommit = result.AtomicCommit; var transaction = result.Transaction; var transactionResult = result.TransactionResult; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.readMessageByUserId( new Gs2Inbox.ReadMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withConfig(null) .withTimeOffsetToken(null) ); const item = result.getItem(); const transactionId = result.getTransactionId(); const stampSheet = result.getStampSheet(); const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); const autoRunStampSheet = result.getAutoRunStampSheet(); const atomicCommit = result.getAtomicCommit(); const transaction = result.getTransaction(); const transactionResult = result.getTransactionResult(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.read_message_by_user_id( inbox.ReadMessageByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_message_name('message-0001') .with_config(None) .with_time_offset_token(None) ) item = result.item transaction_id = result.transaction_id stamp_sheet = result.stamp_sheet stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id auto_run_stamp_sheet = result.auto_run_stamp_sheet atomic_commit = result.atomic_commit transaction = result.transaction transaction_result = result.transaction_result except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.read_message_by_user_id({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", config=nil, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.read_message_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", config=nil, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` --- ### batchReadMessages メッセージを一括開封
複数のメッセージを一度にアトミックに開封し、既読としてマークして、結合された readAcquireActions（報酬）を実行します。
指定されたメッセージのいずれかが既に開封済みの場合、「alreadyRead」エラーが返され、メッセージは処理されません。
入手アクションのないメッセージは即座に既読としてマークされ、報酬のあるメッセージは単一のトランザクションでまとめて処理されます。
1回のバッチ操作で最大10件のメッセージを開封できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | messageNames | List<string> | | ✓| | 1 ~ 10 items | メッセージ名リスト | | config | [List<Config>](#config) | | | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Message>](#message) | メッセージのリスト | | transactionId | string | 発行されたトランザクションID | | stampSheet | string | スタンプシート | | stampSheetEncryptionKeyId | string | スタンプシートの署名計算に使用した暗号鍵GRN | | autoRunStampSheet | bool? | トランザクションの自動実行が有効か | | atomicCommit | bool? | トランザクションをアトミックにコミットするか | | transaction | string | 発行されたトランザクション | | transactionResult | [TransactionResult](#transactionresult) | トランザクション実行結果 | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.BatchReadMessages( &inbox.BatchReadMessagesRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), MessageNames: []*string{ pointy.String("message-0001"), pointy.String("message-0002"), }, Config: nil, } ) if err != nil { panic("error occurred") } items := result.Items transactionId := result.TransactionId stampSheet := result.StampSheet stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId autoRunStampSheet := result.AutoRunStampSheet atomicCommit := result.AtomicCommit transaction := result.Transaction transactionResult := result.TransactionResult ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\BatchReadMessagesRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->batchReadMessages( (new BatchReadMessagesRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withMessageNames([ "message-0001", "message-0002", ]) ->withConfig(null) ); $items = $result->getItems(); $transactionId = $result->getTransactionId(); $stampSheet = $result->getStampSheet(); $stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId(); $autoRunStampSheet = $result->getAutoRunStampSheet(); $atomicCommit = $result->getAtomicCommit(); $transaction = $result->getTransaction(); $transactionResult = $result->getTransactionResult(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.BatchReadMessagesRequest; import io.gs2.inbox.result.BatchReadMessagesResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { BatchReadMessagesResult result = client.batchReadMessages( new BatchReadMessagesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageNames(Arrays.asList( "message-0001", "message-0002" )) .withConfig(null) ); List items = result.getItems(); String transactionId = result.getTransactionId(); String stampSheet = result.getStampSheet(); String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); boolean autoRunStampSheet = result.getAutoRunStampSheet(); boolean atomicCommit = result.getAtomicCommit(); String transaction = result.getTransaction(); TransactionResult transactionResult = result.getTransactionResult(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.BatchReadMessages( new Gs2.Gs2Inbox.Request.BatchReadMessagesRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithMessageNames(new string[] { "message-0001", "message-0002", }) .WithConfig(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var transactionId = result.TransactionId; var stampSheet = result.StampSheet; var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId; var autoRunStampSheet = result.AutoRunStampSheet; var atomicCommit = result.AtomicCommit; var transaction = result.Transaction; var transactionResult = result.TransactionResult; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.batchReadMessages( new Gs2Inbox.BatchReadMessagesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageNames([ "message-0001", "message-0002", ]) .withConfig(null) ); const items = result.getItems(); const transactionId = result.getTransactionId(); const stampSheet = result.getStampSheet(); const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); const autoRunStampSheet = result.getAutoRunStampSheet(); const atomicCommit = result.getAtomicCommit(); const transaction = result.getTransaction(); const transactionResult = result.getTransactionResult(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.batch_read_messages( inbox.BatchReadMessagesRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_message_names([ 'message-0001', 'message-0002', ]) .with_config(None) ) items = result.items transaction_id = result.transaction_id stamp_sheet = result.stamp_sheet stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id auto_run_stamp_sheet = result.auto_run_stamp_sheet atomic_commit = result.atomic_commit transaction = result.transaction transaction_result = result.transaction_result except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.batch_read_messages({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageNames={ "message-0001", "message-0002" }, config=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.batch_read_messages_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageNames={ "message-0001", "message-0002" }, config=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` --- ### batchReadMessagesByUserId ユーザーIDを指定してメッセージを一括開封
指定されたユーザーの複数のメッセージを一度にアトミックに開封し、既読としてマークして、結合された readAcquireActions（報酬）を実行します。
指定されたメッセージのいずれかが既に開封済みの場合、「alreadyRead」エラーが返され、メッセージは処理されません。
入手アクションのないメッセージは即座に既読としてマークされ、報酬のあるメッセージは単一のトランザクションでまとめて処理されます。
1回のバッチ操作で最大10件のメッセージを開封できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | messageNames | List<string> | | ✓| | 1 ~ 10 items | メッセージ名リスト | | config | [List<Config>](#config) | | | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Message>](#message) | メッセージのリスト | | transactionId | string | 発行されたトランザクションID | | stampSheet | string | スタンプシート | | stampSheetEncryptionKeyId | string | スタンプシートの署名計算に使用した暗号鍵GRN | | autoRunStampSheet | bool? | トランザクションの自動実行が有効か | | atomicCommit | bool? | トランザクションをアトミックにコミットするか | | transaction | string | 発行されたトランザクション | | transactionResult | [TransactionResult](#transactionresult) | トランザクション実行結果 | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.BatchReadMessagesByUserId( &inbox.BatchReadMessagesByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), MessageNames: []*string{ pointy.String("message-0001"), pointy.String("message-0002"), }, Config: nil, TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } items := result.Items transactionId := result.TransactionId stampSheet := result.StampSheet stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId autoRunStampSheet := result.AutoRunStampSheet atomicCommit := result.AtomicCommit transaction := result.Transaction transactionResult := result.TransactionResult ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\BatchReadMessagesByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->batchReadMessagesByUserId( (new BatchReadMessagesByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withMessageNames([ "message-0001", "message-0002", ]) ->withConfig(null) ->withTimeOffsetToken(null) ); $items = $result->getItems(); $transactionId = $result->getTransactionId(); $stampSheet = $result->getStampSheet(); $stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId(); $autoRunStampSheet = $result->getAutoRunStampSheet(); $atomicCommit = $result->getAtomicCommit(); $transaction = $result->getTransaction(); $transactionResult = $result->getTransactionResult(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.BatchReadMessagesByUserIdRequest; import io.gs2.inbox.result.BatchReadMessagesByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { BatchReadMessagesByUserIdResult result = client.batchReadMessagesByUserId( new BatchReadMessagesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageNames(Arrays.asList( "message-0001", "message-0002" )) .withConfig(null) .withTimeOffsetToken(null) ); List items = result.getItems(); String transactionId = result.getTransactionId(); String stampSheet = result.getStampSheet(); String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); boolean autoRunStampSheet = result.getAutoRunStampSheet(); boolean atomicCommit = result.getAtomicCommit(); String transaction = result.getTransaction(); TransactionResult transactionResult = result.getTransactionResult(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.BatchReadMessagesByUserId( new Gs2.Gs2Inbox.Request.BatchReadMessagesByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithMessageNames(new string[] { "message-0001", "message-0002", }) .WithConfig(null) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var transactionId = result.TransactionId; var stampSheet = result.StampSheet; var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId; var autoRunStampSheet = result.AutoRunStampSheet; var atomicCommit = result.AtomicCommit; var transaction = result.Transaction; var transactionResult = result.TransactionResult; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.batchReadMessagesByUserId( new Gs2Inbox.BatchReadMessagesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageNames([ "message-0001", "message-0002", ]) .withConfig(null) .withTimeOffsetToken(null) ); const items = result.getItems(); const transactionId = result.getTransactionId(); const stampSheet = result.getStampSheet(); const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); const autoRunStampSheet = result.getAutoRunStampSheet(); const atomicCommit = result.getAtomicCommit(); const transaction = result.getTransaction(); const transactionResult = result.getTransactionResult(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.batch_read_messages_by_user_id( inbox.BatchReadMessagesByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_message_names([ 'message-0001', 'message-0002', ]) .with_config(None) .with_time_offset_token(None) ) items = result.items transaction_id = result.transaction_id stamp_sheet = result.stamp_sheet stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id auto_run_stamp_sheet = result.auto_run_stamp_sheet atomic_commit = result.atomic_commit transaction = result.transaction transaction_result = result.transaction_result except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.batch_read_messages_by_user_id({ namespaceName="namespace-0001", userId="user-0001", messageNames={ "message-0001", "message-0002" }, config=nil, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.batch_read_messages_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", messageNames={ "message-0001", "message-0002" }, config=nil, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` --- ### deleteMessage メッセージを削除
認証済みユーザーの受信箱からメッセージを完全に削除します。
既読状態に関係なくメッセージレコードが削除されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | 削除されたメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DeleteMessage( &inbox.DeleteMessageRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), MessageName: pointy.String("message-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DeleteMessageRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->deleteMessage( (new DeleteMessageRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withMessageName("message-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DeleteMessageRequest; import io.gs2.inbox.result.DeleteMessageResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DeleteMessageResult result = client.deleteMessage( new DeleteMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DeleteMessage( new Gs2.Gs2Inbox.Request.DeleteMessageRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithMessageName("message-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.deleteMessage( new Gs2Inbox.DeleteMessageRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withMessageName("message-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.delete_message( inbox.DeleteMessageRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_message_name('message-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.delete_message({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.delete_message_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", messageName="message-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### deleteMessageByUserId ユーザーIDを指定してメッセージを削除
指定されたユーザーの受信箱からメッセージを完全に削除します。
既読状態に関係なくメッセージレコードが削除されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | messageName | string | | ✓| UUID | ~ 36文字 | メッセージ名
メッセージの一意な名前を保持します。
名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Message](#message) | 削除されたメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DeleteMessageByUserId( &inbox.DeleteMessageByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), MessageName: pointy.String("message-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DeleteMessageByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->deleteMessageByUserId( (new DeleteMessageByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withMessageName("message-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DeleteMessageByUserIdRequest; import io.gs2.inbox.result.DeleteMessageByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DeleteMessageByUserIdResult result = client.deleteMessageByUserId( new DeleteMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); Message item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DeleteMessageByUserId( new Gs2.Gs2Inbox.Request.DeleteMessageByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithMessageName("message-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.deleteMessageByUserId( new Gs2Inbox.DeleteMessageByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withMessageName("message-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.delete_message_by_user_id( inbox.DeleteMessageByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_message_name('message-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.delete_message_by_user_id({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.delete_message_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", messageName="message-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### describeGlobalMessages 全ユーザーに向けたメッセージの一覧を取得
指定されたネームスペース内の現在アクティブなグローバルメッセージの一覧を取得します。
受信期間内のメッセージのみが返され、受信ウィンドウ外のメッセージは除外されます。
グローバルメッセージは、ReceiveGlobalMessage API を使用して個々のユーザーメッセージに変換できるブロードキャストメッセージです。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<GlobalMessage>](#globalmessage) | 全ユーザーに向けたメッセージのリスト | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DescribeGlobalMessages( &inbox.DescribeGlobalMessagesRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } items := result.Items ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DescribeGlobalMessagesRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->describeGlobalMessages( (new DescribeGlobalMessagesRequest()) ->withNamespaceName("namespace-0001") ); $items = $result->getItems(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DescribeGlobalMessagesRequest; import io.gs2.inbox.result.DescribeGlobalMessagesResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DescribeGlobalMessagesResult result = client.describeGlobalMessages( new DescribeGlobalMessagesRequest() .withNamespaceName("namespace-0001") ); List items = result.getItems(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeGlobalMessages( new Gs2.Gs2Inbox.Request.DescribeGlobalMessagesRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.describeGlobalMessages( new Gs2Inbox.DescribeGlobalMessagesRequest() .withNamespaceName("namespace-0001") ); const items = result.getItems(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.describe_global_messages( inbox.DescribeGlobalMessagesRequest() .with_namespace_name('namespace-0001') ) items = result.items except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.describe_global_messages({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.describe_global_messages_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; ``` --- ### getGlobalMessage 全ユーザーに向けたメッセージを取得
名前を指定して特定のグローバルメッセージを取得します。
メッセージは受信期間内である必要があります。受信ウィンドウ外の場合、404 エラーが返されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | globalMessageName | string | | ✓| | ~ 128文字 | グローバルメッセージ名
グローバルメッセージ固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [GlobalMessage](#globalmessage) | 全ユーザーに向けたメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetGlobalMessage( &inbox.GetGlobalMessageRequest { NamespaceName: pointy.String("namespace-0001"), GlobalMessageName: pointy.String("globalMessage-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetGlobalMessageRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getGlobalMessage( (new GetGlobalMessageRequest()) ->withNamespaceName("namespace-0001") ->withGlobalMessageName("globalMessage-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetGlobalMessageRequest; import io.gs2.inbox.result.GetGlobalMessageResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetGlobalMessageResult result = client.getGlobalMessage( new GetGlobalMessageRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessage-0001") ); GlobalMessage item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetGlobalMessage( new Gs2.Gs2Inbox.Request.GetGlobalMessageRequest() .WithNamespaceName("namespace-0001") .WithGlobalMessageName("globalMessage-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getGlobalMessage( new Gs2Inbox.GetGlobalMessageRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessage-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_global_message( inbox.GetGlobalMessageRequest() .with_namespace_name('namespace-0001') .with_global_message_name('globalMessage-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_global_message({ namespaceName="namespace-0001", globalMessageName="globalMessage-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_global_message_async({ namespaceName="namespace-0001", globalMessageName="globalMessage-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getReceivedByUserId ユーザーIDを指定して受信済みグローバルメッセージを取得
指定されたユーザーが既に受信したグローバルメッセージ名のリストを取得します。
この追跡レコードは、ReceiveGlobalMessage がまだユーザーに配信されていないグローバルメッセージを判別し、重複配信を防ぐために使用されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Received](#received) | 受信済みグローバルメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetReceivedByUserId( &inbox.GetReceivedByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetReceivedByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getReceivedByUserId( (new GetReceivedByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetReceivedByUserIdRequest; import io.gs2.inbox.result.GetReceivedByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetReceivedByUserIdResult result = client.getReceivedByUserId( new GetReceivedByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withTimeOffsetToken(null) ); Received item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetReceivedByUserId( new Gs2.Gs2Inbox.Request.GetReceivedByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getReceivedByUserId( new Gs2Inbox.GetReceivedByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_received_by_user_id( inbox.GetReceivedByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_received_by_user_id({ namespaceName="namespace-0001", userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_received_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### updateReceivedByUserId ユーザーIDを指定して受信済みグローバルメッセージを更新
ユーザーが受信したグローバルメッセージ名のリストを直接更新します。
特定のグローバルメッセージを受信済みとして手動でマークしたり、再配信のために受信状態をリセットするために使用できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | receivedGlobalMessageNames | List<string> | | | [] | 0 ~ 100 items | 受信済みグローバルメッセージ名リスト
ユーザーが既に受信したグローバルメッセージ名のリストです。グローバルメッセージの受信操作が実行されると、このリストに名前が含まれるメッセージはスキップされます。最大100件です。 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Received](#received) | 更新した受信済みグローバルメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.UpdateReceivedByUserId( &inbox.UpdateReceivedByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), ReceivedGlobalMessageNames: []*string{ pointy.String("message-3001"), pointy.String("message-3002"), pointy.String("message-3003"), }, TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\UpdateReceivedByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->updateReceivedByUserId( (new UpdateReceivedByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withReceivedGlobalMessageNames([ "message-3001", "message-3002", "message-3003", ]) ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.UpdateReceivedByUserIdRequest; import io.gs2.inbox.result.UpdateReceivedByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { UpdateReceivedByUserIdResult result = client.updateReceivedByUserId( new UpdateReceivedByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withReceivedGlobalMessageNames(Arrays.asList( "message-3001", "message-3002", "message-3003" )) .withTimeOffsetToken(null) ); Received item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateReceivedByUserId( new Gs2.Gs2Inbox.Request.UpdateReceivedByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithReceivedGlobalMessageNames(new string[] { "message-3001", "message-3002", "message-3003", }) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.updateReceivedByUserId( new Gs2Inbox.UpdateReceivedByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withReceivedGlobalMessageNames([ "message-3001", "message-3002", "message-3003", ]) .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.update_received_by_user_id( inbox.UpdateReceivedByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_received_global_message_names([ 'message-3001', 'message-3002', 'message-3003', ]) .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.update_received_by_user_id({ namespaceName="namespace-0001", userId="user-0001", receivedGlobalMessageNames={ "message-3001", "message-3002", "message-3003" }, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.update_received_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", receivedGlobalMessageNames={ "message-3001", "message-3002", "message-3003" }, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### deleteReceivedByUserId ユーザーIDを指定して受信済みグローバルメッセージを削除
指定されたユーザーの受信追跡レコードを削除します。
削除後、次回の ReceiveGlobalMessage 呼び出し時にすべてのアクティブなグローバルメッセージが未受信として扱われ、個別メッセージとして再配信されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Received](#received) | 受信済みグローバルメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DeleteReceivedByUserId( &inbox.DeleteReceivedByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DeleteReceivedByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->deleteReceivedByUserId( (new DeleteReceivedByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DeleteReceivedByUserIdRequest; import io.gs2.inbox.result.DeleteReceivedByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DeleteReceivedByUserIdResult result = client.deleteReceivedByUserId( new DeleteReceivedByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withTimeOffsetToken(null) ); Received item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DeleteReceivedByUserId( new Gs2.Gs2Inbox.Request.DeleteReceivedByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.deleteReceivedByUserId( new Gs2Inbox.DeleteReceivedByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.delete_received_by_user_id( inbox.DeleteReceivedByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.delete_received_by_user_id({ namespaceName="namespace-0001", userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.delete_received_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### exportMaster グローバルメッセージマスターを有効化可能なマスターデータ形式でエクスポート
ネームスペース内のすべてのグローバルメッセージマスターを、有効化に適した JSON ドキュメントとしてエクスポートします。
エクスポートされるデータには、各グローバルメッセージの完全な設定（メタデータ、開封時入手アクション、有効期限設定、受信期間参照）が含まれます。
このデータは別のネームスペースでマスターデータを有効化するために使用したり、バージョン管理目的で保存したりできます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentMessageMaster](#currentmessagemaster) | 有効化可能なグローバルメッセージのマスターデータ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.ExportMaster( &inbox.ExportMasterRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\ExportMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->exportMaster( (new ExportMasterRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.ExportMasterRequest; import io.gs2.inbox.result.ExportMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { ExportMasterResult result = client.exportMaster( new ExportMasterRequest() .withNamespaceName("namespace-0001") ); CurrentMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.ExportMaster( new Gs2.Gs2Inbox.Request.ExportMasterRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.exportMaster( new Gs2Inbox.ExportMasterRequest() .withNamespaceName("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.export_master( inbox.ExportMasterRequest() .with_namespace_name('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.export_master({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.export_master_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getCurrentMessageMaster 現在アクティブなグローバルメッセージのマスターデータを取得
ネームスペース内で利用可能なグローバルメッセージを定義する、現在アクティブなマスターデータを取得します。
これは最後に有効化されたデータであり、グローバルメッセージリクエストと ReceiveGlobalMessage 操作の提供に使用されています。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentMessageMaster](#currentmessagemaster) | 現在アクティブなグローバルメッセージのマスターデータ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetCurrentMessageMaster( &inbox.GetCurrentMessageMasterRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetCurrentMessageMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getCurrentMessageMaster( (new GetCurrentMessageMasterRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetCurrentMessageMasterRequest; import io.gs2.inbox.result.GetCurrentMessageMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetCurrentMessageMasterResult result = client.getCurrentMessageMaster( new GetCurrentMessageMasterRequest() .withNamespaceName("namespace-0001") ); CurrentMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetCurrentMessageMaster( new Gs2.Gs2Inbox.Request.GetCurrentMessageMasterRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getCurrentMessageMaster( new Gs2Inbox.GetCurrentMessageMasterRequest() .withNamespaceName("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_current_message_master( inbox.GetCurrentMessageMasterRequest() .with_namespace_name('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_current_message_master({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_current_message_master_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### preUpdateCurrentMessageMaster 現在アクティブなマスターデータを更新（3フェーズ版）
1MBを超えるマスターデータをアップロードする場合は、3フェーズで更新を行います。
1. このAPIを実行し、アップロード用のトークンとURLを取得します。
2. 取得したURLに対して、マスターデータをアップロードします。
3. UpdateCurrentMessageMaster にアップロードで取得したトークンを渡して実行し、マスターデータを反映します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | uploadToken | string | アップロード後に結果を反映する際に使用するトークン | | uploadUrl | string | アップロード処理の実行に使用するURL | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.PreUpdateCurrentMessageMaster( &inbox.PreUpdateCurrentMessageMasterRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } uploadToken := result.UploadToken uploadUrl := result.UploadUrl ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\PreUpdateCurrentMessageMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->preUpdateCurrentMessageMaster( (new PreUpdateCurrentMessageMasterRequest()) ->withNamespaceName("namespace-0001") ); $uploadToken = $result->getUploadToken(); $uploadUrl = $result->getUploadUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.PreUpdateCurrentMessageMasterRequest; import io.gs2.inbox.result.PreUpdateCurrentMessageMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { PreUpdateCurrentMessageMasterResult result = client.preUpdateCurrentMessageMaster( new PreUpdateCurrentMessageMasterRequest() .withNamespaceName("namespace-0001") ); String uploadToken = result.getUploadToken(); String uploadUrl = result.getUploadUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.PreUpdateCurrentMessageMaster( new Gs2.Gs2Inbox.Request.PreUpdateCurrentMessageMasterRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var uploadToken = result.UploadToken; var uploadUrl = result.UploadUrl; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.preUpdateCurrentMessageMaster( new Gs2Inbox.PreUpdateCurrentMessageMasterRequest() .withNamespaceName("namespace-0001") ); const uploadToken = result.getUploadToken(); const uploadUrl = result.getUploadUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.pre_update_current_message_master( inbox.PreUpdateCurrentMessageMasterRequest() .with_namespace_name('namespace-0001') ) upload_token = result.upload_token upload_url = result.upload_url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.pre_update_current_message_master({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.pre_update_current_message_master_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` --- ### updateCurrentMessageMaster 現在アクティブなグローバルメッセージのマスターデータを更新
現在アクティブなグローバルメッセージを置き換える新しいマスターデータを有効化します。
2つのモードをサポートします：「direct」はインライン JSON データ用（小さなペイロードに適用）、「preUpload」は署名付き URL 経由でアップロードされたデータ用（1MBを超えるデータに必要、PreUpdate で取得したトークンを使用）。
有効化後、新しいグローバルメッセージは ReceiveGlobalMessage 操作に即座に利用可能になります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | mode | 文字列列挙型
enum {
  "direct",
  "preUpload"
}
| | | "direct" | | 更新モード"direct": マスターデータを直接更新 / "preUpload": マスターデータをアップロードしてから更新 / | | settings | string | {mode} == "direct" | ✓※| | ~ 5242880 バイト (5MB) | マスターデータ
※ mode が "direct" であれば必須 | | uploadToken | string | {mode} == "preUpload" | ✓※| | ~ 1024文字 | 事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。
※ mode が "preUpload" であれば必須 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentMessageMaster](#currentmessagemaster) | 更新された現在アクティブなグローバルメッセージのマスターデータ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.UpdateCurrentMessageMaster( &inbox.UpdateCurrentMessageMasterRequest { NamespaceName: pointy.String("namespace-0001"), Mode: pointy.String("direct"), Settings: pointy.String("{\n \"version\": \"2020-03-12\",\n \"globalMessages\": [\n {\n \"name\": \"message-0001\",\n \"metadata\": \"hoge\"\n },\n {\n \"name\": \"message-0002\",\n \"metadata\": \"fuga\",\n \"readAcquireActions\": [\n {\n \"action\": \"Gs2Inventory:AcquireItemSetByUserId\",\n \"request\": \"Gs2Inventory:AcquireItemSetByUserId-request\"\n }\n ],\n \"expiresTimeSpan\": {\n \"days\": 1,\n \"hours\": 2,\n \"minutes\": 3\n }\n },\n {\n \"name\": \"message-0003\",\n \"metadata\": \"piyo\",\n \"expiresAt\": 1000\n }\n ]\n}"), UploadToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\UpdateCurrentMessageMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->updateCurrentMessageMaster( (new UpdateCurrentMessageMasterRequest()) ->withNamespaceName("namespace-0001") ->withMode("direct") ->withSettings("{\n \"version\": \"2020-03-12\",\n \"globalMessages\": [\n {\n \"name\": \"message-0001\",\n \"metadata\": \"hoge\"\n },\n {\n \"name\": \"message-0002\",\n \"metadata\": \"fuga\",\n \"readAcquireActions\": [\n {\n \"action\": \"Gs2Inventory:AcquireItemSetByUserId\",\n \"request\": \"Gs2Inventory:AcquireItemSetByUserId-request\"\n }\n ],\n \"expiresTimeSpan\": {\n \"days\": 1,\n \"hours\": 2,\n \"minutes\": 3\n }\n },\n {\n \"name\": \"message-0003\",\n \"metadata\": \"piyo\",\n \"expiresAt\": 1000\n }\n ]\n}") ->withUploadToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.UpdateCurrentMessageMasterRequest; import io.gs2.inbox.result.UpdateCurrentMessageMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { UpdateCurrentMessageMasterResult result = client.updateCurrentMessageMaster( new UpdateCurrentMessageMasterRequest() .withNamespaceName("namespace-0001") .withMode("direct") .withSettings("{\n \"version\": \"2020-03-12\",\n \"globalMessages\": [\n {\n \"name\": \"message-0001\",\n \"metadata\": \"hoge\"\n },\n {\n \"name\": \"message-0002\",\n \"metadata\": \"fuga\",\n \"readAcquireActions\": [\n {\n \"action\": \"Gs2Inventory:AcquireItemSetByUserId\",\n \"request\": \"Gs2Inventory:AcquireItemSetByUserId-request\"\n }\n ],\n \"expiresTimeSpan\": {\n \"days\": 1,\n \"hours\": 2,\n \"minutes\": 3\n }\n },\n {\n \"name\": \"message-0003\",\n \"metadata\": \"piyo\",\n \"expiresAt\": 1000\n }\n ]\n}") .withUploadToken(null) ); CurrentMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateCurrentMessageMaster( new Gs2.Gs2Inbox.Request.UpdateCurrentMessageMasterRequest() .WithNamespaceName("namespace-0001") .WithMode("direct") .WithSettings("{\n \"version\": \"2020-03-12\",\n \"globalMessages\": [\n {\n \"name\": \"message-0001\",\n \"metadata\": \"hoge\"\n },\n {\n \"name\": \"message-0002\",\n \"metadata\": \"fuga\",\n \"readAcquireActions\": [\n {\n \"action\": \"Gs2Inventory:AcquireItemSetByUserId\",\n \"request\": \"Gs2Inventory:AcquireItemSetByUserId-request\"\n }\n ],\n \"expiresTimeSpan\": {\n \"days\": 1,\n \"hours\": 2,\n \"minutes\": 3\n }\n },\n {\n \"name\": \"message-0003\",\n \"metadata\": \"piyo\",\n \"expiresAt\": 1000\n }\n ]\n}") .WithUploadToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.updateCurrentMessageMaster( new Gs2Inbox.UpdateCurrentMessageMasterRequest() .withNamespaceName("namespace-0001") .withMode("direct") .withSettings("{\n \"version\": \"2020-03-12\",\n \"globalMessages\": [\n {\n \"name\": \"message-0001\",\n \"metadata\": \"hoge\"\n },\n {\n \"name\": \"message-0002\",\n \"metadata\": \"fuga\",\n \"readAcquireActions\": [\n {\n \"action\": \"Gs2Inventory:AcquireItemSetByUserId\",\n \"request\": \"Gs2Inventory:AcquireItemSetByUserId-request\"\n }\n ],\n \"expiresTimeSpan\": {\n \"days\": 1,\n \"hours\": 2,\n \"minutes\": 3\n }\n },\n {\n \"name\": \"message-0003\",\n \"metadata\": \"piyo\",\n \"expiresAt\": 1000\n }\n ]\n}") .withUploadToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.update_current_message_master( inbox.UpdateCurrentMessageMasterRequest() .with_namespace_name('namespace-0001') .with_mode('direct') .with_settings('{\n "version": "2020-03-12",\n "globalMessages": [\n {\n "name": "message-0001",\n "metadata": "hoge"\n },\n {\n "name": "message-0002",\n "metadata": "fuga",\n "readAcquireActions": [\n {\n "action": "Gs2Inventory:AcquireItemSetByUserId",\n "request": "Gs2Inventory:AcquireItemSetByUserId-request"\n }\n ],\n "expiresTimeSpan": {\n "days": 1,\n "hours": 2,\n "minutes": 3\n }\n },\n {\n "name": "message-0003",\n "metadata": "piyo",\n "expiresAt": 1000\n }\n ]\n}') .with_upload_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.update_current_message_master({ namespaceName="namespace-0001", mode="direct", settings="{\n \"version\": \"2020-03-12\",\n \"globalMessages\": [\n {\n \"name\": \"message-0001\",\n \"metadata\": \"hoge\"\n },\n {\n \"name\": \"message-0002\",\n \"metadata\": \"fuga\",\n \"readAcquireActions\": [\n {\n \"action\": \"Gs2Inventory:AcquireItemSetByUserId\",\n \"request\": \"Gs2Inventory:AcquireItemSetByUserId-request\"\n }\n ],\n \"expiresTimeSpan\": {\n \"days\": 1,\n \"hours\": 2,\n \"minutes\": 3\n }\n },\n {\n \"name\": \"message-0003\",\n \"metadata\": \"piyo\",\n \"expiresAt\": 1000\n }\n ]\n}", uploadToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.update_current_message_master_async({ namespaceName="namespace-0001", mode="direct", settings="{\n \"version\": \"2020-03-12\",\n \"globalMessages\": [\n {\n \"name\": \"message-0001\",\n \"metadata\": \"hoge\"\n },\n {\n \"name\": \"message-0002\",\n \"metadata\": \"fuga\",\n \"readAcquireActions\": [\n {\n \"action\": \"Gs2Inventory:AcquireItemSetByUserId\",\n \"request\": \"Gs2Inventory:AcquireItemSetByUserId-request\"\n }\n ],\n \"expiresTimeSpan\": {\n \"days\": 1,\n \"hours\": 2,\n \"minutes\": 3\n }\n },\n {\n \"name\": \"message-0003\",\n \"metadata\": \"piyo\",\n \"expiresAt\": 1000\n }\n ]\n}", uploadToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### updateCurrentMessageMasterFromGitHub 現在アクティブなグローバルメッセージのマスターデータをGitHubから更新
GitHub リポジトリからマスターデータを取得し、現在のグローバルメッセージ設定として有効化します。
チェックアウト設定で、マスターデータ JSON を取得するリポジトリ、ブランチ/タグ、およびファイルパスを指定します。
ファイル内のテンプレート変数（region、ownerId、userId）は処理中に自動的に置換されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | checkoutSetting | [GitHubCheckoutSetting](#githubcheckoutsetting) | | ✓| | | GitHubからマスターデータをチェックアウトする設定 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentMessageMaster](#currentmessagemaster) | 更新された現在アクティブなグローバルメッセージのマスターデータ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.UpdateCurrentMessageMasterFromGitHub( &inbox.UpdateCurrentMessageMasterFromGitHubRequest { NamespaceName: pointy.String("namespace-0001"), CheckoutSetting: &inbox.GitHubCheckoutSetting{ ApiKeyId: pointy.String("apiKeyId-0001"), RepositoryName: pointy.String("gs2io/master-data"), SourcePath: pointy.String("path/to/file.json"), ReferenceType: pointy.String("branch"), BranchName: pointy.String("develop"), }, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\UpdateCurrentMessageMasterFromGitHubRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->updateCurrentMessageMasterFromGitHub( (new UpdateCurrentMessageMasterFromGitHubRequest()) ->withNamespaceName("namespace-0001") ->withCheckoutSetting((new GitHubCheckoutSetting()) ->withApiKeyId("apiKeyId-0001") ->withRepositoryName("gs2io/master-data") ->withSourcePath("path/to/file.json") ->withReferenceType("branch") ->withBranchName("develop") ) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.UpdateCurrentMessageMasterFromGitHubRequest; import io.gs2.inbox.result.UpdateCurrentMessageMasterFromGitHubResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { UpdateCurrentMessageMasterFromGitHubResult result = client.updateCurrentMessageMasterFromGitHub( new UpdateCurrentMessageMasterFromGitHubRequest() .withNamespaceName("namespace-0001") .withCheckoutSetting(new GitHubCheckoutSetting() .withApiKeyId("apiKeyId-0001") .withRepositoryName("gs2io/master-data") .withSourcePath("path/to/file.json") .withReferenceType("branch") .withBranchName("develop") ) ); CurrentMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateCurrentMessageMasterFromGitHub( new Gs2.Gs2Inbox.Request.UpdateCurrentMessageMasterFromGitHubRequest() .WithNamespaceName("namespace-0001") .WithCheckoutSetting(new Gs2.Gs2Inbox.Model.GitHubCheckoutSetting() .WithApiKeyId("apiKeyId-0001") .WithRepositoryName("gs2io/master-data") .WithSourcePath("path/to/file.json") .WithReferenceType("branch") .WithBranchName("develop") ), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.updateCurrentMessageMasterFromGitHub( new Gs2Inbox.UpdateCurrentMessageMasterFromGitHubRequest() .withNamespaceName("namespace-0001") .withCheckoutSetting(new Gs2Inbox.model.GitHubCheckoutSetting() .withApiKeyId("apiKeyId-0001") .withRepositoryName("gs2io/master-data") .withSourcePath("path/to/file.json") .withReferenceType("branch") .withBranchName("develop") ) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.update_current_message_master_from_git_hub( inbox.UpdateCurrentMessageMasterFromGitHubRequest() .with_namespace_name('namespace-0001') .with_checkout_setting(inbox.GitHubCheckoutSetting() .with_api_key_id('apiKeyId-0001') .with_repository_name('gs2io/master-data') .with_source_path('path/to/file.json') .with_reference_type('branch') .with_branch_name('develop') ) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.update_current_message_master_from_git_hub({ namespaceName="namespace-0001", checkoutSetting={ api_key_id="apiKeyId-0001", repository_name="gs2io/master-data", source_path="path/to/file.json", reference_type="branch", branch_name="develop", }, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.update_current_message_master_from_git_hub_async({ namespaceName="namespace-0001", checkoutSetting={ api_key_id="apiKeyId-0001", repository_name="gs2io/master-data", source_path="path/to/file.json", reference_type="branch", branch_name="develop", }, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### describeGlobalMessageMasters 全ユーザーに向けたメッセージの一覧を取得
受信期間に関係なく、指定されたネームスペース内のすべてのグローバルメッセージマスターのページネーション付きリストを取得します。
まだアクティブでないメッセージや既に期限切れのメッセージも含む、管理用のビューです。
名前の接頭辞によるオプションのフィルタリングをサポートします。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | namePrefix | string | | | | ~ 64文字 | 全ユーザーに向けたメッセージ名のフィルター接頭辞 | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<GlobalMessageMaster>](#globalmessagemaster) | 全ユーザーに向けたメッセージのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DescribeGlobalMessageMasters( &inbox.DescribeGlobalMessageMastersRequest { NamespaceName: pointy.String("namespace-0001"), NamePrefix: nil, PageToken: nil, Limit: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DescribeGlobalMessageMastersRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->describeGlobalMessageMasters( (new DescribeGlobalMessageMastersRequest()) ->withNamespaceName("namespace-0001") ->withNamePrefix(null) ->withPageToken(null) ->withLimit(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DescribeGlobalMessageMastersRequest; import io.gs2.inbox.result.DescribeGlobalMessageMastersResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DescribeGlobalMessageMastersResult result = client.describeGlobalMessageMasters( new DescribeGlobalMessageMastersRequest() .withNamespaceName("namespace-0001") .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeGlobalMessageMasters( new Gs2.Gs2Inbox.Request.DescribeGlobalMessageMastersRequest() .WithNamespaceName("namespace-0001") .WithNamePrefix(null) .WithPageToken(null) .WithLimit(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var nextPageToken = result.NextPageToken; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.describeGlobalMessageMasters( new Gs2Inbox.DescribeGlobalMessageMastersRequest() .withNamespaceName("namespace-0001") .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.describe_global_message_masters( inbox.DescribeGlobalMessageMastersRequest() .with_namespace_name('namespace-0001') .with_name_prefix(None) .with_page_token(None) .with_limit(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.describe_global_message_masters({ namespaceName="namespace-0001", namePrefix=nil, pageToken=nil, limit=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.describe_global_message_masters_async({ namespaceName="namespace-0001", namePrefix=nil, pageToken=nil, limit=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### createGlobalMessageMaster グローバルメッセージマスターを新規作成
全ユーザーにブロードキャストされる新しいグローバルメッセージテンプレートを作成します。
readAcquireActions（メッセージの開封時に付与される報酬）と、メッセージの有効期限を絶対タイムスタンプ（expiresAt）またはユーザーが受信した時点からの相対的な期間（expiresTimeSpan）で設定できます。
オプションで、messageReceptionPeriodEventId に GS2-Schedule のイベントを参照して、ユーザーがメッセージを受信できる時間ウィンドウを制御できます。
作成したマスターは、現在のマスターデータの更新プロセスを通じて有効化する必要があります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | name | string | | ✓| UUID | ~ 64文字 | グローバルメッセージ名
ネームスペース内でこのグローバルメッセージを一意に識別する名前です。各ユーザーが既に受信したグローバルメッセージを追跡し、重複配信を防止するために使用されます。指定しない場合はUUIDとして自動生成されます。 | | metadata | string | | ✓| | ~ 4096文字 | メタデータ
メッセージのタイトル、本文、表示パラメータなどを含むJSON文字列など、グローバルメッセージの内容を表す任意のデータです。ユーザーがこのグローバルメッセージを受信すると、メタデータは受信ボックス内の個別メッセージにコピーされます。GS2はこの値を解釈しません。最大4096文字です。 | | readAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | 開封時入手アクション
このグローバルメッセージからコピーされたメッセージをユーザーが開封した際に実行される入手アクションのリストです。これらのアクションはメタデータとともに各ユーザーの個別メッセージにコピーされます。グローバルメッセージあたり最大100アクションです。 | | expiresTimeSpan | [TimeSpan](#timespan) | | | | | 有効期限までの期間
ユーザーがこのグローバルメッセージを受信（コピー）した時刻から、コピーされたメッセージが期限切れとなり受信ボックスから自動削除されるまでの期間です。日、時間、分の組み合わせで指定します。有効期限に達するとメッセージは既読状態に関わらず削除され、未受け取りの添付報酬も含めて削除されます。 | | messageReceptionPeriodEventId | string | | | | ~ 1024文字 | メッセージ受信期間イベントID
このグローバルメッセージを受信（ユーザーの受信ボックスにコピー）できる時間枠を定義するGS2-ScheduleイベントのGRNです。この期間外では、ユーザーがグローバルメッセージの受信操作をトリガーしてもメッセージは配信されません。期間限定のイベント告知や季節キャンペーン報酬に便利です。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [GlobalMessageMaster](#globalmessagemaster) | 作成した全ユーザーに向けたメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.CreateGlobalMessageMaster( &inbox.CreateGlobalMessageMasterRequest { NamespaceName: pointy.String("namespace-0001"), Name: pointy.String("globalMessageMaster-0001"), Metadata: pointy.String("{\"type\": \"globalMessageMaster\", \"body\": \"hello\"}"), ReadAcquireActions: []inbox.AcquireAction{ inbox.AcquireAction{ Action: pointy.String("Gs2Inventory:AcquireItemSetByUserId"), Request: pointy.String("Gs2Inventory:AcquireItemSetByUserId-request"), }, }, ExpiresTimeSpan: nil, MessageReceptionPeriodEventId: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\CreateGlobalMessageMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->createGlobalMessageMaster( (new CreateGlobalMessageMasterRequest()) ->withNamespaceName("namespace-0001") ->withName("globalMessageMaster-0001") ->withMetadata("{\"type\": \"globalMessageMaster\", \"body\": \"hello\"}") ->withReadAcquireActions([ (new \Gs2\Inbox\Model\AcquireAction()) ->withAction("Gs2Inventory:AcquireItemSetByUserId") ->withRequest("Gs2Inventory:AcquireItemSetByUserId-request"), ]) ->withExpiresTimeSpan(null) ->withMessageReceptionPeriodEventId(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.CreateGlobalMessageMasterRequest; import io.gs2.inbox.result.CreateGlobalMessageMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { CreateGlobalMessageMasterResult result = client.createGlobalMessageMaster( new CreateGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withName("globalMessageMaster-0001") .withMetadata("{\"type\": \"globalMessageMaster\", \"body\": \"hello\"}") .withReadAcquireActions(Arrays.asList( new io.gs2.inbox.model.AcquireAction() .withAction("Gs2Inventory:AcquireItemSetByUserId") .withRequest("Gs2Inventory:AcquireItemSetByUserId-request") )) .withExpiresTimeSpan(null) .withMessageReceptionPeriodEventId(null) ); GlobalMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.CreateGlobalMessageMaster( new Gs2.Gs2Inbox.Request.CreateGlobalMessageMasterRequest() .WithNamespaceName("namespace-0001") .WithName("globalMessageMaster-0001") .WithMetadata("{\"type\": \"globalMessageMaster\", \"body\": \"hello\"}") .WithReadAcquireActions(new Gs2.Core.Model.AcquireAction[] { new Gs2.Core.Model.AcquireAction() .WithAction("Gs2Inventory:AcquireItemSetByUserId") .WithRequest("Gs2Inventory:AcquireItemSetByUserId-request"), }) .WithExpiresTimeSpan(null) .WithMessageReceptionPeriodEventId(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.createGlobalMessageMaster( new Gs2Inbox.CreateGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withName("globalMessageMaster-0001") .withMetadata("{\"type\": \"globalMessageMaster\", \"body\": \"hello\"}") .withReadAcquireActions([ new Gs2Inbox.model.AcquireAction() .withAction("Gs2Inventory:AcquireItemSetByUserId") .withRequest("Gs2Inventory:AcquireItemSetByUserId-request"), ]) .withExpiresTimeSpan(null) .withMessageReceptionPeriodEventId(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.create_global_message_master( inbox.CreateGlobalMessageMasterRequest() .with_namespace_name('namespace-0001') .with_name('globalMessageMaster-0001') .with_metadata('{"type": "globalMessageMaster", "body": "hello"}') .with_read_acquire_actions([ inbox.AcquireAction() .with_action('Gs2Inventory:AcquireItemSetByUserId') .with_request('Gs2Inventory:AcquireItemSetByUserId-request'), ]) .with_expires_time_span(None) .with_message_reception_period_event_id(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.create_global_message_master({ namespaceName="namespace-0001", name="globalMessageMaster-0001", metadata="{\"type\": \"globalMessageMaster\", \"body\": \"hello\"}", readAcquireActions={ { action="Gs2Inventory:AcquireItemSetByUserId", request="Gs2Inventory:AcquireItemSetByUserId-request", } }, expiresTimeSpan=nil, messageReceptionPeriodEventId=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.create_global_message_master_async({ namespaceName="namespace-0001", name="globalMessageMaster-0001", metadata="{\"type\": \"globalMessageMaster\", \"body\": \"hello\"}", readAcquireActions={ { action="Gs2Inventory:AcquireItemSetByUserId", request="Gs2Inventory:AcquireItemSetByUserId-request", } }, expiresTimeSpan=nil, messageReceptionPeriodEventId=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getGlobalMessageMaster 全ユーザーに向けたメッセージを取得
メタデータ、開封時入手アクション、有効期限設定、受信期間設定を含む、特定のグローバルメッセージマスターの詳細を取得します。
GlobalMessage の Get API とは異なり、受信期間内かどうかに関係なくメッセージを返します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | globalMessageName | string | | ✓| UUID | ~ 64文字 | グローバルメッセージ名
ネームスペース内でこのグローバルメッセージを一意に識別する名前です。各ユーザーが既に受信したグローバルメッセージを追跡し、重複配信を防止するために使用されます。指定しない場合はUUIDとして自動生成されます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [GlobalMessageMaster](#globalmessagemaster) | 全ユーザーに向けたメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.GetGlobalMessageMaster( &inbox.GetGlobalMessageMasterRequest { NamespaceName: pointy.String("namespace-0001"), GlobalMessageName: pointy.String("globalMessageMaster-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\GetGlobalMessageMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->getGlobalMessageMaster( (new GetGlobalMessageMasterRequest()) ->withNamespaceName("namespace-0001") ->withGlobalMessageName("globalMessageMaster-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.GetGlobalMessageMasterRequest; import io.gs2.inbox.result.GetGlobalMessageMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { GetGlobalMessageMasterResult result = client.getGlobalMessageMaster( new GetGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessageMaster-0001") ); GlobalMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.GetGlobalMessageMaster( new Gs2.Gs2Inbox.Request.GetGlobalMessageMasterRequest() .WithNamespaceName("namespace-0001") .WithGlobalMessageName("globalMessageMaster-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.getGlobalMessageMaster( new Gs2Inbox.GetGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessageMaster-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.get_global_message_master( inbox.GetGlobalMessageMasterRequest() .with_namespace_name('namespace-0001') .with_global_message_name('globalMessageMaster-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.get_global_message_master({ namespaceName="namespace-0001", globalMessageName="globalMessageMaster-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.get_global_message_master_async({ namespaceName="namespace-0001", globalMessageName="globalMessageMaster-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### updateGlobalMessageMaster 全ユーザーに向けたメッセージを更新
既存のグローバルメッセージマスターのプロパティを更新します。
メタデータ、開封時入手アクション（報酬）、有効期限設定、受信期間イベント参照を変更できます。
変更は、現在のマスターデータの更新プロセスを通じて有効化する必要があります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | globalMessageName | string | | ✓| UUID | ~ 64文字 | グローバルメッセージ名
ネームスペース内でこのグローバルメッセージを一意に識別する名前です。各ユーザーが既に受信したグローバルメッセージを追跡し、重複配信を防止するために使用されます。指定しない場合はUUIDとして自動生成されます。 | | metadata | string | | ✓| | ~ 4096文字 | メタデータ
メッセージのタイトル、本文、表示パラメータなどを含むJSON文字列など、グローバルメッセージの内容を表す任意のデータです。ユーザーがこのグローバルメッセージを受信すると、メタデータは受信ボックス内の個別メッセージにコピーされます。GS2はこの値を解釈しません。最大4096文字です。 | | readAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | 開封時入手アクション
このグローバルメッセージからコピーされたメッセージをユーザーが開封した際に実行される入手アクションのリストです。これらのアクションはメタデータとともに各ユーザーの個別メッセージにコピーされます。グローバルメッセージあたり最大100アクションです。 | | expiresTimeSpan | [TimeSpan](#timespan) | | | | | 有効期限までの期間
ユーザーがこのグローバルメッセージを受信（コピー）した時刻から、コピーされたメッセージが期限切れとなり受信ボックスから自動削除されるまでの期間です。日、時間、分の組み合わせで指定します。有効期限に達するとメッセージは既読状態に関わらず削除され、未受け取りの添付報酬も含めて削除されます。 | | messageReceptionPeriodEventId | string | | | | ~ 1024文字 | メッセージ受信期間イベントID
このグローバルメッセージを受信（ユーザーの受信ボックスにコピー）できる時間枠を定義するGS2-ScheduleイベントのGRNです。この期間外では、ユーザーがグローバルメッセージの受信操作をトリガーしてもメッセージは配信されません。期間限定のイベント告知や季節キャンペーン報酬に便利です。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [GlobalMessageMaster](#globalmessagemaster) | 更新した全ユーザーに向けたメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.UpdateGlobalMessageMaster( &inbox.UpdateGlobalMessageMasterRequest { NamespaceName: pointy.String("namespace-0001"), GlobalMessageName: pointy.String("globalMessageMaster-0001"), Metadata: pointy.String("{\"type\": \"globalMessageMaster2\", \"body\": \"hello2\"}"), ReadAcquireActions: []inbox.AcquireAction{ inbox.AcquireAction{ Action: pointy.String("Gs2Inventory:AcquireItemSetByUserId2"), Request: pointy.String("Gs2Inventory:AcquireItemSetByUserId-request2"), }, }, ExpiresTimeSpan: &inbox.TimeSpan{ Days: pointy.Int32(1), Hours: pointy.Int32(2), Minutes: pointy.Int32(3), }, MessageReceptionPeriodEventId: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\UpdateGlobalMessageMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->updateGlobalMessageMaster( (new UpdateGlobalMessageMasterRequest()) ->withNamespaceName("namespace-0001") ->withGlobalMessageName("globalMessageMaster-0001") ->withMetadata("{\"type\": \"globalMessageMaster2\", \"body\": \"hello2\"}") ->withReadAcquireActions([ (new \Gs2\Inbox\Model\AcquireAction()) ->withAction("Gs2Inventory:AcquireItemSetByUserId2") ->withRequest("Gs2Inventory:AcquireItemSetByUserId-request2"), ]) ->withExpiresTimeSpan((new \Gs2\Inbox\Model\TimeSpan()) ->withDays(1) ->withHours(2) ->withMinutes(3)) ->withMessageReceptionPeriodEventId(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.UpdateGlobalMessageMasterRequest; import io.gs2.inbox.result.UpdateGlobalMessageMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { UpdateGlobalMessageMasterResult result = client.updateGlobalMessageMaster( new UpdateGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessageMaster-0001") .withMetadata("{\"type\": \"globalMessageMaster2\", \"body\": \"hello2\"}") .withReadAcquireActions(Arrays.asList( new io.gs2.inbox.model.AcquireAction() .withAction("Gs2Inventory:AcquireItemSetByUserId2") .withRequest("Gs2Inventory:AcquireItemSetByUserId-request2") )) .withExpiresTimeSpan(new io.gs2.inbox.model.TimeSpan() .withDays(1) .withHours(2) .withMinutes(3)) .withMessageReceptionPeriodEventId(null) ); GlobalMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateGlobalMessageMaster( new Gs2.Gs2Inbox.Request.UpdateGlobalMessageMasterRequest() .WithNamespaceName("namespace-0001") .WithGlobalMessageName("globalMessageMaster-0001") .WithMetadata("{\"type\": \"globalMessageMaster2\", \"body\": \"hello2\"}") .WithReadAcquireActions(new Gs2.Core.Model.AcquireAction[] { new Gs2.Core.Model.AcquireAction() .WithAction("Gs2Inventory:AcquireItemSetByUserId2") .WithRequest("Gs2Inventory:AcquireItemSetByUserId-request2"), }) .WithExpiresTimeSpan(new Gs2.Gs2Inbox.Model.TimeSpan_() .WithDays(1) .WithHours(2) .WithMinutes(3)) .WithMessageReceptionPeriodEventId(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.updateGlobalMessageMaster( new Gs2Inbox.UpdateGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessageMaster-0001") .withMetadata("{\"type\": \"globalMessageMaster2\", \"body\": \"hello2\"}") .withReadAcquireActions([ new Gs2Inbox.model.AcquireAction() .withAction("Gs2Inventory:AcquireItemSetByUserId2") .withRequest("Gs2Inventory:AcquireItemSetByUserId-request2"), ]) .withExpiresTimeSpan(new Gs2Inbox.model.TimeSpan() .withDays(1) .withHours(2) .withMinutes(3)) .withMessageReceptionPeriodEventId(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.update_global_message_master( inbox.UpdateGlobalMessageMasterRequest() .with_namespace_name('namespace-0001') .with_global_message_name('globalMessageMaster-0001') .with_metadata('{"type": "globalMessageMaster2", "body": "hello2"}') .with_read_acquire_actions([ inbox.AcquireAction() .with_action('Gs2Inventory:AcquireItemSetByUserId2') .with_request('Gs2Inventory:AcquireItemSetByUserId-request2'), ]) .with_expires_time_span( inbox.TimeSpan() .with_days(1) .with_hours(2) .with_minutes(3)) .with_message_reception_period_event_id(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.update_global_message_master({ namespaceName="namespace-0001", globalMessageName="globalMessageMaster-0001", metadata="{\"type\": \"globalMessageMaster2\", \"body\": \"hello2\"}", readAcquireActions={ { action="Gs2Inventory:AcquireItemSetByUserId2", request="Gs2Inventory:AcquireItemSetByUserId-request2", } }, expiresTimeSpan={ days=1, hours=2, minutes=3, }, messageReceptionPeriodEventId=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.update_global_message_master_async({ namespaceName="namespace-0001", globalMessageName="globalMessageMaster-0001", metadata="{\"type\": \"globalMessageMaster2\", \"body\": \"hello2\"}", readAcquireActions={ { action="Gs2Inventory:AcquireItemSetByUserId2", request="Gs2Inventory:AcquireItemSetByUserId-request2", } }, expiresTimeSpan={ days=1, hours=2, minutes=3, }, messageReceptionPeriodEventId=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### deleteGlobalMessageMaster 全ユーザーに向けたメッセージを削除
指定されたグローバルメッセージマスターを削除します。
マスターデータの更新を有効化した後、メッセージは新しいユーザーの受信に利用できなくなります。
既に個別メッセージとしてユーザーに受信されたメッセージは影響を受けません。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | globalMessageName | string | | ✓| UUID | ~ 64文字 | グローバルメッセージ名
ネームスペース内でこのグローバルメッセージを一意に識別する名前です。各ユーザーが既に受信したグローバルメッセージを追跡し、重複配信を防止するために使用されます。指定しない場合はUUIDとして自動生成されます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [GlobalMessageMaster](#globalmessagemaster) | 削除した全ユーザーに向けたメッセージ | #### 実装例 **Go** ```go import "github.com/gs2io/gs2-golang-sdk/core" import "github.com/gs2io/gs2-golang-sdk/inbox" import "github.com/openlyinc/pointy" session := core.Gs2RestSession{ Credential: &core.BasicGs2Credential{ ClientId: "your client id", ClientSecret: "your client secret", }, Region: core.ApNortheast1, } if err := session.Connect(); err != nil { panic("error occurred") } client := inbox.Gs2InboxRestClient{ Session: &session, } result, err := client.DeleteGlobalMessageMaster( &inbox.DeleteGlobalMessageMasterRequest { NamespaceName: pointy.String("namespace-0001"), GlobalMessageName: pointy.String("globalMessageMaster-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php use Gs2\Core\Model\BasicGs2Credential; use Gs2\Core\Model\Region; use Gs2\Core\Net\Gs2RestSession; use Gs2\Core\Exception\Gs2Exception; use Gs2\Inbox\Gs2InboxRestClient; use Gs2\Inbox\Request\DeleteGlobalMessageMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2InboxRestClient( $session ); try { $result = $client->deleteGlobalMessageMaster( (new DeleteGlobalMessageMasterRequest()) ->withNamespaceName("namespace-0001") ->withGlobalMessageName("globalMessageMaster-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java import io.gs2.core.model.Region; import io.gs2.core.model.BasicGs2Credential; import io.gs2.core.rest.Gs2RestSession; import io.gs2.core.exception.Gs2Exception; import io.gs2.inbox.rest.Gs2InboxRestClient; import io.gs2.inbox.request.DeleteGlobalMessageMasterRequest; import io.gs2.inbox.result.DeleteGlobalMessageMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2InboxRestClient client = new Gs2InboxRestClient(session); try { DeleteGlobalMessageMasterResult result = client.deleteGlobalMessageMaster( new DeleteGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessageMaster-0001") ); GlobalMessageMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2InboxRestClient(session); AsyncResult asyncResult = null; yield return client.DeleteGlobalMessageMaster( new Gs2.Gs2Inbox.Request.DeleteGlobalMessageMasterRequest() .WithNamespaceName("namespace-0001") .WithGlobalMessageName("globalMessageMaster-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript import Gs2Core from '@/gs2/core'; import * as Gs2Inbox from '@/gs2/inbox'; const session = new Gs2Core.Gs2RestSession( "ap-northeast-1", new Gs2Core.BasicGs2Credential( 'your client id', 'your client secret' ) ); await session.connect(); const client = new Gs2Inbox.Gs2InboxRestClient(session); try { const result = await client.deleteGlobalMessageMaster( new Gs2Inbox.DeleteGlobalMessageMasterRequest() .withNamespaceName("namespace-0001") .withGlobalMessageName("globalMessageMaster-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python from gs2 import core from gs2 import inbox session = core.Gs2RestSession( core.BasicGs2Credential( 'your client id', 'your client secret' ), "ap-northeast-1", ) session.connect() client = inbox.Gs2InboxRestClient(session) try: result = client.delete_global_message_master( inbox.DeleteGlobalMessageMasterRequest() .with_namespace_name('namespace-0001') .with_global_message_name('globalMessageMaster-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('inbox') api_result = client.delete_global_message_master({ namespaceName="namespace-0001", globalMessageName="globalMessageMaster-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('inbox') api_result_handler = client.delete_global_message_master_async({ namespaceName="namespace-0001", globalMessageName="globalMessageMaster-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` ---