ה-API של YouTube Analytics מאפשר לכם לאחזר נתונים של YouTube Analytics עבור ערוץ או בעלי תוכן ב-YouTube. ה-API תומך בשאילתות בזמן אמת ומפיק דוח על סמך הפרמטרים של בקשת ה-API.
ה-API תומך בשני סוגי פונקציות:
-
אחזור דוחות – שיטת ה-API של
reports.queryמאחזרת דוחות YouTube Analytics. -
ניהול קבוצות ב-YouTube Analytics – קבוצה ב-YouTube Analytics היא אוסף מותאם אישית של עד 500 ערוצים, סרטונים, פלייליסטים או נכסים. ממשק ה-API תומך בכמה שיטות כדי ליצור, לאחזר ולעדכן קבוצות ב-YouTube Analytics. בעלי ערוצים ובעלי תוכן יוכלו להשתמש בשיטה
reports.queryכדי לאחזר נתונים נצברים של כל הפריטים בקבוצה, וכך לסייע בניתוח הביצועים.
הדף הזה מספק סקירה כללית קצרה על משאבי ה-API והמשאבים שמאפשרים את הפונקציות האלה.
הרשאה
כל הבקשות ל-API של YouTube Analytics חייבות להיות מאושרות. במדריך ההרשאות מוסבר איך להשתמש בפרוטוקול OAuth 2.0 כדי לאחזר אסימוני הרשאה.
בקשות להרשאות API של YouTube Analytics כוללות את היקפי ההרשאות הבאים:
| טווחים | |
|---|---|
| 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. כל בקשה משתמשת בפרמטרים של שאילתה כדי לציין מזהה ערוץ או בעל תוכן, תאריך התחלה, תאריך סיום ומדד אחד לפחות. אפשר גם לספק פרמטרים נוספים של שאילתה, כמו מאפיינים, מסננים והוראות מיון.
| Method | בקשת HTTP | תיאור |
|---|---|---|
מזהי URI ביחס ל-https://youtubeanalytics.googleapis.com/v2 |
||
query |
GET /reports |
מאחזר דוח של YouTube Analytics. כל בקשת API משתמשת בפרמטרים של שאילתה כדי לציין מזהה ערוץ או בעלי תוכן, תאריך התחלה, תאריך סיום ומדד אחד לפחות. אפשר גם לספק פרמטרים נוספים של שאילתה, כמו מאפיינים, מסננים או הוראות מיון.
|
ניהול קבוצות
ה-API מספק שני משאבים ליצירה ולניהול של קבוצות ב-YouTube Analytics:
קבוצות
משאב group מייצג קבוצת YouTube Analytics, שהיא אוסף מותאם אישית של עד 500 ערוצים, סרטונים, פלייליסטים או נכסים.
כל הפריטים בקבוצה חייבים לייצג את אותו סוג משאב. לדוגמה, אי אפשר ליצור קבוצה שמכילה 100 סרטונים ו-100 פלייליסטים.
קבוצת Analytics יכולה להכיל רק משאבים שהעלית או הצהרת על בעלות, או כאלה שמקושרים לערוץ בניהולך. לכן, הבעלים של הערוץ יכולים ליצור קבוצות של סרטונים ופלייליסטים. בעלי תוכן יכולים ליצור קבוצות של סרטונים, פלייליסטים, ערוצים או נכסים.
מידע נוסף על המשאב הזה זמין במאמר ייצוג משאבים ורשימת הנכסים.
| Method | בקשת 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 |
מתבצעת מחיקה של קבוצה. |
קיבוץ פריטים
משאב groupItem מייצג פריט בקבוצה YouTube Analytics.
מידע נוסף על המשאב הזה זמין במאמר ייצוג משאבים ורשימת הנכסים.
| Method | בקשת HTTP | תיאור |
|---|---|---|
מזהי URI ביחס ל-https://youtubeanalytics.googleapis.com/v2 |
||
list |
GET /groupItems |
מחזירה אוסף של פריטי קבוצה התואמים לפרמטרים של בקשת ה-API. |
insert |
POST /groupItems |
יצירת פריט קבוצתי |
delete |
DELETE /groupItems |
מסיר פריט מקבוצה. |