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 dont l'utilisateur authentifié est propriétaire, ou un ou plusieurs groupes par leur ID unique.

Demande

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 relatifs à votre contenu YouTube. Elle permet d'accéder aux métriques d'activité des utilisateurs, comme le nombre de vues et d'avis.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Affichez les rapports monétaires YouTube Analytics relatifs à votre contenu YouTube. Elle permet d'accéder aux métriques d'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érez 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 Affichez 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écifier exactement l'un des paramètres suivants)
id string
Le paramètre id spécifie une liste d'ID de groupes YouTube séparés par des virgules pour 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 du 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 correctement autorisé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 correctement autorisée. Remarque:Ce paramètre est réservé aux partenaires de contenu 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 demande identifient un utilisateur YouTube qui agit au nom du propriétaire de contenu spécifié dans la valeur du paramètre. 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 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 qui peut ê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 ressource de l'API. La valeur sera youtube#groupListResponse.
etag etag
ETag de cette ressource.
items[] list
Liste des groupes correspondant aux paramètres de requête de l'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 extraire la page suivante de l'ensemble de résultats.

Erreurs

L'API ne définit aucun message d'erreur unique à cette méthode d'API. Toutefois, cette méthode peut toujours renvoyer des erreurs générales d'API répertoriées dans la documentation sur les messages d'erreur.

Essayer

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