SuperChatEvents

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

• «اَبَر گپ‌ها» با رنگی برجسته می‌شوند.
• Super Chat برای مدت زمان مشخصی در تیکر سنجاق‌شده باقی می‌ماند.

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

روش‌ها

«میانای برنامه‌سازی کاربردی» از روش‌های زیر برای منابع superChatEvents پشتیبانی می‌کند:

فهرست

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

نمایش منبع

ساختار 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 نوع منبع میانای برنامه‌سازی کاربردی را مشخص می‌کند. مقدار youtube#superChatEvent خواهد بود.
etag	etag Etag این منبع.
id	string شناسه‌ای که YouTube برای شناسایی یکتای رویداد «چت مستقیم ویژه» اختصاص می‌دهد.
snippet	object شیء snippet حاوی جزئیات اصلی درباره رویداد Super Chat است.
snippet.channelId	string شناسه کانال YouTube که کانال پخش‌کننده جاری‌سازی زنده مرتبط با رویداد Super Chat را شناسایی می‌کند.
snippet.supporterDetails	object جزئیات مربوط به کانال حامی.
snippet.supporterDetails.channelId	string شناسه کانال YouTube حامی.
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 را ببینید.) در این فهرست، سطحی که کمترین مبلغ خرید را دارد سطح ۱ است، مبلغ بعدی سطح ۲ است، و به همین ترتیب.
snippet.isSuperStickerEvent	boolean نشان می‌دهد که آیا منبع Super Sticker است یا نه، که نوع خاصی از پیام Super Chat است که تصویر مرتبطی دارد. اگر مقدار این فیلد true باشد، فیلد superStickerMetadata حاوی اطلاعاتی خواهد بود که می‌توان از آن برای نمایش تصویر استفاده کرد.
snippet.superStickerMetadata	object جزئیات مربوط به Super Sticker. این شیء فقط درصورتی برگردانده می‌شود که مقدار فیلد snippet.isSuperStickerEvent برابر با true باشد.
snippet.superStickerMetadata.stickerId	string شناسه یکتایی که تصویر برچسب را شناسایی می‌کند. توجه داشته باشید که تصویر فقط به‌عنوان بخشی از پیام Super Sticker نمایش داده می‌شود زمانی که کاربران پنجره گپ را در YouTube مشاهده می‌کنند. اما نشانی وب تصویر ازطریق میانای برنامه‌سازی کاربردی دردسترس نیست. فقط برای مرجع، می‌توانید در این فایل CSV ببینید کدام شناسه‌های برچسب به کدام Super Sticker مربوط می‌شوند.
snippet.superStickerMetadata.altText	string رشته نوشتاری که برچسب را توصیف می‌کند. فیلد snippet.superStickerMetadata.language زبان نوشتار را شناسایی می‌کند. هنگام فراخوانی روش superChatEvents.list، مقدار پارامتر hl را روی زبان موردنظر برای نوشتار تنظیم کنید.
snippet.superStickerMetadata.language	string زبان مقدار خصوصیت snippet.superStickerMetadata.altText. اگر Super Sticker نوشتاری را نیز نمایش دهد، آن نوشتار هم به این زبان است.