YouTube Reporting API - Data Model

Important:Les rapports quotidiens d'API et de remplissage sont disponibles pendant 60 jours à compter de leur génération. Les rapports de données historiques sont disponibles pendant 30 jours à compter de leur génération.

Cette règle s'applique globalement à l'ensemble des rapports et jobs de création de rapports. Pour en savoir plus, consultez l'historique des révisions de l'API YouTube Reporting.

L'API YouTube Reporting est compatible avec les rapports prédéfinis qui contiennent un ensemble complet de données YouTube Analytics pour une chaîne ou un propriétaire de contenu. Ces rapports vous permettent de télécharger les ensembles de données groupées que vous pouvez interroger avec l'API YouTube Analytics ou dans la section Analytics de Creator Studio.

L'API est également compatible avec un ensemble de rapports générés automatiquement et gérés par le système, mis à la disposition des propriétaires de contenu ayant accès aux rapports correspondants dans le menu "Rapports". Ces rapports contiennent des données sur les revenus publicitaires et les revenus des abonnements YouTube Premium. Pour en savoir plus, consultez la documentation sur les rapports gérés par le système.

Présentation

Dans ces rapports, les champs de rapport se caractérisent par des dimensions ou des métriques:

  • Les dimensions sont des critères courants utilisés pour agréger les données, comme la date à laquelle une action s'est produite ou le pays où se trouvaient les utilisateurs. Dans un rapport, chaque ligne de données correspond à une combinaison unique de valeurs de dimension.
  • Les métriques sont des mesures individuelles liées à l'activité des utilisateurs, aux performances des annonces ou aux revenus estimés. Les métriques sur l'activité des utilisateurs incluent, entre autres, le nombre de vues des vidéos et les notes (mentions "J'aime" et "Je n'aime pas").

Par exemple, le rapport de base sur l'activité de l'utilisateur pour les canaux contient les dimensions suivantes:

  • day: date à laquelle l'activité a eu lieu.
  • channel: chaîne YouTube associée à l'activité.
  • video: vidéo YouTube associée à l'activité.
  • liveOrOnDemand: valeur indiquant si les spectateurs ont regardé une diffusion vidéo en direct.
  • subscribedStatus: valeur indiquant si les spectateurs étaient abonnés à la chaîne.
  • country: pays où se trouvaient les spectateurs.

Le rapport contient également de nombreuses métriques, telles que les vues, les clics sur "J'aime" et la durée moyenne des vues (averageViewDuration, etc.). Après avoir récupéré et importé le rapport, une application peut effectuer de nombreux calculs différents basés sur des valeurs de dimension communes.

Par exemple, pour calculer le nombre total de vues en Allemagne à une date spécifique, additionnez les valeurs de la métrique vues pour toutes les lignes où la valeur de la colonne country est DE et la valeur de la colonne day est la date au format YYYY-MM-DD.

Récupérer des rapports YouTube Analytics

Pour récupérer des rapports sur les chaînes et les propriétaires de contenu via l'API, procédez comme suit : Consultez la documentation relative aux rapports gérés par le système pour savoir comment les récupérer.

Étape 1: Récupérez les identifiants d'autorisation

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

Les requêtes de l'API YouTube Reporting utilisent les niveaux d'autorisation suivants:

Lunettes
https://www.googleapis.com/auth/yt-analytics.readonly Affichez les rapports YouTube Analytics relatifs à votre contenu YouTube. Ce champ d'application permet d'accéder à des métriques sur l'activité des utilisateurs, comme le nombre de vues et de notes.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Afficher les rapports monétaires YouTube Analytics concernant votre contenu YouTube. Ce champ d'application 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.

Étape 2: Identifiez le rapport à récupérer

Appelez la méthode reportTypes.list de l'API afin de récupérer la liste des rapports pouvant être générés pour la chaîne ou le propriétaire de contenu. La méthode renvoie une liste d'ID et de noms de rapports. Capturez la valeur de la propriété id pour les rapports que vous souhaitez générer. Par exemple, l'ID du rapport sur l'activité de base des utilisateurs pour les canaux est channel_basic_a1.

Vous trouverez également le nom des rapports dans la documentation qui définit les rapports sur les canaux et les rapports sur les propriétaires de contenu compatibles.

Étape 3: Créez une tâche de création de rapports

YouTube ne commence à générer votre rapport que lorsque vous créez une tâche de création de rapport pour ce rapport. Par conséquent, les rapports ne sont générés que pour les chaînes et les propriétaires de contenu qui souhaitent les récupérer.

Pour créer une tâche de création de rapports, appelez la méthode jobs.create de l'API. Définissez les valeurs suivantes dans le corps de la requête:

  • Définissez la valeur de la propriété reportTypeId sur l'ID de rapport récupéré à l'étape 2.
  • Définissez la valeur de la propriété name sur le nom que vous souhaitez associer au rapport.

La réponse de l'API à la méthode jobs.create contient une ressource Job, qui spécifie l'élément ID qui identifie la tâche de manière unique. Vous pouvez commencer à récupérer le rapport dans les 48 heures suivant la création du job. Le premier rapport disponible a lieu le jour où vous avez planifié le job.

Par exemple, si vous planifiez une tâche le 1er septembre, le rapport du 1er septembre sera prêt le 3 septembre. Le rapport du 2 septembre sera publié le 4 septembre, et ainsi de suite.

Étape 4: Récupérez l'ID du job

Remarque:Si votre candidature a stocké l'ID d'offre d'emploi renvoyé à l'étape 3, vous pouvez ignorer cette étape.

Appelez la méthode jobs.list pour récupérer la liste des tâches planifiées. La propriété reportTypeId de chaque ressource Job renvoyée identifie le type de rapport généré par cette tâche. Votre application a besoin de la valeur de la propriété id de la même ressource à l'étape suivante.

