Channels: list

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

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

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

Use Case ทั่วไป

ส่งคำขอ

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
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