The following code samples, which use the Google APIs Client Library for Java
, are available for the YouTube Reporting API
and YouTube Analytics API. You can download these code samples from the java
folder of the YouTube APIs code sample repository on GitHub
.
-
Bulk reports (YouTube Reporting API)
-
Targeted query reports (YouTube Analytics API)
Bulk reports
Retrieve reports
This sample demonstrates how to retrieve reports created by a specific job. It calls the jobs.list
method to retrieve reporting jobs. It then calls the reports.list
method with the jobId
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.
/* * 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 ; }}
Create a reporting job
This sample demonstrates how to create a reporting job. It calls the reportTypes.list
method to retrieve a list of available report types. It then calls the jobs.create
method to create a new reporting job.
/* * 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 ; } }
Targeted query reports
Retrieve top 10 videos by view count
This sample calls the API's reports.query
method to retrieve YouTube Analytics data. By default, the report retrieves the top 10 videos based on viewcounts, and it returns several metrics for those videos, sorting the results in reverse order by viewcount. By setting command line parameters, you can use the same code to retrieve other reports as well.
/* * 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 ; } }
