Sponsors: list

توجه: این روش از 31 مارس 2020 منسوخ شده است. با روش members.list جایگزین شده است. می‌توانید اطلاعات مربوط به آن روش را در مستندات YouTube Data API بیابید.

روش sponsors.list دیگر در 30 سپتامبر 2020 یا پس از آن پشتیبانی نخواهد شد. مشتریان API باید تماس‌ها را به روش sponsors.list به‌روزرسانی کنند تا از روش members.list استفاده کنند.

فهرست اعضا (که قبلا به عنوان "حامیان مالی" شناخته می شد) برای یک کانال. درخواست API باید توسط مالک کانال مجاز باشد.

موارد استفاده رایج

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/sponsors

مجوز

این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).

محدوده
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

مولفه های

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

مولفه های
پارامترهای مورد نیاز
part string
پارامتر part قسمت های منبع sponsor را مشخص می کند که پاسخ API شامل آن خواهد شد. مقادیر پشتیبانی شده id و snippet هستند.
پارامترهای اختیاری
filter string
پارامتر filter مشخص می کند که کدام کانال حامی مالی را بازگرداند. مقدار پیش فرض newest است.

مقادیر قابل قبول عبارتند از:
  • all - همه حامیان مالی، از جدیدترین تا قدیمی‌ترین را برگردانید.
  • newest - یک صفحه از جدیدترین حامیان مالی را برگردانید. درخواست‌های بعدی با استفاده از nextPageToken ، مشترکین جدیدتر را هنگام ثبت‌نام بازیابی می‌کنند.
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند. مقادیر قابل قبول شامل 0 تا 50 است. مقدار پیش فرض 5 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. در یک پاسخ API، ویژگی های nextPageToken و prevPageToken صفحات دیگری را شناسایی می کنند که می توانند بازیابی شوند.

درخواست بدن

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

واکنش

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

{
  "kind": "youtube#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor resource
  ]
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

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

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
forbidden (403) insufficientPermissions شما مجوزهای لازم برای مشاهده حامیان کانال را ندارید.
invalidValue (400) invalidValueInRequest درخواست حاوی یک مقدار نامعتبر است.
invalidValue (400) sponsorshipNotEnabledForChannelId کانال حمایت های مالی را فعال نمی کند.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.