LiveBroadcasts: list

Affiche la liste des diffusions YouTube qui correspondent aux paramètres de requête API.

Cas d'utilisation courants

Demande

Requête HTTP

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

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

Définition du champ d'application
https://www.googleapis.com/auth/youtube.readonly
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
part string
Le paramètre part spécifie une liste d'une ou 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 de part que vous pouvez inclure dans la valeur du paramètre sont id, snippet, contentDetails, monetizationDetails et status.
Filtres (spécifiez exactement un des paramètres suivants)
broadcastStatus string
Le paramètre broadcastStatus filtre la réponse de l'API pour n'inclure que les diffusions dont l'état est spécifié.

Les valeurs acceptées sont les suivantes :
  • active : renvoie les diffusions en direct en cours.
  • all : renvoie toutes les diffusions.
  • completed : renvoie les diffusions déjà terminées.
  • upcoming : renvoie les diffusions qui n'ont pas encore commencé.
id string
Le paramètre id spécifie une liste d'ID de diffusion YouTube séparés par une virgule qui identifient les diffusions en cours de récupération. Dans une ressource liveBroadcast, la propriété id spécifie l'ID de l'annonce.
mine boolean
Le paramètre mine peut être utilisé pour indiquer à l'API de ne renvoyer que les annonces appartenant à l'utilisateur authentifié. Définissez la valeur du paramètre sur true pour ne récupérer que vos propres annonces.
Paramètres facultatifs
broadcastType string
Le paramètre broadcastType filtre la réponse de l'API pour n'inclure que les annonces du type spécifié. Ce paramètre doit être utilisé dans les requêtes qui définissent le paramètre mine sur true ou qui utilisent le paramètre broadcastStatus. La valeur par défaut est event.

Valeurs possibles :
  • all : renvoie toutes les diffusions.
  • event : renvoie uniquement les diffusions d'événements planifiées.
  • persistent : renvoie uniquement les diffusions persistantes.
maxResults unsigned integer
Le paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer dans l'ensemble de résultats. Les valeurs autorisées vont de 0 à 50, inclus. La valeur par défaut est 5.
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 agissant pour le compte 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 fois pour accéder à toutes les données relatives à leurs vidéos et à leur chaîne, sans avoir à fournir d'identifiants 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 exclusivement destiné 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 via un compte CMS associé au propriétaire de contenu spécifié par le paramètre onBehalfOfContentOwner. Enfin, la chaîne spécifiée par le paramètre onBehalfOfContentOwnerChannel doit être associée au propriétaire de contenu spécifié 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 différentes. Cela 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.
pageToken string
Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse d'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages pouvant être récupérées.

Corps de la requête

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

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:

Propriétés
kind string
Identifie le type de ressource API. La valeur est youtube#liveBroadcastListResponse.
etag etag
Etag de cette ressource.
nextPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats.
prevPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente de l'ensemble de résultats.
pageInfo object
L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
pageInfo.totalResults integer
Nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste des diffusions correspondant aux critères de la requête.

Erreurs

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

Type d'erreur Détails de l'erreur Description
insufficientPermissions insufficientLivePermissions La requête n'est pas autorisée à récupérer la diffusion en direct.
insufficientPermissions liveStreamingNotEnabled L'utilisateur qui a autorisé la demande ne peut pas diffuser de vidéos en direct sur YouTube. Pour en savoir plus, l'utilisateur peut consulter la page https://www.youtube.com/features.

Essayer

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