ทรัพยากร liveChatMessage
แสดงข้อความแชทในแชทสดของ YouTube แหล่งข้อมูลอาจมีรายละเอียดเกี่ยวกับข้อความประเภทต่างๆ เช่น ข้อความที่โพสต์ใหม่หรือกิจกรรมการให้เงินสนับสนุนของแฟนๆ
ฟีเจอร์แชทสดจะเปิดใช้โดยค่าเริ่มต้นสำหรับการถ่ายทอดสด และพร้อมให้ใช้งานขณะถ่ายทอดสด (หลังจากที่กิจกรรมสิ้นสุดลง จะไม่มีแชทสดสำหรับกิจกรรมนั้นอีกต่อไป)
เมธอด
API รองรับเมธอดต่อไปนี้สำหรับทรัพยากร liveChatMessages
การนำเสนอทรัพยากร
โครงสร้าง 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 }, "messageDeletedDetails": { "deletedMessageId": 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, "questionText": string, }, "status": enum }, }, "membershipGiftingDetails": { "giftMembershipsCount": integer, "giftMembershipsLevelName": string }, "giftMembershipReceivedDetails": { "memberLevelName": string, "gifterChannelId": string, "associatedMembershipGiftingMessageId": 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 กำหนดเพื่อระบุข้อความที่ไม่ซ้ำกัน |
snippet |
object ออบเจ็กต์ snippet มีรายละเอียดหลักเกี่ยวกับข้อความแชท |
snippet.type |
string ประเภทข้อความ พร็อพเพอร์ตี้นี้จะปรากฏเสมอ และค่าจะเป็นตัวกำหนดว่าช่องใดจะแสดงในทรัพยากร ค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้นี้ ได้แก่
|
snippet.liveChatId |
string รหัสที่ระบุแชทสดโดยไม่ซ้ำกันซึ่งเกี่ยวข้องกับข้อความ รหัสแชทสดที่เชื่อมโยงกับการออกอากาศจะแสดงในพร็อพเพอร์ตี้ snippet.liveChatId ของทรัพยากร liveBroadcast |
snippet.authorChannelId |
string รหัสของผู้ใช้ที่เขียนข้อความ ช่องนี้จะกรอกเฉพาะประเภทข้อความต่อไปนี้
|
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.messageDeletedDetails |
object ออบเจ็กต์นี้มีรายละเอียดเกี่ยวกับข้อความที่ลบโดยผู้ดูแลแชทหรือเจ้าของช่องของการถ่ายทอดสด และจะแสดงก็ต่อเมื่อประเภทข้อความเป็น messageDeletedEvent เท่านั้น |
snippet.messageDeletedDetails.deletedMessageId |
string รหัสที่ระบุข้อความที่ถูกลบโดยไม่ซ้ำกัน ค่านี้เหมือนกับค่าพร็อพเพอร์ตี้ id ของข้อความต้นฉบับ ตัวอย่างเช่น หาก textMessageEvent มีค่าพร็อพเพอร์ตี้ id เป็น 123 และมีการลบข้อความดังกล่าวในภายหลัง ค่า snippet.messageDeletedDetails.deletedMessageId จะเป็น 123 สำหรับข้อความนั้นหากคุณแคชข้อความแชทหลังจากเรียกข้อมูลมาแล้ว ให้ใช้ค่าของพร็อพเพอร์ตี้นี้เพื่อระบุข้อความที่ไม่ควรแสดงอีกต่อไป |
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 Stickers และจะแสดงก็ต่อเมื่อประเภทข้อความเป็น superStickerEvent เท่านั้น |
snippet.superStickerDetails.superStickerMetadata |
object รายละเอียดเกี่ยวกับ Super Stickers |
snippet.superStickerDetails.superStickerMetadata.stickerId |
string รหัสที่ไม่ซ้ำกันซึ่งระบุรูปภาพสติกเกอร์ โปรดทราบว่ารูปภาพจะแสดงเป็นส่วนหนึ่งของข้อความ Super Stickers เมื่อผู้ใช้ดูหน้าต่างแชทบน YouTube เท่านั้น แต่ URL ของรูปภาพไม่พร้อมให้ใช้งานเมื่อใช้ API โปรดทราบว่าคุณจะเห็นรหัสสติกเกอร์ที่เกี่ยวข้องกับ 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.questionText |
string ข้อความของคำถามในแบบสำรวจสด |
snippet.pollDetails.metadata.status |
enum สถานะของกิจกรรมแบบสำรวจสด ค่าที่ถูกต้องสำหรับคุณสมบัตินี้คือ
|
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 |
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 ค่านี้ระบุว่าผู้เขียนเป็นผู้ดูแลแชทสดหรือไม่ |