LiveStreams: list

Renvoie une liste de flux vidéo correspondant aux paramètres de la requête API.

Cas d'utilisation courants

Requête

Requête HTTP

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

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

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 ressources liveStream séparées par une virgule que la réponse de l'API inclura. Les noms part que vous pouvez inclure dans la valeur de paramètre sont id, snippet, cdn et status.
Filtres (spécifiez exactement l'un des paramètres suivants)
id string
Le paramètre id spécifie une liste d'ID de flux YouTube séparés par une virgule qui identifient les flux récupérés. Dans une ressource liveStream, la propriété id spécifie l'ID du flux.
mine boolean
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Le paramètre mine peut être utilisé pour demander à l'API de ne renvoyer que les flux appartenant à l'utilisateur authentifié. Définissez la valeur de paramètre sur true pour ne récupérer que vos propres flux.
Paramètres facultatifs
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 onBehalfOfContentOwner paramètre indique que les identifiants d'autorisation de la requête identifient un utilisateur du 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 vidéo et de 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 du contenu YouTube spécifié.
onBehalfOfContentOwnerChannel string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. 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 onBehalfOfContentOwnerChannel 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 pourraient ê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#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream 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#liveStreamListResponse.
etag etag
L'Etag de cette ressource.
nextPageToken string
Le 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
Le 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
Le nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Le nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste des diffusions en direct 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, veuillez consulter 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 spécifiée.
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 https://www.youtube.com/features.

Essayer

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