プロフィール読み取り

  • [アーティクル]

プロファイルには、プレイヤー プロフィール、エンティティ プロフィール、キャラクター プロフィール、グループ、およびインベントリに関連して保存されたすべてのデータが含まれます。 プロフィール データは、個々のプレーヤー、プレーヤーのグループ、またはアイテムに適用される情報であり、PlayFab によって Key/Value Pairs (KVP) に格納されます。

次の API を使用すると、プロファイル読み取りメーターがインクリメントされます。

管理 API

  • CheckLimitedEditionItemAvailability 限定エディションの項目のグローバルカウントを確認します。

  • GetAllSegments プレイヤー セグメント定義の配列を取得します。 この結果は、セグメント ID を必要とする GetPlayersInSegment などの後続の API 呼び出しで使用できます。 セグメント名は変更できますが、そのセグメントの ID は変更されません。

  • ExportMasterPlayerData マスター プレイヤー アカウントのすべての関連データをエクスポートします。

  • GetCatalogItems 定義されているすべてのプロパティを含む、タイトルの仮想商品カタログの指定されたバージョンを取得します。

  • GetContentList タイトルのすべての内容を一覧表示し、サイズなどの統計情報を取得します。

  • GetDataReport 要求されたレポートのダウンロード URL を取得します。

  • GetPlayerSegments この時点でプレイヤーが現在属しているすべてのセグメントを一覧表示します。

  • GetPlayerTags プレイヤー プロファイルから特定の名前空間 (省略可能) を持つすべてのタグを取得します。

  • GetPolicy 要求されたポリシーを取得します。

  • GetPublisherData カスタム パブリッシャー設定のキー値ストアを取得します。

  • GetRandomResultTables タイトルのランダム ドロップ テーブル構成を取得します。

  • GetStoreItems すべての価格を含め、指定したストアに定義されている一連のアイテムを取得します。

  • GetTitleData クライアントが読み取ることができるカスタム タイトル設定のキー値ストアを取得します。

  • [GetUserAccountInfo](指定された一意識別子との一致に基づいて、指定されたユーザーに関連する詳細を取得します) 指定された一意識別子との一致に基づいて、指定されたユーザーに関連する詳細を取得します。

  • GetUserBans ユーザーのすべての禁止を取得します。

  • GetUserData クライアントが読み取りおよび書き込み可能なユーザーのタイトル固有のカスタム データを取得します。

  • GetUserInternalData クライアントがアクセスできないユーザーのタイトル固有のカスタム データを取得します。

  • GetUserInventory 指定されたユーザーの仮想商品の現在のインベントリを取得します

  • GetUserPublisherData クライアントが読み取りおよび書き込み可能なパブリッシャー固有のカスタム データを取得します。

  • GetUserPublisherInternalData クライアントがアクセスできないパブリッシャー固有のカスタム データを取得します。

  • GetUserPublisherReadOnlyData クライアントによる読み取り専用のパブリッシャー固有のカスタム データを取得します。

  • GetUserReadOnlyData クライアントによる読み取り専用のユーザー向けタイトル固有のカスタム データを取得します。

  • ListVirtualCurrencyTypesタイトルに対して定義されているすべての仮想通貨の一覧を返します

  • GetPlayerIdFromAuthToken 承認トークンからプレイヤーの ID を取得します。

  • GetPlayersInSegment 特定のセグメント内のすべてのプレイヤーをページングできます。 この API は、作成時にセグメント定義に一致し、Total Seconds to Live を通じて存続するすべてのプレイヤー プロファイルのスナップショットを作成し、後続の継続トークンの使用ごとに有効期間を更新します。 ページングの過程で変更されたプロファイルは、結果に反映されません。 AB テスト セグメントは現在、この操作ではサポートされていません。

  • GetExperiments タイトルのすべての実験の詳細を取得します。

  • GetLatestScorecard タイトルの実験の最新のスコアカードを取得します。

  • GetTreatmentAssignment タイトルで実行中のすべての実験について、プレーヤーの治療の割り当てを取得します。

