LiveChatMessages

liveChatMessageทรัพยากรแสดงถึงข้อความแชทในแชทสดของ YouTube แหล่งข้อมูลนี้อาจมีรายละเอียดเกี่ยวกับข้อความหลายประเภท รวมถึงข้อความที่เพิ่งโพสต์หรือการให้เงินสนับสนุนของแฟนๆ

ระบบจะเปิดใช้ฟีเจอร์แชทสดโดยค่าเริ่มต้นสำหรับการถ่ายทอดสด และจะพร้อมใช้งานในขณะที่ถ่ายทอดสดกำลังดำเนินอยู่ (หลังจากกิจกรรมจบลง แชทสดสำหรับกิจกรรมนั้นจะใช้งานไม่ได้อีกต่อไป)

เมธอด

API รองรับวิธีการต่อไปนี้สำหรับทรัพยากร liveChatMessages

list
แสดงรายการข้อความแชทสดของแชทที่เฉพาะเจาะจง ลองใช้เลย
streamList
เปิดใช้การเชื่อมต่อการสตรีมเซิร์ฟเวอร์เพื่อรับข้อความแชทสดสำหรับแชทที่เฉพาะเจาะจงโดยมีความหน่วงต่ำ ลองใช้เลย
แทรก
เพิ่มข้อความหรือแบบสำรวจลงในแชทสด ลองใช้เลย
transition
เปลี่ยนสถานะของข้อความที่ใช้แสดงอยู่ ลองใช้เลย
ลบ
ลบข้อความแชท คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่องหรือผู้ดูแลแชทสด ลองใช้เลย

การแสดงทรัพยากร

โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบของทรัพยากร liveChatMessages

{
  "kind": "youtube#liveChatMessage",
  "etag": etag,
  "id": string,
  "snippet": {
    "type": string,
    "liveChatId": string,
    "authorChannelId": string,
    "publishedAt": datetime,
    "hasDisplayContent": boolean,
    "displayMessage": string,
    "fanFundingEventDetails": {
      "amountMicros": unsigned long,
      "currency": string,
      "amountDisplayString": string,
      "userComment": string
    },
    "textMessageDetails": {
      "messageText": string
    },
    "userBannedDetails": {
      "bannedUserDetails": {
        "channelId": string,
        "channelUrl": string,
        "displayName": string,
        "profileImageUrl": string
      },
      "banType": string,
      "banDurationSeconds": unsigned long
    },
    "memberMilestoneChatDetails": {
      "userComment": string,
      "memberMonth": unsigned integer,
      "memberLevelName": string
    },
    "newSponsorDetails": {
      "memberLevelName": string,
      "isUpgrade": bool
    },
    "superChatDetails": {
      "amountMicros": unsigned long,
      "currency": string,
      "amountDisplayString": string,
      "userComment": string,
      "tier": unsigned integer
    },
    "superStickerDetails": {
      "superStickerMetadata": {
        "stickerId": string,
        "altText": string,
        "language": string
      },
      "amountMicros": unsigned long,
      "currency": string,
      "amountDisplayString": string,
      "tier": unsigned integer
    },
    "pollDetails": {
      "metadata": {
        "options": {
          "optionText": string,
          "tally": string,
        },
        "questionText": string,
        "status": enum
      },
    },
    "membershipGiftingDetails": {
      "giftMembershipsCount": integer,
      "giftMembershipsLevelName": string
    },
    "giftMembershipReceivedDetails": {
      "memberLevelName": string,
      "gifterChannelId": string,
      "associatedMembershipGiftingMessageId": string
    },
    "giftEventDetails": {
      "giftMetadata": {
        "jewelsAmount": integer,
        "giftName": string,
        "giftUrl": string,
        "giftDuration": object,
        "seconds": integer,
        "nanos": integer,
        "hasVisualEffect": boolean,
        "comboCount": integer,
        "altText": string,
        "language": string
      },
    },
  },
  "authorDetails": {
    "channelId": string,
    "channelUrl": string,
    "displayName": string,
    "profileImageUrl": string,
    "isVerified": boolean,
    "isChatOwner": boolean,
    "isChatSponsor": boolean,
    "isChatModerator": boolean
  },
}

