หน้านี้ได้รับการแปลโดย 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
  ],
  "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` ซึ่งแสดงถึงแบบสำรวจที่ใช้งานอยู่ แชทหนึ่งๆ จะมีแบบสำรวจได้เพียง 1 รายการเท่านั้น

ข้อผิดพลาด

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

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

ลองใช้งาน

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