YouTube Reporting API - Get Bulk Data Reports

API отчетов YouTube поддерживает предопределенные отчеты, содержащие полный набор данных YouTube Analytics для канала или владельца контента. Эти отчеты позволяют загружать большие объемы данных, которые можно запрашивать с помощью API YouTube Analytics или в разделе «Аналитика» в Creator Studio.

API также поддерживает набор автоматически генерируемых системных отчетов, доступных владельцам контента, имеющим доступ к соответствующим отчетам в меню «Отчеты» . Эти отчеты содержат данные о доходах от рекламы и доходах от подписки YouTube Premium. Дополнительную информацию см. в документации по системным отчетам .

Обзор

В этих отчетах поля подразделяются на измерения и метрики:

• Измерения — это распространенные критерии, используемые для агрегирования данных, такие как дата совершения действия или страна, в которой находились пользователи. В отчете каждая строка данных содержит уникальную комбинацию значений измерений.
• Метрики — это отдельные показатели, связанные с активностью пользователей, эффективностью рекламы или предполагаемым доходом. Метрики активности пользователей включают в себя такие данные, как количество просмотров видео и оценки (лайки и дизлайки).

Например, базовый отчет об активности пользователей по каналам содержит следующие параметры:

• день : Дата, когда произошло событие.
• канал : YouTube-канал, связанный с данным мероприятием.
• Видео : Видео на YouTube, связанное с данным мероприятием.
• liveOrOnDemand : Значение, указывающее, смотрели ли зрители прямую видеотрансляцию.
• subscribedStatus : Значение, указывающее, были ли зрители подписаны на канал.
• Страна : Страна, в которой находились зрители.

Отчет также содержит множество метрик, таких как просмотры , лайки и средняя продолжительность просмотра . После получения и импорта отчета приложение может выполнять множество различных вычислений на основе значений распространенных параметров.

Например, чтобы рассчитать общее количество просмотров в Германии на определенную дату, нужно просуммировать значения метрики просмотров для всех строк, где значение столбца «Страна» равно DE , а значение столбца «День» — дате в формате YYYY-MM-DD .

Получить отчеты YouTube Analytics

Следующие шаги описывают, как получать отчеты о каналах и владельцах контента через API. Инструкции по получению этих отчетов см. в разделе «Системные отчеты» .

Шаг 1: Получение учетных данных авторизации

Все запросы к API отчетов YouTube должны быть авторизованы. Чтобы получить токены авторизации через протокол OAuth 2.0, см. руководство по авторизации .

Для запросов к API отчетов YouTube используются следующие области авторизации:

Области применения
https://www.googleapis.com/auth/yt-analytics.readonly	Просматривайте отчеты YouTube Analytics по вашему контенту на YouTube. Этот раздел предоставляет доступ к показателям активности пользователей, таким как количество просмотров и оценок.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	Просматривайте финансовые отчеты YouTube Analytics по вашему контенту на YouTube. Этот раздел предоставляет доступ к показателям активности пользователей, а также к прогнозируемым показателям дохода и эффективности рекламы.

Шаг 2: Определите отчет, который необходимо получить.

Вызовите метод reportTypes.list API, чтобы получить список отчетов, которые могут быть сгенерированы для владельца канала или контента. Метод возвращает список идентификаторов и названий отчетов. Укажите значение свойства id для отчетов, которые вы хотите сгенерировать. Например, идентификатор базового отчета об активности пользователей для каналов — channel_basic_a3 .

Названия отчетов также можно найти в документации, определяющей поддерживаемые отчеты по каналам и отчеты для владельцев контента .

Шаг 3: Создайте задание для формирования отчетов.

YouTube начнет формировать ваш отчет только после того, как вы создадите для него задание на создание отчета. (Таким образом, отчеты создаются только для тех каналов и владельцев контента, которые действительно хотят их получить.)

Для создания задания на создание отчета вызовите метод jobs.create API. В теле запроса укажите следующие значения:

• Установите значение свойства reportTypeId равным идентификатору отчета, полученному на шаге 2.
• Установите значение свойства name равным имени, которое вы хотите связать с отчетом.