พร็อพเพอร์ตี้

ตารางต่อไปนี้กำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#liveChatMessage
etag etag
Etag ของทรัพยากรนี้
id string
รหัสที่ YouTube กำหนดเพื่อระบุข้อความที่ไม่ซ้ำกัน
หมายเหตุ: สำหรับ giftEvents อาจมีการนำรหัสเดิมมาใช้ซ้ำเพื่ออัปเดตจำนวนคอมโบ
snippet object
ออบเจ็กต์ snippet มีรายละเอียดหลักเกี่ยวกับข้อความในแชท
snippet.type string
ประเภทของข้อความ พร็อพเพอร์ตี้นี้จะแสดงเสมอ และค่าของพร็อพเพอร์ตี้นี้จะกำหนดว่าฟิลด์ใดจะแสดงในทรัพยากร

ค่าที่ใช้ได้สำหรับพร็อพเพอร์ตี้นี้มีดังนี้
  • chatEndedEvent - แชทสิ้นสุดแล้วและไม่สามารถแทรกข้อความหลังจากข้อความนี้ได้ ซึ่งจะเกิดขึ้นโดยอัตโนมัติหลังจากที่การออกอากาศสิ้นสุดลง ระบบจะไม่ส่งข้อความประเภทนี้สำหรับแชทสดในการออกอากาศเริ่มต้นของช่อง
  • sponsorOnlyModeEndedEvent – แชทไม่ได้อยู่ในโหมดสำหรับผู้สนับสนุนเท่านั้นอีกต่อไป ซึ่งหมายความว่าตอนนี้ผู้ใช้ที่ไม่ได้เป็นผู้สนับสนุนจะส่งข้อความได้แล้ว กิจกรรมนี้ไม่มีเนื้อหาที่แสดง
  • sponsorOnlyModeStartedEvent – แชทเข้าสู่โหมดสำหรับผู้สนับสนุนโดยเฉพาะ ซึ่งหมายความว่าจะมีเพียงผู้สนับสนุนเท่านั้นที่ส่งข้อความได้ กิจกรรมนี้ไม่มีเนื้อหาที่แสดง
  • newSponsorEvent – ผู้ใช้ใหม่ได้สปอนเซอร์ช่องที่เป็นเจ้าของแชทสด author จะมีรายละเอียดของผู้สนับสนุนรายใหม่
  • memberMilestoneChatEvent – ผู้ใช้ส่งข้อความแชทสุดพิเศษสำหรับสมาชิก
  • superChatEvent - ผู้ใช้ซื้อ Super Chat
  • superStickerEvent – ผู้ใช้ซื้อ Super Stickers
  • textMessageEvent - ผู้ใช้ส่งข้อความ
  • tombstone - เครื่องหมายหลุมศพแสดงว่าเคยมีข้อความที่มีรหัสและเวลาเผยแพร่นี้ แต่ถูกลบไปแล้ว ระบบจะไม่ส่งข้อความนี้เมื่อลบข้อความ แต่จะแสดงเพื่อระบุตำแหน่งที่ข้อความเคยอยู่ก่อนที่จะถูกลบ มีเพียงฟิลด์ snippet.liveChatId, snippet.type และ snippet.publishedAt เท่านั้นที่อยู่ในข้อความประเภทนี้
  • userBannedEvent – โมเดอเรเตอร์แบนผู้ใช้ ฟิลด์ author มีรายละเอียดของผู้ดูแล
  • membershipGiftingEvent – ผู้ใช้ซื้อแพ็กเกจสมาชิกให้แก่ผู้ชมรายอื่น
  • giftMembershipReceivedEvent - ผู้ใช้ได้รับแพ็กเกจสมาชิกแบบของขวัญ
  • pollDetails - ผู้ใช้สร้างแบบสำรวจสด
  • giftEvent - ผู้ใช้แลกอัญมณีเป็นของขวัญ
