FanFundingEvents: list

توجه: این یک اعلامیه منسوخ شدن است.

ویژگی Fan Funding منسوخ شده است و Fan Funding API در 28 فوریه 2017 خاموش خواهد شد. این اعلامیه لغو همزمان با انتشار ویژگی جدید Super Chat YouTube است.

رویدادهای تأمین مالی طرفداران را برای یک کانال فهرست می کند. درخواست API باید توسط مالک کانال مجاز باشد.

درخواست

درخواست HTTP

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

مجوز

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

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

مولفه های

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

مولفه های
پارامترهای مورد نیاز
part string
پارامتر part بخش‌های منبع fanFundingEvent را مشخص می‌کند که پاسخ API شامل آن خواهد شد. مقادیر پشتیبانی شده id و snippet هستند.
پارامترهای اختیاری
hl string
پارامتر hl به API دستور می دهد تا یک رشته نمایش ارز محلی برای یک زبان برنامه خاص که وب سایت YouTube از آن پشتیبانی می کند، بازیابی کند. به عنوان مثال، در زبان انگلیسی، ارز به صورت $1.50 نمایش داده می شود، اما در زبان فرانسوی، به صورت 1,50$ نمایش داده می شود.

مقدار پارامتر باید کد زبانی باشد که در لیستی که با روش i18nLanguages.list برگردانده شده است.
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند. مقادیر قابل قبول شامل 0 تا 50 است. مقدار پیش فرض 5 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که از سرور API خواسته می شود آن را برگرداند. در یک پاسخ API، ویژگی nextPageToken صفحه بعدی نتایج را برای درخواست مشخص می کند.

درخواست بدن

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

واکنش

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

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

خواص

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

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

خطاها

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

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

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

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