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

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

string

必須。作成するトークンの値。Play Games に対して不透明で、安定していないと見なされます（鍵のローテーションで暗号化されます）。
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

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

リンク オペレーションの終了までに、プレーヤーとペルソナのエントリが 1 つだけアプリケーションのスコープ内に残るようにする必要があります。

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

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

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

ConflictingLinksResolutionPolicy

ペルソナとプレーヤーのリンクが、指定された基数制約に違反する結果となる場合に適用される解決策ポリシー。

列挙型

状態

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

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