snippet.liveChatId string
รหัสที่ระบุแชทสดที่ไม่ซ้ำกันซึ่งเชื่อมโยงกับข้อความ ระบบจะแสดงรหัสแชทสดที่เชื่อมโยงกับการออกอากาศในพร็อพเพอร์ตี้ snippet.liveChatId ของทรัพยากร liveBroadcast
snippet.authorChannelId string
รหัสของผู้ใช้ที่เขียนข้อความ ระบบจะกรอกข้อมูลในช่องนี้สำหรับข้อความประเภทต่อไปนี้เท่านั้น
  • หากประเภทข้อความเป็น textMessageEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ใช้ที่เขียนข้อความ
  • หากประเภทข้อความเป็น fanFundingEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ใช้ที่ให้เงินสนับสนุนการออกอากาศ
  • หากประเภทข้อความเป็น newSponsorEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ใช้ที่เพิ่งเป็นสปอนเซอร์
  • หากประเภทข้อความเป็น memberMilestoneChatEvent ค่าพร็อพเพอร์ตี้จะระบุสมาชิกที่ส่งข้อความ
  • หากประเภทข้อความเป็น userBannedEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ดูแลที่แบนผู้ใช้
  • หากประเภทข้อความเป็น membershipGiftingEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ใช้ที่ซื้อการให้ของขวัญเป็นสมาชิก
  • หากประเภทข้อความเป็น giftMembershipReceivedEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ใช้ที่ได้รับแพ็กเกจสมาชิกแบบของขวัญ
  • หากประเภทข้อความเป็น pollEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ใช้ที่สร้างโพลสด
  • หากประเภทข้อความเป็น giftEvent ค่าพร็อพเพอร์ตี้จะระบุผู้ใช้ที่ส่งของขวัญ
snippet.publishedAt datetime
วันที่และเวลาที่เผยแพร่ข้อความครั้งแรก โดยค่าจะระบุในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ)
snippet.hasDisplayContent boolean
ระบุว่าข้อความมีเนื้อหาที่ควรแสดงต่อผู้ใช้หรือไม่
snippet.displayMessage string
มีสตริงที่แสดงต่อผู้ใช้ ช่องนี้จะไม่แสดงหากประเภทข้อความเป็น chatEndedEvent หรือ tombstone
snippet.fanFundingEventDetails object
หมายเหตุ: เราเลิกใช้งานออบเจ็กต์นี้และพร็อพเพอร์ตี้ย่อยแล้ว ตั้งแต่วันที่ 28 กุมภาพันธ์ 2017 เป็นต้นไป liveChatMessageทรัพยากรจะไม่แสดงรายละเอียดสำหรับเหตุการณ์การให้เงินสนับสนุนของแฟนๆ อีกต่อไป

ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับเหตุการณ์การให้เงินสนับสนุน โดยจะปรากฏเฉพาะเมื่อประเภทข้อความเป็น fanFundingEvent
snippet.fanFundingEventDetails.amountMicros unsigned long
หมายเหตุ: เราเลิกใช้งานพร็อพเพอร์ตี้นี้แล้ว

จำนวนเงินของกองทุน
snippet.fanFundingEventDetails.currency string
หมายเหตุ: เราเลิกใช้งานพร็อพเพอร์ตี้นี้แล้ว

สกุลเงินที่ใช้ในการชำระเงิน
snippet.fanFundingEventDetails.amountDisplayString string
หมายเหตุ: ระบบเลิกใช้งานพร็อพเพอร์ตี้นี้แล้ว

สตริงที่แสดงซึ่งแสดงจำนวนเงินและสกุลเงินของกองทุนต่อผู้ใช้
snippet.fanFundingEventDetails.userComment string
หมายเหตุ: พร็อพเพอร์ตี้นี้เลิกใช้งานแล้ว

