Profile Reads メーター API の説明

​

Admin API

• CheckLimitedEditionItemAvailability 限定版アイテムのグローバル カウントを確認します。
• GetAllSegments プレイヤー セグメント定義の配列を取得します。この結果は、Segment ID が必要な GetPlayersInSegment などの後続の API 呼び出しで使用できます。セグメント名は変更できますが、そのセグメントの ID は変更されません。
• ExportMasterPlayerData マスター プレイヤー アカウントの関連データをすべてエクスポートします。
• GetCatalogItems タイトルの仮想グッズ カタログの指定バージョンを、定義済みのプロパティすべてを含めて取得します。
• GetContentList タイトルの全コンテンツを一覧表示し、サイズなどの統計情報を取得します。
• GetDataReport 要求されたレポートのダウンロード URL を取得します。
• GetPlayerSegments 現時点でプレイヤーが所属するすべてのセグメントを一覧表示します。
• GetPlayerTags 指定した名前空間 (省略可) を持つすべてのタグをプレイヤー プロファイルから取得します。
• GetPolicy 要求されたポリシーを取得します。
• GetPublisherData カスタム パブリッシャー設定のキー/バリュー ストアを取得します。
• GetRandomResultTables タイトルのランダム ドロップ テーブル構成を取得します。
• GetStoreItems 指定されたストア用に定義されたアイテム セットを、定義済みの価格すべてを含めて取得します。
• GetTitleData クライアントが読み取り可能なカスタム タイトル設定のキー/バリュー ストアを取得します。
• [GetUserAccountInfo](Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier) 指定された一意識別子との一致に基づき、特定ユーザーの関連詳細を取得します。
• GetUserBans ユーザーのすべての BAN を取得します。
• GetUserData クライアントで読み書き可能な、ユーザーのタイトル固有カスタム データを取得します。
• GetUserInternalData クライアントからアクセスできないユーザーのタイトル固有カスタム データを取得します。
• GetUserInventory 指定ユーザーの現在の仮想グッズ インベントリを取得します。
• GetUserPublisherData クライアントで読み書き可能な、ユーザーのパブリッシャー固有カスタム データを取得します。
• GetUserPublisherInternalData クライアントからアクセスできないユーザーのパブリッシャー固有カスタム データを取得します。
• GetUserPublisherReadOnlyData クライアントで読み取り専用となる、ユーザーのパブリッシャー固有カスタム データを取得します。
• GetUserReadOnlyData クライアントで読み取り専用となる、ユーザーのタイトル固有カスタム データを取得します。
• ListVirtualCurrencyTypes タイトルに定義されているすべての仮想通貨のリストを返します。
• GetPlayerIdFromAuthToken 認証トークンからプレイヤーの ID を取得します。
• GetPlayersInSegment 指定セグメント内のすべてのプレイヤーをページングできます。この API は、作成時にセグメント定義に一致するプレイヤー プロファイルのスナップショットを作成し、Total Seconds to Live の期間存続します。Continuation Token を使用するたびに寿命が更新されます。ページング中に変更されたプロファイルは結果に反映されません。AB テスト セグメントは現在この操作でサポートされていません。
• GetExperiments タイトルのすべての実験の詳細を取得します。
• GetLatestScorecard タイトルの実験の最新のスコアカードを取得します。
• GetTreatmentAssignment タイトル内で実行中のすべての実験について、プレイヤーへのトリートメント割り当てを取得します。

​

Client API

