LiveBroadcasts: control

Nota: El método liveBroadcasts.control dejó de estar disponible y dejará de funcionar a partir del 1 de octubre de 2020. Después de esa fecha, todas las llamadas a este método mostrarán un error (403) prohibido y, luego, se quitará por completo.

Los clientes también pueden implementar su claqueta agregando una superposición al video enviado a los servidores de transferencia de YouTube. Consulta el anuncio de baja.

Controla la configuración de una lista que se puede mostrar en la transmisión continua.

Casos de uso habituales

Solicitud

Solicitud HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).

Alcance
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
id string
El parámetro id especifica el ID de transmisión en vivo de YouTube que identifica de forma exclusiva la transmisión en la que se actualiza la lista.
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 de part que puedes incluir en el valor del parámetro son id, snippet, contentDetails y status.
Parámetros opcionales
displaySlate boolean
El parámetro displaySlate especifica si se habilita o inhabilita la lista.
offsetTimeMs unsigned long
El parámetro offsetTimeMs especifica una compensación horaria positiva en la que se producirá el cambio de lista especificado. El valor se mide en milisegundos desde el comienzo de la transmisión continua de monitor, que es el tiempo que comenzó la fase de prueba de la transmisión. Aunque se especifica en milisegundos, el valor es en realidad una aproximación y YouTube completa la acción solicitada lo más cerca posible de ese tiempo.

Si no especificas un valor para este parámetro, YouTube realiza la acción lo antes posible. Consulta la guía de Introducción para obtener más detalles.

Importante: Solo debes especificar un valor para este parámetro si la transmisión se retrasa.
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 de 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 varios 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. 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 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 se debe autorizar mediante 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.
walltime datetime
El parámetro walltime especifica la hora real en la que se producirá el cambio de lista especificado. El valor se especifica en el formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

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 recurso liveBroadcast en el cuerpo de la respuesta.

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
backendError errorDisplaySlate Se produjo un error al ejecutar la acción solicitada.
forbidden (403) liveBroadcastControlNotAllowed La acción solicitada solo se permite si el estado de la transmisión es live.
insufficientPermissions insufficientLivePermissions El usuario no está autorizado para la operación solicitada, posiblemente porque no tiene permiso para transmitir en vivo.
insufficientPermissions liveStreamingNotEnabled El usuario que autorizó la solicitud no está habilitado para transmitir video en vivo en YouTube. El usuario puede encontrar más información en https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields Solo se puede especificar uno de offsetTimeMs y walltime.
invalidValue (400) invalidOffsetTimeMs El valor del parámetro offsetTimeMs no es válido. El valor del parámetro debe ser positivo, pero el parámetro solo se puede especificar si la transmisión continua de monitor está habilitada.
invalidValue (400) invalidWalltime El valor del parámetro walltime no es válido.
notFound (404) liveBroadcastNotFound La emisión especificada por el parámetro id no existe.
required (400) actionRequired La solicitud a la API debe especificar al menos una acción. En este momento, la única acción admitida es la capacidad de habilitar o inhabilitar la lista.
required (400) idRequired El parámetro id obligatorio debe identificar la transmisión que se está actualizando.

Pruébela.

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