পাইথন কোড নমুনা

নিম্নলিখিত কোড নমুনাগুলি, যা Python জন্য Google API ক্লায়েন্ট লাইব্রেরি ব্যবহার করে, YouTube Reporting API এবং YouTube Analytics API এর জন্য উপলব্ধ৷ আপনি GitHub-এ YouTube APIs কোড নমুনা সংগ্রহস্থলের python ফোল্ডার থেকে এই কোড নমুনাগুলি ডাউনলোড করতে পারেন।

বাল্ক রিপোর্ট

রিপোর্ট পুনরুদ্ধার

এই কোড নমুনা দেখায় কিভাবে একটি নির্দিষ্ট কাজের দ্বারা তৈরি রিপোর্ট পুনরুদ্ধার করতে হয়। রিপোর্টিং কাজ পুনরুদ্ধার করার জন্য এটি jobs.list পদ্ধতিকে কল করে। এটি তারপর সেই কাজের দ্বারা তৈরি প্রতিবেদনগুলি পুনরুদ্ধার করতে একটি নির্দিষ্ট কাজের আইডিতে সেট করা jobId প্যারামিটার সহ reports.list পদ্ধতিকে কল করে। অবশেষে, নমুনা প্রতিটি রিপোর্টের জন্য ডাউনলোড URL প্রিন্ট করে।

#!/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)

একটি রিপোর্টিং কাজ তৈরি করুন

এই কোড নমুনা দেখায় কিভাবে একটি রিপোর্টিং কাজ তৈরি করতে হয়। উপলব্ধ রিপোর্ট প্রকারের একটি তালিকা পুনরুদ্ধার করতে এটি reportTypes.list পদ্ধতিকে কল করে। এটি তারপর একটি নতুন রিপোর্টিং কাজ তৈরি করতে jobs.create পদ্ধতিকে কল করে।

#!/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)

টার্গেটেড ক্যোয়ারী রিপোর্ট

দৈনিক চ্যানেল পরিসংখ্যান পুনরুদ্ধার করুন

এই উদাহরণটি 2017 ক্যালেন্ডার বছরের জন্য অনুমোদিত ব্যবহারকারীর চ্যানেলের দৈনিক ভিউ এবং অন্যান্য মেট্রিক্স পুনরুদ্ধার করতে YouTube Analytics API-কে কল করে৷ নমুনাটি Google APIs Python ক্লায়েন্ট লাইব্রেরি ব্যবহার করে।

কোডটি https://www.googleapis.com/auth/yt-analytics.readonly স্কোপ অ্যাক্সেস করার জন্য ব্যবহারকারীর অনুমতির অনুরোধ করে।

SCOPES = ['https://www.googleapis.com/auth/yt-analytics.readonly']

আপনার অ্যাপ্লিকেশনটিকে অন্যান্য স্কোপে অ্যাক্সেসের অনুরোধ করতে হতে পারে। উদাহরণস্বরূপ, একটি অ্যাপ্লিকেশন যা YouTube Analytics API এবং YouTube Data API কল করে ব্যবহারকারীদের তাদের YouTube অ্যাকাউন্টগুলিতে অ্যাক্সেস দেওয়ার প্রয়োজন হতে পারে৷ অনুমোদন ওভারভিউ সাধারণত ইউটিউব অ্যানালিটিক্স API কল করে এমন অ্যাপ্লিকেশনগুলিতে ব্যবহৃত স্কোপগুলি সনাক্ত করে৷

অনুমোদনের শংসাপত্র সেট আপ করুন