ความคิดเห็นที่ผู้ใช้เพิ่มลงในกิจกรรมการให้เงินสนับสนุนของแฟนๆ นี้
snippet.textMessageDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับข้อความ โดยจะปรากฏขึ้นเมื่อประเภทข้อความเป็น textMessageEvent เท่านั้น
snippet.textMessageDetails.messageText string
ข้อความของผู้ใช้
snippet.userBannedDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับผู้ใช้ที่ถูกแบนจากแชท รวมถึงมีรายละเอียดเกี่ยวกับการแบนด้วย คุณแบนผู้ใช้จากแชทได้แบบถาวรหรือชั่วคราว
snippet.userBannedDetails.bannedUserDetails object
ออบเจ็กต์นี้มีข้อมูลเกี่ยวกับผู้ใช้ที่ถูกแบน
snippet.userBannedDetails.bannedUserDetails.channelId string
รหัสช่อง YouTube ของผู้ใช้ที่ถูกแบน
snippet.userBannedDetails.bannedUserDetails.channelUrl string
URL ของช่อง YouTube ของผู้ใช้ที่ถูกแบน
snippet.userBannedDetails.bannedUserDetails.displayName string
ชื่อที่แสดงของช่อง YouTube ของผู้ใช้ที่ถูกแบน
snippet.userBannedDetails.bannedUserDetails.profileImageUrl string
รูปโปรไฟล์ของช่อง YouTube ของผู้ใช้ที่ถูกแบน
snippet.userBannedDetails.banType string
ประเภทของการแบน ค่าที่ใช้ได้สำหรับพร็อพเพอร์ตี้นี้มีดังนี้
  • ถาวร
  • ชั่วคราว
snippet.userBannedDetails.banDurationSeconds unsigned long
ระยะเวลาการแบน พร็อพเพอร์ตี้นี้จะแสดงก็ต่อเมื่อค่าพร็อพเพอร์ตี้ snippet.userBannedDetails.banType เป็น temporary
snippet.memberMilestoneChatDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับเหตุการณ์เป้าหมายสำหรับสมาชิก โดยจะปรากฏขึ้นเมื่อประเภทข้อความเป็น memberMilestoneChatEvent เท่านั้น
snippet.memberMilestoneChatDetails.userComment string
ความคิดเห็นที่สมาชิกเพิ่มลงในข้อความแชทสุดพิเศษสำหรับสมาชิกนี้ ช่องนี้จะเว้นว่างไว้สำหรับข้อความที่ไม่มีความคิดเห็นจากสมาชิก
snippet.memberMilestoneChatDetails.memberMonth unsigned integer
จำนวนเดือนทั้งหมด (ปัดขึ้น) ที่ผู้ชมเป็นสมาชิกซึ่งทำให้ผู้ชมได้รับข้อความแชทสุดพิเศษสำหรับสมาชิกนี้ ซึ่งเป็นจำนวนเดือนเท่ากับที่แสดงต่อผู้ใช้ YouTube
snippet.memberMilestoneChatDetails.memberLevelName string
ชื่อระดับที่ผู้ชมเป็นสมาชิก ชื่อระดับจะกำหนดโดยช่อง YouTube ที่เสนอการเป็นสมาชิก ในบางกรณี ระบบจะไม่กรอกข้อมูลในช่องนี้
snippet.newSponsorDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับกิจกรรมการประกาศสมาชิกใหม่ ระบบจะตั้งค่านี้ก็ต่อเมื่อประเภทเป็น newSponsorEvent เท่านั้น "สมาชิก" คือคำที่ใช้เรียก "ผู้สนับสนุน"
snippet.newSponsorDetails.memberLevelName string
ชื่อระดับที่ผู้ชมเป็นสมาชิก ชื่อระดับจะกำหนดโดยช่อง YouTube ที่เสนอการเป็นสมาชิก ในบางกรณี ระบบจะไม่กรอกข้อมูลในช่องนี้
snippet.newSponsorDetails.isUpgrade bool
ระบุว่าผู้ชมเพิ่งอัปเกรดจากระดับที่ต่ำกว่าหรือไม่ สำหรับผู้ชมที่ไม่ได้เป็นสมาชิกในขณะที่ซื้อ ค่าฟิลด์จะเป็น false
snippet.superChatDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับเหตุการณ์ Super Chat โดยจะปรากฏขึ้นเมื่อประเภทข้อความเป็น superChatEvent เท่านั้น
snippet.superChatDetails.amountMicros unsigned long
ยอดรวมการซื้อในหน่วยไมโครของสกุลเงินที่ซื้อ เช่น หากยอดรวมการซื้อคือ 1 ดอลลาร์ ค่าพร็อพเพอร์ตี้ snippet.amountMicros จะเป็น 1000000
snippet.superChatDetails.currency string
สกุลเงินที่ใช้ในการซื้อ ค่านี้คือรหัสสกุลเงิน ISO 4217
snippet.superChatDetails.amountDisplayString string
สตริง เช่น $1.00 ที่มีจำนวนเงินและสกุลเงินของการซื้อ สตริงนี้มีไว้เพื่อแสดงต่อผู้ใช้
snippet.superChatDetails.userComment string
ความคิดเห็นที่ผู้ใช้เพิ่มลงในเหตุการณ์ Super Chat นี้
snippet.superChatDetails.tier unsigned integer
ระดับของข้อความแบบชำระเงิน โปรดทราบว่าในทรัพยากร superChatEvent พร็อพเพอร์ตี้ snippet.messageType จะมีค่านี้

