הפונקציה מחזירה אוסף של תמונות פלייליסט שתואמות לפרמטרים של בקשת ה-API. תוכלו לאחזר את תמונת הפלייליסט של פלייליסט ספציפי או לאחזר תמונת פלייליסט אחת או יותר לפי המזהים הייחודיים שלהם.
השפעה על המכסה: לקריאה לשיטה הזו יש עלות מכסה של יחידה אחת.
בקשה
בקשת HTTP
GET https://www.googleapis.com/youtube/v3/playlistImages
אישור
הבקשה הזו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
היקף |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שנתמכים בשאילתה הזו. כל הפרמטרים הרשומים הם פרמטרים של שאילתות.
פרמטרים | ||
---|---|---|
פרמטרים נדרשים | ||
part |
string הפרמטר |
|
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים) | ||
id |
string הפרמטר id מציין רשימה מופרדת בפסיקים של מזהה תמונה ייחודי אחד או יותר של פלייליסט. |
|
playlistId |
string הפרמטר playlistId מציין את המזהה הייחודי של הפלייליסט שעבורו רוצים לאחזר את תמונות הפלייליסט. הערה: למרות שזהו פרמטר אופציונלי, בכל בקשה לאחזור תמונות פלייליסט צריך לציין ערך לפרמטר id או לפרמטר playlistId . |
|
פרמטרים אופציונליים | ||
maxResults |
unsigned integer הפרמטר maxResults מציין את המספר המקסימלי של תמונות שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50 , כולל. ערך ברירת המחדל הוא 5 . |
|
onBehalfOfContentOwner |
string ניתן להשתמש בפרמטר הזה רק בבקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה להרשאה של הבקשה מזהים משתמש YouTube CMS שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube, שבבעלותם ובניהולם של ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ שלהם, בלי שיצטרכו לספק פרטי כניסה לאימות לכל ערוץ בנפרד. חשבון מערכת ניהול התוכן שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
|
onBehalfOfContentOwnerChannel |
string ניתן להשתמש בפרמטר הזה רק בבקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. שלך פרמטר onBehalfOfContentOwnerChannel
מציין את מזהה ערוץ YouTube של הערוץ שאליו הסרטון מועבר
נוסף. הפרמטר הזה נדרש כאשר בקשה מציינת ערך עבור
onBehalfOfContentOwner , וניתן להשתמש בו רק
ביחד עם הפרמטר הזה. בנוסף, הבקשה חייבת להיות
מורשה באמצעות חשבון מערכת ניהול תוכן שמקושר לבעלי התוכן,
מציין את הפרמטר onBehalfOfContentOwner . לבסוף,
הערוץ שערך הפרמטר onBehalfOfContentOwnerChannel
מציין חייב להיות מקושר לבעלי התוכן
הפרמטר onBehalfOfContentOwner מציין.מיועד לשותפי תוכן של YouTube, שבבעלותם ובניהולם ערוצי YouTube שונים. הוא מאפשר לבעלי תוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בפרמטר. בלי צורך לספק פרטי כניסה לאימות בערוץ נפרד. |
|
pageToken |
string הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובה מ-API, הנכסים nextPageToken ו-prevPageToken מזהים דפים אחרים שאפשר לאחזר. |
גוף הבקשה
אין לספק גוף בקשה כשמבצעים קריאה ל-method הזה.
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:
{ "kind": "youtube#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
מאפיינים
בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:
מאפיינים | |
---|---|
kind |
string מזהה את הסוג של משאב ה-API. הערך יהיה youtube#playlistImageListResponse . |
nextPageToken |
string האסימון שיכול לשמש כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות. |
prevPageToken |
string האסימון שיכול לשמש כערך של הפרמטר pageToken לאחזור הדף הקודם בקבוצת התוצאות. |
pageInfo |
object האובייקט pageInfo כולל פרטי חלוקה לדפים של קבוצת התוצאות. |
pageInfo.totalResults |
integer המספר הכולל של התוצאות בקבוצת התוצאות. |
pageInfo.resultsPerPage |
integer מספר התוצאות שכלולות בתגובת ה-API. |
items[] |
list רשימה של תמונות פלייליסט שתואמות לקריטריונים של הבקשה. |