Reports: Query

این روش به شما امکان می دهد بسیاری از گزارش های مختلف Analytics را بازیابی کنید. هر درخواست از پارامترهای پرس و جو برای تعیین شناسه کانال یا مالک محتوا، تاریخ شروع، تاریخ پایان و حداقل یک معیار استفاده می کند. همچنین می توانید پارامترهای پرس و جو اضافی مانند ابعاد، فیلترها و دستورالعمل های مرتب سازی را ارائه دهید.

• معیارها اندازه‌گیری‌های فردی فعالیت کاربر، مانند بازدیدها یا رتبه‌بندی ویدیوها (پسندیدن و نپسندیدن) هستند.
• ابعاد معیارهای رایجی هستند که برای جمع‌آوری داده‌ها استفاده می‌شوند، مانند تاریخی که فعالیت کاربر در آن اتفاق افتاده یا کشوری که کاربران در آن قرار داشته‌اند. در یک گزارش، هر ردیف از داده ها دارای ترکیبی منحصر به فرد از مقادیر ابعاد است.
• فیلترها مقادیر ابعادی هستند که داده های بازیابی را مشخص می کنند. برای مثال، می‌توانید داده‌های یک کشور خاص، یک ویدیوی خاص یا گروهی از ویدیوها را بازیابی کنید.

توجه: گزارش‌های مالک محتوا فقط برای شرکای محتوای YouTube که در برنامه شریک YouTube شرکت می‌کنند قابل دسترسی است.

درخواست

GET https://youtubeanalytics.googleapis.com/v2/reports

واکنش

همانطور که در تعریف پارامتر alt اشاره شد، API می تواند پاسخ ها را در قالب JSON یا CSV برگرداند. اطلاعات مربوط به بدنه پاسخ برای هر نوع در زیر نشان داده شده است:

{
  "kind": "youtubeAnalytics#resultTable",
  "columnHeaders": [
    {
      "name": string,
      "dataType": string,
      "columnType": string
    },
    ... more headers ...
  ],
  "rows": [
    [
      {value}, {value}, ...
    ]
  ]
}

day, views, likes, ...
"2012-01-01", 12.0, 3, ...
"2012-01-02", 16.0, 2, ...
"2012-01-03", 18.0, 8, ...
...

gapi.auth2.init({client_id: 'YOUR_CLIENT_ID'});

<script src="https://apis.google.com/js/api.js"></script>
<script>
  function authenticate() {
    return gapi.auth2.getAuthInstance()
        .signIn({scope: "https://www.googleapis.com/auth/yt-analytics.readonly"})
        .then(function() { console.log("Sign-in successful"); },
              function(err) { console.error("Error signing in", err); });
  }
  function loadClient() {
    return gapi.client.load("https://youtubeanalytics.googleapis.com/$discovery/rest?version=v2")
        .then(function() { console.log("GAPI client loaded for API"); },
              function(err) { console.error("Error loading GAPI client for API", err); });
  }
  // Make sure the client is loaded and sign-in is complete before calling this method.
  function execute() {
    return gapi.client.youtubeAnalytics.reports.query({
      "ids": "channel==MINE",
      "startDate": "2017-01-01",
      "endDate": "2017-12-31",
      "metrics": "views,estimatedMinutesWatched,averageViewDuration,averageViewPercentage,subscribersGained",
      "dimensions": "day",
      "sort": "day"
    })
        .then(function(response) {
                // Handle the results here (response.result has the parsed body).
                console.log("Response", response);
              },
              function(err) { console.error("Execute error", err); });
  }
  gapi.load("client:auth2", function() {
    gapi.auth2.init({client_id: 'YOUR_CLIENT_ID'});
  });
</script>
<button onclick="authenticate().then(loadClient)">authorize and load</button>
<button onclick="execute()">execute</button>
yt_analytics_v2.html

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

# -*- 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'
  )
yt_analytics_v2.py