В ответе API на метод jobs.create содержится ресурс Job , в котором указан ID , однозначно идентифицирующий задание. Вы можете начать получать отчеты в течение 48 часов с момента создания задания, и первый доступный отчет будет относиться к дню, когда вы запланировали задание.

Например, если вы запланируете задание на 1 сентября, то отчет за 1 сентября будет готов 3 сентября. Отчет за 2 сентября будет опубликован 4 сентября.

Шаг 4: Получите идентификатор задания.

Примечание: Если ваше приложение сохранило идентификатор задания, полученный на шаге 3, то этот шаг можно пропустить.

Вызовите метод jobs.list , чтобы получить список запланированных заданий. Свойство reportTypeId в каждом возвращаемом ресурсе Job определяет тип отчета, который генерирует это задание. Вашему приложению потребуется значение свойства id из того же ресурса на следующем шаге.

Шаг 5: Получите URL-адрес для скачивания отчета.

Вызовите метод jobs.reports.list , чтобы получить список отчетов, созданных для задания. В запросе установите параметр jobId равным идентификатору задания для отчета, который вы хотите получить.

Совет: Используйте параметр createdAfter , чтобы указать, что API должен возвращать только отчеты, созданные после указанного времени. Этот параметр позволяет гарантировать, что API будет возвращать только те отчеты, которые вы еще не обработали.

Ответ API содержит список ресурсов Report для данного задания. Каждый ресурс ссылается на отчет, содержащий данные за уникальный 24-часовой период. Обратите внимание, что YouTube генерирует отчеты для скачивания за дни, за которые данные отсутствовали. Эти отчеты содержат строку заголовка, но не содержат дополнительных данных.

• Свойства startTime и endTime ресурса определяют период времени, который охватывают данные отчета.
• Свойство downloadUrl ресурса определяет URL-адрес, с которого можно получить отчет.
• Свойство createTime ресурса указывает дату и время создания отчета. Ваше приложение должно сохранить это значение и использовать его для определения того, изменились ли ранее загруженные отчеты.

Шаг 6: Скачайте отчет

Для получения отчета отправьте HTTP GET-запрос по адресу downloadUrl полученному на шаге 5.

Вы можете уменьшить пропускную способность, необходимую для загрузки отчетов, включив сжатие gzip для запросов на загрузку. Хотя вашему приложению потребуется дополнительное процессорное время для распаковки ответов API, выгода от использования меньших сетевых ресурсов обычно перевешивает эти затраты.

Чтобы получать ответ в формате gzip, установите заголовок HTTP-запроса Accept-Encoding в gzip , как показано в следующем примере:

Accept-Encoding: gzip

Отчеты о процессах

Передовые методы

Приложения, использующие API отчетов YouTube, всегда должны следовать этим рекомендациям:

• Чтобы определить порядок столбцов отчета, используйте строку заголовка отчета. Например, не следует предполагать, что количество просмотров будет первым показателем, возвращаемым в отчете, только потому, что это первый показатель, указанный в описании отчета. Вместо этого используйте строку заголовка отчета, чтобы определить, в каком столбце содержатся эти данные.

• Чтобы обеспечить совместимость вашей системы обработки отчетов с будущими версиями, ваше приложение должно быть готово к добавлению новых метрик в любой отчет и должно быть готово обрабатывать и включать эти новые столбцы по мере их появления. Новые метрики отображаются в виде новых столбцов в заголовке отчета.

