API Reference

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

ה-API תומך בשני סוגים של פונקציות:

  • אחזור דוחות – שיטת reports.query של ה-API מאחזרת דוחות של YouTube Analytics.

  • ניהול קבוצות ב-YouTube Analytics – קבוצה ב-YouTube Analytics היא אוסף מותאם אישית של עד 500 ערוצים, סרטונים, פלייליסטים או נכסים. ה-API תומך בכמה שיטות ליצירה, אחזור ועדכון של קבוצות ב-YouTube Analytics. לאחר מכן, בעלי הערוצים והתכנים יכולים להשתמש בשיטה reports.query כדי לאחזר נתונים מצטברים של כל הפריטים בקבוצה, וכך לעזור בניתוח הביצועים.

בדף הזה נספק סקירה כללית קצרה על המשאבים והשיטות של ה-API שמאפשרים את הפונקציות האלה.

אישור

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

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

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

אחזור דוחות

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://youtubeanalytics.googleapis.com/v2
query GET /reports אחזור דוח מ-YouTube Analytics. כל בקשת API משתמשת בפרמטרים של שאילתות כדי לציין מזהה ערוץ או בעל תוכן, תאריך התחלה, תאריך סיום ומדד אחד לפחות. אפשר גם לספק פרמטרים נוספים של שאילתה, כמו מאפיינים, מסננים או הוראות מיון.
  • מדדים הם מדידות ספציפיות של פעילות המשתמשים, כמו צפיות בסרטונים או דירוגים (לייקים ודיסלייקים).
  • מאפיינים הם קריטריונים נפוצים שמשמשים לצבירת נתונים, כמו התאריך שבו התרחשה פעילות המשתמש או המדינה שבה המשתמשים היו ממוקמים. בדוח, לכל שורה של נתונים יש שילוב ייחודי של ערכי מאפיינים.
  • מסננים הם ערכים של מאפיינים שמציינים את הנתונים שיוחזרו. לדוגמה, אפשר לאחזר נתונים לגבי מדינה ספציפית, סרטון ספציפי או קבוצת סרטונים.
הרשימות של דוחות הערוץ ושל דוחות בעלי התוכן מגדירות את השילובים החוקיים של מדדים, מאפיינים ומסננים.

ניהול קבוצות

ה-API מספק שני משאבים ליצירה ולניהול של קבוצות ב-YouTube Analytics:

קבוצות

משאב group מייצג קבוצה ב-YouTube Analytics. הקבוצה היא אוסף מותאם אישית של עד 500 ערוצים, סרטונים, פלייליסטים או נכסים.

כל הפריטים בקבוצה חייבים לייצג את אותו סוג של משאב. לדוגמה, אי אפשר ליצור קבוצה שמכילה 100 סרטונים ו-100 פלייליסטים.

קבוצה ב-Analytics יכולה להכיל רק משאבים שהעליתם או הבעתם עליהם בעלות, או משאבים שמקושרים לערוץ שאתם מנהלים. כתוצאה מכך, בעלי ערוצים יכולים ליצור קבוצות של סרטונים ופלייליסטים. בעלי תוכן יכולים ליצור קבוצות של סרטונים, פלייליסטים, ערוצים או נכסים.

מידע נוסף על המשאב הזה זמין בייצוג המשאב וברשימה של המאפיינים שלו.

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://youtubeanalytics.googleapis.com/v2
list GET /groups הפונקציה מחזירה רשימה של קבוצות שתואמות לפרמטרים של בקשת ה-API. לדוגמה, אפשר לאחזר את כל הקבוצות שבבעלות המשתמש המאומת, או לאחזר קבוצה אחת או יותר לפי המזהים הייחודיים שלהן.
insert POST /groups יצירת קבוצה ב-YouTube Analytics. אחרי שיוצרים קבוצה, משתמשים בשיטה groupItems.insert כדי להוסיף פריטים לקבוצה.
update PUT /groups שינוי המטא-נתונים של קבוצה. נכון לעכשיו, הנכס היחיד שאפשר לעדכן הוא שם הקבוצה. (משתמשים בסמלים groupItems.insert ו-groupItems.delete כדי להוסיף ולהסיר פריטים לקבוצה).
delete DELETE /groups מחיקה של קבוצה.

GroupItems

משאב groupItem מייצג פריט בקבוצה ב-YouTube Analytics.

מידע נוסף על המשאב הזה זמין בייצוג המשאב וברשימה של המאפיינים שלו.

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://youtubeanalytics.googleapis.com/v2
list GET /groupItems הפונקציה מחזירה אוסף של פריטים בקבוצה שתואמים לפרמטר של בקשת ה-API.
insert POST /groupItems יצירת פריט קבוצתי.
delete DELETE /groupItems הסרת פריט מקבוצה.