Renvoie une liste de flux vidéo qui correspondent aux paramètres de requête de l'API.
Cas d'utilisation courants
Demande
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
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 | ||
---|---|---|
Réglages obligatoires | ||
part |
string Le paramètre part spécifie une liste d'une ou de plusieurs propriétés de ressources liveStream , séparées par une virgule, qui seront incluses dans la réponse de l'API. Les noms part que vous pouvez inclure dans la valeur du paramètre sont id , snippet , cdn et status . |
|
Filtres (spécifier exactement l'un des paramètres suivants) | ||
id |
string Le paramètre id spécifie les 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 permet de demander à l'API de ne renvoyer que les flux appartenant à l'utilisateur authentifié. Définissez la valeur du 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 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 requête correctement autorisée. Remarque : Ce paramètre est réservé aux partenaires de contenu YouTube. Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui agit au nom 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 différentes. Elle permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de 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 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 réservé aux partenaires de contenu YouTube. Le paramètre onBehalfOfContentOwnerChannel spécifie l'ID de la chaîne à 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 . 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 indiqué 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 indiqué 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. Elle permet aux propriétaires de contenu de s'authentifier une fois et d'effectuer des actions pour le compte de la chaîne spécifiée dans la valeur du paramètre, sans avoir à fournir d'identifiants 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 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 ETag de cette ressource. |
nextPageToken |
string Jeton pouvant être utilisé comme valeur du paramètre pageToken pour extraire la page suivante de 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 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 de diffusions en direct correspondant aux critères de requête. |
Erreurs
Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.
Type d'erreur | Détails de l'erreur | Description |
---|---|---|
insufficientPermissions |
insufficientLivePermissions |
La requête n'est pas autorisée à récupérer le flux en direct spécifié. |
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 la page https://www.youtube.com/features. |
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête API et la réponse.