LiveBroadcasts: list

Devuelve una lista de transmisiones de YouTube que coinciden con los parámetros de solicitud de 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 leer más sobre autenticación y 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 indican 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 de recursos de liveBroadcast que la respuesta de API va a incluir. Los nombres part que se pueden 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 que solo incluya transmisiones con el estado especificado.

Los valores aceptables son los siguientes:
  • active: muestra las transmisiones en vivo actuales.
  • all: muestra todas las transmisiones.
  • completed: Muestra transmisiones que ya finalizaron.
  • upcoming: Muestra transmisiones que aún no comenzaron.
id string
El parámetro id especifica una lista separada por comas de ID de transmisiones 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 indicar a la API que solo muestre transmisiones que pertenezcan 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 que solo incluya transmisiones con el tipo especificado. El parámetro debe usarse en 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: muestra todas las transmisiones.
  • event: muestra solo las transmisiones de eventos programadas.
  • persistent: Muestra solo 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 0 a 50, ambos incluidos. El valor predeterminado es 5.
onBehalfOfContentOwner string
Este parámetro solo se puede utilizar en una solicitud autorizada debidamente.
Nota: Este parámetro está dirigido exclusivamente a 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 utilizar en una solicitud autorizada debidamente.
Nota: Este parámetro está dirigido exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwnerChannel especifica el ID del canal de YouTube del canal 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 que esté vinculada al propietario del contenido que se especifica en 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 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#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
Etag de este recurso.
nextPageToken string
Token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente del conjunto de resultados.
prevPageToken string
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 información de paginación para el conjunto de resultados.
pageInfo.totalResults integer
La cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
La cantidad de resultados incluidos en la respuesta de la API.
items[] list
Una lista de transmisiones que coinciden con los criterios de la solicitud.

Errores

La siguiente tabla identifica los mensajes de error que la API podría devolver 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 tiene autorización para recuperar la transmisión en vivo.
insufficientPermissions liveStreamingNotEnabled El usuario que autorizó la solicitud no está habilitado para transmitir video en vivo en YouTube. Para obtener más información, consulta Elegibilidad de funciones.

Pruébalo

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