Members

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

ข้อจำกัดการเข้าถึงต่อไปนี้มีผลบังคับใช้

  • สิทธิ์เข้าถึงปลายทาง members และ membershipsLevels จำกัดไว้สำหรับครีเอเตอร์ YouTube ที่มีโปรแกรมผู้จัดการพาร์ทเนอร์ YouTube ที่ดูแลโดยเฉพาะ
  • ระบบจะให้สิทธิ์เข้าถึงในระดับช่อง เนื่องจากการอนุญาตพิเศษระดับช่องนี้ ขอบเขต OAuth youtube.channel-memberships.creator จึงไม่ต้องผ่านกระบวนการยืนยันตัวตน OAuth มาตรฐานของ Google Cloud

เมธอด

API รองรับเมธอดต่อไปนี้สำหรับทรัพยากร member

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

การแสดงทรัพยากร

โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบของทรัพยากร member

{
  "kind": "youtube#member",
  "etag": etag,
  "snippet": {
    "creatorChannelId": string,
    "memberDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "membershipsDetails": {
      "highestAccessibleLevel": string,
      "highestAccessibleLevelDisplayName": string,
      "accessibleLevels": [
        string
      ],
      "membershipsDuration": {
        "memberSince": datetime,
        "memberTotalDurationMonths": integer,
      },
      "membershipsDurationAtLevel": [
        {
          "level": string,
          "memberSince": datetime,
          "memberTotalDurationMonths": integer,
        }
      ]
    }
  }
}

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

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

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#member
etag etag
Etag ของทรัพยากรนี้
snippet object
ออบเจ็กต์ snippet มีรายละเอียดเกี่ยวกับสมาชิก
snippet.creatorChannelId string
รหัสช่อง YouTube ของครีเอเตอร์ที่เสนอการเป็นสมาชิก
snippet.memberDetails object
ออบเจ็กต์นี้มีข้อมูลโปรไฟล์เกี่ยวกับช่อง YouTube ที่ชำระเงินค่าสมาชิก

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

การตอบกลับจาก API จะมีทรัพยากรสำหรับสมาชิกเหล่านั้นเพื่อให้แน่ใจว่าจำนวนถูกต้อง แม้ว่าจะไม่ได้ตั้งค่ารายละเอียดโปรไฟล์ภายในออบเจ็กต์ memberDetails ก็ตาม ระบบจะยังคงระบุ membershipsDetails สำหรับสมาชิกดังกล่าว
snippet.memberDetails.channelId string
รหัสช่อง YouTube ของช่องสมาชิก หากตั้งค่าไว้ คุณจะถือว่ารหัสช่องเป็นตัวระบุที่ไม่ซ้ำกันสำหรับสมาชิกได้ด้วย หากไม่ได้ตั้งค่าไว้ ระบบจะไม่สามารถระบุสมาชิกได้อย่างไม่ซ้ำกัน แต่ทรัพยากรจะยังคงแสดงรายละเอียดการเป็นสมาชิก เช่น ระดับที่สมาชิกเข้าถึงได้และระยะเวลาการเป็นสมาชิก
snippet.memberDetails.channelUrl string
URL ของช่อง
snippet.memberDetails.displayName string
ชื่อที่แสดงของช่อง
snippet.memberDetails.profileImageUrl string
URL รูปโปรไฟล์ของช่อง
snippet.membershipsDetails object
ออบเจ็กต์นี้มีรายละเอียดการเป็นสมาชิกสำหรับช่องสมาชิก
snippet.membershipsDetails.highestAccessibleLevel string
รหัสของระดับการเป็นสมาชิกสูงสุดที่ช่องสมาชิกเข้าถึงได้ในปัจจุบัน ค่านี้ สอดคล้องกับค่าพร็อพเพอร์ตี้ id ในทรัพยากร membershipsLevel
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
ชื่อของระดับการเป็นสมาชิกสูงสุดที่ช่องสมาชิกเข้าถึงได้ในปัจจุบัน ค่านี้สอดคล้องกับค่าพร็อพเพอร์ตี้ displayName ในทรัพยากร membershipsLevel
snippet.membershipsDetails.accessibleLevels[] list (of strings)
รายการรหัสสำหรับระดับการเป็นสมาชิกทั้งหมดที่ผู้ใช้เข้าถึงได้ในปัจจุบัน รายการนี้รวมถึง ระดับที่ใช้งานอยู่ในปัจจุบันและระดับทั้งหมดที่ต่ำกว่า
snippet.membershipsDuration object
ออบเจ็กต์นี้มีข้อมูลเกี่ยวกับระยะเวลาทั้งหมดของการเป็นสมาชิกปัจจุบัน โดยไม่คำนึงถึงระดับราคา พร็อพเพอร์ตี้ snippet.membershipsDetails.membershipsDurationAtLevel[] จากนั้นจะมีรายการออบเจ็กต์ที่มีรายละเอียดเกี่ยวกับระยะเวลาการเป็นสมาชิก ที่สมาชิกมีสิทธิ์เข้าถึงระดับการเป็นสมาชิกหนึ่งๆ

