CINXE.COM

<!doctype html> <html lang="en" dir="ltr"> <head> <meta name="google-signin-client-id" content="721724668570-nbkv1cfusk7kk4eni4pjvepaus73b13t.apps.googleusercontent.com"> <meta name="google-signin-scope" content="profile email https://www.googleapis.com/auth/developerprofiles https://www.googleapis.com/auth/developerprofiles.award"> <meta property="og:site_name" content="Google for Developers"> <meta property="og:type" content="website"><meta name="theme-color" content="#ff0000"><meta charset="utf-8"> <meta content="IE=Edge" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="manifest" href="/_pwa/developers/manifest.json" crossorigin="use-credentials"> <link rel="preconnect" href="//www.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.gstatic.com" crossorigin> <link rel="preconnect" href="//fonts.googleapis.com" crossorigin> <link rel="preconnect" href="//apis.google.com" crossorigin> <link rel="preconnect" href="//www.google-analytics.com" crossorigin><link rel="stylesheet" href="//fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"> <link rel="stylesheet" href="//fonts.googleapis.com/css2?family=Material+Icons&family=Material+Symbols+Outlined&display=block"><link rel="stylesheet" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/css/app.css"> <link rel="shortcut icon" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/favicon-new.png"> <link rel="apple-touch-icon" href="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/touchicon-180-new.png"><link rel="canonical" href="https://developers.google.com/youtube/reporting/v1/reports"><link rel="search" type="application/opensearchdescription+xml" title="Google for Developers" href="https://developers.google.com/s/opensearch.xml"> <link rel="alternate" hreflang="en" href="https://developers.google.com/youtube/reporting/v1/reports" /><link rel="alternate" hreflang="x-default" href="https://developers.google.com/youtube/reporting/v1/reports" /><link rel="alternate" hreflang="ar" href="https://developers.google.com/youtube/reporting/v1/reports?hl=ar" /><link rel="alternate" hreflang="bn" href="https://developers.google.com/youtube/reporting/v1/reports?hl=bn" /><link rel="alternate" hreflang="zh-Hans" href="https://developers.google.com/youtube/reporting/v1/reports?hl=zh-cn" /><link rel="alternate" hreflang="zh-Hant" href="https://developers.google.com/youtube/reporting/v1/reports?hl=zh-tw" /><link rel="alternate" hreflang="fa" href="https://developers.google.com/youtube/reporting/v1/reports?hl=fa" /><link rel="alternate" hreflang="fr" href="https://developers.google.com/youtube/reporting/v1/reports?hl=fr" /><link rel="alternate" hreflang="de" href="https://developers.google.com/youtube/reporting/v1/reports?hl=de" /><link rel="alternate" hreflang="he" href="https://developers.google.com/youtube/reporting/v1/reports?hl=he" /><link rel="alternate" hreflang="hi" href="https://developers.google.com/youtube/reporting/v1/reports?hl=hi" /><link rel="alternate" hreflang="id" href="https://developers.google.com/youtube/reporting/v1/reports?hl=id" /><link rel="alternate" hreflang="it" href="https://developers.google.com/youtube/reporting/v1/reports?hl=it" /><link rel="alternate" hreflang="ja" href="https://developers.google.com/youtube/reporting/v1/reports?hl=ja" /><link rel="alternate" hreflang="ko" href="https://developers.google.com/youtube/reporting/v1/reports?hl=ko" /><link rel="alternate" hreflang="pl" href="https://developers.google.com/youtube/reporting/v1/reports?hl=pl" /><link rel="alternate" hreflang="pt-BR" href="https://developers.google.com/youtube/reporting/v1/reports?hl=pt-br" /><link rel="alternate" hreflang="ru" href="https://developers.google.com/youtube/reporting/v1/reports?hl=ru" /><link rel="alternate" hreflang="es-419" href="https://developers.google.com/youtube/reporting/v1/reports?hl=es-419" /><link rel="alternate" hreflang="th" href="https://developers.google.com/youtube/reporting/v1/reports?hl=th" /><link rel="alternate" hreflang="tr" href="https://developers.google.com/youtube/reporting/v1/reports?hl=tr" /><link rel="alternate" hreflang="vi" href="https://developers.google.com/youtube/reporting/v1/reports?hl=vi" /><title>YouTube Reporting API - Get Bulk Data Reports  |  YouTube Analytics and Reporting APIs  |  Google for Developers</title> <meta property="og:title" content="YouTube Reporting API - Get Bulk Data Reports  |  YouTube Analytics and Reporting APIs  |  Google for Developers"><meta property="og:url" content="https://developers.google.com/youtube/reporting/v1/reports"><meta property="og:image" content="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/opengraph/youtube-theme.png"> <meta property="og:image:width" content="1200"> <meta property="og:image:height" content="675"><meta property="og:locale" content="en"><meta name="twitter:card" content="summary_large_image"><script type="application/ld+json"> { "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{ "@type": "ListItem", "position": 1, "name": "YouTube", "item": "https://developers.google.com/youtube" },{ "@type": "ListItem", "position": 2, "name": "Analytics and Reporting APIs", "item": "https://developers.google.com/youtube/analytics" },{ "@type": "ListItem", "position": 3, "name": "YouTube Reporting API - Get Bulk Data Reports", "item": "https://developers.google.com/youtube/reporting/v1/reports" }] } </script> <link rel="stylesheet" href="/extras.css"></head> <body class="" template="page" theme="youtube-theme" type="reference" layout="docs" concierge='closed' display-toc pending> <devsite-progress type="indeterminate" id="app-progress"></devsite-progress> <section class="devsite-wrapper"> <devsite-cookie-notification-bar></devsite-cookie-notification-bar><devsite-header role="banner"> <div class="devsite-header--inner nocontent"> <div class="devsite-top-logo-row-wrapper-wrapper"> <div class="devsite-top-logo-row-wrapper"> <div class="devsite-top-logo-row"> <button type="button" id="devsite-hamburger-menu" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Navigation menu button" visually-hidden aria-label="Open menu"> </button> <div class="devsite-product-name-wrapper"> <a href="https://developers.google.com/youtube"> <div class="devsite-product-logo-container" size="medium" > <picture> <img class="devsite-product-logo" alt="YouTube" src="https://developers.google.com/static/site-assets/logo-youtube.svg" srcset=" /static/site-assets/logo-youtube.svg" sizes="64px" loading="lazy" > </picture> </div> </a> <ul class="devsite-breadcrumb-list" aria-label="Product breadcrumb"> <li class="devsite-breadcrumb-item "> <a href="https://developers.google.com/youtube" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="YouTube" > YouTube </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/youtube/analytics" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="2" track-type="globalNav" track-name="breadcrumb" track-metadata-position="2" track-metadata-eventdetail="YouTube Analytics and Reporting APIs" > Analytics and Reporting APIs </a> </li> </ul> </div> <div class="devsite-top-logo-row-middle"> <div class="devsite-header-upper-tabs"> </div> <devsite-search enable-signin enable-search enable-suggestions enable-query-completion project-name="YouTube Analytics and Reporting APIs" tenant-name="Google for Developers" project-scope="/youtube/analytics" url-scoped="https://developers.google.com/s/results/youtube/analytics" > <form class="devsite-search-form" action="https://developers.google.com/s/results" method="GET"> <div class="devsite-search-container"> <button type="button" search-open class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Open search"></button> <div class="devsite-searchbox"> <input aria-activedescendant="" aria-autocomplete="list" aria-label="Search" aria-expanded="false" aria-haspopup="listbox" autocomplete="off" class="devsite-search-field devsite-search-query" name="q" placeholder="Search" role="combobox" type="text" value="" > <div class="devsite-search-image material-icons" aria-hidden="true"> </div> <div class="devsite-search-shortcut-icon-container" aria-hidden="true"> <kbd class="devsite-search-shortcut-icon">/</kbd> </div> </div> </div> </form> <button type="button" search-close class="devsite-search-button devsite-header-icon-button button-flat material-icons" aria-label="Close search"></button> </devsite-search> </div> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es" >Español</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> <devsite-user enable-profiles fp-auth id="devsite-user"> Sign in </devsite-user> </div> </div> </div> <div class="devsite-collapsible-section "> <div class="devsite-header-background"> <div class="devsite-doc-set-nav-row"> <devsite-tabs class="lower-tabs"> <nav class="devsite-tabs-wrapper" aria-label="Lower tabs"> <tab > <a href="https://developers.google.com/youtube/analytics" track-metadata-eventdetail="https://developers.google.com/youtube/analytics" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - home" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Home" track-name="home" > Home </a> </tab> <tab > <a href="https://developers.google.com/youtube/reporting" track-metadata-eventdetail="https://developers.google.com/youtube/reporting" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - overview" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Overview" track-name="overview" > Overview </a> </tab> <tab > <a href="https://developers.google.com/youtube/reporting/guides/authorization" track-metadata-eventdetail="https://developers.google.com/youtube/reporting/guides/authorization" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - authorization" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Authorization" track-name="authorization" > Authorization </a> </tab> <tab class="devsite-active"> <a href="https://developers.google.com/youtube/reporting/v1/reports" track-metadata-eventdetail="https://developers.google.com/youtube/reporting/v1/reports" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - bulk reports" track-metadata-module="primary nav" aria-label="Bulk Reports, selected" data-category="Site-Wide Custom Events" data-label="Tab: Bulk Reports" track-name="bulk reports" > Bulk Reports </a> </tab> <tab > <a href="https://developers.google.com/youtube/analytics/data_model" track-metadata-eventdetail="https://developers.google.com/youtube/analytics/data_model" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - targeted queries" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Targeted Queries" track-name="targeted queries" > Targeted Queries </a> </tab> <tab > <a href="https://developers.google.com/youtube/reporting/v1/code_samples" track-metadata-eventdetail="https://developers.google.com/youtube/reporting/v1/code_samples" class="devsite-tabs-content gc-analytics-event " track-type="nav" track-metadata-position="nav - resources" track-metadata-module="primary nav" data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" > Resources </a> </tab> </nav> </devsite-tabs> </div> </div> </div> </div> </devsite-header> <devsite-book-nav scrollbars > <div class="devsite-book-nav-filter" > <input type="text" placeholder="Filter" aria-label="Type to filter" role="searchbox"> </div> <nav class="devsite-book-nav devsite-nav nocontent" aria-label="Side menu"> <div class="devsite-mobile-header"> <button type="button" id="devsite-close-nav" class="devsite-header-icon-button button-flat material-icons gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Close navigation" aria-label="Close navigation"> </button> <div class="devsite-product-name-wrapper"> <a href="https://developers.google.com/youtube"> <div class="devsite-product-logo-container" size="medium" > <picture> <img class="devsite-product-logo" alt="YouTube" src="https://developers.google.com/static/site-assets/logo-youtube.svg" srcset=" /static/site-assets/logo-youtube.svg" sizes="64px" loading="lazy" > </picture> </div> </a> <ul class="devsite-breadcrumb-list" aria-label="Upper header breadcrumb"> <li class="devsite-breadcrumb-item "> <a href="https://developers.google.com/youtube" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="YouTube" > YouTube </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/youtube/analytics" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Upper Header" data-value="2" track-type="globalNav" track-name="breadcrumb" track-metadata-position="2" track-metadata-eventdetail="YouTube Analytics and Reporting APIs" > Analytics and Reporting APIs </a> </li> </ul> </div> </div> <div class="devsite-book-nav-wrapper"> <div class="devsite-mobile-nav-top"> <ul class="devsite-nav-list"> <li class="devsite-nav-item"> <a href="/youtube/analytics" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Home" track-name="home" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Home" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Home </a> </li> <li class="devsite-nav-item"> <a href="/youtube/reporting" class="devsite-nav-title gc-analytics-event " data-category="Site-Wide Custom Events" data-label="Tab: Overview" track-name="overview" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Overview" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Overview </a> </li> <li class="devsite-nav-item"> <a href="/youtube/reporting/guides/authorization" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Authorization" track-name="authorization" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Authorization" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Authorization </a> </li> <li class="devsite-nav-item"> <a href="/youtube/reporting/v1/reports" class="devsite-nav-title gc-analytics-event devsite-nav-has-children devsite-nav-active" data-category="Site-Wide Custom Events" data-label="Tab: Bulk Reports" track-name="bulk reports" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Bulk Reports" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Bulk Reports </a> </li> <li class="devsite-nav-item"> <a href="/youtube/analytics/data_model" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Targeted Queries" track-name="targeted queries" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Targeted Queries" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Targeted Queries </a> </li> <li class="devsite-nav-item"> <a href="/youtube/reporting/v1/code_samples" class="devsite-nav-title gc-analytics-event devsite-nav-has-children " data-category="Site-Wide Custom Events" data-label="Tab: Resources" track-name="resources" data-category="Site-Wide Custom Events" data-label="Responsive Tab: Resources" track-type="navMenu" track-metadata-eventDetail="globalMenu" track-metadata-position="nav"> Resources </a> </li> </ul> </div> <div class="devsite-mobile-nav-bottom"> <ul class="devsite-nav-list" menu="_book"> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> YouTube Reporting API </div></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> Bulk Data Reports for YouTube Analytics </div></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports" >Get Bulk Data Reports</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/dimensions" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/dimensions" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/dimensions" >Dimensions</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/metrics" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/metrics" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/metrics" >Metrics</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/channel_reports" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/channel_reports" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/channel_reports" >Channel Reports</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/content_owner_reports" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/content_owner_reports" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/content_owner_reports" >Content Owner Reports</a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> System-Managed Reports </div></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/reports" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/reports" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/reports" >Overview</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed" >Get System-Managed Reports</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/fields" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/fields" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/fields" >Fields</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/financial-summaries" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/financial-summaries" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/financial-summaries" >Financial Summaries</a></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Financial Reports </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/financial-reports" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/financial-reports" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/financial-reports" >All Financial Reports</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/ads" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/ads" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/ads" >Ads</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/subscriptions" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/subscriptions" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/subscriptions" >Subscriptions</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/shorts" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/shorts" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/shorts" >Shorts</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/taxes" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/taxes" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/taxes" >Taxes</a></li></ul></div></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/videos" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/videos" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/videos" >Videos</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/assets" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/assets" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/assets" >Assets</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/references" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/references" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/references" >References</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/claims" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/claims" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/claims" >Claims</a></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reports/system_managed/primetime" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reports/system_managed/primetime" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reports/system_managed/primetime" >Primetime</a></li> <li class="devsite-nav-item devsite-nav-heading"><div class="devsite-nav-title devsite-nav-title-no-path"> API Reference </div></li> <li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest" >Overview</a></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Jobs </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs" >Overview</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs/create" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs/create" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs/create" >create</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs/delete" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs/delete" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs/delete" >delete</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs/get" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs/get" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs/get" >get</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs/list" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs/list" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs/list" >list</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> Reports </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs.reports" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs.reports" >Overview</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/get" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs.reports/get" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs.reports/get" >get</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/jobs.reports/list" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list" >list</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-expandable"><div class="devsite-expandable-nav"> <a class="devsite-nav-toggle" aria-hidden="true"></a><div class="devsite-nav-title devsite-nav-title-no-path" tabindex="0" role="button"> ReportTypes </div><ul class="devsite-nav-section"><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/reportTypes" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/reportTypes" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/reportTypes" >Overview</a></li><li class="devsite-nav-item"><a href="/youtube/reporting/v1/reference/rest/v1/reportTypes/list" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/v1/reference/rest/v1/reportTypes/list" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/v1/reference/rest/v1/reportTypes/list" >list</a></li></ul></div></li> <li class="devsite-nav-item devsite-nav-break"></li> <li class="devsite-nav-item"><a href="/youtube/reporting/revision_history" class="devsite-nav-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Book nav link, pathname: /youtube/reporting/revision_history" track-type="bookNav" track-name="click" track-metadata-eventdetail="/youtube/reporting/revision_history" >Revision History</a></li> </ul> </div> </div> </nav> </devsite-book-nav> <section id="gc-wrapper"> <main role="main" class="devsite-main-content" has-book-nav > <devsite-content> <article class="devsite-article"> <div class="devsite-article-meta nocontent" role="navigation"> <ul class="devsite-breadcrumb-list" aria-label="Breadcrumb"> <li class="devsite-breadcrumb-item "> <a href="https://developers.google.com/" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="1" track-type="globalNav" track-name="breadcrumb" track-metadata-position="1" track-metadata-eventdetail="" > Home </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/products" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="2" track-type="globalNav" track-name="breadcrumb" track-metadata-position="2" track-metadata-eventdetail="" > Products </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/youtube" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="3" track-type="globalNav" track-name="breadcrumb" track-metadata-position="3" track-metadata-eventdetail="YouTube" > YouTube </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/youtube/analytics" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="4" track-type="globalNav" track-name="breadcrumb" track-metadata-position="4" track-metadata-eventdetail="YouTube Analytics and Reporting APIs" > Analytics and Reporting APIs </a> </li> <li class="devsite-breadcrumb-item "> <div class="devsite-breadcrumb-guillemet material-icons" aria-hidden="true"></div> <a href="https://developers.google.com/youtube/reporting/v1/reports" class="devsite-breadcrumb-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Breadcrumbs" data-value="5" track-type="globalNav" track-name="breadcrumb" track-metadata-position="5" track-metadata-eventdetail="" > Bulk Reports </a> </li> </ul> <devsite-thumb-rating position="header"> </devsite-thumb-rating> </div> <h1 class="devsite-page-title" tabindex="-1"> YouTube Reporting API - Get Bulk Data Reports </h1> <devsite-feature-tooltip ack-key="AckCollectionsBookmarkTooltipDismiss" analytics-category="Site-Wide Custom Events" analytics-action-show="Callout Profile displayed" analytics-action-close="Callout Profile dismissed" analytics-label="Create Collection Callout" class="devsite-page-bookmark-tooltip nocontent" dismiss-button="true" id="devsite-collections-dropdown" dismiss-button-text="Dismiss" close-button-text="Got it"> <devsite-bookmark></devsite-bookmark> Stay organized with collections Save and categorize content based on your preferences. </devsite-feature-tooltip> <div class="devsite-page-title-meta"><devsite-view-release-notes></devsite-view-release-notes></div> <devsite-toc class="devsite-nav" depth="2" devsite-toc-embedded > </devsite-toc> <div class="devsite-article-body clearfix "> <div itemscope itemtype="http://developers.google.com/ReferenceObject"> <meta itemprop="name" content="Channel Reports"/> <div class="caution">Important: Daily API reports and backfill reports are available for 60 days from the time that they are generated. <a href="#historical-data">Historical data</a> reports are available for 30 days from the time that they are generated. This policy applies globally to all reports and reporting jobs. For complete details, see the YouTube Reporting API's <a href="/youtube/reporting/revision_history#may-22,-2018">revision history</a>.</div> The YouTube Reporting API supports predefined reports that contain a comprehensive set of YouTube Analytics data for a channel or content owner. These reports allow you to download the bulk data sets that you can query with the <a href="/youtube/analytics/v1">YouTube Analytics API</a> or in the <a href="https://www.youtube.com/analytics">Analytics</a> section of the Creator Studio. The API also supports a set of automatically generated, system-managed reports that are available to content owners that have access to the corresponding reports in the <a href="https://support.google.com/youtube/answer/7648605">Reports menu</a>. Those reports contain ad revenue data and YouTube Premium subscription revenue data. See the <a href="/youtube/reporting/v1/reports/system_managed">system-managed reports</a> documentation for more information. <h2 id="overview" data-text="Overview" tabindex="-1">Overview</h2> Report fields in these reports are characterized as either dimensions or metrics: <ul> <li>Dimensions are common criteria that are used to aggregate data, such as the date on which an action occurred or the country where the users were located. In a report, each row of data has a unique combination of dimension values.</li> <li>Metrics are individual measurements related to user activity, ad performance, or estimated revenue. User activity metrics include things like video view counts and ratings (likes and dislikes).</li> </ul> As an example, the basic user activity report for channels contains the following dimensions: <ul> <li><a href="/youtube/reporting/v1/reports/dimensions#day">day</a>: The date on which the activity occurred.</li> <li><a href="/youtube/reporting/v1/reports/dimensions#channel">channel</a>: The YouTube channel associated with the activity.</li> <li><a href="/youtube/reporting/v1/reports/dimensions#video">video</a>: The YouTube video associated with the activity.</li> <li><a href="/youtube/reporting/v1/reports/dimensions#liveOrOnDemand">liveOrOnDemand</a>: A value that indicates whether viewers were watching a live video stream.</li> <li><a href="/youtube/reporting/v1/reports/dimensions#subscribedStatus">subscribedStatus</a>: A value that indicates whether the viewers were subscribed to the channel.</li> <li><a href="/youtube/reporting/v1/reports/dimensions#country">country</a>: The country where the viewers were located.</li> </ul> The report also contains a lot of metrics, such as <a href="/youtube/reporting/v1/reports/metrics#views">views</a>, <a href="/youtube/reporting/v1/reports/metrics#likes">likes</a>, and <a href="/youtube/reporting/v1/reports/metrics#averageViewDuration">averageViewDuration</a>. After retrieving and importing the report, an application could make many different calculations based on common dimension values. For example, to calculate the total number of views in Germany on a specific date, sum the <a href="/youtube/reporting/v1/reports/metrics#views">views</a> metric values for all rows where the <a href="/youtube/reporting/v1/reports/dimensions#country">country</a> column value is <code translate="no" dir="ltr">DE</code> and the <a href="/youtube/reporting/v1/reports/dimensions#day">day</a> column value is the date in <code translate="no" dir="ltr">YYYY-MM-DD</code> format. <h2 id="retrieving-youtube-analytics-reports" data-text="Retrieving YouTube Analytics reports" tabindex="-1">Retrieving YouTube Analytics reports</h2> The following steps explain how to retrieve channel and content owner reports through the API. For instructions on how to retrieve those reports, see <a href="/youtube/reporting/v1/reports/system_managed_reports">system-managed reports</a>. <h3 id="step-1:-retrieve-authorization-credentials" data-text="Step 1: Retrieve authorization credentials" tabindex="-1">Step 1: Retrieve authorization credentials</h3> All YouTube Reporting API requests must be authorized. To retrieve authorization tokens through the OAuth 2.0 protocol, see <a href="/youtube/reporting/guides/authorization">Authorization guide</a>. YouTube Reporting API requests use the following authorization scopes: <table class="responsive"> <tr> <th colspan="2">Scopes</th> </tr> <tbody> <tr> <td>https://www.googleapis.com/auth/yt-analytics.readonly</td> <td>View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts.</td> </tr> <tr> <td>https://www.googleapis.com/auth/yt-analytics-monetary.readonly</td> <td>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.</td> </tr> </table> <h3 id="step-2:-identify-the-report-to-retrieve" data-text="Step 2: Identify the report to retrieve" tabindex="-1">Step 2: Identify the report to retrieve</h3> Call the API's <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/reportTypes/list">reportTypes.list</a></code> method to retrieve a list of reports that can be generated for the channel or content owner. The method returns a list of report IDs and names. Capture the <code translate="no" dir="ltr">id</code> property value for the reports that you want to have generated. For example, the ID of the basic user activity report for channels is <code translate="no" dir="ltr">channel_basic_a1</code>. You can also find the report names in the documentation that defines supported <a href="/youtube/reporting/v1/reports/channel_reports">channel reports</a> and <a href="/youtube/reporting/v1/reports/content_owner_reports">content owner reports</a>. <h3 id="step-3:-create-a-reporting-job" data-text="Step 3: Create a reporting job" tabindex="-1">Step 3: Create a reporting job</h3> YouTube does not begin to generate your report until you create a reporting job for that report. (As such, reports are only generated for the channels and content owners that actually want to retrieve them.) To create a reporting job, call the API's <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs/create">jobs.create</a></code> method. Set the following values in the request body: <ul> <li>Set the <code translate="no" dir="ltr">reportTypeId</code> property's value to the report ID that you retrieved in step 2.</li> <li>Set the <code translate="no" dir="ltr">name</code> property's value to the name that you want to associate with the report.</li> </ul> The API response to the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs/create">jobs.create</a></code> method contains a <code translate="no" dir="ltr">Job</code> resource, which specifies the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs#id">ID</a></code> that uniquely identifies the job. You can start retrieving the report within 48 hours of the time that the job is created, and the first available report will be for the day that you scheduled the job. For example, if you schedule a job on September 1, then the report for September 1 will be ready on September 3. The report for September 2 will be posted on September 4. <h3 id="step-4:-retrieve-the-job-id" data-text="Step 4: Retrieve the job ID" tabindex="-1">Step 4: Retrieve the job ID</h3> Note: If your application stored the job ID returned in step 3, then you can skip this step. Call the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs/list">jobs.list</a></code> method to retrieve a list of scheduled jobs. The <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs#reportTypeId">reportTypeId</a></code> property in each returned <code translate="no" dir="ltr">Job</code> resource identifies the type of report that that job generates. Your application needs the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs#id">id</a></code> property value from the same resource in the following step. <h3 id="step-5:-retrieve-the-reports-download-url" data-text="Step 5: Retrieve the report's download URL" tabindex="-1">Step 5: Retrieve the report's download URL</h3> Call the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list">jobs.reports.list</a></code> method to retrieve a list of reports created for the job. In the request, set the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#jobId">jobId</a></code> parameter to the job ID of the report that you want to retrieve. Tip: Use the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#createdAfter">createdAfter</a></code> 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. The API response contains a list of <code translate="no" dir="ltr">Report</code> resources for that job. Each resource refers to a report that contains data for a unique 24-hour period. Note that YouTube does generate downloadable reports for days on which no data was available. Those reports contain a header row but do not contain additional data. <ul> <li>The resource's <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#startTime">startTime</a></code> and <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#endTime">endTime</a></code> properties identify the time period that the report's data covers.</li> <li>The resource's <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#downloadUrl">downloadUrl</a></code> property identifies the URL from which the report can be fetched.</li> <li>The resource's <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime">createTime</a></code> 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.</li> </ul> <h3 id="step-6:-download-the-report" data-text="Step 6: Download the report" tabindex="-1">Step 6: Download the report</h3> Send an HTTP GET request to the <code translate="no" dir="ltr">downloadUrl</code> obtained in step 5 to retrieve the report. You can reduce the bandwidth needed to download reports by enabling gzip compression on download requests. While your application will need additional CPU time to uncompress API responses, the benefit of consuming fewer network resources usually outweighs that cost. To receive a gzip-encoded response, set the <code translate="no" dir="ltr">Accept-Encoding</code> HTTP request header to <code translate="no" dir="ltr">gzip</code> as shown in the following example: <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Text only">Accept-Encoding: gzip</pre></devsite-code> <h2 id="processing-reports" data-text="Processing reports" tabindex="-1">Processing reports</h2> <h3 id="best-practices" data-text="Best practices" tabindex="-1">Best practices</h3> Applications that use the YouTube Reporting API should always follow these practices: <ul> <li> To determine the ordering of the report's columns, use the report's header row. For example, do not assume that <a href="/youtube/reporting/v1/reports/metrics#views">views</a> 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. </li> <li> To avoid repeatedly processing the same report, keep a record of the reports that you have downloaded. The following list suggests a couple of ways to do that. <ul> <li> When calling the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list">reports.list</a></code> method, use the <a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list#createdAfter">createdAfter</a> parameter to only retrieve reports created after a certain date. (Omit the <code translate="no" dir="ltr">createdAfter</code> parameter the first time you retrieve reports.) Each time you retrieve and successfully process reports, store the timestamp corresponding to the <a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime">date and time</a> when the newest of those reports was created. Then, update the <code translate="no" dir="ltr">createdAfter</code> parameter value on each successive call to the <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports/list">reports.list</a></code> method to ensure that you are only retrieving new reports, including new reports with backfilled data, each time you call the API. As a safeguard, before retrieving a report, also check to ensure that the report's <a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#id">ID</a> is not already listed in your database. </li> <li> Store the <a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#id">ID</a> for each report that you have downloaded and processed. You can also store additional information like the <a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime">date and time</a> when each report was generated or the report's <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#startTime">startTime</a></code> and <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#endTime">endTime</a></code>, which together identify the period for which the report contains data. Note that each job will likely have many reports since each report contains data for a 24-hour period. Use the report ID to identify reports that you still need to download and import. However, if two new reports have the same <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#startTime">startTime</a></code> and <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#endTime">endTime</a></code> property values, only import the report with the newer <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#createTime">createTime</a></code> value. </li> </ul> </li> <li> Reports contain IDs associated with YouTube resources. To retrieve additional metadata for those resources, use <a href="/youtube/v3/docs">YouTube Data API</a>. As noted in the <a href="/youtube/terms/developer-policies">YouTube API Services Developer Policies</a> (sections III.E.4.b through III.E.4.d), API clients must either delete or refresh stored resource metadata from that API after 30 days. </li> </ul> <h3 id="report-characteristics" data-text="Report characteristics" tabindex="-1">Report characteristics</h3> API reports are versioned <code translate="no" dir="ltr">.csv</code> (comma-separated values) files that have the following characteristics: <ul> <li> Each report contains data for a unique 24-hour period lasting from 12:00 AM through 11:59 PM Pacific Standard Time (UTC-8). As such, in any given report, the <a href="/youtube/reporting/v1/reports/dimensions#day">day</a> dimension value is always the same. </li> <li> Reports are updated daily. </li> <li> YouTube does generate downloadable reports for days on which no data was available. Those reports will contain a header row but will not contain additional data. </li> <li>API reports are available for 60 days from the time that they are generated, with the exception of historical data generated for new reporting jobs. Reports are inaccessible after they are more than 60 days old. that are already more than 60 days old.</li> <li>Reports containing <a href="#historical-data">historical data</a> are available for 30 days from the time that they are generated. Reports that contain historical data are inaccessible after they are more than 30 days old.</li> <li> Report data is not filtered. As such, a channel report contains all data for a channel's videos or playlists with the exception noted in the following paragraph related to deleted resources. Similarly, a content owner report contains all data for the content owner's channels (videos, playlists, ad performance, etc) with the following exception. Although report data is not filtered, reports do not contain any references to YouTube resources that were deleted at least 30 days prior to the date that the report was generated. </li> <li> Report data is not sorted. </li> <li> Reports omit rows that do not have metrics. In other words, rows that do not have any metrics are excluded from the report. For example, if a video has no views in Albania on a particular day, that day's report will not contain rows for Albania. </li> <li> Reports do not contain rows that provide summary data for metrics, such as the total number of views for all of a channel's videos. You can calculate those total values as the sum of the values in the report, but that sum might not include metrics for deleted videos, as noted above. You can also use the <a href="/youtube/analytics/data_model">YouTube Analytics API</a> to retrieve total counts. The YouTube Analytics API does return total values that include metrics for deleted resources even though those resources are not explicitly referenced in API responses. </li> </ul> <h3 id="backfill-data" data-text="Backfill data" tabindex="-1">Backfill data</h3> Backfill data refers to a data set that replaces a previously delivered set. When a backfill data report is available, your application should retrieve the new report and update your stored data to match the revised data set. For example, your application could delete the previous data for the time period covered in the report and then import the new data set. If YouTube has backfill data, it generates a new report with a new <a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#id">report ID</a>. In that case, the report's <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#startTime">startTime</a></code> and <code translate="no" dir="ltr"><a href="/youtube/reporting/v1/reference/rest/v1/jobs.reports#endTime">endTime</a></code> property values will match the start and end times of a report that was previously available and that you might have previously downloaded. Backfill reports do not contain any references to YouTube resources that were deleted at least 30 days prior to the date the report was generated. <h3 id="historical-data" data-text="Historical data" tabindex="-1">Historical data</h3> When you schedule a new reporting job, YouTube generates historical reports from that day forward, and generates reports covering the 30-day period prior to the time that you created the job. Thus, in this documentation, historical data refers to a report that contains data for a time period before the reporting job was scheduled. Historical reports are posted as soon as they are available. Typically, all of the historical data is posted for a job within a couple of days. As explained in the <a href="#report-characteristics">Report characteristics</a> section, reports containing historical data are available for 30 days from the time that they are generated. Reports that contain non-historical data are available for 60 days. <h3 id="data-anonymization" data-text="Data anonymization" tabindex="-1">Data anonymization</h3> To ensure the anonymity of YouTube viewers, values for some dimensions are returned only if a metric in the same row meets a certain threshold. For example, in the video traffic source report for channels, each row contains a number of dimensions, including <a href="/youtube/reporting/v1/reports/dimensions#Traffic_Source_Dimensions">trafficSourceType</a> and <a href="/youtube/reporting/v1/reports/dimensions#trafficSourceDetail">trafficSourceDetail</a>. Each row also contains various metrics, including <a href="/youtube/reporting/v1/reports/metrics#views">views</a>. In rows that describe traffic that originated from a YouTube search, the <a href="/youtube/reporting/v1/reports/dimensions#trafficSourceDetail">trafficSourceDetail</a> dimension identifies the search term that led to the traffic. In this example, the following rules apply: <ul> <li> The traffic source report identifies the query term (<a href="/youtube/reporting/v1/reports/dimensions#trafficSourceDetail">trafficSourceDetail</a>) only if it led to at least a certain number of views of a particular video on a particular day. In this case, <a href="/youtube/reporting/v1/reports/metrics#views">views</a> is the metric, <a href="/youtube/reporting/v1/reports/dimensions#video">video</a> is the aggregating dimension, and <a href="/youtube/reporting/v1/reports/dimensions#trafficSourceDetail">trafficSourceDetail</a> is the anonymized dimension.</li> </li> <li> The report includes an additional row that aggregates metrics for all <a href="/youtube/reporting/v1/reports/dimensions#trafficSourceDetail">trafficSourceDetail</a> values that do not meet the view count threshold. That row reports the total number of views associated with those query terms but does not identify the terms themselves. </li> </ul> The following tables illustrate these rules. The first table contains a hypothetical set of raw data that YouTube would use to generate a traffic source report, and the second table contains the report itself. In this example, the view count threshold is 10, meaning the report only identifies a search term if it led to at least 10 views of a particular video on a particular day. (Actual thresholds are subject to change.) <h4 id="raw-youtube-search-traffic-data-for-a-video" data-text="Raw YouTube search traffic data for a video" tabindex="-1">Raw YouTube search traffic data for a video</h4> Assume that the data below describes YouTube search traffic to a particular video on a particular day. <table> <tr> <th>search term</th> <th>views</th> <th>estimated minutes watched</th> </tr> <tr> <td>gangnam style</td> <td>100</td> <td>200</td> </tr> <tr> <td>psy</td> <td>15</td> <td>25</td> </tr> <tr> <td>psy gangnam</td> <td>9</td> <td>15</td> </tr> <tr> <td>oppa gangnam</td> <td>5</td> <td>8</td> </tr> <tr> <td>horse riding dance</td> <td>2</td> <td>5</td> </tr> </table> <h4 id="sample-traffic-source-report" data-text="Sample traffic source report" tabindex="-1">Sample traffic source report</h4> The following table shows an excerpt from the traffic source report that YouTube would generate for the raw data in the preceding section. (The actual report would contain more dimensions and metrics.) In this example, the report identifies search terms only if they led to at least 10 views. Actual thresholds are subject to change. In the report's third row, the <code translate="no" dir="ltr">trafficSourceDetail</code> dimension value is <code translate="no" dir="ltr">NULL</code>. The <code translate="no" dir="ltr">views</code> and <code translate="no" dir="ltr">estimatedMinutesWatched</code> metrics contain the combined views and minutes watched for the three search terms that generated fewer than 10 views. <table> <tr> <th>trafficSourceDetail</th> <th>views</th> <th>estimatedMinutesWatched</th> </tr> <tr> <td>gangnam style</td> <td>100</td> <td>200</td> </tr> <tr> <td>psy</td> <td>15</td> <td>25</td> </tr> <tr> <td>NULL</td> <td>16</td> <td>28</td> </tr> </table> <h4 id="dimensions-subject-to-anonymization" data-text="Dimensions subject to anonymization" tabindex="-1">Dimensions subject to anonymization</h4> The following table identifies dimension values that are anonymized if associated metric values do not meet a certain threshold. In each case, the metric's value is aggregated over another dimension. For example, if the metric is <a href="/youtube/reporting/v1/reports/metrics#views">views</a> and the aggregating dimension is <a href="/youtube/reporting/v1/reports/dimensions#video">video</a>, then the dimension value is anonymized unless the video was viewed a certain number of times. <table> <tr> <th>Metric</th> <th>Aggregating dimension(s)</th> <th>Anonymized dimension</th> <th>Anonymized value</th> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#subscribersGained">subscribersGained</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#channel">channel</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#country">country</a></td> <td><code translate="no" dir="ltr">ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#subscribersGained">subscribersGained</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#channel">channel</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#province">province</a></td> <td><code translate="no" dir="ltr">US-ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#subscribersLost">subscribersLost</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#channel">channel</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#country">country</a></td> <td><code translate="no" dir="ltr">ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#subscribersLost">subscribersLost</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#channel">channel</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#province">province</a></td> <td><code translate="no" dir="ltr">US-ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#comments">comments</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#country">country</a></td> <td><code translate="no" dir="ltr">ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#comments">comments</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#province">province</a></td> <td><code translate="no" dir="ltr">US-ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#likes">likes</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#country">country</a></td> <td><code translate="no" dir="ltr">ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#likes">likes</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#province">province</a></td> <td><code translate="no" dir="ltr">US-ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#dislikes">dislikes</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#country">country</a></td> <td><code translate="no" dir="ltr">ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#dislikes">dislikes</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#province">province</a></td> <td><code translate="no" dir="ltr">US-ZZ</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#views">views</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#ageGroup">ageGroup</a></td> <td><code translate="no" dir="ltr">NULL</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#views">views</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#gender">gender</a></td> <td><code translate="no" dir="ltr">NULL</code></td> </tr> <tr> <td><a href="/youtube/reporting/v1/reports/metrics#views">views</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#video">video</a> and <a href="/youtube/reporting/v1/reports/dimensions#trafficSourceDetail">trafficSourceDetail</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#trafficSourceDetail">trafficSourceDetail</a></td> <td><code translate="no" dir="ltr">NULL</code></td> </tr> <tr> <td>Number of subscribers to channel</td> <td><a href="/youtube/reporting/v1/reports/dimensions#channel">channel</a></td> <td><a href="/youtube/reporting/v1/reports/dimensions#subscribedStatus">subscribedStatus</a></td> <td><code translate="no" dir="ltr">NULL</code></td> </tr> </table> <h2 id="code-samples" data-text="Code samples" tabindex="-1">Code samples</h2> The following code samples demonstrate how to use the API to create a reporting job and then retrieve a report for that job. Two code samples are provided for each language: <ol> <li> The first code sample shows how to retrieve a list of available report types and then create a new reporting job. </li> <li> The second code sample shows how to retrieve a report for a particular job. You can begin retrieving reports within 48 hours of the time that the job is created. </li> </ol> Note: The following code samples may not represent all supported programming languages. For the list of supported languages, see <a href="/youtube/v3/libraries">client libraries</a>. <div id="code-sample" class="ds-selector-tabs" data-ds-scope="code-sample"> <section> <h3 id="java" data-text="Java" tabindex="-1">Java</h3> The following samples use the <a target="_blank" href="https://code.google.com/p/google-api-java-client/">Java client library</a>: <ul> <li><a href="#java-example-create-reporting-job">Example 1: Create a reporting job</a></li> <li><a href="#java-example-retrieve-report">Example 2: Retrieve a report</a></li> </ul> Example 1: Create a reporting job The following code sample calls the <code translate="no" dir="ltr">reportTypes.list</code> method to retrieve a list of available report types. It then calls the <code translate="no" dir="ltr">jobs.create</code> method to create a new reporting job. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Java">/* * 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; } } <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/youtube/api-samples/blob/07263305b59a7c3275bc7e925f9ce6cabf774022/java/src/main/java/com/google/api/services/samples/youtube/cmdline/reporting/CreateReportingJob.java" class="gc-analytics-event" data-category="github_link" data-label="youtube/api-samples/java/src/main/java/com/google/api/services/samples/youtube/cmdline/reporting/CreateReportingJob.java" data-code-snippet="true" data-github-path="youtube/api-samples/java/src/main/java/com/google/api/services/samples/youtube/cmdline/reporting/CreateReportingJob.java">CreateReportingJob.java</a></div></pre></devsite-code> Example 2: Retrieve a report The code sample calls the <code translate="no" dir="ltr">jobs.list</code> method to retrieve a list of reporting jobs. It then calls the <code translate="no" dir="ltr">reports.list</code> method with the <code translate="no" dir="ltr">jobId</code> parameter set to a specific job ID to retrieve reports created by that job. Finally, the sample prints out the download URL for each report.</li></ul> <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Java">/* * 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; }} <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/youtube/api-samples/blob/07263305b59a7c3275bc7e925f9ce6cabf774022/java/src/main/java/com/google/api/services/samples/youtube/cmdline/reporting/RetrieveReports.java" class="gc-analytics-event" data-category="github_link" data-label="youtube/api-samples/java/src/main/java/com/google/api/services/samples/youtube/cmdline/reporting/RetrieveReports.java" data-code-snippet="true" data-github-path="youtube/api-samples/java/src/main/java/com/google/api/services/samples/youtube/cmdline/reporting/RetrieveReports.java">RetrieveReports.java</a></div></pre></devsite-code> </section> <section> <h3 id="php" data-text="PHP" tabindex="-1">PHP</h3> The following samples use the <a target="_blank" href="https://github.com/googleapis/google-api-php-client">PHP client library</a>. <ul> <li><a href="#php-example-create-reporting-job">Example 1: Create a reporting job</a></li> <li><a href="#php-example-retrieve-report">Example 2: Retrieve a report</a></li> </ul> Example 1: Create a reporting job The following code sample calls the <code translate="no" dir="ltr">reportTypes.list</code> method to retrieve a list of available report types. It then calls the <code translate="no" dir="ltr">jobs.create</code> method to create a new reporting job. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="PHP"><?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('No report types found.'); } else if ($_GET['reportTypeId']){ createReportingJob($youtubeReporting, $_GET['reportTypeId'], $_GET['jobName'], $htmlBody); } } catch (Google_Service_Exception $e) { $htmlBody = sprintf('A service error occurred: <code>%s</code>', htmlspecialchars($e->getMessage())); } catch (Google_Exception $e) { $htmlBody = sprintf('An client error occurred: <code>%s</code>', htmlspecialchars($e->getMessage())); } $_SESSION[$tokenSessionKey] = $client->getAccessToken(); } elseif ($OAUTH2_CLIENT_ID == 'REPLACE_ME') { $htmlBody = <<<END <h3>Client Credentials Required</h3> You need to set <code>\$OAUTH2_CLIENT_ID</code> and <code>\$OAUTH2_CLIENT_ID</code> before proceeding. 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> You need to <a href="$authUrl">authorize access</a> before proceeding. 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> <div> Report Type Id: <input type="text" id="reportTypeId" name="reportTypeId" placeholder="Enter Report Type Id"> </div> <input type="submit" value="Create!"> </form> <?=$htmlBody?> </body> </html> <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/youtube/api-samples/blob/07263305b59a7c3275bc7e925f9ce6cabf774022/php/create_reporting_job.php" class="gc-analytics-event" data-category="github_link" data-label="youtube/api-samples/php/create_reporting_job.php" data-code-snippet="true" data-github-path="youtube/api-samples/php/create_reporting_job.php">create_reporting_job.php</a></div></pre></devsite-code> Example 2: Retrieve a report The code sample calls the <code translate="no" dir="ltr">jobs.list</code> method to retrieve a list of reporting jobs. It then calls the <code translate="no" dir="ltr">reports.list</code> method with the <code translate="no" dir="ltr">jobId</code> parameter set to a specific job ID to retrieve reports created by that job. Finally, the sample prints out the download URL for each report. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="PHP"><?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); } } ?> <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/youtube/api-samples/blob/07263305b59a7c3275bc7e925f9ce6cabf774022/php/retrieve_reports.php" class="gc-analytics-event" data-category="github_link" data-label="youtube/api-samples/php/retrieve_reports.php" data-code-snippet="true" data-github-path="youtube/api-samples/php/retrieve_reports.php">retrieve_reports.php</a></div></pre></devsite-code> </section> <section> <h3 id="python" data-text="Python" tabindex="-1">Python</h3> The following samples use the <a target="_blank" href="https://developers.google.com/api-client-library/python/">Python client library</a>. <ul> <li><a href="#python-example-create-reporting-job">Example 1: Create a reporting job</a></li> <li><a href="#python-example-retrieve-report">Example 2: Retrieve a report</a></li> </ul> Example 1: Create a reporting job The following code sample calls the <code translate="no" dir="ltr">reportTypes.list</code> method to retrieve a list of available report types. It then calls the <code translate="no" dir="ltr">jobs.create</code> method to create a new reporting job. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Python">#!/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) <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/youtube/api-samples/blob/07263305b59a7c3275bc7e925f9ce6cabf774022/python/create_reporting_job.py" class="gc-analytics-event" data-category="github_link" data-label="youtube/api-samples/python/create_reporting_job.py" data-code-snippet="true" data-github-path="youtube/api-samples/python/create_reporting_job.py">create_reporting_job.py</a></div></pre></devsite-code> Example 2: Retrieve a report The code sample calls the <code translate="no" dir="ltr">jobs.list</code> method to retrieve a list of reporting jobs. It then calls the <code translate="no" dir="ltr">reports.list</code> method with the <code translate="no" dir="ltr">jobId</code> parameter set to a specific job ID to retrieve reports created by that job. Finally, the sample prints out the download URL for each report. <div></div><devsite-code><pre class="devsite-click-to-copy" translate="no" dir="ltr" is-upgraded syntax="Python">#!/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) <div class="devsite-github-link nocode no-select"><a target="_top" href="https://github.com/youtube/api-samples/blob/07263305b59a7c3275bc7e925f9ce6cabf774022/python/retrieve_reports.py" class="gc-analytics-event" data-category="github_link" data-label="youtube/api-samples/python/retrieve_reports.py" data-code-snippet="true" data-github-path="youtube/api-samples/python/retrieve_reports.py">retrieve_reports.py</a></div></pre></devsite-code> </section> </div> </div> </div> <devsite-recommendations display="in-page" hidden yield> </devsite-recommendations> <devsite-thumb-rating position="footer"> </devsite-thumb-rating> <devsite-recommendations id="recommendations-link" yield></devsite-recommendations> <div class="devsite-floating-action-buttons"> </div> </article> <devsite-content-footer class="nocontent"> Except as otherwise noted, the content of this page is licensed under the <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 License</a>, and code samples are licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 License</a>. For details, see the <a href="https://developers.google.com/site-policies">Google Developers Site Policies</a>. Java is a registered trademark of Oracle and/or its affiliates. Last updated 2024-11-04 UTC. </devsite-content-footer> <devsite-notification > </devsite-notification> <div class="devsite-content-data"> <template class="devsite-content-data-template"> [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-04 UTC."],[],[]] </template> </div> </devsite-content> </main> <devsite-footer-promos class="devsite-footer"> <nav class="devsite-footer-promos nocontent" aria-label="Promotions"> <ul class="devsite-footer-promos-list"> <li class="devsite-footer-promo"> <a href="https://blog.youtube" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Promo Link (index 1)" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-youtube.svg" loading="lazy" alt="Blog"> </picture> Blog </a> <div class="devsite-footer-promo-description">The latest news on the YouTube blog</div> </li> <li class="devsite-footer-promo"> <a href="https://github.com/youtube/api-samples" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Promo Link (index 2)" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-github.svg" loading="lazy" alt="GitHub"> </picture> GitHub </a> <div class="devsite-footer-promo-description">Find API code samples and other YouTube open-source projects.</div> </li> <li class="devsite-footer-promo"> <a href="https://issuetracker.google.com/issues/new?component=186600&template=874803" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Promo Link (index 3)" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/developers_64dp.png" loading="lazy" alt="Issue Tracker"> </picture> Issue Tracker </a> <div class="devsite-footer-promo-description">Something wrong? Send us a bug report!</div> </li> <li class="devsite-footer-promo"> <a href="http://stackoverflow.com/questions/ask?tags=youtube-api" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Promo Link (index 4)" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-stack-overflow.svg" loading="lazy" alt="Stack Overflow"> </picture> Stack Overflow </a> <div class="devsite-footer-promo-description">Ask a question under the youtube-api tag</div> </li> <li class="devsite-footer-promo"> <a href="https://research.youtube/" class="devsite-footer-promo-title gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Promo Link (index 5)" > <picture> <img class="devsite-footer-promo-icon" src="/static/site-assets/logo-youtube.svg" loading="lazy" alt="YouTube Researcher Program"> </picture> YouTube Researcher Program </a> <div class="devsite-footer-promo-description">For researchers interested in using data from YouTube’s global API</div> </li> </ul> </nav> </devsite-footer-promos> <devsite-footer-linkboxes class="devsite-footer"> <nav class="devsite-footer-linkboxes nocontent" aria-label="Footer links"> <ul class="devsite-footer-linkboxes-list"> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Tools</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="https://developers.google.com/apis-explorer/#p/" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 1)" > Google APIs Explorer </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/youtube/youtube_player_demo" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 2)" > YouTube Player Demo </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/youtube/youtube_subscribe_button" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 3)" > Configure a Subscribe Button </a> </li> </ul> </li> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Issue Tracker</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="https://issuetracker.google.com/issues/new?component=186600&template=874803" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 1)" > File a bug </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://issuetracker.google.com/issues/new?component=186600&template=874803" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 2)" > Request a feature </a> </li> <li class="devsite-footer-linkbox-item"> <a href="https://issuetracker.google.com/issues?q=componentid:186600" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 3)" > See open issues </a> </li> </ul> </li> <li class="devsite-footer-linkbox "> <h3 class="devsite-footer-linkbox-heading no-link">Product Info</h3> <ul class="devsite-footer-linkbox-list"> <li class="devsite-footer-linkbox-item"> <a href="/youtube/terms/api-services-terms-of-service" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 1)" > Terms of Service </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/youtube/terms/developer-policies" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 2)" > Developer Policies </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/youtube/terms/required-minimum-functionality" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 3)" > Required Minimum Functionality </a> </li> <li class="devsite-footer-linkbox-item"> <a href="/youtube/terms/branding-guidelines" class="devsite-footer-linkbox-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Link (index 4)" > Branding Guidelines </a> </li> </ul> </li> </ul> </nav> </devsite-footer-linkboxes> <devsite-footer-utility class="devsite-footer"> <div class="devsite-footer-utility nocontent"> <nav class="devsite-footer-sites" aria-label="Other Google Developers websites"> <a href="https://developers.google.com/" class="devsite-footer-sites-logo-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google Developers Link"> <picture> <img class="devsite-footer-sites-logo" src="https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/lockup-google-for-developers.svg" loading="lazy" alt="Google Developers"> </picture> </a> <ul class="devsite-footer-sites-list"> <li class="devsite-footer-sites-item"> <a href="//developer.android.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Android Link" > Android </a> </li> <li class="devsite-footer-sites-item"> <a href="//developer.chrome.com/home" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Chrome Link" > Chrome </a> </li> <li class="devsite-footer-sites-item"> <a href="//firebase.google.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Firebase Link" > Firebase </a> </li> <li class="devsite-footer-sites-item"> <a href="//cloud.google.com" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google Cloud Platform Link" > Google Cloud Platform </a> </li> <li class="devsite-footer-sites-item"> <a href="//ai.google.dev/" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer Google AI Link" > Google AI </a> </li> <li class="devsite-footer-sites-item"> <a href="/products" class="devsite-footer-sites-link gc-analytics-event" data-category="Site-Wide Custom Events" data-label="Footer All products Link" > All products </a> </li> </ul> </nav> <nav class="devsite-footer-utility-links" aria-label="Utility links"> <ul class="devsite-footer-utility-list"> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="/terms/site-terms" data-category="Site-Wide Custom Events" data-label="Footer Terms link" > Terms </a> </li> <li class="devsite-footer-utility-item "> <a class="devsite-footer-utility-link gc-analytics-event" href="//policies.google.com/privacy" data-category="Site-Wide Custom Events" data-label="Footer Privacy link" > Privacy </a> </li> <li class="devsite-footer-utility-item glue-cookie-notification-bar-control"> <a class="devsite-footer-utility-link gc-analytics-event" href="#" data-category="Site-Wide Custom Events" data-label="Footer Manage cookies link" aria-hidden="true" > Manage cookies </a> </li> <li class="devsite-footer-utility-item devsite-footer-utility-button"> Sign up for the Google for Developers newsletter <a class="devsite-footer-utility-link gc-analytics-event" href="/newsletter/subscribe" data-category="Site-Wide Custom Events" data-label="Footer Subscribe link" > Subscribe </a> </li> </ul> <devsite-language-selector> <ul role="presentation"> <li role="presentation"> <a role="menuitem" lang="en" >English</a> </li> <li role="presentation"> <a role="menuitem" lang="de" >Deutsch</a> </li> <li role="presentation"> <a role="menuitem" lang="es" >Español</a> </li> <li role="presentation"> <a role="menuitem" lang="es_419" >Español – América Latina</a> </li> <li role="presentation"> <a role="menuitem" lang="fr" >Français</a> </li> <li role="presentation"> <a role="menuitem" lang="id" >Indonesia</a> </li> <li role="presentation"> <a role="menuitem" lang="it" >Italiano</a> </li> <li role="presentation"> <a role="menuitem" lang="pl" >Polski</a> </li> <li role="presentation"> <a role="menuitem" lang="pt_br" >Português – Brasil</a> </li> <li role="presentation"> <a role="menuitem" lang="vi" >Tiếng Việt</a> </li> <li role="presentation"> <a role="menuitem" lang="tr" >Türkçe</a> </li> <li role="presentation"> <a role="menuitem" lang="ru" >Русский</a> </li> <li role="presentation"> <a role="menuitem" lang="he" >עברית</a> </li> <li role="presentation"> <a role="menuitem" lang="ar" >العربيّة</a> </li> <li role="presentation"> <a role="menuitem" lang="fa" >فارسی</a> </li> <li role="presentation"> <a role="menuitem" lang="hi" >हिंदी</a> </li> <li role="presentation"> <a role="menuitem" lang="bn" >বাংলা</a> </li> <li role="presentation"> <a role="menuitem" lang="th" >ภาษาไทย</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_cn" >中文 – 简体</a> </li> <li role="presentation"> <a role="menuitem" lang="zh_tw" >中文 – 繁體</a> </li> <li role="presentation"> <a role="menuitem" lang="ja" >日本語</a> </li> <li role="presentation"> <a role="menuitem" lang="ko" >한국어</a> </li> </ul> </devsite-language-selector> </nav> </div> </devsite-footer-utility> <devsite-panel></devsite-panel> <devsite-concierge data-info-panel data-ai-panel data-api-explorer-panel > </devsite-concierge> </section></section> <devsite-sitemask></devsite-sitemask> <devsite-snackbar></devsite-snackbar> <devsite-tooltip ></devsite-tooltip> <devsite-heading-link></devsite-heading-link> <devsite-analytics> <script type="application/json" analytics>[{"dimensions": {"dimension3": false, "dimension4": "YouTube Analytics and Reporting APIs", "dimension5": "en", "dimension6": "en", "dimension1": "Signed out", "dimension11": false}, "gaid": "UA-24532603-1", "metrics": {"ratings_count": "metric2", "ratings_value": "metric1"}, "purpose": 1}]</script> <script type="application/json" tag-management>{"at": "True", "ga4": [{"id": "G-272J68FCRF", "purpose": 1}], "ga4p": [{"id": "G-272J68FCRF", "purpose": 1}], "gtm": [], "parameters": {"internalUser": "False", "language": {"machineTranslated": "False", "requested": "en", "served": "en"}, "pageType": "reference", "projectName": "YouTube Analytics and Reporting APIs", "signedIn": "False", "tenant": "developers", "recommendations": {"sourcePage": "", "sourceType": 0, "sourceRank": 0, "sourceIdenticalDescriptions": 0, "sourceTitleWords": 0, "sourceDescriptionWords": 0, "experiment": ""}, "experiment": {"ids": ""}}}</script> </devsite-analytics> <devsite-badger></devsite-badger> <script nonce="zAYCbH5dlhE6lnijuQn7TRW2S5buFd"> (function(d,e,v,s,i,t,E){d['GoogleDevelopersObject']=i; t=e.createElement(v);t.async=1;t.src=s;E=e.getElementsByTagName(v)[0]; E.parentNode.insertBefore(t,E);})(window, document, 'script', 'https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/js/app_loader.js', '[1,"en",null,"/js/devsite_app_module.js","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers","https://developers-dot-devsite-v2-prod.appspot.com",1,null,["/_pwa/developers/manifest.json","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/images/video-placeholder.svg","https://www.gstatic.com/devrel-devsite/prod/v870e399c64f7c43c99a3043db4b3a74327bb93d0914e84a0c3dba90bbfd67625/developers/images/favicon-new.png","https://fonts.googleapis.com/css?family=Google+Sans:400,500|Roboto:400,400italic,500,500italic,700,700italic|Roboto+Mono:400,500,700&display=swap"],1,null,[1,6,8,12,14,17,21,25,50,52,63,70,75,76,80,87,91,92,93,97,98,100,101,102,103,104,105,107,108,109,110,112,113,117,118,120,122,124,125,126,127,129,130,131,132,133,134,135,136,138,140,141,147,148,149,151,152,156,157,158,159,161,163,164,168,169,170,179,180,182,183,186,191,193,196],"AIzaSyAP-jjEJBzmIyKR4F-3XITp8yM9T1gEEI8","AIzaSyB6xiKGDR5O3Ak2okS4rLkauxGUG7XP0hg","developers.google.com","AIzaSyAQk0fBONSGUqCNznf6Krs82Ap1-NV6J4o","AIzaSyCCxcqdrZ_7QMeLCRY20bh_SXdAYqy70KY",null,null,null,["Search__enable_suggestions_from_borg","Cloud__enable_cloudx_ping","Profiles__enable_awarding_url","Profiles__enable_dashboard_curated_recommendations","MiscFeatureFlags__emergency_css","TpcFeatures__enable_required_headers","Cloud__enable_cloudx_experiment_ids","Search__enable_ai_search_summaries","Search__enable_page_map","Experiments__reqs_query_experiments","Profiles__require_profile_eligibility_for_signin","Profiles__enable_release_notes_notifications","Cloud__enable_cloud_dlp_service","Concierge__enable_pushui","Cloud__enable_cloud_shell","Profiles__enable_page_saving","CloudShell__cloud_code_overflow_menu","Concierge__enable_concierge","BookNav__enable_tenant_cache_key","TpcFeatures__enable_mirror_tenant_redirects","MiscFeatureFlags__developers_footer_image","Search__enable_ai_search_summaries_restricted","Cloud__enable_cloud_facet_chat","MiscFeatureFlags__enable_firebase_utm","Profiles__enable_complete_playlist_endpoint","MiscFeatureFlags__enable_variable_operator","MiscFeatureFlags__developers_footer_dark_image","DevPro__enable_cloud_innovators_plus","MiscFeatureFlags__enable_project_variables","Profiles__enable_completecodelab_endpoint","CloudShell__cloud_shell_button","Search__enable_dynamic_content_confidential_banner","EngEduTelemetry__enable_engedu_telemetry","Profiles__enable_profile_collections","Profiles__enable_recognition_badges","Profiles__enable_developer_profiles_callout","Significatio__enable_by_tenant","Cloud__enable_free_trial_server_call","Analytics__enable_clearcut_logging","DevPro__enable_developer_subscriptions","Cloud__enable_llm_concierge_chat","Cloud__enable_legacy_calculator_redirect","MiscFeatureFlags__enable_explain_this_code","MiscFeatureFlags__enable_view_transitions","Cloud__enable_cloud_shell_fte_user_flow","Concierge__enable_concierge_restricted","Search__enable_ai_eligibility_checks","Profiles__enable_public_developer_profiles"],null,null,"AIzaSyBLEMok-5suZ67qRPzx0qUtbnLmyT_kCVE","https://developerscontentserving-pa.clients6.google.com","AIzaSyCM4QpTRSqP5qI4Dvjt4OAScIN8sOUlO-k","https://developerscontentsearch-pa.clients6.google.com",1,4,null,"https://developerprofiles-pa.clients6.google.com",[1,"developers","Google for Developers","developers.google.com",null,"developers-dot-devsite-v2-prod.appspot.com",null,null,[1,1,[1],null,null,null,null,null,null,null,null,[1],null,null,null,null,null,null,[1],[1,null,null,[1,20],"/recommendations/information"],null,null,null,[1,1,1],[1,1,null,1,1]],null,[null,null,null,null,null,null,"/images/lockup-new.svg","/images/touchicon-180-new.png",null,null,null,null,1,null,null,null,null,null,null,null,null,1,null,null,null,"/images/lockup-dark-theme-new.svg",[]],[],null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,[6,1,14,15,20,22,23,29,32,36],null,[[null,null,null,[3,7,10,2,39,17,4,32,24,11,12,13,34,15,25],null,null,[1,[["docType","Choose a content type",[["Tutorial",null,null,null,null,null,null,null,null,"Tutorial"],["Guide",null,null,null,null,null,null,null,null,"Guide"],["Sample",null,null,null,null,null,null,null,null,"Sample"]]],["product","Choose a product",[["Android",null,null,null,null,null,null,null,null,"Android"],["ARCore",null,null,null,null,null,null,null,null,"ARCore"],["ChromeOS",null,null,null,null,null,null,null,null,"ChromeOS"],["Firebase",null,null,null,null,null,null,null,null,"Firebase"],["Flutter",null,null,null,null,null,null,null,null,"Flutter"],["Assistant",null,null,null,null,null,null,null,null,"Google Assistant"],["GoogleCloud",null,null,null,null,null,null,null,null,"Google Cloud"],["GoogleMapsPlatform",null,null,null,null,null,null,null,null,"Google Maps Platform"],["GooglePay",null,null,null,null,null,null,null,null,"Google Pay & Google Wallet"],["GooglePlay",null,null,null,null,null,null,null,null,"Google Play"],["Tensorflow",null,null,null,null,null,null,null,null,"TensorFlow"]]],["category","Choose a topic",[["AiAndMachineLearning",null,null,null,null,null,null,null,null,"AI and Machine Learning"],["Data",null,null,null,null,null,null,null,null,"Data"],["Enterprise",null,null,null,null,null,null,null,null,"Enterprise"],["Gaming",null,null,null,null,null,null,null,null,"Gaming"],["Mobile",null,null,null,null,null,null,null,null,"Mobile"],["Web",null,null,null,null,null,null,null,null,"Web"]]]]]],[1,1],null,1],[[["UA-24532603-1"],["UA-22084204-5"],null,null,["UA-24532603-5"],null,null,[["G-272J68FCRF"],null,null,[["G-272J68FCRF",2]]],[["UA-24532603-1",2]],null,[["UA-24532603-5",2]],null,1],[[14,11],[3,2],[5,4],[11,8],[15,12],[1,1],[4,3],[12,9],[16,13],[6,5],[13,10]],[[1,1],[2,2]]],null,4,null,null,null,null,null,null,null,null,null,null,null,null,null,"developers.devsite.google"],null,"pk_live_5170syrHvgGVmSx9sBrnWtA5luvk9BwnVcvIi7HizpwauFG96WedXsuXh790rtij9AmGllqPtMLfhe2RSwD6Pn38V00uBCydV4m"]') </script> <devsite-a11y-announce></devsite-a11y-announce> </body> </html>