เมื่อคุณส่งคำขอรับข้อความแชทเป็นครั้งแรก API จะส่งกลับประวัติการแชทบางส่วนหรือทั้งหมด โดยขึ้นอยู่กับความยาว��องประวัติ ข้อความในคำตอบจะเรียงลำดับจากเก่าสุดไปใหม่สุด
nextPageToken
ในการตอบกลับจะให้โทเค็นซึ่งในคำขอถัดไปจะระบุผลลัพธ์ชุดถัดไปที่ไคลเอ็นต์ API ควรเรียก- พร็อพเพอร์ตี้
pollingIntervalMillis
ระบุระยะเวลาที่ไคลเอ็นต์ API ควรรอก่อนที่จะขอผลลัพธ์เพิ่มเติม
pageToken
เป็นค่า nextPageToken
และเซิร์ฟเวอร์ API จะแสดงข้อความแชทเพิ่มเติม หากมี และภายในชุดผลลัพธ์นั้น ข้อความจะเรียงลำดับจากเก่าสุดไปใหม่สุดUse Case ทั่วไป
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/messages
พารามิเตอร์
ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงอยู่เป็นพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จำเป็น | ||
liveChatId |
string พารามิเตอร์ liveChatId จะระบุรหัสของแชทที่จะแสดงข้อความ ระบบจะส่งรหัสแชทสดที่เชื่อมโยงกับการออกอากาศกลับมาในพร็อพเพอร์ตี้ snippet.liveChatId ของทรัพยากร liveBroadcast |
|
part |
string พารามิเตอร์ part จะระบุส่วนทรัพยากร liveChatMessage ที่การตอบกลับจ��ก API จะรวมไว้ ค่าที่รองรับคือ id , snippet และ authorDetails |
|
พารามิเตอร์ที่ไม่บังคับ | ||
hl |
string พารามิเตอร์ hl จะสั่งให้ API ดึงข้อมูลสตริงที่แสดงเป็นสกุลเงินท้องถิ่นสำหรับภาษาของแอปพลิเคชันที่เฉพาะเจาะจงซึ่งเว็บไซต์ YouTube รองรับ เช่น ในภาษาอังกฤษ สกุลเงินจะแสดงเป็น $1.50 แต่ในภาษาฝรั่งเศสจะแสดงเป็น 1,50$ ค่าพารามิเตอร์ต้องเป็นรหัสภาษาที่รวมอยู่ในรายการที่แสดงผลโดยเมธอด i18nLanguages.list |
|
maxResults |
unsigned integer พารามิเตอร์ maxResults จะระบุจำนวนข้อความสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับได้คือ 200 ถึง 2000 ค่าเริ่มต้นคือ 500 |
|
pageToken |
string พารามิเตอร์ pageToken จะระบุหน้าเว็บที่เฉพาะเจาะจงในชุดผลลัพธ์ที่ควรแสดง ในการตอบกลับของ API พร็อพเพอร์ตี้ nextPageToken ระบุหน้าอื่นๆ ที่ดึงได้ |
|
profileImageSize |
unsigned integer พารามิเตอร์ profileImageSize จะระบุขนาดของรูปโปรไฟล์ผู้ใช้ที่ควรแสดงผลในชุดผลการค้นหา รูปภาพเป็นสี่เหลี่ยมจัตุรัส ค่าเริ่มต้นคือ 88 ซึ่งหมายความว่ารูปภาพจะมีขนาด 88 x 88 พิกเซล ค่าที่ยอมรับได้จะอยู่ในช่วง 16 ถึง 720 เท่านั้น |
เนื้อหาของคำขอ
ไม่ต้องระบุเนื้อหาคำขอเมื่อเรียกใช้วิธีการนี้
คำตอบ
หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบสนองที่มีโครงสร้างต่อไปนี้
{ "kind": "youtube#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatMessage Resource ] }
พร็อพเพอร์ตี้
ตารางต่อไปนี้จะกำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ | |
---|---|
kind |
string ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#liveChatMessageListResponse |
etag |
etag Etag ของแหล่งข้อมูลนี้ |
nextPageToken |
string โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าถัดไปในชุดผลลัพธ์ |
pollingIntervalMillis |
unsigned integer ระยะเวลาในหน่วยมิลลิวินาทีที่ไคลเอ็นต์ควรรอก่อนทำโพลอีกครั้งสำหรับข้อความแชทสดใหม่ |
offlineAt |
datetime วันที่และเวลาที่สตรีมแบบสดที่สำคัญเปลี่ยนเป็นแบบออฟไลน์ พร็อพเพอร์ตี้นี้จะปรากฏก็ต่อเมื่อสตรีมออฟไลน์อยู่แล้วเท่านั้น ค่าจะระบุไว้ในรูปแบบ ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) |
pageInfo |
object ออบเจ็กต์ pageInfo สรุปข้อมูลการแบ่งหน้าสำหรับชุดผลลัพธ์ |
pageInfo.totalResults |
integer จำนวนผลลัพธ์ทั้งหมดในชุดผลลัพธ์ |
pageInfo.resultsPerPage |
integer จำนวนผลลัพธ์ที่รวมอยู่ในการตอบกลับของ API |
items[] |
list รายการข้อความ แต่ละรายการในลิสต์คือทรัพยากร liveChatMessage |
activePollItem |
object ข้อมูลแบบสำรวจในข้อความ แบบสำรวจแต่ละรายการเป็นทรัพยากร liveChatMessage ประเภท pollEvent ซึ่งแสดงถึงแบบสำรวจที่ใช้งานอยู่ แชทหนึ่งจะมีแบบสำรวจได้เพียง 1 รายการเท่านั้น |
ข้อผิดพลาด
ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงผลเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอ��ข้อความแสดงข้อผิดพลาด
ประเภทข้อผิดพลาด | รายละเอียดข้อผิดพลาด | คำอธิบาย |
---|---|---|
forbidden (403) |
forbidden |
คุณไม่มีสิทธิ์ที่จำเป็นในการเรียกข้อความสำหรับแชทสดที่ระบุ |
forbidden (403) |
liveChatDisabled |
ไม่ได้เปิดใช้งานแชทสดสำหรับการออกอากาศที่ระบุ |
forbidden (403) |
liveChatEnded |
แชทสดที่ระบุไม่เผยแพร่แล้ว |
notFound (404) |
liveChatNotFound |
ไม่พบแชทสดที่คุณพยายามเรียก โปรดตรวจสอบค่าของพารามิเตอร์ liveChatId ของคําขอเพื่อให้แน่ใจว่าถูกต้อง |
rateLimitExceeded |
rateLimitExceeded |
คำขอส่งเร็วเกินไปหลังจากคำขอก่อนหน้า ข้อผิดพลาดนี้เกิดขึ้นเมื่อระบบส่งคำขอ API เพื่อเรียกข้อความบ่อยกว่าอัตราการรีเฟรชของ YouTube ซึ่งทำให้สิ้นเปลืองแบนด์วิดท์โดยไม่จำเป็น |
ลองใช้เลย
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้เพื่อดูคำขอและการตอบสนองของ API