SuperChatEvents: list

رویدادهای Super Chat را از جریان‌های زنده یک کانال در 30 روز گذشته فهرست کنید.

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

درخواست کنید

درخواست HTTP 

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

مجوز

این درخواست نیاز به مجوز با حداقل یکی از حوزه های زیر دارد. برای مطالعه بیشتر درباره احراز هویت و مجوز، به اجرای احراز هویت OAuth 2.0 مراجعه کنید.

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

پارامترها

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

پارامترها
پارامترهای مورد نیاز
part string
پارامتر part بخش‌های منبع superChatEvent را که پاسخ API شامل می‌شود، مشخص می‌کند. مقادیر پشتیبانی شده id و snippet هستند.
پارامترهای اختیاری
hl string
پارامتر hl به سرور API دستور می دهد تا مقدار ویژگی snippet.displayString را که مقدار خرید و ارز یک Super Chat را مطابق با قراردادهای یک زبان خاص نشان می دهد، فرمت کند. مقدار پارامتر باید کد زبانی باشد که در لیستی که با روش i18nLanguages.list برگردانده شده است. مقدار پیش‌فرض en است، به این معنی که رفتار پیش‌فرض قالب‌بندی رشته‌های نمایشی است که در زبان انگلیسی استفاده می‌شوند. به عنوان مثال، به طور پیش فرض، یک رشته به جای $1.00 به صورت $1,00 قالب بندی می شود.
maxResults unsigned integer
پارامتر maxResults حداکثر تعداد مواردی را که باید در مجموعه نتایج برگردانده شوند را مشخص می کند. مقادیر قابل قبول شامل 1 تا 50 است. مقدار پیش فرض 5 است.
pageToken string
پارامتر pageToken صفحه خاصی را در مجموعه نتایج مشخص می کند که باید برگردانده شود. در یک پاسخ API، ویژگی های nextPageToken و prevPageToken صفحات دیگری را شناسایی می کنند که می توانند بازیابی شوند.

درخواست بدن

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

پاسخ

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

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

خواص

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

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

خطاها

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

نوع خطا جزئیات خطا توضیحات
forbidden (403) insufficientPermissions درخواست به درستی برای بازیابی رویدادهای Super Chat مجاز نیست.

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

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