• Чтобы избежать повторной обработки одного и того же отчета, ведите учет загруженных отчетов. Ниже приведен список нескольких способов, как это сделать.

  • При вызове метода reports.list используйте параметр createdAfter , чтобы получать только отчеты, созданные после определенной даты. (При первом получении отчетов параметр createdAfter следует опустить.)

    Каждый раз, когда вы получаете и успешно обрабатываете отчеты, сохраняйте метку времени, соответствующую дате и времени создания самого нового из этих отчетов. Затем обновляйте значение параметра createdAfter при каждом последующем вызове метода reports.list , чтобы гарантировать, что при каждом обращении к API вы получаете только новые отчеты, включая новые отчеты с заполненными данными.

    В качестве меры предосторожности, перед получением отчета также убедитесь, что идентификатор отчета еще не указан в вашей базе данных.

  • Сохраните идентификатор каждого загруженного и обработанного отчета. Вы также можете сохранить дополнительную информацию, такую ​​как дата и время создания каждого отчета, а также startTime и endTime , которые вместе определяют период, за который отчет содержит данные. Обратите внимание, что каждое задание, вероятно, будет содержать много отчетов, поскольку каждый отчет содержит данные за 24-часовой период.

    Используйте идентификатор отчета, чтобы определить отчеты, которые вам еще нужно загрузить и импортировать. Однако, если два новых отчета имеют одинаковые значения свойств startTime и endTime , импортируйте только тот отчет, у которого значение createTime больше.

• Отчеты содержат идентификаторы, связанные с ресурсами YouTube. Для получения дополнительных метаданных для этих ресурсов используйте YouTube Data API . Как указано в Политике разработчиков сервисов YouTube API (разделы III.E.4.b–III.E.4.d), клиенты API должны либо удалить, либо обновить сохраненные метаданные ресурсов из этого API через 30 дней.

Характеристики отчета

Отчеты API представляют собой версионированные файлы .csv (значения, разделенные запятыми), обладающие следующими характеристиками:

• Каждый отчет содержит данные за уникальный 24-часовой период, с 00:00 до 23:59 по тихоокеанскому стандартному времени (UTC-8). Таким образом, в любом отчете значение параметра «день» всегда одинаково.

• Отчеты обновляются ежедневно.

• YouTube генерирует отчеты для скачивания за дни, по которым данные отсутствовали. Эти отчеты будут содержать заголовок, но не будут включать дополнительные данные.

• Отчеты, созданные через API, доступны в течение 60 дней с момента их генерации, за исключением исторических данных, созданных для новых заданий по формированию отчетов. Отчеты становятся недоступными по истечении 60 дней с момента их создания.
• Отчеты, содержащие исторические данные, доступны в течение 30 дней с момента их создания. Отчеты, содержащие исторические данные, становятся недоступными по истечении 30 дней с момента их создания.

• Данные отчета не фильтруются. Таким образом, отчет по каналу содержит все данные по видео или плейлистам канала, за исключением ресурсов, указанных в следующем абзаце. Аналогично, отчет владельца контента содержит все данные по каналам владельца контента (видео, плейлисты, эффективность рекламы и т. д.), за исключением следующего.

  Хотя данные отчета не фильтруются, в отчетах отсутствуют ссылки на ресурсы YouTube, удаленные как минимум за 30 дней до даты создания отчета.

• Данные в отчете не отсортированы.

• В отчетах отсутствуют строки, для которых нет метрик. Другими словами, из отчета исключаются строки, не имеющие метрик. Например, если у видео нет просмотров в Албании в определенный день, отчет за этот день не будет содержать строк для Албании.

• Отчеты не содержат строк с сводными данными по метрикам, таким как общее количество просмотров всех видео канала. Вы можете рассчитать эти общие значения как сумму значений в отчете, но эта сумма может не включать метрики для удаленных видео. Вы также можете использовать API YouTube Analytics для получения общих значений. API YouTube Analytics возвращает общие значения, которые включают метрики для удаленных ресурсов, даже если эти ресурсы явно не указаны в ответах API.

• Пустые значения измерений: В пакетных отчетах столбцы измерений, такие как video_id или channel_id могут содержать пустые строки в следующих случаях:

  • Удаленные ресурсы: Если видео или канал были удалены, в отчете не указывается идентификатор удаленного ресурса, но строка с ним сохраняется для обеспечения агрегированных итоговых показателей для родительского объекта.
  • Показатели на уровне канала: В отчетах, включающих измерение video_id , показатели, относящиеся к уровню канала (например, подписки, полученные непосредственно с главной страницы канала), отображаются в строке, где video_id — пустая строка.

Данные обратной засыпки