• GetAllUsersCharacters 特定ユーザーに属するすべてのキャラクターを一覧表示します。CharacterId はグローバル一意ではありません。一意性を保証するには、親の PlayFabId と併せて characterId を評価する必要があります。
• 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 識別子 (Game Center Programming Guide では Player Identifier として参照される) セットに対応する一意の PlayFab 識別子を取得します。
• GetPlayFabIDsFromGenericIDs 指定した汎用サービス識別子セットに対応する一意の PlayFab 識別子を取得します。汎用識別子は、プレイヤー アカウントに追加されたときにタイトルが指定した、サービス名にプレイヤーのサービス固有 ID を組み合わせたものです。
• GetPlayFabIDsFromGoogleIDs 指定した Google 識別子セットに対応する一意の PlayFab 識別子を取得します。Google 識別子はユーザー アカウントの ID で、Google+ People API 呼び出しの id として利用可能です。
• GetPlayFabIDsFromKongregateIDs 指定した Kongregate 識別子セットに対応する一意の PlayFab 識別子を取得します。Kongregate 識別子はユーザー アカウントの ID で、Kongregate API メソッドの user_id として利用可能です (例: https://docs.kongregate.com/docs/concepts-handling-guests)。
• GetPlayFabIDsFromNintendoSwitchDeviceIds 指定した Nintendo Switch 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPlayFabIDsFromPSNAccountIDs 指定した PlayStation™ Network 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPlayFabIDsFromSteamIDs 指定した Steam 識別子セットに対応する一意の PlayFab 識別子を取得します。Steam 識別子はユーザー アカウントのプロファイル ID で、Steamworks Community API 呼び出しの SteamId として利用可能です。
• GetPlayFabIDsFromTwitchIDs 指定した Twitch 識別子セットに対応する一意の PlayFab 識別子を取得します。Twitch 識別子はユーザー アカウントの ID で、Twitch API メソッドの “_id” として利用可能です (例: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser)。
• GetPlayFabIDsFromXboxLiveIDs 指定した XboxLive 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPublisherData カスタム パブリッシャー設定のキー/バリュー ストアを取得します。
• GetPurchase 購入とその現在の PlayFab ステータスを取得します。まだアクティブな購入元のインベントリ アイテムを返します。
• GetSharedGroupData 共有グループ オブジェクト内に保存されているデータと、グループのメンバー一覧を取得します。グループの非メンバーはこれを使用してメンバーシップを含むグループ データを取得できますが、非公開としてマークされたキーのデータは受け取れません。共有グループは少人数のプレイヤー間のデータ共有向けに設計されています。詳細については、Using Shared Group Data を参照してください。
• 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 Instant Games の構成が必要です。
• LoginWithGameCenter iOS Game Center プレイヤー識別子を使用してユーザーをサインインさせ、認証済みユーザーが必要な API 呼び出しで後に使用可能なセッション識別子を返します。
• LoginWithGoogleAccount iOS Game Center プレイヤー識別子を使用してユーザーをサインインさせ、認証済みユーザーが必要な API 呼び出しで後に使用可能なセッション識別子を返します。
• LoginWithIOSDeviceID Google アカウント資格情報を使用してユーザーをサインインさせます。
• LoginWithKongregate Kongregate プレイヤー アカウントを使用してユーザーをサインインさせます。
• LoginWithNintendoSwitchDeviceId Nintendo Switch Device ID を使用してユーザーをサインインさせ、認証済みユーザーが必要な API 呼び出しで使用可能なセッション識別子を返します。
• LoginWithOpenIdConnect タイトルと Open ID Connect プロバイダー間の既存の関係によって作成された Open ID Connect JWT を使用してユーザーをログインさせます。
• LoginWithPlayFab 認証済みユーザーが必要な API 呼び出し向けです。他のほとんどのログイン API とは異なり、LoginWithPlayFab は CreateAccountFlag による新規アカウント作成をサポートしません。ユーザー名/パスワード資格情報は RegisterPlayFabUser でアカウントを作成する、または AddUsernamePassword で既存アカウントに追加するために使用できます。
• LoginWithPSN ユーザーを PlayFab アカウントにサインインさせ、認証済みユーザーが必要な API 呼び出しで後に使用可能なセッション識別子を返します。他のほとんどのログイン API とは異なり、LoginWithPlayFab は CreateAccountFlag による新規アカウント作成をサポートしません。ユーザー名/パスワード資格情報は RegisterPlayFabUser でアカウントを作成する、または AddUsernamePassword で既存アカウントに追加するために使用します。
• LoginWithSteam Steam 認証チケットを使用してユーザーをサインインさせ、認証済みユーザーが必要な API 呼び出しで後に使用可能なセッション識別子を返します。
• LoginWithTwitch Twitch アクセス トークンを使用してユーザーをサインインさせます。
• LoginWithXbox XBOX Live トークンを使用してユーザーをサインインさせ、認証済みユーザーが必要な API 呼び出しで後に使用可能なセッション識別子を返します。
• GetPlayerCombinedInfo ユーザーのさまざまな種類の情報をすべて取得します。

​

Data API

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

​

Groups API

• GetGroup グループとそのロールに関する情報を取得します。
• IsMember エンティティがグループ、またはグループ内のロールのメンバーであるかを確認します。
• ListGroupApplications グループへの参加リクエストで未処理のものすべてを一覧表示します。
• ListGroupBlocks グループへの参加をブロックされているすべてのエンティティを一覧表示します。
• ListGroupInvitations グループへの未処理の招待をすべて一覧表示します。
• ListGroupMembers グループの全メンバーを一覧表示します。
• ListMembership エンティティが所属するすべてのグループとロールを一覧表示します。
• ListMembershipOpportunities エンティティ宛の未処理の招待とグループ参加申請をすべて一覧表示します。

​

Profile API

• GetGlobalPolicy グローバル タイトル アクセス ポリシーを取得します。
• GetProfile エンティティのプロファイルを取得します。
• GetProfiles エンティティのプロファイルを取得します。
• GetTitlePlayersFromMasterPlayerAccountIds 指定したマスター プレイヤー アカウントに関連付けられたタイトル プレイヤー アカウントを取得します。

​

Server API

• EvaluateRandomResultTable Random Result Table を評価した結果を返します。Random Result Table がバンドル経由または UnlockContainer 呼び出しで追加された場合に、プレイヤー インベントリに追加されたはずの、ゲーム カタログの ItemId が返されます。
• GetAllSegments プレイヤー セグメント定義の配列を取得します。この結果は、Segment ID が必要な GetPlayersInSegment などの後続の API 呼び出しで使用できます。セグメント名は変更できますが、そのセグメントの ID は変更されません。
• GetAllUsersCharacters 特定ユーザーに属するすべてのキャラクターを一覧表示します。CharacterId はグローバル一意ではありません。一意性を保証するには、親の PlayFabId と併せて characterId を評価する必要があります。
• GetCatalogItems タイトルの仮想グッズ カタログの指定バージョンを、定義済みのプロパティすべてを含めて取得します。
• GetCharacterData クライアントで読み書き可能な、ユーザーのタイトル固有カスタム データを取得します。
• GetCharacterInternalData クライアントからアクセスできない、ユーザーのキャラクターに関するタイトル固有カスタム データを取得します。
• GetCharacterInventory 指定キャラクターの現在の仮想グッズ インベントリを取得します。
• GetCharacterReadOnlyData
• GetCharacterStatistics 指定キャラクターに関するすべてのタイトル固有統計の詳細を取得します。
• GetFriendLeaderboard リーダーボード内の指定した位置から始まる、指定プレイヤーのフレンドの指定統計に関するランク付けされた一覧を取得します。
• GetFriendsList PlayFabId で指定されるユーザーの現在のフレンドを取得します。PlayFab アカウントを持つユーザーに限定されます。リンクされたアカウント (Facebook、Steam) のフレンドも含まれます。一部のリンク サービスのフレンドは任意に除外できます。
• GetLeaderboard リーダーボード内の指定した位置から始まる、指定統計のランク付けされたユーザー一覧を取得します。
• GetLeaderboardAroundCharacter 要求されたユーザーを中心とする、指定統計のランク付けされたキャラクター一覧を取得します。
• GetLeaderboardAroundUser 要求されたユーザーを中心とする、指定統計のランク付けされたキャラクター一覧を取得します。
• GetLeaderboardForUserCharacters 指定統計におけるユーザーのすべてのキャラクター一覧を取得します。
• GetPlayerCombinedInfo ユーザーに関して応答で要求された情報を返します。メール アドレスや Facebook ID などの個人データが返される場合があります。すべてのパラメーターは既定で false です。
• GetPlayerProfile プレイヤーのプロファイルを取得します。
• GetPlayerSegments 現時点でプレイヤーが所属するすべてのセグメントを一覧表示します。
• GetPlayersInSegment 指定セグメント内のすべてのプレイヤーをページングできます。この API は、作成時にセグメント定義に一致するプレイヤー プロファイルのスナップショットを作成し、Total Seconds to Live の期間存続します。Continuation Token を使用するたびに寿命が更新されます。ページング中に変更されたプロファイルは結果に反映されません。AB テスト セグメントは現在この操作でサポートされていません。
• GetPlayerStatistics ローカル プレイヤーに関して、指定した統計の現在のバージョンと値を取得します。
• GetPlayerStatisticVersions 指定した統計で利用可能なバージョンの情報を取得します。
• GetPlayerTags 指定した名前空間 (省略可) を持つすべてのタグをプレイヤー プロファイルから取得します。
• GetPlayFabIDsFromFacebookIDs 指定した Facebook 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPlayFabIDsFromFacebookInstantGamesIds 指定した Facebook 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPlayFabIDsFromGenericIDs 指定した汎用サービス識別子セットに対応する一意の PlayFab 識別子を取得します。汎用識別子は、プレイヤー アカウントに追加されたときにタイトルが指定した、サービス名にプレイヤーのサービス固有 ID を組み合わせたものです。
• GetPlayFabIDsFromNintendoSwitchDeviceIds 指定した Nintendo Switch Device 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPlayFabIDsFromPSNAccountIDs 指定した PlayStation Network 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPlayFabIDsFromSteamIDs 指定した Steam 識別子セットに対応する一意の PlayFab 識別子を取得します。Steam 識別子はユーザー アカウントのプロファイル ID で、Steamworks Community API 呼び出しの SteamId として利用可能です。
• GetPlayFabIDsFromXboxLiveIDs 指定した XboxLive 識別子セットに対応する一意の PlayFab 識別子を取得します。
• GetPublisherData カスタム パブリッシャー設定のキー/バリュー ストアを取得します。
• GetRandomResultTables タイトルの指定したランダム結果テーブルの構成情報を、すべての ItemId 値と重みも含めて取得します。
• GetServerCustomIDsFromPlayFabIDs 指定したサーバー カスタム識別子セットに関連付けられた PlayFab アカウント識別子を取得します。
• GetSharedGroupData 共有グループ オブジェクト内に保存されているデータと、グループのメンバー一覧を取得します。サーバーはすべての公開および非公開グループ データにアクセスできます。共有グループは少人数のプレイヤー間のデータ共有向けに設計されています。詳細については、Using Shared Group Data を参照してください。
• GetStoreItems 指定されたストア用に定義されたアイテム セットを、指定プレイヤー向けに、定義済みの価格すべてを含めて取得します。
• GetTitleData カスタム タイトル設定のキー/バリュー ストアを取得します。
• GetTitleInternalData カスタム内部タイトル設定のキー/バリュー ストアを取得します。
• GetUserAccountInfo 指定ユーザーの関連詳細を取得します。
• GetUserBans ユーザーのすべての BAN を取得します。
• GetUserData クライアントで読み書き可能な、ユーザーのタイトル固有カスタム データを取得します。
• GetUserInternalData クライアントからアクセスできないユーザーのタイトル固有カスタム データを取得します。
• GetUserInventory 指定ユーザーの現在の仮想グッズ インベントリを取得します。
• GetUserPublisherData クライアントで読み書き可能な、ユーザーのパブリッシャー固有カスタム データを取得します。
• GetUserPublisherInternalData クライアントからアクセスできないユーザーのパブリッシャー固有カスタム データを取得します。
• GetUserPublisherReadOnlyData
• GetUserReadOnlyData クライアントで読み取り専用となる、ユーザーのタイトル固有カスタム データを更新します。
• LoginWithServerCustomId 該当プレイヤーのカスタム識別子を使用して、外部サーバー バックエンドからゲーム クライアントを安全にログインさせます。Server Custom ID と Client Custom ID は相互排他的であり、同じプレイヤー アカウントの取得には使用できません。
• LoginWithXbox 外部サーバー バックエンドから XBOX Live トークンを使用してユーザーをサインインさせ、認証済みユーザーが必要な API 呼び出しで後に使用可能なセッション識別子を返します。
• LoginWithXboxId XBOX ID と Sandbox ID を使用してユーザーをサインインさせ、認証済みユーザーが必要な API 呼び出しで後に使用可能なセッション識別子を返します。