בדוגמאות הבאות מוסבר איך משתמשים ב-YouTube Data API (v3) כדי לבצע פונקציות שקשורות למינויים.
אחזור המינויים של ערוץ
כדי לאחזר את ההרשמות לערוץ מסוים, צריך להפעיל את השיטה subscriptions.list
. יש שתי דרכים לזהות את הערוץ:
-
כדי לאחזר את המינויים של המשתמש המאומת הנוכחי, מגדירים את הערך של הפרמטר
mine
כ-true
. חשוב לזכור שצריך לאשר בקשה שמשתמשת בפרמטרmine
באמצעות OAuth 2.0.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &mine=true
-
כדי לאחזר מינויים לכל ערוץ אחר, מגדירים את הערך של הפרמטר
channelId
למזהה הייחודי של ערוץ YouTube של אותו ערוץ. בדוגמה הבאה מתבצעת אחזור של רשימת הערוצים שהערוץ TED רשום אליהם כמנוי ב-YouTube.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &channelId=UCAuUUnT6oDeKwE6v1NGQxug
הערה: ה-API מחזיר קוד תגובה HTTP מסוג
403 (Forbidden)
אם המינויים של הערוץ שצוין לא גלויים לכולם, והבקשה לא אושרה על ידי הבעלים של הערוץ.
דוגמאות קוד זמינות במסמכי העזרה של השיטה subscriptions.list
.
הוסף מינוי
כדי להוסיף מינוי לערוץ, צריך לבצע קריאה ל-method subscriptions.insert
. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0. גוף הבקשה הוא משאב subscription
שמגדיר את הערכים הבאים:
- השדה
snippet.resourceId.kind
מכיל את הערךyoutube#channel
. - המאפיין
snippet.resourceId.channelId
מזהה את הערוץ שאליו נרשמים כמנויים. ערך הנכס הוא מזהה ייחודי של ערוץ YouTube. אפשר לקבל את מזהה הערוץ בכמה דרכים, כולל קריאה ל-methodchannels.list
או אחזור של תוצאות חיפוש של ערוצים.
בקשת ה-API הבאה תירשם אתכם לערוץ TED ב-YouTube:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.insert? part=snippet
גוף הבקשה הוא:
{ "snippet": { "resourceId": { "kind": "youtube#channel", "videoId": "UCAuUUnT6oDeKwE6v1NGQxug" } } }
דוגמאות קוד זמינות במסמכי העזרה של השיטה subscriptions.insert
.
מחיקת מינוי
בדוגמה הזו מוחקים מינוי. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0. בדוגמה הזו יש שני שלבים:
-
שלב 1: אחזור המינויים לערוץ של המשתמש המאומת
קוראים ל-method
subscriptions.list
כדי לאחזר את רשימת המינויים. הדוגמה שלמעלה לאחזור המינויים של ערוץ מסבירה איך שולחים את הבקשה הזו.האפליקציה שמפעילה את ה-API יכולה לעבד את התגובה מה-API כדי להציג רשימה של מינויים, ולהשתמש במזהה של כל מינוי כמפתח. בתגובה, המאפיין
id
של כל פריט מזהה את מזהה המינוי שמזהה באופן ייחודי את המינוי התואם. בשלב הבא תשתמשו בערך הזה כדי להסיר פריט מהרשימה. -
שלב 2: מחיקה של מינוי
כדי למחוק מינוי, צריך לבצע קריאה ל-method
subscriptions.delete
. מגדירים את הפרמטרid
בבקשה למזהה המינוי שרוצים להסיר. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0.כדי להשלים את הבקשה ב-API Explorer, צריך להגדיר את הערך של נכס
id
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.delete? id=SUBSCRIPTION_ID
דוגמאות קוד זמינות במסמכי העזרה של השיטה subscriptions.delete
.
אחזור רשימה של המנויים לערוץ של המשתמש המורשה
כדי לאחזר רשימה של ערוצים שנרשמו לערוץ של המשתמש המאומת הנוכחי, צריך להפעיל את השיטה subscriptions.list
ולהגדיר את הערך של הפרמטר mySubscribers
כ-true
. צריך לאשר את הבקשה באמצעות OAuth 2.0.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &mySubscribers=true