Данные для обратной замены — это набор данных, который заменяет ранее предоставленный набор. Когда доступен отчет с данными для обратной замены, ваше приложение должно получить новый отчет и обновить сохраненные данные в соответствии с измененным набором данных. Например, ваше приложение может удалить предыдущие данные за период времени, охватываемый отчетом, а затем импортировать новый набор данных.

Если у YouTube есть данные для восстановления, он генерирует новый отчет с новым идентификатором . В этом случае значения свойств startTime и endTime отчета будут соответствовать времени начала и окончания отчета, который был доступен ранее и который вы, возможно, уже скачивали.

В отчётах о заполнении пробелов не содержатся ссылки на ресурсы YouTube, удалённые как минимум за 30 дней до даты создания отчёта.

Исторические данные

При планировании нового задания на создание отчета YouTube генерирует исторические отчеты, начиная с этого дня, а также отчеты за 30-дневный период, предшествующий моменту создания задания. Таким образом, в данной документации под историческими данными понимается отчет, содержащий данные за период времени до планирования задания на создание отчета.

Исторические отчеты публикуются по мере их доступности. Как правило, все исторические данные по заданию публикуются в течение нескольких дней. Как поясняется в разделе «Характеристики отчетов» , отчеты, содержащие исторические данные, доступны в течение 30 дней с момента их создания. Отчеты, содержащие неисторические данные, доступны в течение 60 дней.

анонимизация данных

Для обеспечения анонимности зрителей YouTube значения по некоторым параметрам возвращаются только в том случае, если показатель в той же строке соответствует определенному пороговому значению.

Например, в отчете об источниках видеотрафика для каналов каждая строка содержит ряд параметров, включая trafficSourceType и trafficSourceDetail . Каждая строка также содержит различные метрики, включая просмотры . В строках, описывающих трафик, поступивший из поиска на YouTube, параметр trafficSourceDetail определяет поисковый запрос, который привел к трафику.

В этом примере действуют следующие правила:

• В отчете об источниках трафика поисковый запрос ( trafficSourceDetail ) идентифицируется только в том случае, если он привел к определенному количеству просмотров конкретного видео в определенный день. В данном случае просмотры — это метрика, видео — агрегирующий параметр, а trafficSourceDetail — анонимизированный параметр.

• В отчет включена дополнительная строка, которая суммирует метрики для всех значений trafficSourceDetail , не соответствующих пороговому значению количества просмотров. В этой строке отображается общее количество просмотров, связанных с этими поисковыми запросами, но сами запросы не идентифицируются.

Следующие таблицы иллюстрируют эти правила. Первая таблица содержит гипотетический набор исходных данных, которые YouTube использовал бы для создания отчета об источниках трафика, а вторая таблица содержит сам отчет. В этом примере пороговое значение количества просмотров равно 10, что означает, что отчет идентифицирует поисковый запрос только в том случае, если он привел как минимум к 10 просмотрам конкретного видео в конкретный день. (Фактические пороговые значения могут меняться.)

Исходные данные о поисковом трафике видео на YouTube.

Предположим, что следующие данные описывают поисковый трафик на YouTube, направленный на конкретное видео в конкретный день.

поисковый запрос	просмотры	примерное количество просмотренных минут
Гангнам Стайл	100	200
пси	15	25
пси гангнам	9	15
оппа гангнам	5	8
танец верховой езды	2	5

Пример отчета об источниках трафика

В следующей таблице представлен фрагмент отчета об источниках трафика, который YouTube сгенерировал бы на основе исходных данных из предыдущего раздела. (Фактический отчет содержал бы больше параметров и показателей.) В этом примере отчет определяет поисковые запросы только в том случае, если они привели как минимум к 10 просмотрам. Фактические пороговые значения могут изменяться.

В третьей строке отчета значение параметра trafficSourceDetail равно NULL . Показатели views и estimatedMinutesWatched содержат суммарное количество просмотров и минут просмотра для трех поисковых запросов, которые сгенерировали менее 10 просмотров.

trafficSourceDetail	просмотры	оценочное количество просмотренных минут
Гангнам Стайл	100	200
пси	15	25
НУЛЕВОЙ	16	28

