LiveBroadcasts: transition

Modifie l'état d'une diffusion en direct YouTube et lance tous les processus associés au nouvel état. Par exemple, lorsque vous faites passer l'état d'une diffusion à testing, YouTube commence à transmettre la vidéo au flux de surveillance de cette diffusion. Avant d'appeler cette méthode, vérifiez que la valeur de la propriété status.streamStatus du flux associé à votre diffusion est active.

Cas d'utilisation courants

Requête

Requête HTTP

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

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation

Champ d'application
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Paramètres

Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres répertoriés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
broadcastStatus string
Le paramètre broadcastStatus identifie l'état auquel l'annonce change. Notez que pour faire passer une diffusion à l'état testing ou live, le champ status.streamStatus doit être active pour le flux auquel la diffusion est liée.

Les valeurs acceptées sont les suivantes :
  • complete : la diffusion est terminée. YouTube arrête de transmettre la vidéo.
  • live : la diffusion est visible par son audience. YouTube transmet la vidéo au flux de surveillance de la diffusion et à son flux de diffusion.
  • testing : lance le test de la diffusion. YouTube transmet la vidéo au flux de surveillance de la diffusion. Notez que vous ne pouvez faire passer une diffusion à l'état testing que si sa propriété contentDetails.monitorStream.enableMonitorStream est définie sur true.
id string
Le paramètre id spécifie l'identifiant unique de la diffusion en cours de transition vers un autre état.
part string
Le paramètre part spécifie une liste d'une ou de plusieurs propriétés de ressource liveBroadcast séparées par une virgule, qui seront incluses dans la réponse de l'API. Les noms part que vous pouvez inclure dans la valeur du paramètre sont id, snippet, contentDetails et status.
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui agit au nom du propriétaire de contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent un grand nombre de chaînes YouTube. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.
onBehalfOfContentOwnerChannel string
Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwnerChannel spécifie l'ID de la chaîne YouTube à laquelle la vidéo est ajoutée. Ce paramètre est obligatoire lorsqu'une requête spécifie une valeur pour le paramètre onBehalfOfContentOwner. Il ne peut être utilisé qu'avec ce paramètre. En outre, la demande doit être autorisée à l'aide d'un compte CMS associé au propriétaire de contenu spécifié par le paramètre onBehalfOfContentOwner. Enfin, la chaîne indiquée par le paramètre onBehalfOfContentOwnerChannel doit être associée au propriétaire de contenu indiqué par le paramètre onBehalfOfContentOwner.

Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'effectuer des actions au nom de la chaîne spécifiée dans la valeur du paramètre, sans avoir à fournir d'identifiants d'authentification pour chaque canal.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource "liveBroadcast" dans le corps de la réponse.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.

Type d'erreur Détails de l'erreur Description
backendError errorExecutingTransition Une erreur s'est produite lors de la modification de l'état de la diffusion.
forbidden (403) errorStreamInactive La transition demandée n'est pas autorisée lorsque le flux associé à la diffusion est inactif.
forbidden (403) invalidTransition La diffusion en direct ne peut pas passer de son état actuel à l'état demandé.
forbidden (403) redundantTransition L'état de la diffusion en direct est déjà "demandé" ou il est en cours de traitement.
insufficientPermissions insufficientLivePermissions La demande n'est pas autorisée pour effectuer la transition de la diffusion en direct.
insufficientPermissions livePermissionBlocked L'utilisateur qui a autorisé la demande ne peut pas diffuser de vidéo en direct sur YouTube pour le moment. Pour savoir pourquoi l'utilisateur ne peut pas diffuser de vidéos en direct, accédez aux paramètres de sa chaîne à l'adresse https://www.youtube.com/features.
insufficientPermissions liveStreamingNotEnabled L'utilisateur qui a autorisé la demande n'est pas autorisé à diffuser de la vidéo en direct sur YouTube. Pour en savoir plus, l'utilisateur peut consulter la page https://www.youtube.com/features.
notFound (404) liveBroadcastNotFound L'annonce spécifiée par le paramètre id n'existe pas.
rateLimitExceeded (403) userRequestsExceedRateLimit L'utilisateur a envoyé trop de requêtes au cours d'une période donnée.
required (400) idRequired Le paramètre obligatoire id doit identifier la diffusion dont vous souhaitez effectuer la transition.
required (400) statusRequired La requête API doit spécifier une valeur pour le paramètre status.

Essayer

Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.