ตัวอย่างต่อไปนี้แสดงวิธีทำงานของพร็อพเพอร์ตี้เหล่านี้ สมาชิกซื้อการเป็นสมาชิกใหม่ใน เดือนมกราคมที่ระดับการเป็นสมาชิก 1 และมีการเป็นสมาชิกดังกล่าวจนถึงเดือนมีนาคม ในเดือนเมษายนและพฤษภาคม สมาชิกไม่มีการเป็นสมาชิก ในเดือนมิถุนายน สมาชิกกลับมาเป็นสมาชิกอีกครั้งที่ ระดับ 1 จากนั้นในเดือนสิงหาคม สมาชิกอัปเกรดการเป็นสมาชิกเป็นระดับ 2 ดังนั้น หากมีการเรียก API call ในเดือนตุลาคม ทรัพยากร member จะมีข้อมูลต่อไปนี้
"membershipsDetails": {
  "membershipsDuration": {
    "memberSince": "2020-06-01T12:00:00",
    "memberTotalDurationMonths": 7,
  },
  "membershipsDurationAtLevel": [
    {
      "level": "level_1_ID",
      "memberSince": "2020-06-01T12:00:00",
      "memberTotalDurationMonths": 7
    },
    {
      "level": "level_2_ID",
      "memberSince": "2020-08-01T12:00:00",
      "memberTotalDurationMonths": 2
    },
  ]
}
snippet.membershipsDuration.memberSince datetime
วันที่และเวลาที่การเป็นสมาชิกปัจจุบันของสมาชิกเริ่มต้นขึ้น กล่าวคือ สมาชิก มีการเป็นสมาชิกอย่างต่อเนื่องตั้งแต่วันที่และเวลานี้ โปรดทราบว่าระยะเวลาการเป็นสมาชิกที่แตกต่างกันอาจใช้ในระดับการเป็นสมาชิกที่แตกต่างกัน
snippet.membershipsDuration.memberTotalDurationMonths integer
จำนวนเดือนที่ผู้ใช้เป็นสมาชิก โดยปัดเศษลงเป็นจำนวนเต็มที่ใกล้เคียงที่สุด ค่านี้แสดงถึงจำนวนเดือนเต็มที่สมาชิกมีการเป็นสมาชิก แต่จำนวนนี้ไม่ได้หมายความว่าสมาชิกมีการเป็นสมาชิกอย่างต่อเนื่องเป็นเวลาหลายเดือน
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
รายการออบเจ็กต์ ซึ่งแต่ละออบเจ็กต์มีรายละเอียดเกี่ยวกับระยะเวลาการเป็นสมาชิกที่สมาชิกมีสิทธิ์เข้าถึงระดับการเป็นสมาชิกหนึ่งๆ รายการนี้มีออบเจ็กต์ 1 รายการสำหรับระดับการเป็นสมาชิกแต่ละระดับที่สมาชิกเข้าถึงได้ในปัจจุบัน
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
รหัสระดับการเป็นสมาชิก ค่านี้สอดคล้องกับค่าพร็อพเพอร์ตี้ id ในทรัพยากร membershipsLevel
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
วันที่และเวลาที่สมาชิกมีสิทธิ์เข้าถึงระดับการเป็นสมาชิกที่ระบุ กล่าวคือ สมาชิกมีสิทธิ์เข้าถึงระดับดังกล่าวอย่างต่อเนื่องตั้งแต่วันที่และเวลานี้ โปรดทราบว่าระยะเวลาการเป็นสมาชิกที่แตกต่างกันอาจใช้ในระดับการเป็นสมาชิกที่สูงขึ้น
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
จำนวนเดือนที่ผู้ใช้มีสิทธิ์เข้าถึงระดับที่ระบุ โดยปัดเศษลงเป็นจำนวนเต็มที่ใกล้เคียงที่สุด ค่านี้แสดงถึงจำนวนเดือนเต็มที่สมาชิกมี สิทธิ์เข้าถึงระดับดังกล่าว แต่จำนวนนี้ไม่ได้หมายความว่าสมาชิกมีการเป็นสมาชิกอย่างต่อเนื่องเป็นเวลาหลายเดือน