Étape 5: Récupérez l'URL de téléchargement du rapport

Appelez la méthode jobs.reports.list pour récupérer la liste des rapports créés pour le job. Dans la requête, définissez le paramètre jobId sur l'ID de tâche du rapport que vous souhaitez récupérer.

Conseil:Utilisez le paramètre createdAfter pour indiquer que l'API ne doit renvoyer que les rapports créés après un délai spécifié. Ce paramètre permet de s'assurer que l'API renvoie uniquement des rapports que vous n'avez pas encore traités.

La réponse de l'API contient une liste de ressources Report pour cette tâche. Chaque ressource fait référence à un rapport contenant des données pour une période unique de 24 heures. Sachez que YouTube génère des rapports téléchargeables pour les jours où aucune donnée n'était disponible. Ces rapports comportent une ligne d'en-tête, mais ne contiennent aucune donnée supplémentaire.

  • Les propriétés startTime et endTime de la ressource identifient la période couverte par les données du rapport.
  • La propriété downloadUrl de la ressource identifie l'URL à partir de laquelle le rapport peut être extrait.
  • La propriété createTime de la ressource spécifie la date et l'heure de génération du rapport. Votre application doit stocker cette valeur et l'utiliser pour déterminer si les rapports précédemment téléchargés ont changé.

Étape 6: Téléchargez le rapport

Envoyez une requête HTTP GET au downloadUrl obtenu à l'étape 5 pour récupérer le rapport.

Vous pouvez réduire la bande passante nécessaire au téléchargement des rapports en activant la compression gzip pour les requêtes de téléchargement. Bien que votre application nécessite un temps CPU supplémentaire pour décompresser les réponses de l'API, l'avantage d'une consommation moins importante des ressources réseau compense généralement ce coût.

Pour recevoir une réponse encodée au format gzip, définissez l'en-tête de requête HTTP Accept-Encoding sur gzip, comme illustré dans l'exemple suivant:

Accept-Encoding: gzip

Traitement des rapports

Bonnes pratiques

Les applications qui utilisent l'API YouTube Reporting doivent toujours respecter les pratiques suivantes:

  • Pour déterminer l'ordre des colonnes du rapport, utilisez la ligne d'en-tête du rapport. Par exemple, ne partez pas du principe que vues sera la première métrique renvoyée dans un rapport simplement parce qu'il s'agit de la première métrique répertoriée dans la description d'un rapport. Utilisez plutôt la ligne d'en-tête du rapport pour déterminer quelle colonne contient ces données.

  • Pour éviter de traiter plusieurs fois le même rapport, conservez une trace des rapports que vous avez téléchargés. La liste suivante suggère deux façons de procéder.

    • Lorsque vous appelez la méthode reports.list, utilisez le paramètre createdAfter pour récupérer uniquement les rapports créés après une certaine date. Omettez le paramètre createdAfter la première fois que vous récupérez des rapports.

      Chaque fois que vous récupérez et traitez correctement des rapports, stockez le code temporel correspondant à la date et à l'heure de création du dernier de ces rapports. Ensuite, mettez à jour la valeur du paramètre createdAfter à chaque appel successif de la méthode reports.list pour vous assurer de ne récupérer que les nouveaux rapports, y compris ceux contenant des données remplies, chaque fois que vous appelez l'API.

      Par mesure de précaution, avant de récupérer un rapport, vérifiez également que son ID ne figure pas déjà dans votre base de données.

    • Enregistrez l'ID de chaque rapport que vous avez téléchargé et traité. Vous pouvez également stocker d'autres informations, telles que la date et l'heure auxquelles chaque rapport a été généré, ou les valeurs startTime et endTime du rapport, qui identifient ensemble la période pour laquelle le rapport contient des données. Notez que chaque tâche comporte probablement de nombreux rapports, car chaque rapport contient des données pour une période de 24 heures.

      Utilisez l'ID de rapport pour identifier les rapports que vous devez encore télécharger et importer. Toutefois, si deux nouveaux rapports ont les mêmes valeurs de propriété startTime et endTime, n'importez le rapport qu'avec la valeur createTime la plus récente.

  • Les rapports contiennent les ID associés aux ressources YouTube. Pour récupérer des métadonnées supplémentaires pour ces ressources, utilisez l'API YouTube Data. Comme indiqué dans le Règlement pour les développeurs des services d'API YouTube (sections III.E.4.b à III.E.4.d), les clients API doivent supprimer ou actualiser les métadonnées des ressources stockées depuis cette API au bout de 30 jours.

Caractéristiques du rapport

