PFSegmentsServerGetPlayersInSegmentAsync

指定されたセグメント内のすべてのプレイヤーをページングして取得できます。この API は、作成時にセグメント定義に一致するすべてのプレイヤープロファイルのスナップショットを作成し、Total Seconds to Live の期間存続します。Continuation Token を後続で使用するたびに存続期間が更新されます。ページング中に変更されたプロファイルは、結果に反映されません。AB テストセグメントは、この操作では現在サポートされていません。注意: この API は 1 分あたり 30 回までしか呼び出せません。このしきい値を超えた場合はエラーが返されます。

構文

HRESULT PFSegmentsServerGetPlayersInSegmentAsync(  
    PFEntityHandle titleEntityHandle,  
    const PFSegmentsGetPlayersInSegmentRequest* request,  
    XAsyncBlock* async  
)  

パラメーター

titleEntityHandle PFEntityHandle PFAuthenticationGetEntityWithSecretKeyAsync を使用して取得したタイトルエンティティの PFEntityHandle。 request PFSegmentsGetPlayersInSegmentRequest* 値が設定されたリクエストオブジェクト。 async XAsyncBlock*
Inout 非同期操作用の XAsyncBlock。

戻り値

型: HRESULT この API 操作の結果コード。

解説

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

要件

ヘッダー: PFSegments.h

PlayFab API

構文

パラメーター

戻り値

解説

要件

関連項目

​構文

​パラメーター

​戻り値

​解説

​要件

​関連項目

構文

パラメーター

戻り値

解説

要件

関連項目