CommentThreads: list

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

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

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

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

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

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

รายการต่อไปนี้มีชื่อ part ที่คุณสามารถใส่ในค่าพารามิเตอร์ได้
  • id
  • replies
  • snippet
ตัวกรอง (ระบุพารามิเตอร์ตัวใดตัวหนึ่งต่อไปนี้)
allThreadsRelatedToChannelId string
พารามิเตอร์ allThreadsRelatedToChannelId จะสั่งให้ API แสดงผลชุดข้อความของความคิดเห็นทั้งหมดที่เชื่อมโยงกับช่องที่ระบุ การตอบกลับดังกล่าวอาจรวมถึงความคิดเห็นเกี่ยวกับช่องหรือวิดีโอของช่อง
channelId string
พารามิเตอร์ channelId จะสั่งให้ API แสดงผลชุดข้อความความคิดเห็นที่มีความคิดเห็นเกี่ยวกับช่องที่ระบุ (การตอบกลับจะไม่รวมความคิดเห็นที่เหลืออยู่ในวิดีโอที่อัปโหลดโดยช่อง)
id string
พารามิเตอร์ id ระบุรายการรหัสชุดความคิดเห็นที่คั่นด้วยคอมมาสําหรับทรัพยากรที่ระบบควรดึงข้อมูล
videoId string
พารามิเตอร์ videoId จะสั่งให้ API แสดงผลชุดข้อความความคิดเห็นที่เชื่อมโยงกับรหัสวิดีโอที่ระบุ
พารามิเตอร์ที่ไม่บังคับ
maxResults unsigned integer
พารามิเตอร์ maxResults ระบุจํานวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์

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

หมายเหตุ: ไม่รองรับพารามิเตอร์นี้ร่วมกับพารามิเตอร์ id ค่าเริ่มต้นคือ published

ค่าที่ยอมรับได้ ได้แก่
  • heldForReview – เรียกดูชุดข้อความความคิดเห็นที่รอการตรวจสอบโดยผู้ดูแล คุณสามารถรวมชุดข้อความของความคิดเห็นไว้ในการตอบกลับได้ หากความคิดเห็นระดับบนสุดหรือการตอบกลับของความคิดเห็นดังกล่าวอย่างน้อย 1 รายการรอการตรวจสอบ
  • likelySpam - เรียกดูชุดข้อความความคิดเห็นที่จัดประเภทว่าเป็นสแปม คุณรวมชุดความคิดเห็นไว้ในการตอบกลับได้ หากความคิดเห็นระดับบนสุดหรือการตอบกลับของความคิดเห็นนั้นอย่างน้อย 1 รายการถือว่าเป็นสแปม
  • published – เรียกดูชุดข้อความของความคิดเห็นที่เผยแพร่แล้ว นี่คือค่าเริ่มต้น คุณรวมชุดความคิดเห็นไว้ในการตอบกลับได้ หากเผยแพร่ความคิดเห็นระดับบนสุดแล้ว
order string
พารามิเตอร์ order จะระบุลําดับที่การตอบกลับ API ควรแสดงชุดข้อความความคิดเห็น โดยค่าที่ถูกต้องคือ
  • time - จัดเรียงชุดข้อความความคิดเห็นตามเวลา นี่คือลักษณะการทํางานเริ่มต้น
  • relevance - ชุดข้อความของความคิดเห็นจะเรียงลําดับตามความเกี่ยวข้อง
หมายเหตุ: ไม่รองรับพารามิเตอร์นี้ร่วมกับพารามิเตอร์ id
pageToken string
พารามิเตอร์ pageToken จะระบุหน้าที่เจาะจงในชุดผลลัพธ์ที่ควรแสดงผล ในการตอบกลับ API พร็อพเพอร์ตี้ nextPageToken จะระบุหน้าถัดไปของผลลัพธ์ที่สามารถดึงได้

หมายเหตุ: ระบบไม่รองรับพารามิเตอร์นี้เพื่อใช้กับพารามิเตอร์ id
searchTerms string
พารามิเตอร์ searchTerms จะสั่งให้ API จํากัดการตอบกลับ API ให้มีเฉพาะความคิดเห็นที่มีข้อความค้นหาที่ระบุเท่านั้น

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

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

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

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

คำตอบ

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

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

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

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

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) operationNotSupported ตัวกรองรหัสสามารถทํางานร่วมกับความคิดเห็นที่อิงตาม Google+ เท่านั้น
badRequest (400) processingFailure เซิร์ฟเวอร์ API ดําเนินการตามคําขอไม่สําเร็จ แม้ว่านี่อาจเป็นข้อผิดพลาดที่เกิดขึ้นชั่วคราว แต่มักจะระบุว่าอินพุตของคําขอไม่ถูกต้อง ตรวจสอบโครงสร้างของทรัพยากร commentThread ในส่วนเนื้อหาของคําขอเพื่อให้แน่ใจว่าถูกต้อง
forbidden (403) commentsDisabled วิดีโอที่ระบุโดยพารามิเตอร์ videoId ได้ปิดใช้ความคิดเห็น
forbidden (403) forbidden เรียกชุดข้อความความคิดเห็นที่ขอไม่ได้อย่างน้อย 1 รายการเนื่องจากสิทธิ์ไม่เพียงพอ คําขออาจไม่ได้รับอนุญาตอย่างถูกต้อง
notFound (404) channelNotFound ไม่พบแชแนลที่ระบุโดยพารามิเตอร์ channelId หรือ allThreadsRelatedToChannelId
notFound (404) commentThreadNotFound ไม่พบชุดข้อความของความคิดเห็นที่ระบุอย่างน้อย 1 รายการ ตรวจสอบค่าของพารามิเตอร์ id ของคําขอเพื่อให้แน่ใจว่าถูกต้อง
notFound (404) videoNotFound ไม่พบวิดีโอที่พารามิเตอร์ videoId ระบุ

ลองใช้เลย

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