API Reference

L'API YouTube Analytics vous permet de récupérer des données YouTube Analytics pour une chaîne YouTube ou un propriétaire de contenu. L'API est compatible avec les requêtes en temps réel et génère un rapport en fonction des paramètres de requête de l'API.

L'API accepte deux types de fonctions:

  • Récupération de rapports : la méthode reports.query de l'API permet de récupérer des rapports YouTube Analytics.

  • Gestion des groupes YouTube Analytics : un groupe YouTube Analytics est une collection personnalisée rassemblant jusqu'à 500 chaînes, vidéos, playlists ou éléments. L'API propose plusieurs méthodes pour créer, récupérer et mettre à jour des groupes YouTube Analytics. Les propriétaires de chaînes et de contenus peuvent ensuite utiliser la méthode reports.query pour récupérer les données globales de tous les éléments d'un groupe, ce qui peut faciliter l'analyse des performances.

Cette page présente brièvement les ressources et les méthodes de l'API qui permettent d'utiliser ces fonctions.

Autorisation

Toutes les requêtes envoyées à l'API YouTube Analytics doivent être autorisées. Le guide d'autorisation explique comment utiliser le protocole OAuth 2.0 pour récupérer des jetons d'autorisation.

Les requêtes de l'API YouTube Analytics utilisent les champs d'application d'autorisation suivants:

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 Consultez les rapports YouTube Analytics sur les revenus de 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érez votre compte YouTube. Dans l'API YouTube Analytics, les propriétaires de chaînes utilisent cette portée 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 cette portée pour gérer les groupes et les éléments de groupe YouTube Analytics.

Récupération de rapports

La méthode reports.query de l'API vous permet de récupérer de nombreux rapports YouTube Analytics différents. Chaque requête utilise des paramètres de requête pour spécifier un ID de chaîne ou un propriétaire de contenu, une date de début, une date de fin et au moins une métrique. Vous pouvez également fournir des paramètres de requête supplémentaires, tels que des dimensions, des filtres et des instructions de tri.

Méthode Requête HTTP Description
URI relatifs à https://youtubeanalytics.googleapis.com/v2
query GET /reports Récupère un rapport YouTube Analytics. Chaque requête API utilise des paramètres de requête pour spécifier un ID de chaîne ou un propriétaire de contenu, une date de début, une date de fin et au moins une métrique. Vous pouvez également fournir des paramètres de requête supplémentaires, tels que des dimensions, des filtres ou des instructions de tri.
  • Les métriques sont des mesures individuelles de l'activité des utilisateurs, telles que les vues de vidéos ou les notes (mentions "J'aime" et "Je n'aime pas").
  • Les dimensions sont des critères courants utilisés pour agréger des données, comme la date à laquelle l'activité utilisateur s'est produite ou le pays dans lequel les utilisateurs se trouvaient. Dans un rapport, chaque ligne de données comporte une combinaison unique de valeurs de dimension.
  • Les filtres sont des valeurs de dimension qui spécifient les données à récupérer. Par exemple, vous pouvez récupérer des données pour un pays, une vidéo ou un groupe de vidéos spécifiques.
Les listes des rapports sur les canaux et des rapports sur les propriétaires de contenu acceptés définissent les combinaisons valides de métriques, de dimensions et de filtres.

Gestion des groupes

L'API fournit deux ressources pour créer et gérer des groupes YouTube Analytics:

Groupes

Une ressource group représente un groupe YouTube Analytics, qui est une collection personnalisée rassemblant jusqu'à 500 chaînes, vidéos, playlists ou éléments.

Tous les éléments d'un groupe doivent représenter le même type de ressource. Par exemple, vous ne pouvez pas créer un groupe contenant 100 vidéos et 100 playlists.

Un groupe Analytics ne peut contenir que des ressources que vous avez importées ou revendiquées, ou qui sont associées à une chaîne que vous gérez. Les propriétaires de chaînes peuvent donc créer des groupes de vidéos et de playlists. Les propriétaires de contenu peuvent créer des groupes de vidéos, de playlists, de chaînes ou d'éléments.

Pour en savoir plus sur cette ressource, consultez sa représentation et la liste des propriétés.

Méthode Requête HTTP Description
URI relatifs à https://youtubeanalytics.googleapis.com/v2
list GET /groups 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.
insert POST /groups Crée un groupe YouTube Analytics. Après avoir créé un groupe, utilisez la méthode groupItems.insert pour y ajouter des éléments.
update PUT /groups Modifie les métadonnées d'un groupe. Actuellement, la seule propriété pouvant être modifiée est le titre du groupe. (Utilisez groupItems.insert et groupItems.delete pour ajouter et supprimer des éléments de groupe.)
delete DELETE /groups Supprime un groupe.

GroupItems

Une ressource groupItem représente un élément d'un groupe YouTube Analytics.

Pour en savoir plus sur cette ressource, consultez sa représentation et la liste des propriétés.

Méthode Requête HTTP Description
URI relatifs à https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Renvoie une collection d'éléments de groupe correspondant aux paramètres de requête de l'API.
insert POST /groupItems Crée un élément de groupe.
delete DELETE /groupItems Supprime un élément d'un groupe.