YouTube Reporting API - Get Bulk Data Reports
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
YouTube автоматически создает набор управляемых системой отчетов о доходах от рекламы для владельцев контента, у которых есть доступ к соответствующим отчетам в Creator Studio . Эти отчеты предназначены для обеспечения программного доступа к данным, которые также доступны в отчетах, загружаемых вручную и доступных в меню «Отчеты» в YouTube Creator Studio.
Примечание. API предоставляет доступ к другому набору отчетов, чем Creator Studio, хотя отчеты содержат схожие данные. Отчеты API могут иметь другие поля, а также использовать другие имена полей, чем отчеты Creator Studio.
Поскольку YouTube автоматически создает отчеты, управляемые системой, процесс получения этих отчетов отличается от процесса получения отчетов по массовым данным YouTube Analytics, доступных через API.
Получение отчетов
Следующие шаги объясняют, как получить отчеты, управляемые системой, через API.
Шаг 1. Получите учетные данные для авторизации
Все запросы API отчетов YouTube должны быть авторизованы. Руководство по авторизации объясняет, как использовать протокол OAuth 2.0 для получения токенов авторизации.
Запросы YouTube Reporting API используют следующие области авторизации:
| Области применения |
|---|
| https://www.googleapis.com/auth/yt-analytics.readonly | Просматривайте отчеты YouTube Analytics для вашего контента YouTube. Эта область обеспечивает доступ к показателям активности пользователей, таким как количество просмотров и рейтингов. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly | Просматривайте финансовые отчеты YouTube Analytics для вашего контента YouTube. Эта область обеспечивает доступ к показателям активности пользователей, а также к показателям предполагаемого дохода и эффективности рекламы. |
Шаг 2. Получите идентификатор задания для нужного отчета.
Вызовите метод jobs.list , чтобы получить список заданий, управляемых системой. Установите для параметра includeSystemManaged значение true .
Свойство reportTypeId в каждом возвращаемом ресурсе Job определяет тип управляемого системой отчета, связанного с этим заданием. На следующем шаге вашему приложению потребуется значение свойства id из того же ресурса.
В документе «Отчеты» перечислены доступные отчеты, идентификаторы их типов отчетов и поля, которые они содержат. Вы также можете использовать метод reportTypes.list для получения списка поддерживаемых типов отчетов.
Шаг 3. Получите URL-адрес загрузки отчета.
Вызовите метод jobs.reports.list , чтобы получить список отчетов, созданных для задания. В запросе задайте для параметра jobId идентификатор задания отчета, который вы хотите получить.
Вы можете отфильтровать список отчетов, используя любой или все из следующих параметров:
Используйте параметр createdAfter чтобы указать, что API должен возвращать только отчеты, созданные после указанного времени. Этот параметр можно использовать, чтобы API возвращал только те отчеты, которые вы еще не обработали.
Используйте параметр startTimeBefore чтобы указать, что ответ API должен содержать отчеты только в том случае, если самые ранние данные в отчете появились до указанной даты. Параметр createdAfter относится ко времени создания отчета, а эта дата относится к данным в отчете.
Используйте параметр startTimeAtOrAfter чтобы указать, что ответ API должен содержать отчеты только в том случае, если самые ранние данные в отчете относятся к указанной дате или после нее. Как и параметр startTimeBefore , значение этого параметра соответствует данным в отчете, а не времени создания отчета.
Ответ API содержит список ресурсов Report для этого задания. Каждый ресурс ссылается на отчет, содержащий данные за уникальный период.
- Свойства
startTime и endTime ресурса определяют период времени, охватываемый данными отчета. - Свойство
downloadUrl ресурса определяет URL-адрес, с которого можно получить отчет. - Свойство
createTime ресурса указывает дату и время создания отчета. Ваше приложение должно сохранить это значение и использовать его для определения того, изменились ли ранее загруженные отчеты.
Шаг 4. Загрузите отчет
Отправьте запрос HTTP GET на downloadUrl , полученный на шаге 4, чтобы получить отчет.
Обработка отчетов
Лучшие практики
Приложения, использующие API отчетов YouTube, всегда должны следовать следующим правилам:
Используйте строку заголовка отчета, чтобы определить порядок столбцов отчета. Например, не предполагайте, что просмотры будут первой метрикой, возвращаемой в отчете, только потому, что это первая метрика, указанная в описании отчета. Вместо этого используйте строку заголовка отчета, чтобы определить, какой столбец содержит эти данные.
Ведите учет загруженных вами отчетов, чтобы избежать повторной обработки одного и того же отчета. Следующий список предлагает несколько способов сделать это.
При вызове метода reports.list используйте параметр createAfter , чтобы получать только отчеты, созданные после определенной даты. (При первом получении отчетов опустите параметр createdAfter .)
Каждый раз, когда вы получаете и успешно обрабатываете отчеты, сохраняйте временную метку, соответствующую дате и времени создания самого нового из этих отчетов. Затем обновите значение параметра createdAfter при каждом последующем вызове метода reports.list , чтобы гарантировать получение только новых отчетов, включая новые отчеты с заполненными данными, при каждом вызове API.
В целях безопасности перед получением отчета также убедитесь, что идентификатор отчета еще не указан в вашей базе данных.
Сохраните идентификатор для каждого отчета, который вы загрузили и обработали. Вы также можете хранить дополнительную информацию, например дату и время создания каждого отчета или startTime и endTime отчета, которые вместе определяют период, за который отчет содержит данные. В отчетах, которые извлекают большие объемы данных для YouTube Analytics, каждое задание, скорее всего, будет содержать множество отчетов, поскольку каждый отчет содержит данные за 24-часовой период. Задания, управляемые системой и охватывающие более длительные периоды времени, будут иметь меньше отчетов.
Используйте идентификатор отчета, чтобы определить отчеты, которые вам еще нужно загрузить и импортировать. Однако если два новых отчета имеют одинаковые значения свойств startTime и endTime , импортируйте отчет только с новым значением createTime .
Характеристики отчета
Отчеты API представляют собой файлы .csv с указанием версий (значения, разделенные запятыми), которые имеют следующие характеристики:
Каждый отчет содержит данные за уникальный период, продолжающийся с 00:00 по тихоокеанскому времени в дату начала отчета до 23:59 по тихоокеанскому времени в дату окончания отчета.
Данные отчета не отсортированы.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-08-21 UTC.
[[["Прост для понимания","easyToUnderstand","thumb-up"],["Помог мне решить мою проблему","solvedMyProblem","thumb-up"],["Другое","otherUp","thumb-up"]],[["Отсутствует нужная мне информация","missingTheInformationINeed","thumb-down"],["Слишком сложен/слишком много шагов","tooComplicatedTooManySteps","thumb-down"],["Устарел","outOfDate","thumb-down"],["Проблема с переводом текста","translationIssue","thumb-down"],["Проблемы образцов/кода","samplesCodeIssue","thumb-down"],["Другое","otherDown","thumb-down"]],["Последнее обновление: 2025-08-21 UTC."],[[["\u003cp\u003eYouTube's Reporting API provides access to system-managed ad revenue reports, which differ from Creator Studio reports in terms of fields and naming, yet contain similar data.\u003c/p\u003e\n"],["\u003cp\u003eRetrieving these reports involves four steps: getting authorization credentials, retrieving the job ID, getting the report's download URL, and downloading the report.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires specific authorization scopes, either \u003ccode\u003ehttps://www.googleapis.com/auth/yt-analytics.readonly\u003c/code\u003e for general user activity metrics or \u003ccode\u003ehttps://www.googleapis.com/auth/yt-analytics-monetary.readonly\u003c/code\u003e for monetary and ad performance metrics.\u003c/p\u003e\n"],["\u003cp\u003eBest practices for using the API include using the header row to identify column ordering and keeping a record of downloaded reports to avoid reprocessing the same data, while also checking for updated reports.\u003c/p\u003e\n"],["\u003cp\u003eEach report is a \u003ccode\u003e.csv\u003c/code\u003e file containing data for a specific period, from 12:00 a.m. to 11:59 p.m. Pacific Time, and the data within the reports is not sorted.\u003c/p\u003e\n"]]],["YouTube provides system-managed ad revenue reports accessible via the Reporting API. To retrieve these reports, first, obtain authorization credentials using OAuth 2.0. Next, retrieve the job ID for the desired report type by calling `jobs.list` with `includeSystemManaged` set to `true`. Then, call `jobs.reports.list`, providing the job ID, to get the report's download URL, which may be filtered by creation or start times. Finally, use an HTTP GET request to download the report. Remember to store downloaded report details to avoid reprocessing.\n"],null,["# YouTube Reporting API - Get Bulk Data Reports\n\nYouTube automatically generates a set of system-managed ad revenue reports for content owners that have access to the corresponding reports in [Creator Studio](http://studio.youtube.com/). These reports are designed to provide programmatic access to data that is also available in manually downloadable reports accessible in the [Reports menu](https://support.google.com/youtube/answer/7648605) of the YouTube Creator Studio.\n\n**Note:** The API provides access to a different set of reports than Creator Studio, though the reports contain similar data. API reports might have different fields and also use different field names than Creator Studio reports.\n\nSince YouTube automatically generates system-managed reports, the process for retrieving these reports is different than for the YouTube Analytics bulk data reports available via the API.\n\nRetrieving reports\n------------------\n\nThe following steps explain how to retrieve system-managed reports via the API.\n\n### Step 1: Retrieve authorization credentials\n\nAll YouTube Reporting API requests must be authorized. The [Authorization guide](/youtube/reporting/guides/authorization) explains how to use the OAuth 2.0 protocol to retrieve authorization tokens.\n\nYouTube Reporting API requests use the following authorization scopes:\n\n| Scopes ||\n|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| https://www.googleapis.com/auth/yt-analytics.readonly | View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts. |\n| https://www.googleapis.com/auth/yt-analytics-monetary.readonly | View YouTube Analytics monetary reports for your YouTube content. This scope provides access to user activity metrics and to estimated revenue and ad performance metrics. |\n\n### Step 2: Retrieve the job ID for the desired report\n\nCall the `jobs.list` method to retrieve a list of system-managed jobs. Set the [includeSystemManaged](/youtube/reporting/v1/reference/rest/v1/jobs/list#includeSystemManaged) parameter to `true`.\n\nThe [reportTypeId](/youtube/reporting/v1/reference/rest/v1/jobs#reportTypeId) property in each returned `Job` resource identifies the type of system-managed report associated with that job. Your application needs the [id](/youtube/reporting/v1/reference/rest/v1/jobs#id) property value from the same resource in the following step.\n\nThe [Reports](/youtube/reporting/v1/reports/system_managed/reports) document lists available reports, their report type IDs, and the fields they contain. You can also use the [reportTypes.list](/youtube/reporting/v1/reference/rest/v1/reportTypes/list) method to retrieve a list of supported report types.\n\n### Step 3: Retrieve the report's download URL\n\nCall the `jobs.reports.list` method to retrieve a list of reports created for the job. In the request, set the [jobId](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#jobId) parameter to the job ID of the report that you want to retrieve.\n\nYou can filter the list of reports using any or all of the following parameters:\n\n- Use the [createdAfter](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#createdAfter) parameter to indicate that the API should only return reports created after a specified time. This parameter can be used to ensure that the API only returns reports that you have not already processed.\n\n- Use the [startTimeBefore](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#startTimeBefore) parameter to indicate that the API response should only contain reports if the earliest data in the report is before the specified date. Whereas the `createdAfter` parameter pertains to the time the report was created, this date pertains to the data in the report.\n\n- Use the [startTimeAtOrAfter](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#startTimeAtOrAfter) parameter to indicate that the API response should only contain reports if the earliest data in the report is on or after the specified date. Like the `startTimeBefore` parameter, this parameter value corresponds to the data in the report and not the time the report was created.\n\nThe API response contains a list of `Report` resources for that job. Each resource refers to a report that contains data for a unique period.\n\n- The resource's [startTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#startTime) and [endTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#endTime) properties identify the time period that the report's data covers.\n- The resource's [downloadUrl](/youtube/reporting/v1/reference/rest/v1/jobs.reports#downloadUrl) property identifies the URL from which the report can be fetched.\n- The resource's [createTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime) property specifies the date and time when the report was generated. Your application should store this value and use it to determine whether previously downloaded reports have changed.\n\n### Step 4: Download the report\n\nSend an HTTP GET request to the `downloadUrl` obtained in step 4 to retrieve the report.\n\nProcessing reports\n------------------\n\n### Best practices\n\nApplications that use the YouTube Reporting API should *always* follow these practices:\n\n- Use a report's header row to determine the ordering of the report's columns. For example, do not assume that [views](/youtube/reporting/v1/reports/metrics#views) will be the first metric returned in a report just because it is the first metric listed in a report description. Instead, use the report's header row to determine which column contains that data.\n\n- Keep a record of the reports you have downloaded to avoid repeatedly processing the same report. The following list suggests a couple of ways to do that.\n\n - When calling the [reports.list](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list) method, use the [createdAfter](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#createdAfter) parameter to only retrieve reports created after a certain date. (Omit the `createdAfter` parameter the first time you retrieve reports.)\n\n Each time you retrieve and successfully process reports, store the timestamp corresponding to the [date and time](/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime) when the newest of those reports was created. Then, update the `createdAfter` parameter value on each successive call to the [reports.list](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list) method to ensure that you are only retrieving new reports, including new reports with backfilled data, each time you call the API.\n\n As a safeguard, before retrieving a report, also check to ensure that the report's [ID](/youtube/reporting/v1/reference/rest/v1/jobs.reports#id) is not already listed in your database.\n - Store the [ID](/youtube/reporting/v1/reference/rest/v1/jobs.reports#id) for each report that you have downloaded and processed. You can also store additional information like the [date and time](/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime) when each report was generated or the report's [startTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#startTime) and [endTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#endTime), which together identify the period for which the report contains data. For reports that retrieve bulk data for YouTube Analytics, each job will likely have many reports since each report contains data for a 24-hour period. System-managed jobs that cover longer time periods will have fewer reports.\n\n Use the report ID to identify reports that you still need to download and import. However, if two new reports have the same [startTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#startTime) and [endTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#endTime) property values, only import the report with the newer [createTime](/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime) value.\n\n### Report characteristics\n\nAPI reports are versioned `.csv` (comma-separated values) files that have the following characteristics:\n\n- Each report contains data for a unique period lasting from 12:00 a.m. Pacific time on the report's start date through 11:59 p.m. Pacific time on the report's end date.\n\n- Report data is not sorted."]]
