PFSegmentsGetPlayersInSegmentRequest

PFSegmentsGetPlayersInSegmentRequest データモデル。最初のリクエストには少なくとも Segment ID を含める必要があります。以降のリクエストでは、Segment ID に加えて Continuation Token も含める必要があります。Continuation Token を送信しない場合、新しいプレイヤーセグメント一覧が生成されます。Continuation Token が渡されるたびに、Total Seconds to Live の長さがリフレッシュされます。リクエスト間の時間が長すぎて、後続のリクエストが Total Seconds to Live を超えた場合はエラーが返され、ページングは終了します。この API はリソースを大量に消費するため、高いリクエスト量を発生させる可能性のあるシナリオでは使用しないでください。この API へのリクエストは、タイトルごとに一度に 1 件のみ行ってください。API への同時リクエストは APIConcurrentRequestLimitExceeded エラーで拒否される場合があります。

構文

typedef struct PFSegmentsGetPlayersInSegmentRequest {  
    const char* continuationToken;  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    bool const* getProfilesAsync;  
    uint32_t const* maxBatchSize;  
    uint32_t const* secondsToLive;  
    const char* segmentId;  
} PFSegmentsGetPlayersInSegmentRequest;  

メンバー

continuationToken const char*
null 終端 (省略可能) 結果の後続ページを取得する場合の継続トークン。 customTags PFStringDictionaryEntry const*
nullptr の可能性あり (省略可能) リクエストに関連付けられた省略可能なカスタムタグ (例: ビルド番号、外部トレース識別子など)。 customTagsCount uint32_t customTags の数。 getProfilesAsync bool const*
nullptr の可能性あり (省略可能) true に設定した場合、プロファイルは非同期に読み込まれ、最初のプロファイルバッチが読み込まれるまで、レスポンスには継続トークンとおおよそのプロファイル数が含まれます。ネットワークタイムアウトを避けるためにこのパラメーターを使用してください。 maxBatchSize uint32_t const*
nullptr の可能性あり (省略可能) 最大値は 10,000 です。値 0 を指定すると、プロファイルの読み込みが行われず、このセグメントに一致するプロファイルの件数のみが返されます。 secondsToLive uint32_t const*
nullptr の可能性あり (省略可能) 継続トークンを有効に保つ秒数。トークンの有効期限が切れると、ページングを続行することはできません。既定値は 300 (5 分) です。最大値は 5,400 (90 分) です。 segmentId const char*
null 終端 このセグメントの一意の識別子。

要件

ヘッダー: PFSegmentsTypes.h

PlayFab API

構文

メンバー

要件

関連項目

​構文

​メンバー

​要件

​関連項目

構文

メンバー

要件

関連項目