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