Method: recall.linkPersona

提供されたリコール セッション ID でエンコードされている PGS プレーヤー プリンシパルをゲーム内アカウントに関連付ける

HTTP リクエスト

POST https://games.googleapis.com/games/v1/recall:linkPersona

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "sessionId": string,
  "persona": string,
  "token": string,
  "cardinalityConstraint": enum (RecallTokensCardinalityConstraint),
  "conflictingLinksResolutionPolicy": enum (ConflictingLinksResolutionPolicy),

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
フィールド
sessionId

string

必須。サーバーで生成される不透明な文字列。PGS プレーヤー、Google のユーザー、アプリケーションを識別するために必要なすべての情報をエンコードします。
persona

string

必須。ゲーム内アカウントの固定の ID。同じペルソナを異なるゲームに再利用しないでください。
token

string

必須。作成するトークンの値。Play ゲームには不透明で、不安定であるとみなされます（鍵のローテーションで暗号化されます）。
cardinalityConstraint

enum (RecallTokensCardinalityConstraint)

必須。ペルソナをゲームのスコープ内のプレーヤーにリンクする際に監視するカーディナリティ制約。
共用体フィールド expiration。トークンの有効期限または有効期間（省略可）。expiration は次のいずれかになります。
expireTime

string (Timestamp format)

入力のみ。有効期限（省略可）。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
ttl

string (Duration format)

入力のみ。有効期間（省略可）。

「s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

レスポンスの本文

ペルソナのリンクを試みた結果。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "state": enum (State)
}
フィールド
state

enum (State)

出力のみ。ペルソナのリンク試行のステータス。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/androidpublisher

詳細については、OAuth 2.0 の概要をご覧ください。

RecallTokensCardinalityConstraint

ペルソナをゲームのスコープ内のプレーヤーにリンクする際に監視するカーディナリティ制約。

列挙型
ONE_PERSONA_TO_ONE_PLAYER

ゲーム内ペルソナと Play ゲームサービス プレーヤーの間の 1 対 1 のカーディナリティ。

リンク操作の終了時までに、プレーヤーとペルソナのエントリは 1 つのみで、アプリケーションのスコープ内に残ります。

この制約を指定したときに新しいリンクが作成されるかどうかは、選択した ConflictingLinksResolutionPolicy によって決まります。

  • KEEP_EXISTING_LINKS が指定されていて、指定されたペルソナがすでに別のプレーヤーにリンクされている場合、またはプレーヤーがすでに別のペルソナにリンクされている場合、新しいリンクは作成されず、既存のリンクはそのまま維持されます。

  • CREATE_NEW_LINK が指定されていて、指定されたペルソナがすでに別のプレーヤーにリンクされている場合、またはプレーヤーがすでに別のペルソナにリンクされている場合は、新しいリンクが作成されるため古いリンクが削除されます。

ConflictingLinksResolutionPolicy

ペルソナをプレーヤーにリンクすると、指定されたカーディナリティ制約に違反する場合に適用される解決ポリシー。

列挙型

状態

ペルソナのリンク試行のステータス。

列挙型
PERSONA_OR_PLAYER_ALREADY_LINKED リクエストで指定されたリンクは作成されませんでした。すでに既存のリンクが作成されると、指定された RecallTokensCardinalityConstraint に違反する新しいリンクが作成されるためです。