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 แสดงผลชุดความคิดเห็นทั้งหมดที่เชื่อมโยงกับรหัสช่องที่ระบุ
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 และการตอบกลับ