Channels: list

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

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

ผลกระทบต่อโควต้า: การเรียกใช้เมธอดนี้มีค่าใช้จ่ายโควต้า 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
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้เพียง 1 รายการ)
categoryId string
พารามิเตอร์นี้เลิกใช้งานแล้ว พารามิเตอร์ categoryId ระบุ หมวดหมู่คำแนะนำของ YouTube และสามารถใช้เพื่อ ขอช่อง YouTube ที่เชื่อมโยงกับหมวดหมู่นั้นได้
forHandle string
พารามิเตอร์ forHandle ระบุแฮนเดิล YouTube ซึ่งเป็นการขอ ช่องที่เชื่อมโยงกับแฮนเดิลนั้น ค่าพารามิเตอร์สามารถนำหน้าด้วยสัญลักษณ์ @ เช่น หากต้องการดึงข้อมูลทรัพยากรสำหรับช่อง "Google for Developers" ให้ตั้งค่าพารามิเตอร์ forHandle เป็น GoogleDevelopers หรือ @GoogleDevelopers
forUsername string
พารามิเตอร์ forUsername ระบุชื่อผู้ใช้ YouTube ซึ่งเป็นการขอช่องที่เชื่อมโยงกับชื่อผู้ใช้นั้น
id string
พารามิเตอร์ id ระบุรายการรหัสช่อง YouTube อย่างน้อย 1 รายการที่คั่นด้วยคอมมาสำหรับทรัพยากรที่จะดึงข้อมูล ในทรัพยากร 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 บ่งชี้ว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ YouTube CMS ที่ดำเนินการในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ 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 อาจแสดงผลเพื่อตอบสนองต่อการเรียกใช้เมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่ YouTube Data API - ข้อผิดพลาด

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

ลองใช้งาน

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