Les rapports de l'API sont des fichiers .csv (valeurs séparées par des virgules) avec versions gérées qui présentent les caractéristiques suivantes:

  • Chaque rapport contient des données pour une période de 24 heures unique qui s'étend de 00 h 00 à 23 h 59, heure du Pacifique. Par conséquent, dans un rapport donné, la valeur de la dimension jour est toujours la même.

  • Les rapports sont mis à jour quotidiennement.

  • YouTube génère des rapports téléchargeables pour les jours où aucune donnée n'était disponible. Ces rapports comporteront une ligne d'en-tête, mais aucune donnée supplémentaire.

  • Les rapports de l'API sont disponibles pendant 60 jours à compter de leur génération, à l'exception des données historiques générées pour les nouvelles tâches de création de rapports. Les rapports datant de plus de 60 jours sont inaccessibles.
  • Les rapports contenant des données historiques sont disponibles pendant 30 jours à compter de leur génération. Les rapports contenant des données historiques sont inaccessibles au-delà de 30 jours.

  • Les données de rapport ne sont pas filtrées. Par conséquent, un rapport sur la chaîne contient toutes les données concernant les vidéos ou les playlists d'une chaîne, à l'exception des ressources supprimées dans le paragraphe suivant. De même, un rapport sur les propriétaires de contenu contient toutes les données concernant les chaînes du propriétaire de contenu (vidéos, playlists, performances des annonces, etc.), à l'exception de la suivante :

    Bien que les données des rapports ne soient pas filtrées, les rapports ne contiennent aucune référence à des ressources YouTube supprimées au moins 30 jours avant la date de génération du rapport.

  • Les données du rapport ne sont pas triées.

  • Les rapports omettent les lignes qui ne comportent pas de métriques. En d'autres termes, les lignes qui ne comportent aucune métrique sont exclues du rapport. Par exemple, si une vidéo n'a enregistré aucune vue en Albanie un jour donné, le rapport correspondant ne contiendra aucune ligne pour l'Albanie.

  • Les rapports ne contiennent pas de lignes qui fournissent des données récapitulatives sur les métriques, comme le nombre total de vues pour l'ensemble des vidéos d'une chaîne. Vous pouvez calculer ces valeurs totales comme la somme des valeurs du rapport, mais il est possible que cette somme n'inclue pas les métriques sur les vidéos supprimées, comme indiqué ci-dessus. Vous pouvez également utiliser l'API YouTube Analytics pour connaître le nombre total. L'API YouTube Analytics renvoie des valeurs totales qui incluent des métriques pour les ressources supprimées, même si ces ressources ne sont pas explicitement référencées dans les réponses de l'API.

Données de remplissage

Les données de remplissage font référence à un ensemble de données qui remplace un ensemble déjà diffusé. Lorsqu'un rapport de remplissage de données est disponible, votre application doit récupérer le nouveau rapport et mettre à jour vos données stockées pour qu'elles correspondent à l'ensemble de données révisé. Par exemple, votre application peut supprimer les données précédentes de la période couverte par le rapport, puis importer le nouvel ensemble de données.

Si YouTube dispose de données d'annonces de remplissage, un nouveau rapport est généré avec un nouvel ID de rapport. Dans ce cas, les valeurs des propriétés startTime et endTime du rapport correspondent aux heures de début et de fin d'un rapport qui était auparavant disponible et que vous avez peut-être téléchargé précédemment.

Les rapports sur les annonces de remplissage ne contiennent aucune référence à des ressources YouTube supprimées au moins 30 jours avant la date de génération du rapport.

Données historiques

Lorsque vous planifiez une nouvelle tâche de création de rapports, YouTube génère des rapports historiques à compter de ce jour, ainsi que des rapports couvrant la période de 30 jours précédant la création de la tâche. Ainsi, dans cette documentation, les données historiques font référence à un rapport contenant des données pour une période antérieure à la planification de la tâche de création de rapports.

Les rapports historiques sont publiés dès qu'ils sont disponibles. En règle générale, toutes les données historiques d'une offre d'emploi sont publiées dans un délai de quelques jours. Comme expliqué dans la section Caractéristiques du rapport, les rapports contenant des données historiques sont disponibles pendant 30 jours à compter de leur génération. Les rapports contenant des données non historiques sont disponibles pendant 60 jours.

Anonymisation des données

Pour garantir l'anonymat des utilisateurs de YouTube, les valeurs de certaines dimensions ne sont renvoyées que si une métrique de la même ligne atteint un certain seuil.

Par exemple, dans le rapport sur les sources de trafic vidéo pour les canaux, chaque ligne contient un certain nombre de dimensions, y compris trafficSourceType et trafficSourceDetail. Chaque ligne contient également diverses métriques, y compris les vues. Dans les lignes décrivant le trafic provenant d'une recherche YouTube, la dimension trafficSourceDetail identifie le terme de recherche qui a généré le trafic.

Dans cet exemple, les règles suivantes s'appliquent:

  • Le rapport sur les sources de trafic n'identifie le terme de requête (trafficSourceDetail) que s'il a généré au moins un certain nombre de vues d'une vidéo spécifique un jour donné. Dans ce cas, vues est la métrique, vidéo est la dimension d'agrégation et trafficSourceDetail est la dimension anonymisée.

  • Le rapport inclut une ligne supplémentaire qui regroupe les métriques de toutes les valeurs trafficSourceDetail qui n'atteignent pas le seuil de nombre de vues. Cette ligne indique le nombre total de vues associées à ces termes de requête, mais n'identifie pas les termes eux-mêmes.

Les tableaux suivants illustrent ces règles. Le premier tableau contient un ensemble hypothétique de données brutes que YouTube utiliserait pour générer un rapport sur les sources de trafic, et le second contient le rapport lui-même. Dans cet exemple, le seuil du nombre de vues est de 10, ce qui signifie que le rapport n'identifie un terme de recherche que s'il a généré au moins 10 vues d'une vidéo donnée un jour donné. (Les seuils réels sont susceptibles d'être modifiés.)

Données brutes sur le trafic de recherche YouTube pour une vidéo

Supposons que les données ci-dessous décrivent le trafic de recherche YouTube vers une vidéo spécifique pour un jour donné.

terme de recherche vues Estimation du nombre de minutes regardées
style gangnam 100 200
Psy 15 25
psy gangnam 9 15
oppa gangnam 5 8
danse équestre 2 5

Exemple de rapport sur les sources de trafic

Le tableau suivant présente un extrait du rapport sur les sources de trafic que YouTube générerait à partir des données brutes de la section précédente. Le rapport réel contiendra alors plus de dimensions et de métriques. Dans cet exemple, le rapport n'identifie les termes de recherche que s'ils ont généré au moins 10 vues. Les seuils réels sont susceptibles de changer.

