LiveBroadcasts: list

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

Cas d'utilisation courants

Requête

Requête HTTP

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

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants. Pour en savoir plus sur l'authentification et l'autorisation, consultez Implémenter l'authentification OAuth 2.0.

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 présente les paramètres compatibles avec cette requête. Tous les paramètres listé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 que la réponse de l'API inclura. Les noms de part que vous pouvez inclure dans la valeur de paramètre sont id, snippet, contentDetails, monetizationDetails et status.
Filtres (spécifiez exactement l'un des paramètres suivants)
broadcastStatus string
Le paramètre broadcastStatus filtre la réponse de l'API pour n'inclure que les diffusions avec l'état spécifié.

Les valeurs acceptées sont les suivantes :
  • active : renvoie les diffusions en direct actuelles.
  • all : renvoie toutes les diffusions.
  • completed : renvoie les diffusions qui sont 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 la diffusion.
mine boolean
Le paramètre mine peut être utilisé pour demander à l'API de ne renvoyer que les diffusions appartenant à l'utilisateur authentifié. Définissez la valeur de paramètre sur true pour ne récupérer que vos propres diffusions.
Paramètres facultatifs
broadcastType string
Le paramètre broadcastType filtre la réponse de l'API pour n'inclure que les diffusions avec le type spécifié. Le 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.

Les valeurs acceptées sont les suivantes :
  • all : renvoie toutes les diffusions.
  • event : ne renvoie que les diffusions d'événements programmés.
  • persistent : ne renvoie que 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 acceptées sont comprises entre 0 et 50 inclus. La valeur par défaut est 5.
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée.
Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur du système de gestion de contenu (CMS) YouTube qui agit au nom du propriétaire du 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 de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes leurs données de vidéos et de chaînes, 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 du contenu YouTube spécifié.
onBehalfOfContentOwnerChannel string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée.
Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le onBehalfOfContentOwnerChannel paramètre spécifie l'ID de la chaîne YouTube à laquelle une vidéo est ajoutée. Ce paramètre est obligatoire lorsqu'une requête spécifie une valeur pour le paramètre onBehalfOfContentOwner, et il ne peut être utilisé qu'avec ce paramètre. De plus, la requête doit être autorisée à l'aide d'un compte CMS associé au propriétaire du contenu spécifié par le paramètre onBehalfOfContentOwner. Enfin, la chaîne spécifiée par la valeur du paramètre onBehalfOfContentOwnerChannel doit être associée au propriétaire du 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. 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 de paramètre, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne.
pageToken string
Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse de l'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages qui peuvent ê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 de l'API. La valeur sera youtube#liveBroadcastListResponse.
etag etag
Etag de cette ressource.
nextPageToken string
Jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats.
prevPageToken string
Jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente dans 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 qui correspondent 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 Message 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 requête n'est pas autorisé à diffuser des vidéos en direct sur YouTube. Pour en savoir plus, consultez Éligibilité aux fonctionnalités.

Essayer

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