API Reference

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

L'API accepte deux types de fonctions:

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

  • Gestion de groupes dans YouTube Analytics : un groupe YouTube Analytics est une collection personnalisée rassemblant un maximum de 500 chaînes, vidéos, playlists ou éléments. L'API est compatible avec plusieurs méthodes de création, de récupération et de mise à jour des groupes YouTube Analytics. Les propriétaires de chaîne et de contenu peuvent ensuite utiliser la méthode reports.query pour récupérer des données agrégées pour tous les éléments d'un groupe, ce qui peut faciliter l'analyse des performances.

Cette page présente brièvement les ressources et méthodes d'API permettant d'exploiter ces fonctions.

Autorisation

Toutes les demandes de 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 demandes d'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 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.

Récupération des rapports

La méthode reports.query de l'API vous permet de récupérer différents rapports YouTube Analytics. Chaque demande 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 statistique. 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 demande d'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 statistiques correspondent à des mesures individuelles de l'activité des utilisateurs, comme le nombre de vues ou d'avis sur les vidéos ("J'aime" et "Je n'aime pas").
  • Les dimensions sont des critères courants utilisés pour regrouper des données, comme la date à laquelle l'activité de l'utilisateur a eu lieu ou le pays où se trouvaient les utilisateurs. Dans un rapport, chaque ligne de données possède 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 les données d'un pays, d'une vidéo ou d'un groupe de vidéos spécifiques.
Les listes de rapports sur les chaînes et de rapports sur les propriétaires de contenu définis définissent les combinaisons de métriques, de dimensions et de filtres valides.

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 un maximum de 500 chaînes, vidéos, playlists ou assets.

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 mises en ligne ou revendiquées, ou qui sont associées à une chaîne que vous gérez. Par conséquent, les propriétaires de chaîne peuvent 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'assets.

Pour en savoir plus sur cette ressource, consultez sa représentation des ressources 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, ajoutez-y des éléments à l'aide de la méthode groupItems.insert.
update PUT /groups Modifie les métadonnées d'un groupe. Actuellement, la seule propriété pouvant être mise à jour est le titre du groupe. (Utilisez les options groupItems.insert et groupItems.delete pour ajouter ou supprimer des éléments de groupe.)
delete DELETE /groups Supprime un groupe.

Articles du groupe

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

Pour en savoir plus sur cette ressource, consultez sa représentation des ressources 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 qui correspondent 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.