LiveChatMessages: list

แสดงรายการข้อความแชทสดสำหรับการแชทที่เฉพาะเจาะจง

เมื่อคุณส่งคำขอแรกเพื่อดึงข้อมูลข้อความแชท API จะแสดงประวัติการแชทบางส่วนหรือทั้งหมด ทั้งนี้ขึ้นอยู่กับความยาวของประวัติ ข้อความในการตอบกลับจะเรียงลำดับจากเก่าสุดไปใหม่สุด
  • nextPageToken ในการตอบกลับจะแสดงโทเค็นที่ในคำขอถัดไปจะระบุชุดผลลัพธ์ถัดไปที่ไคลเอ็นต์ API ควรดึงข้อมูล
  • พร็อพเพอร์ตี้ pollingIntervalMillis จะระบุระยะเวลาที่ไคลเอ็นต์ API ควรรอก่อนที่จะขอผลลัพธ์เพิ่มเติม
เมื่อขอผลลัพธ์เพิ่มเติม ให้ตั้งค่าพารามิเตอร์ pageToken เป็นค่า nextPageToken แล้วเซิร์ฟเวอร์ API จะแสดงข้อความแชทเพิ่มเติม (หากมี) อีกครั้งที่ข้อความในชุดผลลัพธ์นั้นจะเรียงลำดับจากเก่าสุดไปใหม่สุด

ผลกระทบต่อโควต้า: การเรียกเมธอดนี้มีค่าใช้จ่ายโควต้า 5 หน่วย

กรณีการใช้งานทั่วไป

ส่งคำขอ

คำขอ 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

คำขอเริ่มต้นที่ส่งโดยไม่มีโทเค็นการต่อเนื่องจะมีเฉพาะข้อความล่าสุด ซึ่งอาจมีค่าน้อยกว่า maxResults หากมีการระบุไว้

API จะไม่ดึงข้อมูลข้อความที่เก่ากว่าข้อความที่แสดงโดยคำขอเริ่มต้นที่ส่งโดยไม่มีโทเค็นการต่อเนื่อง
pageToken string
พารามิเตอร์ pageToken จะระบุหน้าเฉพาะในชุดผลลัพธ์ที่ควรแสดง ในการตอบกลับจาก API พร็อพเพอร์ตี้ nextPageToken จะระบุหน้าอื่นๆ ที่ดึงข้อมูลได้
profileImageSize unsigned integer
พารามิเตอร์ profileImageSize จะระบุขนาดของรูปโปรไฟล์ผู้ใช้ที่ควรแสดงในชุดผลลัพธ์ รูปภาพจะเป็นสี่เหลี่ยมจัตุรัส ค่าเริ่มต้นคือ 88 ซึ่งหมายความว่ารูปภาพจะมีขนาด 88x88 พิกเซล ค่าที่ยอมรับอยู่ในช่วง 16 ถึง 720 ซึ่งรวมค่าดังกล่าวด้วย

เนื้อความของคำขอ

อย่าระบุเนื้อความของคำขอเมื่อเรียกเมธอดนี้

คำตอบ

หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับที่มีโครงสร้างดังต่อไปนี้

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": 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 ซึ่งแสดงแบบสำรวจความคิดเห็นที่ใช้งานอยู่ การแชทแต่ละครั้งจะมีแบบสำรวจความคิดเห็นได้เพียงรายการเดียว

ข้อผิดพลาด

ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงเพื่อตอบสนองต่อการเรียกเมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่เอกสารประกอบข้อความแสดงข้อผิดพลาด

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
forbidden (403) forbidden คุณไม่มีสิทธิ์ที่จำเป็นในการดึงข้อมูลข้อความสำหรับการแชทสดที่ระบุ
forbidden (403) liveChatDisabled ไม่ได้เปิดใช้แชทสดสำหรับการออกอากาศที่ระบุ
forbidden (403) liveChatEnded แชทสดที่ระบุไม่ได้ไลฟ์สดอีกต่อไป
notFound (404) liveChatNotFound ไม่พบแชทสดที่คุณพยายามดึงข้อมูล ตรวจสอบค่าของพารามิเตอร์ liveChatId ของคำขอเพื่อให้แน่ใจว่าถูกต้อง
rateLimitExceeded rateLimitExceeded คำขอถูกส่งเร็วเกินไปหลังจากคำขอก่อนหน้า ข้อผิดพลาดนี้จะเกิดขึ้นเมื่อมีการส่งคำขอ API เพื่อดึงข้อมูลข้อความบ่อยกว่าอัตราการรีเฟรชของ YouTube ซึ่งเป็นการสิ้นเปลืองแบนด์วิดท์โดยไม่จำเป็น

ลองใช้งาน

ใช้ APIs Explorer เพื่อเรียก API นี้และดูคำขอและการตอบกลับของ API