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 نشان می‌دهد که اطلاعات کاربری مجوز درخواست، کاربر CMS YouTube را شناسایی می‌کند که از طرف مالک محتوای مشخص‌شده در مقدار پارامتر عمل می‌کند. این پارامتر برای شرکای محتوای YouTube است که مالک و مدیر کانال‌های مختلف YouTube هستند. این ویژگی به مالکان محتوا امکان می‌دهد یک‌بار اصالت‌سنجی کنند و به تمام داده‌های ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال جداگانه اطلاعات اصالت‌سنجی ارائه دهند. حساب CMS که کاربر با آن اصالت‌سنجی می‌کند باید به مالک محتوای YouTube مشخص‌شده پیوند داده شده باشد.
onBehalfOfContentOwnerChannel string
از این پارامتر فقط می‌توان در درخواست مجاز مناسب استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است.

پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را مشخص می‌کند که ویدیو به آن اضافه می‌شود. این پارامتر زمانی لازم است که درخواستی مقداری را برای پارامتر onBehalfOfContentOwner مشخص کند و فقط می‌تواند در ارتباط با آن پارامتر استفاده شود. علاوه‌براین، درخواست باید بااستفاده از حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می‌کند پیوند داده شده است، مجاز شود. درنهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص می‌کند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می‌کند پیوند داده شود.

این پارامتر برای شرکای محتوای YouTube درنظر گرفته شده است که مالک و مدیر بسیاری از کانال‌های YouTube مختلف هستند. این پارامتر به مالکان محتوا امکان می‌دهد یک‌بار اصالت‌سنجی کنند و ازطرف کانال مشخص‌شده در مقدار پارامتر، کنش‌هایی را انجام دهند، بدون اینکه نیاز باشد برای هر کانال جداگانه اعتبارنامه‌های اصالت‌سنجی ارائه دهند.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج شناسایی می‌کند که باید برگردانده شود. در پاسخ میانای برنامه‌سازی کاربردی، ویژگی‌های nextPageToken و prevPageToken صفحه‌های دیگری را که می‌توان بازیابی کرد شناسایی می‌کنند.

متن درخواست

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

پاسخ

درصورت موفقیت‌آمیز بودن، این روش بدنه پاسخی با ساختار زیر برمی‌گرداند:

{
          "kind": "youtube#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

مشخصات

جدول زیر خصوصیات نشان‌داده‌شده در این منبع را تعریف می‌کند:

مشخصات
kind string
نوع منبع میانای برنامه‌سازی کاربردی را مشخص می‌کند. مقدار youtube#playlistImageListResponse خواهد بود.
nextPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.
prevPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه قبلی در مجموعه نتایج استفاده شود.
pageInfo object
شیء pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله‌سازی می‌کند.
pageInfo.totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo.resultsPerPage integer
تعداد نتایج موجود در پاسخ میانای برنامه‌سازی کاربردی.
items[] list
فهرستی از تصاویر فهرست پخش که با معیارهای درخواست مطابقت دارند.