Channels: list

หมายเหตุ: ค่าพร็อพเพอร์ตี้ statistics.subscriberCount ของทรัพยากร channel ได้รับการอัปเดตเพื่อแสดงการเปลี่ยนแปลงนโยบาย YouTube ที่ส่งผลต่อวิธีแสดงจํานวนผู้ติดตามแล้ว โปรดดูประวัติการแก้ไขหรือศูนย์ช่วยเหลือของ YouTube สําหรับข้อมูลเพิ่มเติม

แสดงผลคอลเล็กชันทรัพยากร channel อย่างน้อย 1 รายการที่ตรงกับเกณฑ์คําขอ

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

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

ส่งคำขอ

คำขอ HTTP

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

การให้สิทธิ์

คําขอที่ดึงส่วน auditDetails สําหรับทรัพยากร channel ต้องระบุโทเค็นการให้สิทธิ์ที่มีขอบเขต https://www.googleapis.com/auth/youtubepartner-channel-audit นอกจากนี้ คุณต้องเพิกถอนโทเค็นที่ใช้ขอบเขตนั้นเมื่อ MCN ตัดสินใจยอมรับหรือปฏิเสธช่อง หรือภายใน 2 สัปดาห์นับจากวันที่ออกโทเค็น

พารามิเตอร์

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

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

หากพารามิเตอร์ระบุพร็อพเพอร์ตี้ที่มีพร็อพเพอร์ตี้ย่อย พร็อพเพอร์ตี้ย่อยจะรวมอยู่ในการตอบกลับ ตัวอย่างเช่น ในทรัพยากร channel พร็อพเพอร์ตี้ contentDetails มีพร็อพเพอร์ตี้อื่นๆ เช่น พร็อพเพอร์ตี้ uploads ดังนั้น หากคุณตั้งค่า part=contentDetails การตอบกลับ API จะมีพร็อพเพอร์ตี้ที่ซ้อนอยู่ทั้งหมดเหล่านั้นด้วย

รายการต่อไปนี้มีชื่อ part ที่สามารถรวมในค่าพารามิเตอร์ได้
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
ตัวกรอง (ระบุพารามิเตอร์ตัวใดตัวหนึ่งต่อไปนี้)
categoryId string
เราเลิกใช้งานพารามิเตอร์นี้แล้ว พารามิเตอร์ categoryId ระบุหมวดหมู่คู่มือ YouTube และใช้เพื่อขอช่อง YouTube ที่เชื่อมโยงกับหมวดหมู่นั้นได้
forUsername string
พารามิเตอร์ forUsername จะระบุชื่อผู้ใช้ YouTube ดังนั้นจึงขอช่องที่เชื่อมโยงกับชื่อผู้ใช้นั้น
id string
พารามิเตอร์ id ระบุรายการที่คั่นด้วยคอมมาของรหัสช่อง YouTube สําหรับทรัพยากรที่กําลังดึงมา ในทรัพยากร channel พร็อพเพอร์ตี้ id จะระบุรหัสช่อง YouTube ของช่อง
managedByMe boolean
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

ตั้งค่าของพารามิเตอร์นี้เป็น true เพื่อกําหนดให้ API แสดงเฉพาะช่องที่จัดการโดยเจ้าของเนื้อหาที่พารามิเตอร์ onBehalfOfContentOwner ระบุ ผู้ใช้ต้องตรวจสอบสิทธิ์เป็นบัญชี CMS ที่ลิงก์กับเจ้าของเนื้อหาที่ระบุ และต้องระบุ onBehalfOfContentOwner
mine boolean
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง ตั้งค่าของพารามิเตอร์นี้เป็น true เพื่อกําหนดให้ API แสดงผลเฉพาะช่องของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์เท่านั้น
พารามิเตอร์ที่ไม่บังคับ
hl string
พารามิเตอร์ hl จะสั่งให้ API ดึงข้อมูลข้อมูลเมตาของทรัพยากรที่แปลแล้วสําหรับภาษาของแอปพลิเคชันที่เว็บไซต์ YouTube รองรับ ค่าพารามิเตอร์ต้องเป็นรหัสภาษาที่อยู่ในรายการที่แสดงโดยเมธอด i18nLanguages.list

หากมีรายละเอียดทรัพยากรที่แปลเป็นภาษาดังกล่าว ออบเจ็กต์ snippet.localized ของทรัพยากรจะมีค่าที่แปลแล้ว อย่างไรก็ตาม หากไม่มีรายละเอียดที่แปลเป็นภาษาท้องถิ่น ออบเจ็กต์ snippet.localized จะมีรายละเอียดทรัพยากรอยู่ในภาษาเริ่มต้นของทรัพยากรนั้นๆ
maxResults unsigned integer
พารามิเตอร์ maxResults จะระบุจํานวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับคือ 0 ถึง 50 ค่าเริ่มต้นคือ 5
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคําขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

พารามิเตอร์ onBehalfOfContentOwner ระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคําขอระบุผู้ใช้ CMS ของ YouTube ที่ทําหน้าที่ในนามของเจ้าของเนื้อหาที่ระบุในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหา YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ จํานวนมาก ช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้เพียงครั้งเดียวและเข้าถึงข้อมูลวิดีโอและช่องทั้งหมดได้โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบของแต่ละช่อง บัญชี CMS ที่ผู้ใช้ตรวจสอบสิทธิ์ด้วยจะต้องลิงก์กับเจ้าของเนื้อหาของ YouTube ที่ระบุ
pageToken string
พารามิเตอร์ pageToken จะระบุหน้าที่เจาะจงในชุดผลลัพธ์ที่ควรแสดงผล ในการตอบกลับ API พร็อพเพอร์ตี้ nextPageToken และ prevPageToken จะระบุหน้าอื่นๆ ที่สามารถดึงข้อมูลได้

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

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

คำตอบ

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

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

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

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

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) invalidCriteria อาจระบุตัวกรองต่อไปนี้ได้ไม่เกิน 1 รายการ ได้แก่ id, categoryId, mine, managedByMe, forUsername ในกรณีที่ตรวจสอบสิทธิ์เจ้าของเนื้อหาผ่านพารามิเตอร์ onBehalfOfContentOwner อาจระบุเฉพาะ id หรือ managedByMe เท่านั้น
forbidden (403) channelForbidden แชแนลที่ระบุโดยพารามิเตอร์ id ไม่รองรับคําขอหรือคําขอไม่ได้รับอนุญาตอย่างถูกต้อง
notFound (404) categoryNotFound ไม่พบหมวดหมู่ที่ระบุโดยพารามิเตอร์ categoryId ใช้เมธอด guideCategory.list เพื่อเรียกข้อมูลรายการค่าที่ถูกต้อง
notFound (404) channelNotFound ไม่พบแชแนลที่ระบุในพารามิเตอร์ id

ลองใช้เลย

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