Dans la troisième ligne du rapport, la valeur de la dimension trafficSourceDetail est NULL. Les métriques views et estimatedMinutesWatched incluent les vues et les minutes regardées combinées pour les trois termes de recherche qui ont généré moins de 10 vues.

trafficSourceDetail vues estimatedMinutesWatched
style gangnam 100 200
Psy 15 25
NULL 16 28

Dimensions soumises à l'anonymisation

Le tableau suivant identifie les valeurs des dimensions anonymisées si celles des métriques associées n'atteignent pas un certain seuil. Dans chaque cas, la valeur de la métrique est cumulée sur une autre dimension. Par exemple, si la métrique est vues et que la dimension d'agrégation est vidéo, la valeur de la dimension est anonymisée, sauf si la vidéo a été visionnée un certain nombre de fois.

Métrique Agrégation des dimensions Dimension anonyme Valeur anonymisée
subscribersGained channel pays ZZ
subscribersGained channel province US-ZZ
subscribersLost channel pays ZZ
subscribersLost channel province US-ZZ
comments vidéo pays ZZ
comments vidéo province US-ZZ
J'aime vidéo pays ZZ
J'aime vidéo province US-ZZ
Je n'aime pas vidéo pays ZZ
Je n'aime pas vidéo province US-ZZ
vues vidéo ageGroup NULL
vues vidéo sexe NULL
vues video et trafficSourceDetail trafficSourceDetail NULL
Nombre d'abonnés à la chaîne channel subscribedStatus NULL

Exemples de code

Les exemples de code suivants montrent comment utiliser l'API pour créer une tâche de création de rapports, puis récupérer un rapport pour cette tâche. Deux exemples de code sont fournis pour chaque langage:

  1. Le premier exemple de code montre comment récupérer la liste des types de rapports disponibles, puis comment créer une tâche de création de rapports.

  2. Le deuxième exemple de code montre comment récupérer un rapport pour une tâche spécifique. Vous pouvez commencer à récupérer des rapports dans les 48 heures suivant la création du job.

Remarque:Les exemples de code suivants peuvent ne pas représenter tous les langages de programmation compatibles. Consultez la documentation sur les bibliothèques clientes pour obtenir la liste des langages acceptés.

Java

Les exemples suivants utilisent la bibliothèque cliente Java:

Exemple 1: Créer une tâche de création de rapports

L'exemple de code suivant appelle la méthode reportTypes.list pour récupérer la liste des types de rapports disponibles. Il appelle ensuite la méthode jobs.create pour créer une tâche de création de rapports.

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListReportTypesResponse;
import com.google.api.services.youtubereporting.model.ReportType;
import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */
public class CreateReportingJob {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Create a reporting job.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "createreportingjob");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-createreportingjob-sample").build();

            // Prompt the user to specify the name of the job to be created.
            String name = getNameFromUser();

            if (listReportTypes()) {
              createReportingJob(getReportTypeIdFromUser(), name);
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists report types. (reportTypes.listReportTypes)
     * @return true if at least one report type exists
     * @throws IOException
     */
    private static boolean listReportTypes() throws IOException {
        // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
        ListReportTypesResponse reportTypesListResponse = youtubeReporting.reportTypes().list()
            .execute();
        List<ReportType> reportTypeList = reportTypesListResponse.getReportTypes();

        if (reportTypeList == null || reportTypeList.isEmpty()) {
          System.out.println("No report types found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Report Types ==================\n");
            for (ReportType reportType : reportTypeList) {
                System.out.println("  - Id: " + reportType.getId());
                System.out.println("  - Name: " + reportType.getName());
                System.out.println("\n-------------------------------------------------------------\n");
           }
        }
        return true;
    }

    /**
     * Creates a reporting job. (jobs.create)
     *
     * @param reportTypeId Id of the job's report type.
     * @param name name of the job.
     * @throws IOException
     */
    private static void createReportingJob(String reportTypeId, String name)
        throws IOException {
        // Create a reporting job with a name and a report type id.
        Job job = new Job();
        job.setReportTypeId(reportTypeId);
        job.setName(name);

        // Call the YouTube Reporting API's jobs.create method to create a job.
        Job createdJob = youtubeReporting.jobs().create(job).execute();

        // Print information from the API response.
        System.out.println("\n================== Created reporting job ==================\n");
        System.out.println("  - ID: " + createdJob.getId());
        System.out.println("  - Name: " + createdJob.getName());
        System.out.println("  - Report Type Id: " + createdJob.getReportTypeId());
        System.out.println("  - Create Time: " + createdJob.getCreateTime());
        System.out.println("\n-------------------------------------------------------------\n");
    }

    /*
     * Prompt the user to enter a name for the job. Then return the name.
     */
    private static String getNameFromUser() throws IOException {

        String name = "";

        System.out.print("Please enter the name for the job [javaTestJob]: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        name = bReader.readLine();

        if (name.length() < 1) {
            // If nothing is entered, defaults to "javaTestJob".
          name = "javaTestJob";
        }

        System.out.println("You chose " + name + " as the name for the job.");
        return name;
    }

    /*
     * Prompt the user to enter a report type id for the job. Then return the id.
     */
    private static String getReportTypeIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the reportTypeId for the job: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the report type Id for the job.");
        return id;
    }
}

CreateReportingJob.java

Exemple 2: Récupérer un rapport

L'exemple de code appelle la méthode jobs.list pour récupérer une liste de tâches de création de rapports. Il appelle ensuite la méthode reports.list avec le paramètre jobId défini sur un ID de tâche spécifique pour récupérer les rapports créés par cette tâche. Enfin, l'exemple affiche l'URL de téléchargement pour chaque rapport. 

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.GenericUrl;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.YouTubeReporting.Media.Download;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListJobsResponse;
import com.google.api.services.youtubereporting.model.ListReportsResponse;
import com.google.api.services.youtubereporting.model.Report;

