Update auth libraries, add options, documentation

AndyDiamondstein · web-flow · commit c8e98d8da316 · 2017-10-27T11:14:46.000-04:00
The oauth2client library is deprecated. This update changes the sample to use the google-auth and google-auth-oauthlib libraries instead.

The updated script has improved options, allowing the user to set a content owner ID, job ID, report URL, and/or local filename using command-line arguments. The logic also now bypasses certain functions depending on the command-line arguments set. For example, if you specify the URL of the report that you want to download, the script doesn't prompt you to select a job and a report (since you've already done that).

The prerequisites section in the README file explains how to run this sample (and others in this directory).
diff --git a/python/retrieve_reports.py b/python/retrieve_reports.py
@@ -1,23 +1,36 @@
 #!/usr/bin/python
 
-# Usage example:
-# python retrieve_reports.py
-
-import httplib2
+###
+#
+# 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 sys
 
-from apiclient.discovery import build
-from apiclient.errors import HttpError
-from apiclient.http import MediaIoBaseDownload
+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
-from oauth2client.client import flow_from_clientsecrets
-from oauth2client.file import Storage
-from oauth2client.tools import argparser, run_flow
 
 
 # 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
@@ -27,117 +40,133 @@
 #   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_secrets.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.
-YOUTUBE_ANALYTICS_MONETARY_READ_SCOPE = (
-  "https://www.googleapis.com/auth/yt-analytics-monetary.readonly")
-YOUTUBE_REPORTING_API_SERVICE_NAME = "youtubereporting"
-YOUTUBE_REPORTING_API_VERSION = "v1"
-
-# This variable defines a message to display if the CLIENT_SECRETS_FILE is
-# missing.
-MISSING_CLIENT_SECRETS_MESSAGE = """
-WARNING: Please configure OAuth 2.0
-
-To make this sample run you will need to populate the client_secrets.json file
-found at:
-   %s
-with information from the APIs Console
-https://console.developers.google.com
-
-For more information about the client_secrets.json file format, please visit:
-https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
-""" % os.path.abspath(os.path.join(os.path.dirname(__file__),
-                                   CLIENT_SECRETS_FILE))
-
-# Authorize the request and store authorization credentials.
-def get_authenticated_service(args):
-  flow = flow_from_clientsecrets(CLIENT_SECRETS_FILE, scope=YOUTUBE_ANALYTICS_MONETARY_READ_SCOPE,
-    message=MISSING_CLIENT_SECRETS_MESSAGE)
+CLIENT_SECRETS_FILE = 'client_secret.json'
 
-  storage = Storage("%s-oauth2.json" % sys.argv[0])
-  credentials = storage.get()
-
-  if credentials is None or credentials.invalid:
-    credentials = run_flow(flow, storage, args)
-
-  return build(YOUTUBE_REPORTING_API_SERVICE_NAME, YOUTUBE_REPORTING_API_VERSION,
-    http=credentials.authorize(httplib2.Http()))
+# 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):
-  results = youtube_reporting.jobs().list(
-  ).execute()
+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"]
+  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"]))
+      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"
+    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, job_id):
+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(
-    jobId=job_id
+    **kwargs
   ).execute()
 
-  if "reports" in results and results["reports"]:
-    reports = results["reports"]
+  if 'reports' in results and results['reports']:
+    reports = results['reports']
     for report in reports:
-      print ("Report from '%s' to '%s' downloadable at '%s'"
-        % (report["startTime"], report["endTime"], report["downloadUrl"]))
+      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):
+def download_report(youtube_reporting, report_url, local_file):
   request = youtube_reporting.media().download(
-    resourceName=""
+    resourceName=' '
   )
   request.uri = report_url
-  fh = FileIO('report', mode='wb')
+  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!"
+      print 'Download %d%%.' % int(status.progress() * 100)
+  print 'Download Complete!'
 
 
-# Prompt the user to enter a job id for report retrieval. Then return the id.
+# 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)
+  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 enter a report URL for download. Then return the URL.
+# 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)
+  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__":
-  args = argparser.parse_args()
-
-  youtube_reporting = get_authenticated_service(args)
+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 list_reporting_jobs(youtube_reporting):
-      retrieve_reports(youtube_reporting, get_job_id_from_user())
-      download_report(youtube_reporting, get_report_url_from_user())
+    # 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)
-  else:
-    print "Retrieved reports."
+    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
