YouTube Reporting API

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

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

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

הרשאה

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

בקשות ל-API של דיווח ב-YouTube כוללות את היקפי ההרשאות הבאים:

טווחים
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.

משרות

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

jobs.reports

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

reportTypes

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