> ## 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.

# PFSegmentsGetPlayersInSegmentRequest

> PFSegmentsGetPlayersInSegmentRequest 数据模型。初始请求必须至少包含分段 ID。后续请求也必须包含分段 ID。

PFSegmentsGetPlayersInSegmentRequest 数据模型。初始请求必须至少包含分段 ID。后续请求必须包含分段 ID 以及延续令牌。未能发送延续令牌将导致生成新的玩家分段列表。每次传入延续令牌时，"总生存秒数"的长度都会刷新。如果两次请求间隔时间过长，导致后续请求超过总生存秒数，将返回错误并终止分页。此 API 是资源密集型的，不应在可能产生大量请求的场景中使用。每个标题一次只应对此 API 发出一个请求。对该 API 的并发请求可能会因 APIConcurrentRequestLimitExceeded 错误而被拒绝。

## 语法

```cpp theme={null}
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\*<br />*is null-terminated*

（可选）用于检索后续结果页的延续令牌。

**`customTags`**   [PFStringDictionaryEntry](/services/playfab/api-references/c/pftypes/structs/pfstringdictionaryentry) const\*<br />*may be nullptr*

（可选）与请求关联的可选自定义标记（例如生成号、外部跟踪标识符等）。

**`customTagsCount`**   uint32\_t

customTags 的计数

**`getProfilesAsync`**   bool const\*<br />*may be nullptr*

（可选）如果设置为 true，则异步加载个人资料，并且响应将包含延续令牌和近似的个人资料计数，直到加载首批个人资料。使用此参数有助于避免网络超时。

**`maxBatchSize`**   uint32\_t const\*<br />*may be nullptr*

（可选）最大值为 10,000。值为 0 时将阻止加载任何个人资料，仅返回与此分段匹配的个人资料计数。

**`secondsToLive`**   uint32\_t const\*<br />*may be nullptr*

（可选）保持延续令牌活动状态的秒数。令牌过期后，将无法继续分页结果。默认值为 300（5 分钟）。最大值为 5,400（90 分钟）。

**`segmentId`**   const char\*<br />*is null-terminated*

此分段的唯一标识符。

## 要求

**头文件：** PFSegmentsTypes.h

## 另请参阅

[PFSegmentsTypes 成员](/services/playfab/api-references/c/pfsegmentstypes/pfsegmentstypes_members)


## Related topics

- [PFSegmentsServerGetPlayersInSegmentAsync](/zh-CN/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersinsegmentasync.md)
- [Services C API overview - PFSegmentsTypes.h](/zh-CN/services/playfab/api-references/c/pfsegmentstypes/pfsegmentstypes_members.md)
- [PFSegmentsGetPlayersSegmentsRequest](/zh-CN/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayerssegmentsrequest.md)
- [PFSegmentsServerGetPlayerSegmentsAsync](/zh-CN/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetplayersegmentsasync.md)
- [PFSegmentsGetPlayerTagsRequest](/zh-CN/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayertagsrequest.md)