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