Documentation de référence de l'API

Cette référence d'API explique comment programmer 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 sera diffusé en streaming vidéo en direct sur YouTube.

Pour en savoir plus sur cette ressource, consultez sa représentation 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 Associe une diffusion YouTube à un flux ou supprime une association existante entre une diffusion et un flux. Une diffusion ne peut être associée qu'à un seul flux vidéo, mais un flux vidéo peut être associé à plusieurs diffusions.
delete DELETE /liveBroadcasts Supprime une diffusion.
insert POST /liveBroadcasts Crée une diffusion.
list GET /liveBroadcasts Renvoie une liste des diffusions YouTube qui correspondent aux paramètres de la requête API.
transition POST /liveBroadcasts/transition Modifie l'état d'une diffusion en direct YouTube et lance les processus associés au nouvel état. Par exemple, lorsque vous définissez l'état d'une diffusion sur testing, YouTube commence à transmettre la vidéo au flux de surveillance de cette diffusion. Avant d'appeler cette méthode, vous devez vérifier que la valeur de la propriété status.streamStatus du flux lié à 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 n'est pas autorisé à participer.

Pour en savoir plus sur cette ressource, consultez sa représentation 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 exclusion qui empêche un utilisateur spécifique de participer à un chat en direct, ce qui lui permet de le rejoindre à nouveau. 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 Empêche un utilisateur spécifique de participer au 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 message texte ou un événement de financement par les fans récemment publié.

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

Pour en savoir plus sur cette ressource, consultez sa représentation 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 de chat en direct pour un chat spécifique.
streamList Démonstration du code Active une connexion de streaming serveur pour recevoir les messages du chat en direct d'un chat spécifique avec une faible latence.

LiveChatModerators

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

Pour en savoir plus sur cette ressource, consultez sa représentation 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 au 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 d'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é aux utilisateurs YouTube. Une fois créée, une ressource liveStream peut être associée à une ou plusieurs ressources liveBroadcast.

Pour en savoir plus sur cette ressource, consultez sa représentation 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 peut ensuite la diffuser auprès de votre audience.
list GET /liveStreams Renvoie une liste de flux vidéo correspondant aux paramètres de la requête API.
update PUT /liveStreams Met à jour un flux vidéo. Si les propriétés que vous souhaitez modifier ne peuvent pas être mises à jour, vous devez créer un flux avec les paramètres appropriés.

SuperChatEvents

Une ressource superChatEvent représente un message Super Chat acheté par un fan lors d'une diffusion en direct YouTube. Dans le flux de chat en direct YouTube, les Super Chats se démarquent des autres messages de deux manières :

  • Les Super Chats sont mis en évidence à l'aide d'une couleur.
  • Les Super Chats restent épinglés dans le bandeau pendant une certaine période.

La couleur du Super Chat, la durée pendant laquelle il reste épinglé dans le bandeau et la longueur maximale du message sont toutes déterminées par le montant de l'achat. Pour en savoir plus sur les Super Chats, consultez le Centre d'aide YouTube.

Pour en savoir plus sur cette ressource, consultez sa représentation 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 financièrement les créateurs YouTube. Un événement de financement des fans se produit lorsqu'un utilisateur effectue un paiement ponctuel et volontaire à une chaîne. Pour en savoir plus sur le financement des fans, consultez le Centre d'aide YouTube.

Pour en savoir plus sur cette ressource, consultez sa représentation 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 pour une chaîne. La demande d'API doit être autorisée par le propriétaire de la chaîne.

LiveCuepoints

Une ressource liveCuepoint lance un break publicitaire dans le flux vidéo de la diffusion.

Remarque : La commande API permettant de contrôler les repères est en fait incluse dans l'API YouTube Content ID et présente des exigences d'autorisation différentes de celles des requêtes permettant de gérer les ressources liveBroadcast et liveStream.

Pour en savoir plus sur cette ressource, consultez sa représentation 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. Actuellement, les requêtes envoyées à cette méthode doivent être autorisées par un compte associé à un propriétaire de contenu YouTube.

Sponsors

Une ressource sponsor représente un sponsor pour une chaîne YouTube. Un mécène apporte un soutien financier récurrent à un créateur, comme un abonnement ou des frais d'adhésion, et reçoit des avantages spéciaux. Par exemple, les sponsors peuvent discuter lorsque le créateur active le mode Sponsors uniquement pour un chat.

Pour en savoir plus sur cette ressource, consultez sa représentation 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 demande d'API doit être autorisée par le propriétaire de la chaîne.