YouTube Reporting API
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Com a API YouTube Reporting, os desenvolvedores podem programar jobs de relatórios e baixar os relatórios em massa gerados. A API oferece suporte a um conjunto predefinido de relatórios, cada um deles com um conjunto abrangente de dados do YouTube Analytics para um canal ou proprietário de conteúdo.
As etapas abaixo explicam como programar jobs de relatórios e recuperar relatórios:
- Chame o método
reportTypes.list() para recuperar uma lista de relatórios que um canal ou proprietário de conteúdo pode acessar. - Chame o método
jobs.create() para identificar um relatório que precisa ser gerado para um canal ou proprietário de conteúdo. Depois, use jobs.list() e jobs.delete() da API para recuperar ou mudar a lista de relatórios que estão sendo gerados. - Chame o método
jobs.reports.list() para recuperar uma lista de relatórios gerados para um job específico. Cada recurso na resposta contém uma propriedade downloadUrl que especifica o URL de onde o relatório pode ser baixado. - Envie uma solicitação
GET autorizada para recuperar o relatório do URL de download.
Autorização
Todas as solicitações da API YouTube Reporting precisam ser autorizadas. O guia de autorização explica como usar o protocolo OAuth 2.0 para recuperar tokens de autorização.
As solicitações da API YouTube Reporting usam os seguintes escopos de autorização:
| Escopos |
| https://www.googleapis.com/auth/yt-analytics.readonly |
Visualizar os relatórios do YouTube Analytics para seu conteúdo do YouTube. Este escopo fornece acesso às métricas de atividade do usuário, como contagens de visualização e de classificação. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
Visualizar os relatórios monetários do YouTube Analytics para seu conteúdo do YouTube. Esse escopo dá acesso a métricas de atividade do usuário e a métricas estimadas de receita e performance de anúncios. |
Tipos de recurso
As seções a seguir fornecem descrições gerais dos recursos e métodos da API. Todos os URIs de método mostrados nas tabelas são relativos a https://youtubereporting.googleapis.com.
| Métodos |
create |
POST /v1/jobs
Cria um job de geração de relatórios. Ao criar um job de relatório, você está instruindo o YouTube a gerar esse relatório diariamente. O relatório fica disponível em até 24 horas após a criação do job. |
delete |
DELETE /v1/jobs/{jobId}
Exclui um job de relatório. |
get |
GET /v1/jobs/{jobId}
Recupera informações sobre um job de geração de relatórios específico que foi programado para um canal ou proprietário do conteúdo. |
list |
GET /v1/jobs
Lista os jobs de relatórios programados para um canal ou proprietário de conteúdo. Cada recurso na resposta contém uma propriedade id, que especifica o ID usado pelo YouTube para identificar o trabalho de forma exclusiva. Você precisa desse ID para recuperar a lista de relatórios gerados para o job ou para excluir o job. |
| Métodos |
get |
GET /v1/jobs/{jobId}/reports/{reportId}
Recupera os metadados de um relatório específico. |
list |
GET /v1/jobs/{jobId}/reports
Lista os relatórios gerados para o job de relatórios especificado. |
| Métodos |
list |
GET /v1/reportTypes
Retorna uma lista de tipos de relatórios que o canal ou proprietário do conteúdo pode recuperar. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-21 UTC.
[null,null,["Última atualização 2025-08-21 UTC."],[[["\u003cp\u003eThe YouTube Reporting API allows developers to schedule and download bulk reports containing comprehensive YouTube Analytics data for channels or content owners.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the API to retrieve a list of available reports, create jobs to generate reports, and manage these jobs through listing and deletion.\u003c/p\u003e\n"],["\u003cp\u003eGenerated reports can be downloaded via a specified URL obtained from the API's response, after retrieving them by using the \u003ccode\u003ejobs.reports.list()\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires OAuth 2.0 authorization, and provides scopes for viewing user activity metrics (\u003ccode\u003ehttps://www.googleapis.com/auth/yt-analytics.readonly\u003c/code\u003e) and monetary reports (\u003ccode\u003ehttps://www.googleapis.com/auth/yt-analytics-monetary.readonly\u003c/code\u003e).\u003c/p\u003e\n"]]],["Developers use the YouTube Reporting API to schedule and download bulk reports containing YouTube Analytics data. Key actions include: listing available report types via `reportTypes.list()`, creating reporting jobs with `jobs.create()`, and managing jobs using `jobs.list()` and `jobs.delete()`. To get data, retrieve generated reports for a specific job with `jobs.reports.list()`, each with a downloadable URL. Finally, you can request the download using the given URL. All actions require authorization via OAuth 2.0.\n"],null,["# YouTube Reporting API\n\nThe YouTube Reporting API enables developers to schedule reporting jobs and then download generated bulk reports. The API supports a predefined set of reports, each of which contains a comprehensive set of YouTube Analytics data for a channel or content owner.\n\nThe steps below explain how to schedule reporting jobs and retrieve reports:\n\n1. Call the [reportTypes.list()](/youtube/reporting/v1/reference/rest/v1/reportTypes/list) method to retrieve a list of reports that a channel or content owner can retrieve.\n2. Call the [jobs.create()](/youtube/reporting/v1/reference/rest/v1/jobs/create) method to identify a report that should be generated for a channel or content owner. You can subsequently use the API's [jobs.list()](/youtube/reporting/v1/reference/rest/v1/jobs/list) and [jobs.delete()](/youtube/reporting/v1/reference/rest/v1/jobs/delete) to retrieve or change the list of reports being generated.\n3. Call the [jobs.reports.list()](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list) method to retrieve a list of reports that have been generated for a particular job. Each resource in the response contains a [downloadUrl](/youtube/reporting/v1/reference/rest/v1/jobs.reports#downloadUrl) property that specifies the URL from which the report can be downloaded.\n4. Send an authorized `GET` request to retrieve the report from the download URL.\n\n\u003cbr /\u003e\n\nAuthorization\n-------------\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\nResource types\n--------------\n\nThe following sections provide general descriptions of the API's resources and methods. All method URIs shown in the tables are relative to `https://youtubereporting.googleapis.com`.\n\n### [jobs](/youtube/reporting/v1/reference/rest/v1/jobs)\n\n| Methods ||\n|---------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/youtube/reporting/v1/reference/rest/v1/jobs/create) | `POST /v1/jobs` Creates a reporting job. By creating a reporting job, you are instructing YouTube to generate that report on a daily basis. The report is available within 24 hours of the time that the job is created. |\n| [delete](/youtube/reporting/v1/reference/rest/v1/jobs/delete) | `DELETE /v1/jobs/{jobId}` Deletes a reporting job. |\n| [get](/youtube/reporting/v1/reference/rest/v1/jobs/get) | `GET /v1/jobs/{jobId}` Retrieves information about a specific reporting job that has been scheduled for a channel or content owner. |\n| [list](/youtube/reporting/v1/reference/rest/v1/jobs/list) | `GET /v1/jobs` Lists reporting jobs that have been scheduled for a channel or content owner. Each resource in the response contains an `id` property, which specifies the ID that YouTube uses to uniquely identify the job. You need that ID to retrieve the list of reports that have been generated for the job or to delete the job. |\n\n### [jobs.reports](/youtube/reporting/v1/reference/rest/v1/jobs.reports)\n\n| Methods ||\n|-------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|\n| [get](/youtube/reporting/v1/reference/rest/v1/jobs.reports/get) | `GET /v1/jobs/{jobId}/reports/{reportId}` Retrieves the metadata for a specific report. |\n| [list](/youtube/reporting/v1/reference/rest/v1/jobs.reports/list) | `GET /v1/jobs/{jobId}/reports` Lists reports that have been generated for the specified reporting job. |\n\n### [reportTypes](/youtube/reporting/v1/reference/rest/v1/reportTypes)\n\n| Methods ||\n|------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|\n| [list](/youtube/reporting/v1/reference/rest/v1/reportTypes/list) | `GET /v1/reportTypes` Returns a list of report types that the channel or content owner can retrieve. |"]]
