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 ช่องต่อการเรียก

เนื้อความของคำขอ

อย่าระบุเนื้อความของคำขอเมื่อเรียกเมธอดนี้

คำตอบ

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

{
  "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 ช่อง