PFSegmentsGetPlayersInSegmentRequest - XBOX Game Development Documentation

Modelo de datos de PFSegmentsGetPlayersInSegmentRequest. La solicitud inicial debe contener al menos un identificador de segmento. Las solicitudes posteriores deben contener el identificador de segmento y el token de continuación. Si no se envía el token de continuación, se generará una nueva lista de segmentos de jugadores. Cada vez que se pasa el token de continuación, se actualiza la duración del tiempo total de vida en segundos (Total Seconds to Live). Si pasa demasiado tiempo entre solicitudes hasta el punto de que una solicitud posterior supere el tiempo total de vida en segundos, se devolverá un error y se terminará la paginación. Esta API consume muchos recursos y no debe usarse en escenarios que puedan generar volúmenes de solicitudes elevados. Solo se debe realizar una solicitud a esta API a la vez por título. Las solicitudes simultáneas a la API pueden rechazarse con el error APIConcurrentRequestLimitExceeded.

Sintaxis

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;  

Miembros

continuationToken const char*
is null-terminated (Opcional) Token de continuación si se recuperan páginas de resultados posteriores. customTags PFStringDictionaryEntry const*
may be nullptr (Opcional) Etiquetas personalizadas opcionales asociadas a la solicitud (por ejemplo, número de compilación, identificadores de seguimiento externos, etc.). customTagsCount uint32_t Recuento de customTags getProfilesAsync bool const*
may be nullptr (Opcional) Si se establece en true, los perfiles se cargan de forma asincrónica y la respuesta incluirá un token de continuación y un recuento aproximado de perfiles hasta que se cargue el primer lote de perfiles. Use este parámetro para ayudar a evitar tiempos de espera de red. maxBatchSize uint32_t const*
may be nullptr (Opcional) El máximo es 10 000. El valor 0 impedirá cargar perfiles y devolverá solo el recuento de perfiles que coinciden con este segmento. secondsToLive uint32_t const*
may be nullptr (Opcional) Número de segundos que se mantiene activo el token de continuación. Después de la expiración del token, no es posible seguir paginando los resultados. El valor predeterminado es 300 (5 minutos). El máximo es 5400 (90 minutos). segmentId const char*
is null-terminated Identificador único de este segmento.

Requisitos

Encabezado: PFSegmentsTypes.h

Consulte también

Miembros de PFSegmentsTypes

​Sintaxis

​Miembros

​Requisitos

​Consulte también

Sintaxis

Miembros

Requisitos

Consulte también