CommentThreads: list

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

ผลกระทบของโควต้า: การเรียกใช้เมธอดนี้มีต้นทุนโควต้าเท่ากับ 1 หน่วย

Use Case ทั่วไป

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงอยู่เป็นพารามิเตอร์การค้นหา

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

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

ลองใช้เลย

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