ระดับจะอิงตามจำนวนเงินที่ใช้ในการซื้อข้อความ นอกจากนี้ ยังกำหนดสีที่ใช้ไฮไลต์ข้อความใน UI ของแชทสด ความยาวสูงสุดของข้อความ และระยะเวลาที่ข้อความจะปักหมุดไว้ในทิกเกอร์

คุณดูระดับของ Super Chat ได้ในศูนย์ช่วยเหลือของ YouTube (ดูส่วนที่ขยายได้เกี่ยวกับรายละเอียดการซื้อ Super Chat) ในรายการนั้น ระดับที่มีจำนวนการซื้อต่ำสุดคือระดับที่ 1 ระดับที่มีจำนวนการซื้อต่ำสุดถัดไปคือระดับที่ 2 และอื่นๆ
snippet.superStickerDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับกิจกรรม Super Sticker โดยจะปรากฏขึ้นเมื่อประเภทข้อความเป็น superStickerEvent เท่านั้น
snippet.superStickerDetails.superStickerMetadata object
รายละเอียดเกี่ยวกับ Super Stickers
snippet.superStickerDetails.superStickerMetadata.stickerId string
รหัสที่ไม่ซ้ำกันซึ่งระบุรูปภาพสติกเกอร์ โปรดทราบว่ารูปภาพจะแสดงเป็นส่วนหนึ่งของข้อความ Super Stickers เท่านั้นเมื่อผู้ใช้ดูหน้าต่างแชทบน YouTube อย่างไรก็ตาม คุณจะใช้ API เพื่อดู URL ของรูปภาพไม่ได้ คุณสามารถดูว่ารหัสสติกเกอร์ใดเกี่ยวข้องกับ Super Stickers ใดได้ในไฟล์ CSV นี้เพื่อใช้อ้างอิงเท่านั้น
snippet.superStickerDetails.superStickerMetadata.altText string
สตริงข้อความที่อธิบายสติกเกอร์ snippet.superStickerDetails.superStickerMetadata.language ฟิลด์จะระบุภาษาของข้อความ เมื่อเรียกใช้เมธอด liveChatMessages.list ให้ตั้งค่าพารามิเตอร์ hl เป็นภาษาที่เลือกสำหรับข้อความ
snippet.superStickerDetails.superStickerMetadata.language string
ภาษาของค่าพร็อพเพอร์ตี้ snippet.superStickerDetails.superStickerMetadata.altText
snippet.superStickerDetails.amountMicros unsigned long
ยอดรวมการซื้อในหน่วยไมโครของสกุลเงินที่ซื้อ เช่น หากยอดรวมการซื้อคือ 1 ดอลลาร์ ค่าพร็อพเพอร์ตี้ snippet.amountMicros จะเป็น 1000000
snippet.superStickerDetails.currency string
สกุลเงินที่ใช้ในการซื้อ ค่านี้คือรหัสสกุลเงิน ISO 4217
snippet.superStickerDetails.amountDisplayString string
สตริง เช่น $1.00 ที่มีจำนวนเงินและสกุลเงินของการซื้อ สตริงนี้มีไว้เพื่อแสดงต่อผู้ใช้
snippet.superStickerDetails.tier unsigned integer
ระดับของข้อความแบบชำระเงิน โปรดทราบว่าในทรัพยากร superChatEvent พร็อพเพอร์ตี้ snippet.messageType จะมีค่านี้

