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 และการตอบกลับ