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
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้เพียงรายการเดียว)
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 บ่งชี้ว่าข้อมูลเข้าสู่ระบบสำหรับการให้สิทธิ์ของคำขอระบุผู้ใช้ 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 อาจแสดงเมื่อมีการเรียกใช้เมธอดนี้ ดูรายละเอียดเพิ่มเติมได้ที่ 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