Размеры подлежат анонимизации.

В следующей таблице указаны значения измерений, которые анонимизируются, если соответствующие значения метрик не соответствуют определенному пороговому значению. В каждом случае значение метрики агрегируется по другому измерению. Например, если метрика — просмотры , а агрегирующее измерение — видео , то значение измерения анонимизируется, если видео не было просмотрено определенное количество раз.

Метрическая система	Агрегирование измерений	Анонимизированное измерение	Анонимизированное значение
подписчиковПолучено	канал	страна	ZZ
подписчиковПолучено	канал	провинция	US-ZZ
подписчикиПотеряны	канал	страна	ZZ
подписчикиПотеряны	канал	провинция	US-ZZ
комментарии	видео	страна	ZZ
комментарии	видео	провинция	US-ZZ
нравится	видео	страна	ZZ
нравится	видео	провинция	US-ZZ
неприязнь	видео	страна	ZZ
неприязнь	видео	провинция	US-ZZ
просмотры	видео	возрастная группа	NULL
просмотры	видео	пол	NULL
просмотры	видео и информация о трафике (источник)	trafficSourceDetail	NULL
Количество подписчиков канала	канал	статус подписки	NULL

Примеры кода

Приведенные ниже примеры кода демонстрируют, как использовать API для создания задания на создание отчета, а затем получить отчет по этому заданию. Для каждого языка программирования предоставлено два примера кода:

1. Первый пример кода демонстрирует, как получить список доступных типов отчетов, а затем создать новое задание для создания отчетов.

2. Второй пример кода показывает, как получить отчет для конкретного задания. Вы можете начать получать отчеты в течение 48 часов с момента создания задания.

Примечание: Приведенные ниже примеры кода могут не отражать все поддерживаемые языки программирования. Список поддерживаемых языков см. в разделе клиентских библиотек .

Java

В следующих примерах используется клиентская библиотека Java :

• Пример 1: Создание задания для формирования отчетов
• Пример 2: Получение отчета

Пример 1: Создание задания для формирования отчетов

В приведенном ниже примере кода вызывается метод reportTypes.list для получения списка доступных типов отчетов. Затем вызывается метод jobs.create для создания нового задания на создание отчета.

/*
 * 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

Пример 2: Получение отчета

В приведенном примере кода вызывается метод jobs.list для получения списка заданий на создание отчетов. Затем вызывается метод reports.list с параметром jobId , установленным на конкретный идентификатор задания, для получения отчетов, созданных этим заданием. Наконец, в примере выводится URL-адрес для загрузки каждого отчета.

/*
 * 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

В приведенных ниже примерах используется клиентская библиотека PHP .

• Пример 1: Создание задания для формирования отчетов
• Пример 2: Получение отчета

Пример 1: Создание задания для формирования отчетов

В приведенном ниже примере кода вызывается метод reportTypes.list для получения списка доступных типов отчетов. Затем вызывается метод jobs.create для создания нового задания на создание отчета.

<?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

Пример 2: Получение отчета

В приведенном примере кода вызывается метод jobs.list для получения списка заданий на создание отчетов. Затем вызывается метод reports.list с параметром jobId , установленным на конкретный идентификатор задания, для получения отчетов, созданных этим заданием. Наконец, в примере выводится URL-адрес для загрузки каждого отчета.

<?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

В следующих примерах используется клиентская библиотека Python .

• Пример 1: Создание задания для формирования отчетов
• Пример 2: Получение отчета

Пример 1: Создание задания для формирования отчетов

В приведенном ниже примере кода вызывается метод reportTypes.list для получения списка доступных типов отчетов. Затем вызывается метод jobs.create для создания нового задания на создание отчета.

#!/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

Пример 2: Получение отчета

В приведенном примере кода вызывается метод jobs.list для получения списка заданий на создание отчетов. Затем вызывается метод reports.list с параметром jobId , установленным на конкретный идентификатор задания, для получения отчетов, созданных этим заданием. Наконец, в примере выводится URL-адрес для загрузки каждого отчета.

#!/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