> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PFSegmentsServerGetPlayersInSegmentAsync

> 指定されたセグメント内のすべてのプレイヤーをページングして取得できます。この API は、作成時にセグメント定義に一致するすべてのプレイヤー プロファイルのスナップショットを作成します。

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

## 構文

```cpp theme={null}
HRESULT PFSegmentsServerGetPlayersInSegmentAsync(  
    PFEntityHandle titleEntityHandle,  
    const PFSegmentsGetPlayersInSegmentRequest* request,  
    XAsyncBlock* async  
)  
```

### パラメーター

**`titleEntityHandle`**   PFEntityHandle

PFAuthenticationGetEntityWithSecretKeyAsync を使用して取得したタイトル エンティティの PFEntityHandle。

**`request`**   [PFSegmentsGetPlayersInSegmentRequest\*](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayersinsegmentrequest)

値が設定されたリクエスト オブジェクト。

**`async`**   XAsyncBlock\*<br />*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](/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersinsegmentgetresultsize) と [PFSegmentsServerGetPlayersInSegmentGetResult](/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersinsegmentgetresult) を呼び出して結果を取得します。

## 要件

**ヘッダー:** PFSegments.h

## 関連項目

[PFSegments のメンバー](/services/playfab/api-references/c/pfsegments/pfsegments_members)


## Related topics

- [PFSegmentsServerGetPlayersInSegmentGetResult](/ja-jp/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersinsegmentgetresult.md)
- [Services C API overview - PFSegments.h](/ja-jp/services/playfab/api-references/c/pfsegments/pfsegments_members.md)
- [PFSegmentsServerGetPlayerSegmentsAsync](/ja-jp/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersegmentsasync.md)
- [PFSegmentsServerGetPlayerSegmentsGetResult](/ja-jp/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersegmentsgetresult.md)
- [PFSegmentsServerGetAllSegmentsAsync](/ja-jp/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetallsegmentsasync.md)