Documentation de référence de l'API

Cette documentation de référence de l'API explique comment planifier des diffusions en direct et des flux vidéo sur YouTube à l'aide de l'API YouTube Live Streaming.

Types de ressources

LiveBroadcasts

Une ressource liveBroadcast représente un événement qui est diffusé via une vidéo en direct sur YouTube.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind Lie une diffusion YouTube à un flux ou supprime une liaison existante entre une diffusion et un flux. Une diffusion ne peut être liée qu'à un seul flux vidéo, même si un flux vidéo peut être lié à plusieurs diffusions.
delete DELETE /liveBroadcasts Supprime une diffusion.
insert POST /liveBroadcasts Crée une diffusion.
list GET /liveBroadcasts Affiche une liste des diffusions YouTube qui correspondent aux paramètres de requête de l'API.
transition POST /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.
update PUT /liveBroadcasts Met à jour une diffusion. Par exemple, vous pouvez modifier les paramètres de diffusion définis dans l'objet contentDetails de la ressource liveBroadcast.
cuepoint POST /liveBroadcasts/cuepoint Insère un point de repère dans une diffusion en direct. Le point de repère peut déclencher une coupure publicitaire.

LiveChatBans

Une ressource liveChatBan identifie un utilisateur YouTube et un chat en direct YouTube auquel il est exclu de participer.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans Supprime une interdiction qui empêche un utilisateur spécifique de contribuer à un chat en direct, ce qui lui permet de rejoindre à nouveau le chat. La demande d'API doit être autorisée par le propriétaire de la chaîne ou un modérateur du chat en direct associé à l'exclusion.
insert POST /liveChat/bans Exclut un utilisateur spécifique du chat en direct. La demande d'API doit être autorisée par le propriétaire de la chaîne ou un modérateur du chat en direct associé à l'exclusion.

LiveChatMessages

Une ressource liveChatMessage représente un message de chat dans un chat en direct YouTube. La ressource peut contenir des informations sur plusieurs types de messages, y compris un SMS récemment publié ou un événement de financement par les fans.

La fonctionnalité de chat en direct est activée par défaut pour les diffusions en direct et est disponible tant que l'événement en direct est actif. (Une fois l'événement terminé, le chat en direct n'est plus disponible.)

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages Supprime un message de chat. La demande d'API doit être autorisée par le propriétaire de la chaîne ou un modérateur du chat en direct associé à l'exclusion.
insert POST /liveChat/messages Ajoute un message à un chat en direct.
list GET /liveChat/messages Liste les messages d'un chat spécifique.

LiveChatModerators

Une ressource liveChatModerator représente le modérateur d'un chat en direct YouTube. Un modérateur de chat peut exclure des utilisateurs d'un chat ou annuler cette exclusion, supprimer des messages et effectuer d'autres actions d'administration pour le chat en direct.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators Supprime un modérateur de chat. La demande doit être autorisée par le propriétaire de la chaîne de la diffusion en direct.
insert POST /liveChat/moderators ajoute un modérateur pour le chat ; La demande doit être autorisée par le propriétaire de la chaîne de la diffusion en direct.
list GET /liveChat/moderators Liste les modérateurs pour un chat en direct. La demande doit être autorisée par le propriétaire de la chaîne de la diffusion en direct.

LiveStreams

Une ressource liveStream contient des informations sur le flux vidéo que vous transmettez à YouTube. Le flux fournit le contenu qui sera diffusé auprès des utilisateurs YouTube. Une fois créée, une ressource liveStream peut être liée à une ou plusieurs ressources liveBroadcast.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams Supprime un flux vidéo.
insert POST /liveStreams Crée un flux vidéo. Le flux vous permet d'envoyer votre vidéo à YouTube, qui pourra ensuite la diffuser auprès de votre audience.
list GET /liveStreams Renvoie la liste des flux vidéo qui correspondent aux paramètres de requête de l'API.
update PUT /liveStreams Met à jour un flux vidéo. S'il n'est pas possible de mettre à jour les propriétés à modifier, vous devez créer un nouveau flux avec les paramètres appropriés.

SuperChatEvents

Une ressource superChatEvent représente un message Super Chat acheté par un fan pendant une diffusion en direct YouTube. Dans le chat en direct YouTube, les Super Chats se démarquent des autres messages de deux façons:

  • Les Super Chats sont mis en évidence d'une couleur.
  • Les Super Chats restent épinglés dans le flux pendant un certain temps.

La couleur du Super Chat, la durée pendant laquelle il est épinglé dans le flux et la longueur maximale du message dépendent du montant de l'achat. Consultez le Centre d'aide YouTube pour en savoir plus sur les Super Chats.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
list GET /superChatEvents Lister les événements Super Chat des diffusions en direct d'une chaîne au cours des 30 derniers jours

Types de ressources obsolètes

FanFundingEvents

Une ressource fanFundingEvent représente un événement de financement par les fans sur une chaîne YouTube. Le financement par les fans permet de soutenir les créateurs YouTube de façon financière. Un événement de financement par les fans se produit lorsqu'un utilisateur effectue un paiement volontaire ponctuel en faveur d'une chaîne. Pour en savoir plus sur le financement par les fans, consultez le Centre d'aide YouTube.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents Liste les événements de financement par les fans d'une chaîne. La requête API doit être autorisée par le propriétaire de la chaîne.

LiveCuepoints

Une ressource liveCuepoint lance une coupure publicitaire dans le flux vidéo de la diffusion.

Remarque:La commande d'API permettant de contrôler les points de repère fait partie de l'API YouTube Content ID. Les exigences d'autorisation sont différentes de celles des requêtes de gestion des ressources liveBroadcast et liveStream.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/
insert POST /liveCuepoints Insère un point de repère dans une diffusion en direct. Pour le moment, les demandes envoyées via cette méthode doivent être autorisées par un compte associé à un propriétaire de contenu YouTube.

Sponsors

Une ressource sponsor représente le sponsor d'une chaîne YouTube. Un sponsor offre un soutien monétaire récurrent à un créateur (sous la forme d'un abonnement ou de frais d'abonnement, par exemple) et bénéficie d'avantages spéciaux. Par exemple, les soutiens peuvent utiliser le chat lorsque le créateur active le mode soutien.

Pour en savoir plus sur cette ressource, consultez la section concernant la représentation des ressources et la liste de ses propriétés.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/youtube/v3
list GET /sponsors Liste les sponsors d'une chaîne. La requête API doit être autorisée par le propriétaire de la chaîne.