ระดับจะอิงตามจำนวนเงินที่ใช้ในการซื้อข้อความ นอกจากนี้ ยังกำหนดสีที่ใช้ไฮไลต์ข้อความใน UI ของแชทสด ความยาวสูงสุดของข้อความ และระยะเวลาที่ข้อความจะปักหมุดอยู่ในทิกเกอร์

คุณสามารถดูข้อมูลเกี่ยวกับระดับของ Super Chat ซึ่งรวมถึง Super Stickers ได้ในศูนย์ช่วยเหลือของ YouTube (ดูส่วนที่ขยายได้เกี่ยวกับรายละเอียดการซื้อ Super Chat) ในรายการนั้น ระดับที่มีจำนวนการซื้อต่ำสุดคือระดับที่ 1 ระดับที่มีจำนวนการซื้อต่ำสุดถัดไปคือระดับที่ 2 และอื่นๆ
snippet.pollDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับเหตุการณ์การสำรวจ โดยจะปรากฏขึ้นเมื่อประเภทข้อความเป็น pollEvent เท่านั้น
snippet.pollDetails.metadata object
รายละเอียดเกี่ยวกับเหตุการณ์แบบสำรวจ
snippet.pollDetails.metadata.options object
ตัวเลือกในแบบสำรวจสด
snippet.pollDetails.metadata.options.optionText string
ข้อความของตัวเลือกโพลแบบสด
snippet.pollDetails.metadata.options.tally string
ผลรวมของตัวเลือกโพลสด การนับคะแนนจะแสดงก็ต่อเมื่อเจ้าของช่องให้สิทธิ์คำขอ API
snippet.pollDetails.metadata.questionText string
ข้อความของคำถามในโพลแบบเรียลไทม์
snippet.pollDetails.metadata.status enum
สถานะของกิจกรรมโพลแบบเรียลไทม์ ค่าที่ใช้ได้สำหรับพร็อพเพอร์ตี้นี้มีดังนี้
  • unknown
  • active
  • closed
