Members

หมายเหตุ: ตั้งแต่วันที่ 31 มีนาคม 2020 เป็นต้นไป ปลายทาง members จะแทนที่ปลายทาง sponsors ที่ตอนนี้เลิกใช้งานแล้วและไม่รองรับอีกต่อไปตั้งแต่วันที่ 30 กันยายน 2020 เป็นต้นไป ไคลเอ็นต์ API ควรอัปเดตการเรียกเมธอด sponsors.list เพื่อใช้เมธอด members.list แทน

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

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

วิธีการ

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