প্রথমবারের জন্য স্থানীয়ভাবে এই নমুনা চালানোর আগে, আপনাকে আপনার প্রকল্পের জন্য অনুমোদনের শংসাপত্র সেট আপ করতে হবে:

  1. Google API কনসোলে একটি প্রকল্প তৈরি করুন বা নির্বাচন করুন।
  2. আপনার প্রকল্পের জন্য YouTube Analytics API সক্ষম করুন৷
  3. শংসাপত্র পৃষ্ঠার শীর্ষে, OAuth সম্মতি স্ক্রিন ট্যাবটি নির্বাচন করুন। একটি ইমেল ঠিকানা নির্বাচন করুন, ইতিমধ্যে সেট না থাকলে একটি পণ্যের নাম লিখুন এবং সংরক্ষণ বোতামে ক্লিক করুন৷
  4. শংসাপত্র পৃষ্ঠায়, শংসাপত্র তৈরি করুন বোতামে ক্লিক করুন এবং Oauth ক্লায়েন্ট আইডি নির্বাচন করুন।
  5. অন্যান্য অ্যাপ্লিকেশন প্রকারটি নির্বাচন করুন, "ইউটিউব অ্যানালিটিক্স এপিআই কুইকস্টার্ট" নাম লিখুন, এবং তৈরি করুন বোতামে ক্লিক করুন৷
  6. ফলস্বরূপ ডায়ালগ খারিজ করতে ঠিক আছে ক্লিক করুন।
  7. ক্লায়েন্ট আইডির ডানদিকে (JSON ডাউনলোড করুন) বোতামে ক্লিক করুন।
  8. ডাউনলোড করা ফাইলটি আপনার কাজের ডিরেক্টরিতে সরান।

প্রয়োজনীয় লাইব্রেরি ইনস্টল করুন

আপনাকে পাইথনের জন্য Google APIs ক্লায়েন্ট লাইব্রেরি এবং কিছু অতিরিক্ত লাইব্রেরি ইনস্টল করতে হবে:

pip install --upgrade google-api-python-client
pip install --upgrade google-auth google-auth-oauthlib google-auth-httplib2

কোড চালান

এখন, আপনি আসলে নমুনা পরীক্ষা করার জন্য প্রস্তুত:

  1. আপনার কাজের ডিরেক্টরিতে নীচের কোড নমুনাটি অনুলিপি করুন।
  2. নমুনায়, CLIENT_SECRETS_FILE ভেরিয়েবলের মান আপডেট করুন আপনার অনুমোদনের শংসাপত্র সেট আপ করার পরে আপনি যে ফাইলটি ডাউনলোড করেছেন তার সাথে মেলে।
  3. একটি টার্মিনাল উইন্ডোতে নমুনা কোড চালান:
    python yt_analytics_v2.py
  4. অনুমোদন প্রবাহ মাধ্যমে যান. অনুমোদন প্রবাহ স্বয়ংক্রিয়ভাবে আপনার ব্রাউজারে লোড হতে পারে, অথবা আপনাকে একটি ব্রাউজার উইন্ডোতে প্রমাণীকরণ URL অনুলিপি করতে হতে পারে। অনুমোদন প্রবাহের শেষে, যদি প্রয়োজন হয়, আপনার টার্মিনাল উইন্ডোতে ব্রাউজারে প্রদর্শিত অনুমোদন কোড পেস্ট করুন এবং [রিটার্ন] ক্লিক করুন।
  5. API ক্যোয়ারী কার্যকর হয় এবং JSON প্রতিক্রিয়া টার্মিনাল উইন্ডোতে আউটপুট হয়।

কোডের উদাহরণ

# -*- coding: utf-8 -*-

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

SCOPES = ['https://www.googleapis.com/auth/yt-analytics.readonly']

API_SERVICE_NAME = 'youtubeAnalytics'
API_VERSION = 'v2'
CLIENT_SECRETS_FILE = 'YOUR_CLIENT_SECRET_FILE.json'
def get_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

def execute_api_request(client_library_function, **kwargs):
  response = client_library_function(
    **kwargs
  ).execute()

  print(response)

if __name__ == '__main__':
  # Disable OAuthlib's HTTPs verification when running locally.
  # *DO NOT* leave this option enabled when running in production.
  os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'

  youtubeAnalytics = get_service()
  execute_api_request(
      youtubeAnalytics.reports().query,
      ids='channel==MINE',
      startDate='2017-01-01',
      endDate='2017-12-31',
      metrics='estimatedMinutesWatched,views,likes,subscribersGained'
      dimensions='day',
      sort='day'
  )