ทรัพยากร 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 }, "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 ของ SMS ต้นฉบับ เช่น หาก 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.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 ค่านี้ระบุว่าผู้เขียนเป็นผู้ดูแลแชทสดหรือไม่ |