クライアント API

  • GetAllUsersCharacters 特定のユーザーに属するすべての文字を一覧表示します。 CharacterId はグローバルに一意ではありません。一意性を保証するには、characterId を親 PlayFabId で評価する必要があります。

  • GetCatalogItems 定義されているすべてのプロパティを含む、タイトルの仮想商品カタログの指定されたバージョンを取得します。

  • GetCharacterData クライアントが読み取りおよび書き込み可能なキャラクターのタイトル固有のカスタム データを取得します。

  • GetCharacterInventory 指定されたキャラクターの仮想商品の現在のインベントリを取得します。

  • GetCharacterLeaderboard 指定された統計情報のランク付けされた文字の一覧を、ランキング内の示されたポイントから取得します。

  • GetCharacterReadOnlyData クライアントによる読み取り専用のキャラクター向けタイトル固有のカスタム データを取得します。

  • GetCharacterStatistics ユーザーのすべてのタイトル固有の統計情報の詳細を取得します。

  • GetFriendLeaderboard 指定された統計情報のランク付けされた現在のプレイヤーのフレンドの一覧を、ランキング内の示されたポイントから取得します。

  • GetFriendLeaderboardAroundPlayer 要求された PlayFab ユーザーを中心に、特定の統計情報について現在のプレイヤーのランク付けされたフレンドの一覧を取得します。 PlayFabId が空または null の場合、現在ログインしているユーザーが返されます。

  • GetFriendsList PlayFab アカウントを持つユーザーに制限されたローカル ユーザーの現在のフレンド リストを取得します。 リンクされたアカウント (Facebook、Steam) からのフレンドも含まれています。 必要に応じて、リンクされたサービスのフレンドを除外できます。

  • GetLeaderboard 指定された統計情報のランク付けされたユーザーの一覧を、ランキング内の示されたポイントから取得します。

  • GetLeaderboardAroundCharacter 要求されたキャラクター ID を中心に、特定の統計情報のランク付けされたキャラクターの一覧を取得します。

  • GetLeaderboardAroundPlayer 要求されたプレイヤーを中心に、特定の統計情報のランク付けされたユーザーの一覧を取得します。 PlayFabId が空または null の場合、現在ログインしているユーザーが返されます。

  • GetLeaderboardForUserCharacters 特定の統計情報に対するすべてのユーザーのキャラクターの一覧を取得します。

  • GetPaymentToken プロバイダーがトランザクションを開始するために playfab (フルフィルメント機能) を必要とするが、クライアントがフローの残りの部分を完了する支払いフローの場合。 Xsolla の場合、ここで返されたトークンは、カートを作成するためにクライアントによって Xsolla に渡されます。 支払いが完了したら、返された OrderId を使用して GetPurchase をポーリングします。

  • GetPlayerProfile プレイヤーのプロフィールを取得します。

  • GetPlayerSegments この時点でプレイヤーが現在属しているすべてのセグメントを一覧表示します。

  • GetPlayerStatistics ローカル プレーヤーの指定された統計情報 (何も指定されていない場合は、すべての統計情報の現在のバージョンと値) を取得します。

  • GetPlayerStatisticVersions 指定された統計情報の利用可能なバージョンに関する情報を取得します。

  • GetPlayerTags プレイヤー プロファイルから特定の名前空間 (省略可能) を持つすべてのタグを取得します。

  • GetPlayerTrades プレイヤーが開いたか受け入れたすべてのトレードを取得します。オプションで、トレード ステータスによってフィルター処理できます。

  • GetPlayFabIDsFromFacebookIDs Facebook 識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromFacebookInstantGamesIds Facebook Instant Game 識別子の特定のセットについて一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromGameCenterIDs 指定された一連の Game Center 識別子の一意の PlayFab 識別子を取得します (プレイヤー識別子としてGame Center プログラミング ガイドで参照)。

  • GetPlayFabIDsFromGenericIDs 任意の汎用的なサービス識別子のセットについて一意な PlayFab 識別子を取得します。 汎用識別子は、サービス名のほかプレイヤーのサービス固有 ID です。汎用識別子がプレイヤー アカウントに追加されたときにタイトルによって指定されます。

  • GetPlayFabIDsFromGoogleIDs Google 識別子の特定のセットの一意な PlayFab 識別子を取得します。 Google 識別子は、Google+ People API 呼び出しで "ID" として使用できるユーザー アカウントの ID です。

  • GetPlayFabIDsFromKongregateIDs Kongregate 識別子の特定のセットの一意な PlayFab 識別子を取得します。 Kongregate 識別子はユーザー アカウントの ID であり、Kongregate API メソッド (例: http://developers.kongregate.com/docs/client/getUserId) から "user_id" として使用できます。

  • GetPlayFabIDsFromNintendoSwitchDeviceIds Nintendo Switch 識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromPSNAccountIDs PlayStation™Network 識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromSteamIDs Steam 識別子の特定のセットの一意な PlayFab 識別子を取得します。 Steam 識別子は、Steamworks Community API 呼び出しで SteamId として使用できる、ユーザー アカウントのプロファイル ID です。

  • GetPlayFabIDsFromTwitchIDs Twitch 識別子の特定のセットの一意な PlayFab 識別子を取得します。 Twitch 識別子はユーザー アカウントの ID です。Twitch API メソッド (例: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser) から "_id" として使用できます。

  • GetPlayFabIDsFromXboxLiveIDs XboxLive 識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPublisherData カスタム パブリッシャー設定のキー値ストアを取得します。

  • GetPurchase 現在の PlayFab 状態と共に購入を取得します。 まだアクティブな購入から在庫品目を返します。

  • GetSharedGroupData 共有グループ オブジェクトに格納されているデータと、グループ内のメンバーの一覧を取得します。 グループの非メンバーは、メンバーシップを含むグループ データを取得するためにこれを使用できますが、プライベートとしてマークされたキーのデータは受信しません。 共有グループは、ごく少数のプレイヤー間でデータを共有するように設計されています。「共有グループ データの使用」を参照してください。

  • GetStoreItems すべての価格を含め、指定したストアに定義されている一連のアイテムを取得します。

  • GetTitleData カスタム タイトル設定のキー値ストアを取得します。

  • GetAccountInfo ユーザーの PlayFab アカウントの詳細を取得します。

  • LoginWithAndroidDeviceID Android デバイス識別子を使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithCustomID タイトルで生成されるカスタムの一意な識別子を使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithEmailAddressユーザーを PlayFab アカウントにサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。 他のほとんどのログイン API 呼び出しとは異なり、LoginWithEmailAddress では CreateAccountFlag を介した新しいアカウントの作成は許可されません。 電子メール アドレスは、RegisterPlayFabUser を使用してアカウントを作成するために使用できます。

  • LoginWithFacebook Facebook アクセス トークンを使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithFacebookInstantGamesId Facebook Instant Games ID を使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。 Facebook インスタント ゲームを構成する必要があります。

  • LoginWithGameCenter iOS ゲーム センター プレイヤー識別子を使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithGoogleAccount iOS ゲーム センター プレイヤー識別子を使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithIOSDeviceID Google アカウントの資格情報を使用してユーザーをサインインさせます。

  • LoginWithKongregate Kongregate プレイヤー アカウントを使用してユーザーをサインインさせます。

  • LoginWithNintendoSwitchDeviceIdNintendo Switch Device ID を使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithOpenIdConnect タイトルと Open ID Connect プロバイダーの間の既存のリレーションシップによって作成された Open ID Connect JWT を持つユーザーをログインさせます。

  • 認証されたユーザーを必要とする LoginWithPlayFab。 他のほとんどのログイン API 呼び出しとは異なり、LoginWithPlayFab では CreateAccountFlag を介した新しいアカウントの作成は許可されません。 ユーザー名/パスワードの資格情報は、RegisterPlayFabUser を使用してアカウントを作成したり、AddUsernamePassword を使用して既存のアカウントに追加したりするために使用できます。

  • LoginWithPSN ユーザーを PlayFab アカウントにサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。 他のほとんどのログイン API 呼び出しとは異なり、LoginWithPlayFab では CreateAccountFlag を介した新しいアカウントの作成は許可されません。 ユーザー名/パスワードの資格情報は、RegisterPlayFabUser を使用してアカウントを作成したり、AddUsernamePassword を使用して既存のアカウントに追加したりするために使用できます。

  • LoginWithSteam Steam 識別子チケットを使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithTwitch Twitch アクセス トークンを使用してユーザーをサインインさせます。

  • LoginWithXbox Xbox Live トークンを使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • GetPlayerCombinedInfo ユーザーのさまざまな種類の情報をすべて取得します。

"PlayStation" は、Sony Interactive Entertainment Inc. の登録商標または商標です。

データ API

  • GetObjects エンティティのプロファイルからオブジェクトを取得します。

グループ API

  • GetGroup グループとそのロールに関する情報を取得します。

  • IsMember エンティティがグループまたはグループ内のロールのメンバーであるかどうかを確認します。

  • ListGroupApplications グループに参加するための未処理の要求をすべて一覧表示します。

  • ListGroupBlocks グループへの参加がブロックされているすべてのエンティティを一覧表示します。

  • ListGroupInvitations グループの未処理の招待をすべて一覧表示します。

  • ListGroupMembers グループのメンバーすべてを一覧表示します。

  • ListMembership エンティティのすべてのグループとロールを一覧表示します。

  • ListMembershipOpportunities エンティティのすべての未処理の招待とグループ アプリケーションを一覧表示します。

プロファイル API

  • GetGlobalPolicy グローバル タイトル アクセス ポリシーを取得します。

  • GetProfile エンティティのプロファイルを取得します。

  • GetProfile エンティティのプロファイルを取得します。

  • GetTitlePlayersFromMasterPlayerAccountIds 指定されたマスター プレイヤー アカウントに関連付けられているタイトル プレイヤー アカウントを取得します。

サーバー API

  • EvaluateRandomResultTable Random Result Table の評価の結果を返します。Random Result Table がバンドルまたは UnlockContainer の呼び出しを介して追加された場合に、プレイヤー インベントリに追加されたゲーム カタログの ItemId です。

  • GetAllSegments プレイヤー セグメント定義の配列を取得します。 この結果は、セグメント ID を必要とする GetPlayersInSegment などの後続の API 呼び出しで使用できます。 セグメント名は変更できますが、そのセグメントの ID は変更されません。

  • GetAllUsersCharacters 特定のユーザーに属するすべての文字を一覧表示します。 CharacterId はグローバルに一意ではありません。一意性を保証するには、characterId を親 PlayFabId で評価する必要があります。

  • GetCatalogItems 定義されているすべてのプロパティを含む、タイトルの仮想商品カタログの指定されたバージョンを取得します。

  • GetCharacterData クライアントが読み取りおよび書き込み可能なユーザーのタイトル固有のカスタム データを取得します。

  • GetCharacterInternalData クライアントがアクセスできないユーザーのキャラクターのタイトル固有のカスタム データを取得します。

  • GetCharacterInventory 指定されたキャラクターの仮想商品の現在のインベントリを取得します。

  • GetCharacterReadOnlyData

  • GetCharacterStatistics 特定のキャラクターのすべてのタイトル固有の統計情報の詳細を取得します。

  • GetFriendLeaderboard 指定された統計情報のランク付けされた任意のプレイヤーのフレンドの一覧を、ランキング内の示されたポイントから取得します。

  • GetFriendsList PlayFabId のあるユーザーの現在のフレンド リストを取得します。PlayFab アカウントを持つユーザーに制限されます。 リンクされたアカウント (Facebook、Steam) からのフレンドも含まれています。 必要に応じて、リンクされたサービスのフレンドを除外できます。

  • GetLeaderboard 指定された統計情報のランク付けされたユーザーの一覧を、ランキング内の示されたポイントから取得します。

  • GetLeaderboardAroundCharacter 要求されたユーザー を中心に、特定の統計情報のランク付けされたキャラクターの一覧を取得します。

  • GetLeaderboardAroundUser 要求されたユーザー を中心に、特定の統計情報のランク付けされたキャラクターの一覧を取得します。

  • GetLeaderboardForUserCharacters 特定の統計情報に対するすべてのユーザーのキャラクターの一覧を取得します。

  • GetPlayerCombinedInfo ユーザーの応答で要求された情報を返します。 PII (メール アドレス、Facebook ID など) が返される場合があることに注意してください。 すべてのパラメーターの既定値は false です。

  • GetPlayerProfile プレイヤーのプロフィールを取得します。

  • GetPlayerSegments この時点でプレイヤーが現在属しているすべてのセグメントを一覧表示します。

  • GetPlayersInSegment 特定のセグメント内のすべてのプレイヤーをページングできます。 この API は、作成時にセグメント定義に一致し、Total Seconds to Live を通じて存続するすべてのプレイヤー プロファイルのスナップショットを作成し、後続の継続トークンの使用ごとに有効期間を更新します。 ページングの過程で変更されたプロファイルは、結果に反映されません。 AB テスト セグメントは現在、この操作ではサポートされていません。

  • GetPlayerStatistics ローカル プレーヤーの指定された統計情報の現在のバージョンと値を取得します。

  • GetPlayerStatisticVersions 指定された統計情報の利用可能なバージョンに関する情報を取得します。

  • GetPlayerTags プレイヤー プロファイルから特定の名前空間 (省略可能) を持つすべてのタグを取得します。

  • GetPlayFabIDsFromFacebookIDs Facebook 識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromFacebookInstantGamesIds Facebook 識別子の特定のセットについて一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromGenericIDs 任意の汎用的なサービス識別子のセットについて一意な PlayFab 識別子を取得します。 汎用識別子は、サービス名のほかプレイヤーのサービス固有 ID です。汎用識別子がプレイヤー アカウントに追加されたときにタイトルによって指定されます。

  • GetPlayFabIDsFromNintendoSwitchDeviceIds Nintendo Switch デバイス識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromPSNAccountIDs PlayStation Network 識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPlayFabIDsFromSteamIDs Steam 識別子の特定のセットの一意な PlayFab 識別子を取得します。 Steam 識別子は、Steamworks Community API 呼び出しで SteamId として使用できる、ユーザー アカウントのプロファイル ID です。

  • GetPlayFabIDsFromXboxLiveIDs XboxLive 識別子の特定のセットの一意な PlayFab 識別子を取得します。

  • GetPublisherData カスタム パブリッシャー設定のキー値ストアを取得します。

  • GetRandomResultTables すべての ItemId 値と重みを含む、タイトルの指定されたランダムな結果テーブルの構成情報を取得します。

  • GetServerCustomIDsFromPlayFabIDs 任意のサーバー カスタム識別子のセットに関連付けられている PlayFab アカウント識別子を取得します。

  • GetSharedGroupData 共有グループ オブジェクトに格納されているデータと、グループ内のメンバーの一覧を取得します。 サーバーは、すべてのパブリック およびプライベート グループ データにアクセスできます。 共有グループは、ごく少数のプレイヤー間でデータを共有するために設計されています。「共有グループ データの使用」を参照してください。

  • GetStoreItems 指定されたプレイヤーについて、すべての価格を含め、指定したストアに定義されている一連のアイテムを取得します。

  • GetTitleData カスタム タイトル設定のキー値ストアを取得します。

  • GetTitleInternalData カスタムの内部タイトル設定のキー値ストアを取得します。

  • GetUserAccountInfo 指定したユーザーの関連する詳細を取得します。

  • GetUserBans ユーザーのすべての禁止を取得します。

  • GetUserData クライアントが読み取りおよび書き込み可能なユーザーのタイトル固有のカスタム データを取得します。

  • GetUserInternalData クライアントがアクセスできないユーザーのタイトル固有のカスタム データを取得します。

  • GetUserInventory 指定されたユーザーの仮想商品の現在のインベントリを取得します。

  • GetUserPublisherData クライアントが読み取りおよび書き込み可能なパブリッシャー固有のカスタム データを取得します。

  • GetUserPublisherInternalData クライアントがアクセスできないパブリッシャー固有のカスタム データを取得します。

  • GetUserPublisherReadOnlyData

  • GetUserReadOnlyData クライアントによる読み取り専用のユーザー向けタイトル固有のカスタム データを更新します。

  • LoginWithServerCustomId そのプレイヤーのカスタム識別子を使用して、外部サーバー バックエンドからゲーム クライアントに安全にログインします。 サーバー カスタム ID とクライアント カスタム ID は相互に排他的であり、同じプレイヤー アカウントを取得するために使用することはできません。

  • LoginWithXbox 外部サーバー バックエンドからの Xbox Live トークンを使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。

  • LoginWithXboxId Xbox ID とサンドボックス ID を使用してユーザーをサインインさせ、認証されたユーザーを必要とする API 呼び出しに今後使用できるセッション識別子を返します。