הדוגמאות הבאות מראות איך להשתמש ב-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
.
הוסף מינוי
צריך להתקשר לשיטה subscriptions.insert
כדי להוסיף מינוי לערוץ. יש לאשר את הבקשה הזו באמצעות OAuth 2.0. גוף הבקשה הוא משאב subscription
המגדיר את הערכים הבאים:
snippet.resourceId.kind
מכיל את הערךyoutube#channel
.- המאפיין
snippet.resourceId.channelId
מזהה את הערוץ שאליו נרשמת. ערך הנכס הוא מזהה ייחודי של ערוץ YouTube. יש כמה דרכים להשיג את מזהה הערוץ, כולל הפעלת השיטהchannels.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: אחזור המינויים של הערוץ המאומת של המשתמש
התקשר אל השיטה
subscriptions.list
כדי לאחזר את רשימת המינויים. הדוגמה למעלה לאחזור מינויים של ערוץ מסבירה כיצד להגיש את הבקשה הזו.האפליקציה שקוראת ל-API יכולה לעבד את תגובת ה-API כדי להציג רשימה של מינויים, תוך שימוש במזהה של כל מינוי כמפתח. בתגובה, המאפיין
id
של כל פריט מזהה את מזהה המינוי שמזהה את המינוי התואם באופן ייחודי. אפשר להשתמש בערך הזה כדי להסיר פריט מהרשימה בשלב הבא. -
שלב 2: מחיקת מינוי
כדי למחוק מינוי, יש להתקשר לשיטה
subscriptions.delete
. מגדירים את הפרמטרid
של הבקשה למזהה המינוי שרוצים להסיר. יש לאשר את הבקשה הזו באמצעות OAuth 2.0.כדי להשלים את הבקשה ב-APIs 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