import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

import javax.print.attribute.standard.Media;

/**
 * This sample retrieves reports created by a specific job by:
 *
 * 1. Listing the jobs using the "jobs.list" method.
 * 2. Retrieving reports using the "reports.list" method.
 *
 * @author Ibrahim Ulukaya
 */
public class RetrieveReports {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Retrieve reports.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "retrievereports");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-retrievereports-sample").build();

            if (listReportingJobs()) {
              if(retrieveReports(getJobIdFromUser())) {
                downloadReport(getReportUrlFromUser());
              }
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists reporting jobs. (jobs.listJobs)
     * @return true if at least one reporting job exists
     * @throws IOException
     */
    private static boolean listReportingJobs() throws IOException {
        // Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
        ListJobsResponse jobsListResponse = youtubeReporting.jobs().list().execute();
        List<Job> jobsList = jobsListResponse.getJobs();

        if (jobsList == null || jobsList.isEmpty()) {
          System.out.println("No jobs found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Reporting Jobs ==================\n");
            for (Job job : jobsList) {
                System.out.println("  - Id: " + job.getId());
                System.out.println("  - Name: " + job.getName());
                System.out.println("  - Report Type Id: " + job.getReportTypeId());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Lists reports created by a specific job. (reports.listJobsReports)
     *
     * @param jobId The ID of the job.
     * @throws IOException
     */
    private static boolean retrieveReports(String jobId)
        throws IOException {
        // Call the YouTube Reporting API's reports.list method
        // to retrieve reports created by a job.
        ListReportsResponse reportsListResponse = youtubeReporting.jobs().reports().list(jobId).execute();
        List<Report> reportslist = reportsListResponse.getReports();

        if (reportslist == null || reportslist.isEmpty()) {
            System.out.println("No reports found.");
            return false;
        } else {
            // Print information from the API response.
            System.out.println("\n============= Reports for the job " + jobId + " =============\n");
            for (Report report : reportslist) {
                System.out.println("  - Id: " + report.getId());
                System.out.println("  - From: " + report.getStartTime());
                System.out.println("  - To: " + report.getEndTime());
                System.out.println("  - Download Url: " + report.getDownloadUrl());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Download the report specified by the URL. (media.download)
     *
     * @param reportUrl The URL of the report to be downloaded.
     * @throws IOException
     */
    private static boolean downloadReport(String reportUrl)
        throws IOException {
        // Call the YouTube Reporting API's media.download method to download a report.
        Download request = youtubeReporting.media().download("");
        FileOutputStream fop = new FileOutputStream(new File("report"));
        request.getMediaHttpDownloader().download(new GenericUrl(reportUrl), fop);
        return true;
    }

    /*
     * Prompt the user to enter a job id for report retrieval. Then return the id.
     */
    private static String getJobIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the job id for the report retrieval: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the job Id for the report retrieval.");
        return id;
    }

    /*
     * Prompt the user to enter a URL for report download. Then return the URL.
     */
    private static String getReportUrlFromUser() throws IOException {

        String url = "";

        System.out.print("Please enter the report URL to download: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        url = bReader.readLine();

        System.out.println("You chose " + url + " as the URL to download.");
        return url;
    }}


RetrieveReports.java

PHP

Les exemples suivants utilisent la bibliothèque cliente PHP.

Exemple 1: Créer une tâche de création de rapports

L'exemple de code suivant appelle la méthode reportTypes.list pour récupérer la liste des types de rapports disponibles. Il appelle ensuite la méthode jobs.create pour créer une tâche de création de rapports.

<?php

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();

/*
 * You can acquire an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
$OAUTH2_CLIENT_ID = 'REPLACE_ME';
$OAUTH2_CLIENT_SECRET = 'REPLACE_ME';

$client = new Google_Client();
$client->setClientId($OAUTH2_CLIENT_ID);
$client->setClientSecret($OAUTH2_CLIENT_SECRET);

/*
 * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
 * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
 * use this scope.
 */
$client->setScopes('https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
$redirect = filter_var('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'],
    FILTER_SANITIZE_URL);
$client->setRedirectUri($redirect);

// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

// Check if an auth token exists for the required scopes
$tokenSessionKey = 'token-' . $client->prepareScopes();
if (isset($_GET['code'])) {
  if (strval($_SESSION['state']) !== strval($_GET['state'])) {
    die('The session state did not match.');
  }

  $client->authenticate($_GET['code']);
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
  header('Location: ' . $redirect);
}

if (isset($_SESSION[$tokenSessionKey])) {
  $client->setAccessToken($_SESSION[$tokenSessionKey]);
}

// Check to ensure that the access token was successfully acquired.
if ($client->getAccessToken()) {
  // This code executes if the user enters a name in the form
  // and submits the form. Otherwise, the page displays the form above.
  try {
    if (empty(listReportTypes($youtubeReporting, $htmlBody))) {
      $htmlBody .= sprintf('<p>No report types found.</p>');
    } else if ($_GET['reportTypeId']){
      createReportingJob($youtubeReporting, $_GET['reportTypeId'], $_GET['jobName'], $htmlBody);
    }
  } catch (Google_Service_Exception $e) {
    $htmlBody = sprintf('<p>A service error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  } catch (Google_Exception $e) {
    $htmlBody = sprintf('<p>An client error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  }
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
} elseif ($OAUTH2_CLIENT_ID == 'REPLACE_ME') {
  $htmlBody = <<<END
  <h3>Client Credentials Required</h3>
  <p>
    You need to set <code>\$OAUTH2_CLIENT_ID</code> and
    <code>\$OAUTH2_CLIENT_ID</code> before proceeding.
  <p>
END;
} else {
  // If the user hasn't authorized the app, initiate the OAuth flow
  $state = mt_rand();
  $client->setState($state);
  $_SESSION['state'] = $state;

  $authUrl = $client->createAuthUrl();
  $htmlBody = <<<END
  <h3>Authorization Required</h3>
  <p>You need to <a href="$authUrl">authorize access</a> before proceeding.<p>
END;
}


/**
 * Creates a reporting job. (jobs.create)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportTypeId Id of the job's report type.
 * @param string $name name of the job.
 * @param $htmlBody - html body.
 */
function createReportingJob(Google_Service_YouTubeReporting $youtubeReporting, $reportTypeId,
    $name, &$htmlBody) {
  # Create a reporting job with a name and a report type id.
  $reportingJob = new Google_Service_YouTubeReporting_Job();
  $reportingJob->setReportTypeId($reportTypeId);
  $reportingJob->setName($name);

  // Call the YouTube Reporting API's jobs.create method to create a job.
  $jobCreateResponse = $youtubeReporting->jobs->create($reportingJob);

  $htmlBody .= "<h2>Created reporting job</h2><ul>";
  $htmlBody .= sprintf('<li>"%s" for reporting type "%s" at "%s"</li>',
      $jobCreateResponse['name'], $jobCreateResponse['reportTypeId'], $jobCreateResponse['createTime']);
  $htmlBody .= '</ul>';
}


/**
 * Returns a list of report types. (reportTypes.listReportTypes)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param $htmlBody - html body.
 */
function listReportTypes(Google_Service_YouTubeReporting $youtubeReporting, &$htmlBody) {
  // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
  $reportTypes = $youtubeReporting->reportTypes->listReportTypes();

  $htmlBody .= "<h3>Report Types</h3><ul>";
  foreach ($reportTypes as $reportType) {
    $htmlBody .= sprintf('<li>id: "%s", name: "%s"</li>', $reportType['id'], $reportType['name']);
  }
  $htmlBody .= '</ul>';

  return $reportTypes;
}
?>

<!doctype html>
<html>
<head>
<title>Create a reporting job</title>
</head>
<body>
  <form method="GET">
    <div>
      Job Name: <input type="text" id="jobName" name="jobName" placeholder="Enter Job Name">
    </div>
    <br>
    <div>
      Report Type Id: <input type="text" id="reportTypeId" name="reportTypeId" placeholder="Enter Report Type Id">
    </div>
    <br>
    <input type="submit" value="Create!">
  </form>
  <?=$htmlBody?>
</body>
</html>

create_reporting_job.php

Exemple 2: Récupérer un rapport

L'exemple de code appelle la méthode jobs.list pour récupérer une liste de tâches de création de rapports. Il appelle ensuite la méthode reports.list avec le paramètre jobId défini sur un ID de tâche spécifique pour récupérer les rapports créés par cette tâche. Enfin, l'exemple affiche l'URL de téléchargement pour chaque rapport.

<?php

/**
 * This sample supports the following use cases:
 *
 * 1. Retrieve reporting jobs by content owner:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID"
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --includeSystemManaged==True
 * 2. Retrieving list of downloadable reports for a particular job:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --jobId="JOB_ID"
 * 3. Download a report:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --downloadUrl="DOWNLOAD_URL" --outputFile="report.txt"
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();


define('CREDENTIALS_PATH', '~/.credentials/youtube-php.json');

$longOptions = array(
  'contentOwner::',
  'downloadUrl::',
  'includeSystemManaged::',
  'jobId::',
  'outputFile::',
);

$options = getopt('', $longOptions);

$CONTENT_OWNER_ID = ($options['contentOwner'] ? $options['contentOwner'] : '');
$DOWNLOAD_URL = (array_key_exists('downloadUrl', $options) ?
                 $options['downloadUrl'] : '');
$INCLUDE_SYSTEM_MANAGED = (array_key_exists('includeSystemManaged', $options) ?
                           $options['includeSystemManaged'] : '');
$JOB_ID = (array_key_exists('jobId', $options) ? $options['jobId'] : '');
$OUTPUT_FILE = (array_key_exists('outputFile', $options) ?
                $options['outputFile'] : '');

/*
 * You can obtain an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
function getClient() {
  $client = new Google_Client();
  $client->setAuthConfigFile('client_secrets_php.json');
  $client->addScope(
      'https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
  $client->setRedirectUri('urn:ietf:wg:oauth:2.0:oob');
  $client->setAccessType('offline');

  // Load previously authorized credentials from a file.
  $credentialsPath = expandHomeDirectory(CREDENTIALS_PATH);
  if (file_exists($credentialsPath)) {
    $accessToken = json_decode(file_get_contents($credentialsPath), true);
  } else {
    // Request authorization from the user.
    $authUrl = $client->createAuthUrl();
    printf('Open the following link in your browser:\n%s\n', $authUrl);
    print 'Enter verification code: ';
    $authCode = trim(fgets(STDIN));

    // Exchange authorization code for an access token.
    $accessToken = $client->authenticate($authCode);
    $refreshToken = $client->getRefreshToken();

    // Store the credentials to disk.
    if(!file_exists(dirname($credentialsPath))) {
      mkdir(dirname($credentialsPath), 0700, true);
    }
    file_put_contents($credentialsPath, json_encode($accessToken));
    printf('Credentials saved to %s\n', $credentialsPath);

    //fclose($fp);
  }
  $client->setAccessToken($accessToken);

  // Refresh the token if it's expired.
  if ($client->isAccessTokenExpired()) {
    $client->fetchAccessTokenWithRefreshToken($client->getRefreshToken());
    file_put_contents($credentialsPath, json_encode($client->getAccessToken()));
  }

  return $client;
}

/**
 * Expands the home directory alias '~' to the full path.
 * @param string $path the path to expand.
 * @return string the expanded path.
 */
function expandHomeDirectory($path) {
  $homeDirectory = getenv('HOME');
  if (empty($homeDirectory)) {
    $homeDirectory = getenv('HOMEDRIVE') . getenv('HOMEPATH');
  }
  return str_replace('~', realpath($homeDirectory), $path);
}

/**
 * Returns a list of reporting jobs. (jobs.listJobs)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportingJobs(Google_Service_YouTubeReporting $youtubeReporting,
    $onBehalfOfContentOwner = '', $includeSystemManaged = False) {
  $reportingJobs = $youtubeReporting->jobs->listJobs(
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner,
            'includeSystemManaged' => $includeSystemManaged));
  print ('REPORTING JOBS' . PHP_EOL . '**************' . PHP_EOL);
  foreach ($reportingJobs as $job) {
    print($job['reportTypeId'] . ':' . $job['id'] . PHP_EOL);
  }
  print(PHP_EOL);
}

/**
 * Lists reports created by a specific job. (reports.listJobsReports)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $jobId The ID of the job.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportsForJob(Google_Service_YouTubeReporting $youtubeReporting,
    $jobId, $onBehalfOfContentOwner = '') {
  $reports = $youtubeReporting->jobs_reports->listJobsReports($jobId,
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner));
  print ('DOWNLOADABLE REPORTS' . PHP_EOL . '********************' . PHP_EOL);
  foreach ($reports['reports'] as $report) {
    print('Created: ' . date('d M Y', strtotime($report['createTime'])) .
          ' (' . date('d M Y', strtotime($report['startTime'])) .
          ' to ' . date('d M Y', strtotime($report['endTime'])) . ')' .
          PHP_EOL .  '    ' . $report['downloadUrl'] . PHP_EOL . PHP_EOL);
  }
}

/**
 * Download the report specified by the URL. (media.download)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportUrl The URL of the report to be downloaded.
 * @param string $outputFile The file to write the report to locally.
 * @param $htmlBody - html body.
 */
function downloadReport(Google_Service_YouTubeReporting $youtubeReporting,
    $reportUrl, $outputFile) {
  $client = $youtubeReporting->getClient();
  // Setting the defer flag to true tells the client to return a request that
  // can be called with ->execute(); instead of making the API call immediately.
  $client->setDefer(true);

  // Call YouTube Reporting API's media.download method to download a report.
  $request = $youtubeReporting->media->download('', array('alt' => 'media'));
  $request = $request->withUri(new \GuzzleHttp\Psr7\Uri($reportUrl));
  $responseBody = '';
  try {
    $response = $client->execute($request);
    $responseBody = $response->getBody();
  } catch (Google_Service_Exception $e) {
    $responseBody = $e->getTrace()[0]['args'][0]->getResponseBody();
  }
  file_put_contents($outputFile, $responseBody);
  $client->setDefer(false);
}

// Define an object that will be used to make all API requests.
$client = getClient();
// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

if ($CONTENT_OWNER_ID) {
  if (!$DOWNLOAD_URL && !$JOB_ID) {
    listReportingJobs($youtubeReporting, $CONTENT_OWNER_ID,
                      $INCLUDE_SYSTEM_MANAGED);
  } else if ($JOB_ID) {
    listReportsForJob($youtubeReporting, $JOB_ID, $CONTENT_OWNER_ID);
  } else if ($DOWNLOAD_URL && $OUTPUT_FILE) {
    downloadReport($youtubeReporting, $DOWNLOAD_URL, $OUTPUT_FILE);
  }
}

?>

retrieve_reports.php

Python

Les exemples suivants utilisent la bibliothèque cliente Python.

Exemple 1: Créer une tâche de création de rapports

L'exemple de code suivant appelle la méthode reportTypes.list pour récupérer la liste des types de rapports disponibles. Il appelle ensuite la méthode jobs.create pour créer une tâche de création de rapports.

#!/usr/bin/python

# Create a reporting job for the authenticated user's channel or
# for a content owner that the user's account is linked to.
# Usage example:
# python create_reporting_job.py --name='<name>'
# python create_reporting_job.py --content-owner='<CONTENT OWNER ID>'
# python create_reporting_job.py --content-owner='<CONTENT_OWNER_ID>' --report-type='<REPORT_TYPE_ID>' --name='<REPORT_NAME>'

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from google_auth_oauthlib.flow import InstalledAppFlow


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains

# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
# authenticated user's account. Any request that retrieves earnings or ad performance metrics must
# use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
def list_report_types(youtube_reporting, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)
  results = youtube_reporting.reportTypes().list(**kwargs).execute()
  reportTypes = results['reportTypes']

  if 'reportTypes' in results and results['reportTypes']:
    reportTypes = results['reportTypes']
    for reportType in reportTypes:
      print 'Report type id: %s\n name: %s\n' % (reportType['id'], reportType['name'])
  else:
    print 'No report types found'
    return False

  return True


# Call the YouTube Reporting API's jobs.create method to create a job.
def create_reporting_job(youtube_reporting, report_type_id, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)

  reporting_job = youtube_reporting.jobs().create(
    body=dict(
      reportTypeId=args.report_type,
      name=args.name
    ),
    **kwargs
  ).execute()

  print ('Reporting job "%s" created for reporting type "%s" at "%s"'
         % (reporting_job['name'], reporting_job['reportTypeId'],
             reporting_job['createTime']))


# Prompt the user to enter a report type id for the job. Then return the id.
def get_report_type_id_from_user():
  report_type_id = raw_input('Please enter the reportTypeId for the job: ')
  print ('You chose "%s" as the report type Id for the job.' % report_type_id)
  return report_type_id

# Prompt the user to set a job name
def prompt_user_to_set_job_name():
  job_name = raw_input('Please set a name for the job: ')
  print ('Great! "%s" is a memorable name for this job.' % job_name)
  return job_name


if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  # The 'name' option specifies the name that will be used for the reporting job.
  parser.add_argument('--content-owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports.')
  parser.add_argument('--include-system-managed', default=False,
      help='Whether the API response should include system-managed reports')
  parser.add_argument('--name', default='',
    help='Name for the reporting job. The script prompts you to set a name ' +
         'for the job if you do not provide one using this argument.')
  parser.add_argument('--report-type', default=None,
    help='The type of report for which you are creating a job.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()

  try:
    # Prompt user to select report type if they didn't set one on command line.
    if not args.report_type:
      if list_report_types(youtube_reporting,
                           onBehalfOfContentOwner=args.content_owner,
                           includeSystemManaged=args.include_system_managed):
        args.report_type = get_report_type_id_from_user()
    # Prompt user to set job name if not set on command line.
    if not args.name:
      args.name = prompt_user_to_set_job_name()
    # Create the job.
    if args.report_type:
      create_reporting_job(youtube_reporting,
                           args,
                           onBehalfOfContentOwner=args.content_owner)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)

create_reporting_job.py

Exemple 2: Récupérer un rapport

L'exemple de code appelle la méthode jobs.list pour récupérer une liste de tâches de création de rapports. Il appelle ensuite la méthode reports.list avec le paramètre jobId défini sur un ID de tâche spécifique pour récupérer les rapports créés par cette tâche. Enfin, l'exemple affiche l'URL de téléchargement pour chaque rapport.

#!/usr/bin/python

###
#
# This script retrieves YouTube Reporting API reports. Use cases:
# 1. If you specify a report URL, the script downloads that report.
# 2. Otherwise, if you specify a job ID, the script retrieves a list of
#    available reports for that job and prompts you to select a report.
#    Then it retrieves that report as in case 1.
# 3. Otherwise, the list retrieves a list of jobs for the user or,
#    if specified, the content owner that the user is acting on behalf of.
#    Then it prompts the user to select a job, and then executes case 2 and
#    then case 1.
# Usage examples:
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --job_id=<JOB_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --report_url=<REPORT_URL> --local_file=<LOCAL_FILE>
#
###

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload
from google_auth_oauthlib.flow import InstalledAppFlow
from io import FileIO


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains
# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to YouTube Analytics
# monetary reports for the authenticated user's account. Any request that
# retrieves earnings or ad performance metrics must use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
def list_reporting_jobs(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve the reporting jobs for the user (or content owner).
  results = youtube_reporting.jobs().list(**kwargs).execute()

  if 'jobs' in results and results['jobs']:
    jobs = results['jobs']
    for job in jobs:
      print ('Reporting job id: %s\n name: %s\n for reporting type: %s\n'
        % (job['id'], job['name'], job['reportTypeId']))
  else:
    print 'No jobs found'
    return False

  return True

# Call the YouTube Reporting API's reports.list method to retrieve reports created by a job.
def retrieve_reports(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve available reports for the selected job.
  results = youtube_reporting.jobs().reports().list(
    **kwargs
  ).execute()

  if 'reports' in results and results['reports']:
    reports = results['reports']
    for report in reports:
      print ('Report dates: %s to %s\n       download URL: %s\n'
        % (report['startTime'], report['endTime'], report['downloadUrl']))


# Call the YouTube Reporting API's media.download method to download the report.
def download_report(youtube_reporting, report_url, local_file):
  request = youtube_reporting.media().download(
    resourceName=' '
  )
  request.uri = report_url
  fh = FileIO(local_file, mode='wb')
  # Stream/download the report in a single request.
  downloader = MediaIoBaseDownload(fh, request, chunksize=-1)

  done = False
  while done is False:
    status, done = downloader.next_chunk()
    if status:
      print 'Download %d%%.' % int(status.progress() * 100)
  print 'Download Complete!'


# Prompt the user to select a job and return the specified ID.
def get_job_id_from_user():
  job_id = raw_input('Please enter the job id for the report retrieval: ')
  print ('You chose "%s" as the job Id for the report retrieval.' % job_id)
  return job_id

# Prompt the user to select a report URL and return the specified URL.
def get_report_url_from_user():
  report_url = raw_input('Please enter the report URL to download: ')
  print ('You chose "%s" to download.' % report_url)
  return report_url

if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  parser.add_argument('--content_owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports')
  parser.add_argument('--job_id', default=None,
      help='ID of the job for which you are retrieving reports. If not ' +
           'provided AND report_url is also not provided, then the script ' +
           'calls jobs.list() to retrieve a list of jobs.')
  parser.add_argument('--report_url', default=None,
      help='URL of the report to retrieve. If not specified, the script ' +
           'calls reports.list() to retrieve a list of reports for the ' +
           'selected job.')
  parser.add_argument('--local_file', default='yt_report.txt',
      help='The name of the local file where the downloaded report will be written.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()
  try:
    # If the user has not specified a job ID or report URL, retrieve a list
    # of available jobs and prompt the user to select one.
    if not args.job_id and not args.report_url:
      if list_reporting_jobs(youtube_reporting,
                             onBehalfOfContentOwner=args.content_owner):
        args.job_id = get_job_id_from_user()

    # If the user has not specified a report URL, retrieve a list of reports
    # available for the specified job and prompt the user to select one.
    if args.job_id and not args.report_url:
      retrieve_reports(youtube_reporting,
                       jobId=args.job_id,
                       onBehalfOfContentOwner=args.content_owner)
      args.report_url = get_report_url_from_user()

    # Download the selected report.
    if args.report_url:
      download_report(youtube_reporting, args.report_url, args.local_file)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)

retrieve_reports.py