หน้านี้ได้รับการแปลโดย Cloud Translation API

LiveChatMessages: list

แสดงรายการข้อความแชทแบบสดสําหรับแชทที่ต้องการ

เมื่อคุณส่งคําขอเรียกดูข้อความแชทเป็นครั้งแรก API จะแสดงประวัติการแชทบางส่วนหรือทั้งหมด โดยขึ้นอยู่กับความยาวของประวัติการแชท ข้อความในการตอบกลับจะเรียงลําดับจากเก่าสุดไปใหม่สุด

nextPageToken ในการตอบสนองจะให้โทเค็นที่ในคําขอถัดไปจะระบุชุดผลลัพธ์ถัดไปที่ไคลเอ็นต์ API ของคุณควรเรียกข้อมูล
พร็อพเพอร์ตี้ pollingIntervalMillis ระบุระยะเวลาที่ไคลเอ็นต์ API ของคุณต้องรอก่อนขอผลลัพธ์เพิ่มเติม

เมื่อขอผลลัพธ์เพิ่มเติม ให้ตั้งค่าพารามิเตอร์ pageToken เป็นค่า nextPageToken และเซิร์ฟเวอร์ API จะแสดงข้อความแชทเพิ่มเติม หากมี กล่าวคือ ชุดผลลัพธ์จะเรียงลําดับจากเก่าสุดไปใหม่สุด

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

ส่งคำขอ

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

ข้อผิดพลาด

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

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

ลองใช้เลย

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