Cette page a été traduite par l'API Cloud Translation.

LiveBroadcasts: list

Renvoie une liste de diffusions YouTube correspondant aux paramètres de requête de l'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 correspondant à 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.

Portée
`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 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 ressources `liveBroadcast`, séparées par une virgule, que la réponse de l'API inclue. Les noms `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 annonces avec l'état spécifié. Les valeurs acceptées sont les suivantes: <ph type="x-smartling-placeholder"> </ph> `active` : permet d'afficher les diffusions en direct en cours. `all` : renvoie toutes les diffusions. `completed` : renvoie des diffusions déjà terminées. `upcoming` : renvoie des diffusions qui n'ont pas encore commencé.
`id`	`string` Le paramètre `id` définit une liste d'ID de diffusion YouTube séparés par une virgule qui identifient les diffusions à récupérer. 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 indiquer à l'API de ne renvoyer que des annonces appartenant à l'utilisateur authentifié. Définissez la valeur du 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 annonces du type spécifié. Il 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: <ph type="x-smartling-placeholder"> </ph> `all` : renvoie toutes les diffusions. `event` : permet d'afficher uniquement les événements programmés diffusés. `persistent` : ne renvoie que des annonces 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 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 demande identifient un utilisateur du système de gestion de contenu (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 de nombreuses chaînes YouTube différentes. Elle permet aux propriétaires de contenu de s'authentifier une 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 correctement autorisée. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube. Le paramètre `onBehalfOfContentOwnerChannel` indique 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 spécifiée par la valeur du 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. Il permet aux propriétaires de contenu de s'authentifier une 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 chaîne.
`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 les autres pages pouvant être récupérées.

Corps de la requête

N'indiquez 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 d'API. La valeur sera `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 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 d'annonces 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 de cette méthode. Pour en savoir plus, consultez la section Message d'erreur.

Type d'erreur	Détails de l'erreur	Description
`insufficientPermissions`	`insufficientLivePermissions`	Cette demande n'est pas autorisée à récupérer la diffusion en direct.
`insufficientPermissions`	`liveStreamingNotEnabled`	L'utilisateur qui a autorisé la demande n'est pas autorisé à diffuser des vidéos en direct sur YouTube. Pour en savoir plus, consultez Accès aux fonctionnalités.

Essayer

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