PlaylistImages: list

הפונקציה מחזירה אוסף של תמונות של פלייליסטים שתואמות לפרמטרים של בקשת ה-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

הפרמטר part מציין רשימה מופרדת בפסיקים של מאפיין משאב playlistImage אחד או יותר שייכללו בתגובת ה-API.

אם הפרמטר מזהה מאפיין שמכיל מאפייני צאצא, מאפייני הצאצא ייכללו בתגובה.
מסננים (צריך לציין בדיוק אחד מהפרמטרים הבאים)
id string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהה תמונה ייחודי אחד או יותר של פלייליסט.
playlistId string
הפרמטר playlistId מציין את המזהה הייחודי של הפלייליסט שעבורו רוצים לאחזר תמונות. שימו לב: למרות שזה פרמטר אופציונלי, בכל בקשה לאחזור תמונות של פלייליסטים צריך לציין ערך לפרמטר id או לפרמטר playlistId.
פרמטרים אופציונליים
maxResults ‫unsigned integer
הפרמטר maxResults מציין את המספר המקסימלי של תמונות שיוחזרו בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50, כולל. ערך ברירת המחדל הוא 5.
onBehalfOfContentOwner string
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube.

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

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

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

גוף הבקשה

כשקוראים לשיטה הזו, לא צריך לספק גוף בקשה.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

{
          "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
רשימה של תמונות לפלייליסט שתואמות לקריטריונים של הבקשה.