Members: list

หมายเหตุ: เฉพาะครีเอเตอร์แต่ละรายจะใช้ปลายทางนี้ได้ในการส่งคำขอสำหรับช่อง YouTube ที่เปิดใช้การเป็นสมาชิกของช่องของตนเองเท่านั้น โปรดติดต่อตัวแทนของ Google หรือ YouTube เพื่อขอสิทธิ์เข้าถึง

แสดงสมาชิก (ก่อนหน้านี้เรียกว่า "ผู้สนับสนุน") สำหรับช่อง คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่อง

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

ส่งคำขอ

คำขอ HTTP

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

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

คำขอนี้ต้องได้รับสิทธิ์ภายใต้ขอบเขตต่อไปนี้:

ขอบเขต
https://www.googleapis.com/auth/youtube.channel-memberships.creator

พารามิเตอร์

ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงอยู่เป็นพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จำเป็น
part string
พารามิเตอร์ part จะระบุพร็อพเพอร์ตี้ทรัพยากร member ที่การตอบกลับจาก API จะรวมไว้ด้วย ตั้งค่าพารามิเตอร์เป็น snippet
พารามิเตอร์ที่ไม่บังคับ
mode string
พารามิเตอร์ mode ระบุสมาชิกที่จะรวมไว้ในการตอบกลับของ API ตั้งค่าค่าพารามิเตอร์เป็นค่าใดค่าหนึ่งต่อไปนี้
  • all_current (ค่าเริ่มต้น) - แสดงรายชื่อสมาชิกปัจจุบัน โดยเริ่มจากใหม่สุดไปเก่าสุด เมื่อใช้ค่านี้ ระบบจะมาถึงส่วนท้ายของรายการเมื่อการตอบกลับของ API ไม่มี nextPageToken
  • updates - แสดงเฉพาะสมาชิกที่เข้าร่วมหรืออัปเกรดตั้งแต่การเรียก API ครั้งก่อน โปรดทราบว่าการโทรครั้งแรกจะเริ่มสตรีมการอัปเดตใหม่ แต่ไม่ได้แสดงผลสมาชิกคนใดเลย หากต้องการเริ่มเรียกข้อมูลการอัปเดตการเป็นสมาชิก คุณต้องสำรวจปลายทางโดยใช้ nextPageToken ตามความถี่ที่ต้องการ

    โปรดทราบว่าเมื่อมีการใช้ค่านี้ การตอบกลับของ API จะมี nextPageToken เสมอ
maxResults unsigned integer
พารามิเตอร์ maxResults จะระบุจำนวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับได้คือ 0 ถึง 1000 ค่าเริ่มต้นคือ 5
pageToken string
พารามิเตอร์ pageToken ระบุหน้าที่เจาะจงในชุดผลลัพธ์ที่ควรแสดง โทเค็นนี้มีเฉพาะสำหรับ mode ที่ใช้กับคำขอ API เดิม คุณจึงใช้โทเค็นหน้าเว็บที่ดึงข้อมูลด้วยโหมดหนึ่งเพื่อเปลี่ยนเป็นโหมดอื่นในภายหลังไม่ได้
hasAccessToLevel string
ค่าพารามิเตอร์ hasAccessToLevel คือรหัสระดับที่ระบุระดับขั้นต่ำที่สมาชิกในชุดผลลัพธ์ควรมี
filterByMemberChannelId string
พารามิเตอร์ filterByMemberChannelId ระบุรายการรหัสช่องที่คั่นด้วยคอมมาซึ่งใช้ตรวจสอบสถานะการเป็นสมาชิกของผู้ใช้ที่เฉพาะเจาะจงได้ เช่น UC_1,UC_2,UC_3 สามารถระบุช่องสัญญาณได้สูงสุด 100 ช่องต่อการโทร 1 ครั้ง

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

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

คำตอบ

หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบสนองที่มีโครงสร้างต่อไปนี้

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

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

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

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) channelMembershipsNotEnabled ช่องของครีเอเตอร์ที่ให้สิทธิ์คำขอไม่ได้เปิดใช้การเป็นสมาชิกของช่อง
badRequest (400) invalidMode ค่าพารามิเตอร์ mode ไม่ถูกต้อง ข้อผิดพลาดนี้อาจเกิดขึ้นหากพารามิเตอร์ pageToken ระบุโทเค็นที่มีการเรียกโดยใช้โหมดอื่นที่ไม่ใช่โหมดที่ระบุ
badRequest (400) invalidPageToken ค่าพารามิเตอร์ pageToken ไม่ถูกต้อง ข้อผิดพลาดนี้อาจเกิดขึ้นหากโทเค็นของหน้าที่ใช้ในคำขอหมดอายุหรือระบบไม่รู้จัก
badRequest (400) invalidHasAccessToLevel ค่าพารามิเตอร์ hasAccessToLevel ไม่ถูกต้อง ไม่มีระดับที่มี id ที่ระบุ
badRequest (400) invalidFilterByMemberChannelId ค่าพารามิเตอร์ filterByMemberChannelId ไม่ถูกต้อง ข้อผิดพลาดนี้เกิดขึ้นหากค่าพารามิเตอร์ filterByMemberChannelId ระบุมากกว่า 100 แชแนล