Enumera los moderadores para un chat en vivo. El propietario del canal del chat en vivo debe autorizar la solicitud.
Casos de uso habituales
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
Parámetros
En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.
Parámetros | ||
---|---|---|
Parámetros obligatorios | ||
liveChatId |
string El parámetro liveChatId especifica el chat en vivo de YouTube para el cual la API debe mostrar moderadores. El ID del chat en vivo asociado con una transmisión se muestra en la propiedad snippet.liveChatId del recurso liveBroadcast . |
|
part |
string El parámetro part especifica las partes del recurso liveChatModerator que incluirá la respuesta de la API. Los valores admitidos son id y snippet . |
|
Parámetros opcionales | ||
maxResults |
unsigned integer El parámetro maxResults especifica la cantidad máxima de elementos que se deben mostrar en el conjunto de resultados. Los valores aceptables son 0 a 50 , ambos inclusive. El valor predeterminado es 5 . |
|
pageToken |
string El parámetro pageToken identifica una página específica en el conjunto de resultados que se debe mostrar. En una respuesta de la API, las propiedades nextPageToken y prevPageToken identifican otras páginas que se podrían recuperar. |
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud cuando invoques este método.
Respuesta
Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:
{ "kind": "youtube#liveChatModeratorListResponse", "etag": etag, "prevPageToken": string, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatModerator Resource ] }
Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
Propiedades | |
---|---|
kind |
string Identifica el tipo de recurso de API. El valor será youtube#liveChatModeratorListResponse . |
etag |
etag Es la Etag de este recurso. |
prevPageToken |
string Es el token que se puede usar como valor del parámetro pageToken para recuperar la página anterior en el conjunto de resultados. |
nextPageToken |
string Es el token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados. |
pageInfo |
object El objeto pageInfo encapsula la información de paginación del conjunto de resultados. |
pageInfo.totalResults |
integer La cantidad total de resultados en el conjunto de resultados. |
pageInfo.resultsPerPage |
integer Es la cantidad de resultados incluidos en la respuesta de la API. |
items[] |
list Lista de moderadores que coinciden con los criterios de la solicitud. |
Errores
La API no define ningún mensaje de error exclusivo de este método de API. Sin embargo, este método aún puede mostrar errores generales de la API que se enumeran en la documentación de mensaje de error.
Pruébela.
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.