snippet.membershipGiftingDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับกิจกรรมการซื้อแพ็กเกจสมาชิกแบบของขวัญ โดยจะแสดงเฉพาะในกรณีที่ message type เป็น membershipGiftingEvent
snippet.membershipGiftingDetails.giftMembershipsCount integer
จำนวนการเป็นสมาชิกแบบของขวัญที่ผู้ใช้ซื้อ
snippet.membershipGiftingDetails.giftMembershipsLevelName string
ชื่อระดับการเป็นสมาชิกแบบของขวัญที่ผู้ใช้ซื้อ ชื่อระดับจะกำหนดโดยช่อง YouTube ที่เสนอการเป็นสมาชิก ในบางกรณี ระบบจะไม่กรอกข้อมูลในช่องนี้
snippet.giftMembershipReceivedDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับเหตุการณ์การเป็นสมาชิกแบบของขวัญที่ได้รับ โดยจะแสดงเฉพาะในกรณีที่ message type เป็น giftMembershipReceivedEvent
snippet.giftMembershipReceivedDetails.memberLevelName string
ชื่อระดับที่ผู้ชมเป็นสมาชิก ซึ่งจะตรงกับ snippet.membershipGiftingDetails.giftMembershipsLevelName ของข้อความการให้ของขวัญการเป็นสมาชิกที่เกี่ยวข้อง ชื่อระดับจะกำหนดโดยช่อง YouTube ที่เสนอการเป็นสมาชิก ในบางกรณี ระบบจะไม่กรอกข้อมูลในช่องนี้
snippet.giftMembershipReceivedDetails.gifterChannelId string
รหัสของผู้ใช้ที่ซื้อการเป็นสมาชิกแบบของขวัญ ซึ่งจะตรงกับ snippet.authorChannelId ของข้อความการให้ของขวัญการเป็นสมาชิกที่เกี่ยวข้อง
snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId string
รหัสของข้อความการมอบแพ็กเกจสมาชิกเป็นของขวัญที่เกี่ยวข้องกับแพ็กเกจสมาชิกแบบของขวัญนี้ รหัสนี้จะอ้างอิงถึงข้อความที่มี type เป็น membershipGiftingEvent เสมอ
snippet.giftEventDetails object
ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับกิจกรรมของขวัญ โดยจะแสดงเฉพาะในกรณีที่ message type เป็น giftEvent
snippet.giftEventDetails.giftMetadata object
รายละเอียดเกี่ยวกับกิจกรรมของขวัญ
snippet.giftEventDetails.giftMetadata.jewelsAmount integer
จำนวนอัญมณีที่แลกเป็นของขวัญ
snippet.giftEventDetails.giftMetadata.giftName string
ชื่อของขวัญ
snippet.giftEventDetails.giftMetadata.giftUrl string
URL ของชิ้นงานของขวัญ
snippet.giftEventDetails.giftMetadata.giftDuration object
ระยะเวลาที่จะแสดง URL ของของขวัญ
snippet.giftEventDetails.giftMetadata.giftDuration.seconds integer
จำนวนวินาทีที่จะแสดง URL ของของขวัญ
snippet.giftEventDetails.giftMetadata.giftDuration.nanos integer
จำนวนนาโนวินาทีที่จะแสดง URL ของของขวัญ
snippet.giftEventDetails.giftMetadata.hasVisualEffect boolean
ดูว่าของขวัญมีเอฟเฟกต์ภาพหรือไม่
snippet.giftEventDetails.giftMetadata.comboCount integer
จำนวนคอมโบของขวัญ โดยจะเป็น 0 หากไม่ใช่คอมโบ
snippet.giftEventDetails.giftMetadata.altText string
สตริงข้อความที่อธิบายของขวัญ
snippet.giftEventDetails.giftMetadata.language string
ภาษาของค่าพร็อพเพอร์ตี้ altText
authorDetails object
ออบเจ็กต์ authorDetails มีรายละเอียดเพิ่มเติมเกี่ยวกับผู้ใช้ที่โพสต์ข้อความนี้
authorDetails.channelId string
รหัสช่อง YouTube ของผู้เขียน
authorDetails.channelUrl string
URL ของช่อง YouTube ของผู้เขียน
authorDetails.displayName string
ชื่อที่แสดงของช่อง YouTube ของผู้เขียน
authorDetails.profileImageUrl string
URL ของอวาตาร์ของช่อง YouTube ของผู้เขียน
authorDetails.isVerified boolean
ค่านี้ระบุว่า YouTube ได้ยืนยันตัวตนของผู้เขียนหรือไม่
authorDetails.isChatOwner boolean
ค่านี้ระบุว่าผู้เขียนเป็นเจ้าของแชทสดหรือไม่
authorDetails.isChatSponsor boolean
ค่านี้ระบุว่าผู้เขียนเป็นสปอนเซอร์ของแชทสดหรือไม่
authorDetails.isChatModerator boolean
ค่านี้ระบุว่าผู้เขียนเป็นผู้ดูแลแชทสดหรือไม่