Comments: list

แสดงผลรายการความคิดเห็นที่ตรงกับพารามิเตอร์คําขอ API

ผลกระทบต่อโควต้า: การเรียกใช้วิธีการนี้มีโควต้า ซึ่งมี 1 หน่วย

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

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/youtube/v3/comments

พารามิเตอร์

ตารางต่อไปนี้จะแสดงพารามิเตอร์ที่คําค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงคือพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จําเป็น
part string
พารามิเตอร์ part ระบุรายการที่คั่นด้วยคอมมาของพร็อพเพอร์ตี้ทรัพยากร comment อย่างน้อย 1 รายการที่จะตอบกลับ API

รายการต่อไปนี้มีชื่อ part ที่คุณสามารถใส่ในค่าพารามิเตอร์ได้
  • id
  • snippet
ตัวกรอง (ระบุพารามิเตอร์ตัวใดตัวหนึ่งต่อไปนี้)
id string
พารามิเตอร์ id ระบุรายการรหัสความคิดเห็นที่คั่นด้วยคอมมาสําหรับทรัพยากรที่กําลังดึงมา ในทรัพยากร comment พร็อพเพอร์ตี้ id ระบุรหัสของความคิดเห็น
parentId string
พารามิเตอร์ parentId จะระบุรหัสของความคิดเห็นที่ควรดึงข้อมูลการตอบกลับ

หมายเหตุ: ขณะนี้ YouTube รองรับการตอบกลับสําหรับความคิดเห็นระดับบนสุดเท่านั้น แต่อาจรองรับการตอบกลับในอนาคต
พารามิเตอร์ที่ไม่บังคับ
maxResults unsigned integer
พารามิเตอร์ maxResults ระบุจํานวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์

หมายเหตุ: ไม่รองรับพารามิเตอร์นี้ร่วมกับพารามิเตอร์ id ค่าที่ยอมรับคือ 1 ถึง 100 ค่าเริ่มต้นคือ 20
pageToken string
พารามิเตอร์ pageToken จะระบุหน้าที่เจาะจงในชุดผลลัพธ์ที่ควรแสดงผล ในการตอบกลับ API พร็อพเพอร์ตี้ nextPageToken จะระบุหน้าถัดไปของผลลัพธ์ที่สามารถดึงได้

หมายเหตุ: ระบบไม่รองรับพารามิเตอร์นี้เพื่อใช้กับพารามิเตอร์ id
textFormat string
พารามิเตอร์นี้เป็นตัวบ่งชี้ว่า API ควรแสดงผลความคิดเห็นในรูปแบบ HTML หรือข้อความธรรมดา ค่าเริ่มต้นคือ html

ค่าที่ยอมรับได้ ได้แก่
  • html – แสดงผลความคิดเห็นในรูปแบบ HTML นี่คือค่าเริ่มต้น
  • plainText – แสดงผลความคิดเห็นในรูปแบบข้อความธรรมดา

เนื้อหาของคำขอ

ไม่ต้องให้เนื้อหาคําขอเมื่อเรียกใช้วิธีการนี้

คำตอบ

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

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

พร็อพเพอร์ตี้

ตารางต่อไปนี้กําหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่านี้จะเป็น youtube#commentListResponse
etag etag
Etag ของทรัพยากรนี้
nextPageToken string
โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าถัดไปในชุดผลลัพธ์ได้
pageInfo object
ออบเจ็กต์ pageInfo จะสรุปข้อมูลการแบ่งหน้าสําหรับชุดผลลัพธ์
pageInfo.totalResults integer
จํานวนผลลัพธ์ทั้งหมดในชุดผลลัพธ์
pageInfo.resultsPerPage integer
จํานวนผลลัพธ์ที่รวมอยู่ในการตอบกลับ API
items[] list
รายการความคิดเห็นที่ตรงกับเกณฑ์คําขอ

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) operationNotSupported ตัวกรองรหัสสามารถทํางานร่วมกับความคิดเห็นที่อิงตาม Google+ เท่านั้น
forbidden (403) forbidden เรียกดูความคิดเห็นที่ขอไม่ได้อย่างน้อย 1 รายการเนื่องจากสิทธิ์ไม่เพียงพอ คําขออาจไม่ได้รับอนุญาตอย่างถูกต้อง
notFound (404) commentNotFound ไม่พบความคิดเห็นที่ระบุอย่างน้อย 1 รายการ ตรวจสอบค่าของพารามิเตอร์ id และ parentId ของคําขอเพื่อให้แน่ใจว่าถูกต้อง

ลองใช้เลย

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