Cuando realizas tu primera solicitud para recuperar mensajes del chat, la API muestra una parte o todo el historial del chat, según la duración de ese historial. Los mensajes en la respuesta están ordenados de más antiguos a más recientes.
- El
nextPageToken
de la respuesta proporciona un token que, en tu próxima solicitud, identificará el siguiente conjunto de resultados que tu cliente de la API debe recuperar. - La propiedad
pollingIntervalMillis
indica cuánto tiempo debe esperar el cliente de la API para solicitar resultados adicionales.
pageToken
en el valor nextPageToken
y el servidor de la API muestra mensajes de chat adicionales, si están disponibles. Dentro de ese conjunto de resultados, los mensajes se ordenan desde los más antiguos hasta los más recientes.Casos de uso habituales
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/messages
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 ID del chat cuyos mensajes se mostrarán. 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 liveChatMessage que incluirá la respuesta de la API. Los valores admitidos son id , snippet y authorDetails . |
|
Parámetros opcionales | ||
hl |
string El parámetro hl le indica a la API que recupere una string de visualización de moneda localizada para un idioma de aplicación compatible con el sitio web de YouTube específico. Por ejemplo, en inglés, la moneda se mostraría como $1.50 , pero en francés se mostraría como 1,50$ .El valor del parámetro debe ser un código de idioma incluido en la lista que muestra el método i18nLanguages.list . |
|
maxResults |
unsigned integer El parámetro maxResults especifica la cantidad máxima de mensajes que se deben mostrar en el conjunto de resultados. Los valores aceptables son 200 a 2000 , ambos inclusive. El valor predeterminado es 500 . |
|
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, la propiedad nextPageToken identifica otras páginas que se podrían recuperar. |
|
profileImageSize |
unsigned integer El parámetro profileImageSize especifica el tamaño de las fotos de perfil del usuario que se deben mostrar en el conjunto de resultados. Las imágenes son cuadradas. El valor predeterminado es 88 , lo que significa que las imágenes serán de 88 píxeles por 88 píxeles. Los valores aceptables se encuentran en el rango de 16 a 720 , ambos inclusive. |
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#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatMessage 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#liveChatMessageListResponse . |
etag |
etag Es la Etag de este recurso. |
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. |
pollingIntervalMillis |
unsigned integer Es la cantidad de tiempo, en milisegundos, que debe esperar el cliente antes de volver a sondear los mensajes nuevos del chat en vivo. |
offlineAt |
datetime Es la fecha y hora en que se desconectó la transmisión en vivo subyacente. Esta propiedad solo está presente si la transmisión ya está sin conexión. El valor se especifica en el formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
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 mensajes del chat en vivo. Cada elemento de la lista es un recurso liveChatMessage . |
Errores
En la siguiente tabla se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada a este método. Consulta la documentación sobre mensajes de error para obtener más información.
Tipo de error | Detalle del error | Descripción |
---|---|---|
forbidden (403) |
forbidden |
No tienes los permisos necesarios para recuperar mensajes del chat en vivo especificado. |
forbidden (403) |
liveChatDisabled |
El chat en vivo no está habilitado para la transmisión especificada. |
forbidden (403) |
liveChatEnded |
El chat en vivo que especificaste ya no está en vivo. |
notFound (404) |
liveChatNotFound |
No se puede encontrar el chat en vivo que intentas recuperar. Comprueba el valor del parámetro liveChatId de la solicitud para asegurarte de que sea correcto. |
rateLimitExceeded |
rateLimitExceeded |
La solicitud se envió demasiado rápido después de la solicitud anterior. Este error se produce cuando las solicitudes de la API para recuperar mensajes se envían con más frecuencia que las frecuencias de actualización de YouTube, lo que desperdicia innecesariamente ancho de banda. |
Pruébela.
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.