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

ข้อผิดพลาด

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

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

ลองใช้งาน

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