แสดงรายการความคิดเห็นที่ตรงกับพารามิเตอร์ของคำขอ API
ผลกระทบของโควต้า: การเรียกใช้เมธอดนี้มีต้นทุนโควต้าเท่ากับ 1 หน่วย
Use Case ทั่วไป
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/youtube/v3/comments
พารามิเตอร์
ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงอยู่เป็นพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จำเป็น | ||
part |
string พารามิเตอร์ part ระบุรายการที่คั่นด้วยคอมมาของพร็อพเพอร์ตี้ทรัพยากร comment อย่างน้อย 1 รายการซึ่งการตอบกลับจาก API จะรวมรายการต่อไปนี้มีชื่อ part ชื่อที่คุณรวมไว้ในค่าพารามิเตอร์ได้
|
|
ตัวกรอง (ระบุพารามิเตอร์รายการใดรายการหนึ่งต่อไปนี้เท่านั้น) | ||
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 ค่าที่ยอมรับได้มีดังนี้
|
เนื้อหาของคำขอ
ไม่ต้องระบุเนื้อหาคำขอเมื่อเรียกใช้วิธีการนี้
คำตอบ
หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบสนองที่มีโครงสร้างต่อไปนี้
{ "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