Groups: list

Renvoie une liste de groupes correspondant aux paramètres de requête de l'API. Par exemple, vous pouvez récupérer tous les groupes appartenant à l'utilisateur authentifié, ou récupérer un ou plusieurs groupes en fonction de leur ID unique.

Requête

Requête HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

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

Niveaux d'accès
https://www.googleapis.com/auth/yt-analytics.readonly Affichez les rapports YouTube Analytics sur votre contenu YouTube. Ce champ d'application permet d'accéder aux métriques d'activité des utilisateurs, comme le nombre de vues et le nombre d'évaluations.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Afficher les rapports YouTube Analytics sur les revenus concernant votre contenu YouTube Cette portée permet d'accéder aux métriques sur l'activité des utilisateurs, ainsi qu'aux métriques sur les revenus estimés et les performances des annonces.
https://www.googleapis.com/auth/youtube gérer votre compte YouTube ; Dans l'API YouTube Analytics, les propriétaires de chaîne utilisent ce champ d'application pour gérer les groupes et les éléments de groupe YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Consultez et gérez les éléments YouTube et le contenu associé sur YouTube. Dans l'API YouTube Analytics, les propriétaires de contenu utilisent ce champ d'application pour gérer les groupes et les éléments de groupe YouTube Analytics.

Paramètres

Le tableau ci-dessous liste les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Filtres (spécifiez exactement l'un des paramètres suivants)
id string
Le paramètre id spécifie une liste d'ID de groupe YouTube séparés par une virgule pour la ou les ressources récupérées. Chaque groupe doit appartenir à l'utilisateur authentifié. Dans une ressource group, la propriété id spécifie l'ID de groupe YouTube du groupe.

Notez que si vous ne spécifiez pas de valeur pour le paramètre id, vous devez définir le paramètre mine sur true.
mine boolean
Ce paramètre ne peut être utilisé que dans une requête autorisée appropriée. Définissez la valeur de ce paramètre sur true pour récupérer tous les groupes appartenant à l'utilisateur authentifié.
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête autorisée correctement. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenus YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur YouTube qui agit au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Il permet aux propriétaires de contenus 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 avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.
pageToken string
Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse d'API, la propriété nextPageToken identifie la page suivante pouvant être récupérée.

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#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

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 la ressource d'API. La valeur sera youtube#groupListResponse.
etag etag
Etag de cette ressource.
items[] list
Liste de groupes correspondant aux paramètres de requête API. Chaque élément de la liste représente une ressource group.
nextPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante de l'ensemble de résultats.

Erreurs

L'API ne définit aucun message d'erreur propre à cette méthode d'API. Toutefois, cette méthode peut toujours renvoyer des erreurs API générales listées dans la documentation du message d'erreur.

Essayer

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