LiveBroadcasts: list

Muestra una lista de transmisiones de YouTube que coinciden con los parámetros de solicitud a la API.

Casos de uso habituales

Solicitud

Solicitud HTTP

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

Autorización

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

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

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 una lista separada por comas de una o más propiedades del recurso liveBroadcast que incluirá la respuesta de la API. Los nombres part que puedes incluir en el valor del parámetro son id, snippet, contentDetails, monetizationDetails y status.
Filtros (especifica exactamente uno de los siguientes parámetros)
broadcastStatus string
El parámetro broadcastStatus filtra la respuesta de la API para incluir solo las transmisiones con el estado especificado.

Los valores aceptables son los siguientes:
  • active: Devuelve las transmisiones en vivo actuales.
  • all: Devuelve todas las transmisiones.
  • completed – Devuelve las transmisiones que ya finalizaron.
  • upcoming – Devuelve las transmisiones que aún no comenzaron.
id string
El parámetro id especifica una lista separada por comas de IDs de transmisión de YouTube que identifican las transmisiones que se recuperan. En un recurso liveBroadcast, la propiedad id especifica el ID de la transmisión.
mine boolean
El parámetro mine se puede usar para indicarle a la API que solo muestre las transmisiones que pertenecen al usuario autenticado. Establece el valor del parámetro en true para recuperar solo tus propias transmisiones.
Parámetros opcionales
broadcastType string
El parámetro broadcastType filtra la respuesta de la API para incluir solo las transmisiones con el tipo especificado. El parámetro se debe usar en las solicitudes que establecen el parámetro mine en true o que usan el parámetro broadcastStatus. El valor predeterminado es event.

Los valores aceptables son los siguientes:
  • all: Devuelve todas las transmisiones.
  • event – Devuelve solo las transmisiones de eventos programados.
  • persistent: Devuelve solo las transmisiones persistentes.
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 0 a 50, inclusive. El valor predeterminado es 5.
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada correctamente.
Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario del Sistema de administración de contenido (CMS) de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite a los propietarios del contenido autenticarse una vez y tener acceso a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta de CMS con la que se autentica el usuario debe estar relacionada con el propietario del contenido de YouTube especificado.
onBehalfOfContentOwnerChannel string
Este parámetro solo se puede usar en una solicitud autorizada correctamente.
Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube.

El onBehalfOfContentOwnerChannel parámetro especifica el ID del canal de YouTube al que se agrega un video. Este parámetro es obligatorio cuando una solicitud especifica un valor para el parámetro onBehalfOfContentOwner y solo se puede usar junto con ese parámetro. Además, la solicitud debe autorizarse con una cuenta de CMS vinculada al propietario del contenido que especifica el parámetro onBehalfOfContentOwner. Por último, el canal que especifica el valor del parámetro onBehalfOfContentOwnerChannel debe estar vinculado al propietario del contenido que especifica el parámetro onBehalfOfContentOwner.

Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite a los propietarios de contenido autenticarse una vez y llevar a cabo acciones en nombre del canal especificado en el valor del parámetro, sin tener que proporcionar credenciales de autenticación para cada canal por separado.
pageToken string
El parámetro pageToken identifica una página específica del 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#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast 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#liveBroadcastListResponse.
etag etag
Es el 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.
prevPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página anterior 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
Es una lista de transmisiones que coinciden con los criterios de la solicitud.

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. Para obtener más detalles, consulta el mensaje de error.

Tipo de error Detalle del error Descripción
insufficientPermissions insufficientLivePermissions La solicitud no está autorizada para recuperar la transmisión en vivo.
insufficientPermissions liveStreamingNotEnabled El usuario que autorizó la solicitud no está habilitado para transmitir videos en vivo en YouTube. Para obtener más información, consulta Elegibilidad para las funciones.

Pruébalo

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