SuperChatEvents: list

Muestra una lista de los eventos de Súper chat de las transmisiones en vivo de un canal en los últimos 30 días.

Casos de uso habituales

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/youtube/v3/superChatEvents

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes permisos. Para obtener más información sobre la autenticación y autorización, consulta Cómo implementar la autenticación de OAuth 2.0.

Alcance
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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
part string
El parámetro part especifica las partes de recursos superChatEvent que incluirá la respuesta de la API. Los valores admitidos son id y snippet.
Parámetros opcionales
hl string
El parámetro hl le indica al servidor de la API que aplique formato al valor de la propiedad snippet.displayString, que muestra el importe de la compra y la moneda de un Super Chat, según las convenciones de un idioma en particular. El valor del parámetro debe ser un código de idioma incluido en la lista que devuelve el método i18nLanguages.list. El valor predeterminado es en, lo que significa que el comportamiento predeterminado es dar formato a las cadenas de visualización como se usarían en inglés. Por ejemplo, de forma predeterminada, una cadena tiene el formato $1.00 en lugar de $1,00.
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 de 1 a 50 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#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind string
Identifica el tipo de recurso de la API. El valor será youtube#superChatEventListResponse.
etag etag
Es la etiqueta de Etag de este recurso.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página del conjunto de resultados.
pageInfo object
El objeto pageInfo encapsula la información de paginación del conjunto de resultados.
pageInfo.totalResults integer
Es 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
Una lista de compras de Súper chat que coinciden con los criterios de la solicitud.

Errores

En la siguiente tabla, se identifican los mensajes de error que podría mostrar la API 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) insufficientPermissions La solicitud no tiene la autorización adecuada para recuperar eventos de Súper chat.

Pruébalo

Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.