YouTube Reporting API

‫YouTube Reporting API מאפשר למפתחים לתזמן משימות דיווח ואז להוריד דוחות בכמות גדולה שנוצרו. ה-API תומך בקבוצה מוגדרת מראש של דוחות, שכל אחד מהם מכיל קבוצה מקיפה של נתונים מ-YouTube Analytics לגבי ערוץ או בעלי תוכן.

בשלבים הבאים מוסבר איך לתזמן משימות דיווח ולאחזר דוחות:

  1. קוראים לשיטה reportTypes.list() כדי לאחזר רשימה של דוחות שבעלי ערוץ או בעלי תוכן יכולים לאחזר.
  2. קוראים לשיטה jobs.create() כדי לזהות דוח שצריך ליצור עבור ערוץ או בעלי תוכן. לאחר מכן אפשר להשתמש בשיטות jobs.list() ו-jobs.delete() של ה-API כדי לאחזר או לשנות את רשימת הדוחות שנוצרים.
  3. קוראים לשיטה jobs.reports.list() כדי לאחזר רשימה של דוחות שנוצרו עבור משימה מסוימת. כל משאב בתגובה מכיל מאפיין downloadUrl שמציין את כתובת ה-URL שממנה אפשר להוריד את הדוח.
  4. שליחת בקשת GET מורשית לאחזור הדוח מכתובת ה-URL להורדה.

אישור

כל הבקשות ל-YouTube Reporting API חייבות להיות מאושרות. במדריך ההרשאות מוסבר איך להשתמש בפרוטוקול OAuth 2.0 כדי לאחזר אסימוני הרשאה.

בקשות ל-YouTube Reporting API משתמשות בהיקפי ההרשאות הבאים:

טווחים
https://www.googleapis.com/auth/yt-analytics.readonly עיון בדוחות YouTube Analytics עבור התוכן שלכם ב-YouTube. ההיקף הזה מספק גישה למדדים של פעילות המשתמשים, כמו מספר הצפיות ומספר הדירוגים.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly עיון בדוחות כספיים של YouTube Analytics לגבי התוכן שלכם ב-YouTube. ההיקף הזה מספק גישה למדדי פעילות המשתמשים ולמדדי ההכנסה המשוערת וביצועי המודעות.

סוגי המשאבים

בקטעים הבאים מופיעים תיאורים כלליים של המשאבים והשיטות של ה-API. כל כתובות ה-URI של השיטות שמוצגות בטבלאות הן יחסיות ל-https://youtubereporting.googleapis.com.

משרות

Methods
create POST /v1/jobs
יוצר משימת דיווח. כשיוצרים משימת דיווח, נותנים ל-YouTube הוראה ליצור את הדוח הזה על בסיס יומי. הדוח יהיה זמין תוך 24 שעות מרגע יצירת העבודה.
delete DELETE /v1/jobs/{jobId}
מחיקת עבודת דיווח.
get GET /v1/jobs/{jobId}
מאחזר מידע על משימת דיווח ספציפית שתוזמנה עבור ערוץ או בעלי תוכן.
list GET /v1/jobs
מציג רשימה של משימות דיווח שתוזמנו עבור ערוץ או בעלי תוכן. כל משאב בתגובה מכיל מאפיין id שמציין את המזהה שמשמש את YouTube לזיהוי ייחודי של העבודה. המזהה הזה נחוץ כדי לאחזר את רשימת הדוחות שנוצרו עבור העבודה או כדי למחוק את העבודה.

jobs.reports

Methods
get GET /v1/jobs/{jobId}/reports/{reportId}
מאחזר את המטא-נתונים של דוח ספציפי.
list GET /v1/jobs/{jobId}/reports
רשימת הדוחות שנוצרו עבור משימת הדיווח שצוינה.

reportTypes

Methods
list GET /v1/reportTypes
מחזירה רשימה של סוגי דוחות שאפשר לאחזר לגבי הערוץ או בעלי התוכן.