این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

SuperChatEvents

منبع superChatEvent نشان دهنده پیام Super Chat است که توسط یکی از طرفداران در جریان پخش زنده YouTube خریداری شده است. در جریان چت زنده YouTube، Super Chats از دو جهت از پیام‌های دیگر متمایز است:

سوپر چت ها با یک رنگ برجسته می شوند.
Super Chat برای مدت زمان معینی در تیک تیک پین می ماند.

رنگ Super Chat، مدت زمانی که پین می‌شود و حداکثر طول پیام، همگی با مقدار خرید تعیین می‌شوند. برای کسب اطلاعات بیشتر درباره Super Chats، به مرکز راهنمایی YouTube مراجعه کنید.

مواد و روش ها

API از روش های زیر برای منابع superChatEvents پشتیبانی می کند:

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

نمایندگی منابع

ساختار JSON زیر فرمت یک منبع superChatEvent را نشان می دهد:

{
  "kind": "youtube#superChatEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string,
    "messageType": unsigned integer,
    "isSuperStickerEvent": boolean,
    "superStickerMetadata": {
      "stickerId": string,
      "altText": string,
      "language": string
    }
  }
}

خواص

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

خواص
`kind`	`string` نوع منبع API را مشخص می کند. مقدار `youtube#superChatEvent` خواهد بود.
`etag`	`etag` Etag این منبع
`id`	`string` شناسه ای که YouTube برای شناسایی منحصر به فرد رویداد Super Chat اختصاص می دهد.
`snippet`	`object` شی `snippet` حاوی جزئیات اساسی در مورد رویداد Super Chat است.
`snippet. channelId`	`string` شناسه کانال YouTube که کانالی را که پخش جریانی زنده مرتبط با رویداد Super Chat را پخش می‌کند، مشخص می‌کند.
`snippet. supporterDetails`	`object` جزئیات کانال حامی
`snippet.supporterDetails. channelId`	`string` شناسه کانال یوتیوب حامی.
`snippet.supporterDetails. channelUrl`	`string` آدرس کانال حامی
`snippet.supporterDetails. displayName`	`string` نام نمایشی کانال حامی
`snippet.supporterDetails. profileImageUrl`	`string` نشانی وب آواتار برای کانال حامی.
`snippet. commentText`	`string` محتوای متن نظر حامی.
`snippet. createdAt`	`datetime` تاریخ و زمانی که Super Chat خریداری شد. مقدار در قالب ISO 8601 ( `YYYY-MM-DDThh:mm:ss.sZ` ) مشخص شده است.
`snippet. amountMicros`	`unsigned long` مبلغ خرید، بر حسب میکرو ارز خرید. به عنوان مثال، اگر مبلغ خرید یک دلار باشد، ارزش دارایی `snippet.amountMicros` `1000000` است.
`snippet. currency`	`string` ارزی که خرید با آن انجام شده است. مقدار یک کد ارز ISO 4217 است.
`snippet. displayString`	`string` رشته ای مانند `$1.00` که مقدار خرید و ارز را نشان می دهد. رشته نمایش بر اساس قراردادهای زبان مشخص شده توسط پارامتر درخواست `hl` فرمت می شود. به‌طور پیش‌فرض، رشته‌های نمایشی به شکل انگلیسی فرمت می‌شوند. به عنوان مثال، به طور پیش فرض، یک رشته به جای `$1.00` به صورت `$1,00` قالب بندی می شود.
`snippet. messageType`	`unsigned integer` ردیف برای پیام پولی. توجه داشته باشید که وقتی یک منبع `liveChatMessage` پیام Super Chat را شناسایی می‌کند، ویژگی `snippet.superChatDetails.tier` حاوی این مقدار است. این ردیف بر اساس مقدار پولی است که برای خرید پیام صرف شده است. همچنین رنگ مورد استفاده برای برجسته کردن پیام در رابط کاربری چت زنده، حداکثر طول پیام، و مدت زمانی که پیام پین می‌شود را تعیین می‌کند. سطوح Super Chat در مرکز راهنمای YouTube مستند شده است. (به بخش قابل ارتقا درباره جزئیات خرید Super Chat مراجعه کنید.) در آن لیست، ردیفی که کمترین مقدار خرید را دارد، ردیف 1، کمترین مقدار بعدی، ردیف 2 و غیره است.
`snippet. isSuperStickerEvent`	`boolean` نشان می دهد که آیا منبع یک Super Sticker است یا خیر، که نوع خاصی از پیام Super Chat است که دارای یک تصویر مرتبط است. اگر مقدار این فیلد `true` باشد، فیلد `superStickerMetadata` حاوی اطلاعاتی است که می‌توان از آن برای نمایش تصویر استفاده کرد.
`snippet. superStickerMetadata`	`object` جزئیات در مورد Super Sticker. این شی تنها در صورتی برگردانده می شود که مقدار فیلد `snippet.isSuperStickerEvent` `true` باشد.
`snippet.superStickerMetadata. stickerId`	`string` یک شناسه منحصر به فرد که تصویر برچسب را مشخص می کند. توجه داشته باشید که زمانی که کاربران پنجره چت را در یوتیوب مشاهده می کنند، تصویر تنها به عنوان بخشی از پیام Super Sticker نمایش داده می شود. با این حال، URL تصویر از طریق API در دسترس نیست. فقط برای مرجع، می‌توانید شناسه‌های برچسب مربوط به کدام Super Sticker را در این فایل CSV بیابید.
`snippet.superStickerMetadata. altText`	`string` یک رشته متنی که برچسب را توصیف می کند. فیلد `snippet.superStickerMetadata.language` زبان متن را مشخص می کند. هنگام فراخوانی متد `superChatEvents.list` ، مقدار پارامتر hl را روی زبان دلخواه متن تنظیم کنید.
`snippet.superStickerMetadata. language`	`string` زبان مقدار ویژگی `snippet.superStickerMetadata.altText` . اگر Super Sticker نیز متنی را نمایش می‌دهد، آن متن نیز به این زبان است.