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

# Services C API overview - PFSegmentsTypes.h

> Services C API overview - PFSegmentsTypes.h

## Structures

| Structure                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [PFSegmentsAdCampaignAttribution](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsadcampaignattribution)                 | PFSegmentsAdCampaignAttribution data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| [PFSegmentsAddPlayerTagRequest](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsaddplayertagrequest)                     | PFSegmentsAddPlayerTagRequest data model. This API will trigger a player\_tag\_added event and add a tag with the given TagName and PlayFabID to the corresponding player profile. TagName can be used for segmentation and it is limited to 256 characters. Also there is a limit on the number of tags a title can have.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| [PFSegmentsContactEmailInfo](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentscontactemailinfo)                           | PFSegmentsContactEmailInfo data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [PFSegmentsGetAllSegmentsResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetallsegmentsresult)                   | PFSegmentsGetAllSegmentsResult data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| [PFSegmentsGetPlayerSegmentsResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayersegmentsresult)             | PFSegmentsGetPlayerSegmentsResult data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| [PFSegmentsGetPlayersInSegmentRequest](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayersinsegmentrequest)       | PFSegmentsGetPlayersInSegmentRequest data model. Initial request must contain at least a Segment ID. Subsequent requests must contain the Segment ID as well as the Continuation Token. Failure to send the Continuation Token will result in a new player segment list being generated. Each time the Continuation Token is passed in the length of the Total Seconds to Live is refreshed. If too much time passes between requests to the point that a subsequent request is past the Total Seconds to Live an error will be returned and paging will be terminated. This API is resource intensive and should not be used in scenarios which might generate high request volumes. Only one request to this API at a time should be made per title. Concurrent requests to the API may be rejected with the APIConcurrentRequestLimitExceeded error. |
| [PFSegmentsGetPlayersInSegmentResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayersinsegmentresult)         | PFSegmentsGetPlayersInSegmentResult data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| [PFSegmentsGetPlayersSegmentsRequest](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayerssegmentsrequest)         | PFSegmentsGetPlayersSegmentsRequest data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| [PFSegmentsGetPlayerTagsRequest](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayertagsrequest)                   | PFSegmentsGetPlayerTagsRequest data model. This API will return a list of canonical tags which includes both namespace and tag's name. If namespace is not provided, the result is a list of all canonical tags. TagName can be used for segmentation and Namespace is limited to 128 characters.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| [PFSegmentsGetPlayerTagsResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayertagsresult)                     | PFSegmentsGetPlayerTagsResult data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| [PFSegmentsGetSegmentResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetsegmentresult)                           | PFSegmentsGetSegmentResult data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [PFSegmentsPlayerLinkedAccount](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsplayerlinkedaccount)                     | PFSegmentsPlayerLinkedAccount data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| [PFSegmentsPlayerLocation](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsplayerlocation)                               | PFSegmentsPlayerLocation data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [PFSegmentsPlayerLocationDictionaryEntry](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsplayerlocationdictionaryentry) | Dictionary entry for an associative array with PFSegmentsPlayerLocation values.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| [PFSegmentsPlayerProfile](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsplayerprofile)                                 | PFSegmentsPlayerProfile data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| [PFSegmentsPlayerStatistic](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsplayerstatistic)                             | PFSegmentsPlayerStatistic data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| [PFSegmentsPushNotificationRegistration](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentspushnotificationregistration)   | PFSegmentsPushNotificationRegistration data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [PFSegmentsRemovePlayerTagRequest](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsremoveplayertagrequest)               | PFSegmentsRemovePlayerTagRequest data model. This API will trigger a player\_tag\_removed event and remove a tag with the given TagName and PlayFabID from the corresponding player profile. TagName can be used for segmentation and it is limited to 256 characters.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

## State changes

| State change | Description |
| ------------ | ----------- |

## Enumerations

| Enumeration                                                                                                   | Description          |
| ------------------------------------------------------------------------------------------------------------- | -------------------- |
| [PFSegmentsChurnRiskLevel](/services/playfab/api-references/c/pfsegmentstypes/enums/pfsegmentschurnrisklevel) | ChurnRiskLevel enum. |


## Related topics

- [Services C API overview - PFSegments.h](/services/playfab/api-references/c/pfsegments/pfsegments_members.md)
- [PFSegmentsGetSegmentResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetsegmentresult.md)
- [PFSegmentsGetPlayersInSegmentResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayersinsegmentresult.md)
- [PFSegmentsGetPlayersSegmentsRequest](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayerssegmentsrequest.md)
- [PFSegmentsGetAllSegmentsResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetallsegmentsresult.md)
