Members

Lưu ý: Kể từ ngày 31 tháng 3 năm 2020, điểm cuối members thay thế điểm cuối sponsors hiện không được dùng nữa và không còn được hỗ trợ vào hoặc sau ngày 30 tháng 9 năm 2020. Thay vào đó, ứng dụng API sẽ cập nhật lệnh gọi thành phương thức sponsors.list để sử dụng phương thức members.list.

Chỉ những nhà sáng tạo cá nhân mới có thể sử dụng điểm cuối này để gửi yêu cầu cho kênh YouTube của mình và có hỗ trợ gói hội viên. Hãy liên hệ với đại diện của Google hoặc YouTube để yêu cầu quyền truy cập.

Tài nguyên member đại diện cho hội viên của một kênh YouTube. Một thành viên hỗ trợ định kỳ cho nhà sáng tạo và nhận các lợi ích đặc biệt. Ví dụ: Hội viên có thể trò chuyện khi nhà sáng tạo bật chế độ chỉ dành cho hội viên để trò chuyện.

Phương pháp

API hỗ trợ các phương thức sau cho tài nguyên member:

list
Liệt kê các thành viên (trước đây gọi là "nhà tài trợ") cho một kênh. Yêu cầu API phải do chủ sở hữu kênh uỷ quyền.

Biểu diễn tài nguyên

Cấu trúc JSON sau đây cho thấy định dạng của tài nguyên 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,
        }
      ]
    }
  }
}

Thuộc tính

Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:

Thuộc tính
kind string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#member.
etag etag
Etag của tài nguyên này.
snippet object
Đối tượng snippet chứa thông tin chi tiết về thành viên.
snippet.creatorChannelId string
Mã nhận dạng kênh YouTube của nhà sáng tạo cung cấp chương trình hội viên.
snippet.memberDetails object
Đối tượng này chứa dữ liệu hồ sơ về kênh YouTube đang trả phí cho gói hội viên.

Xin lưu ý rằng kênh có thể có dữ liệu hồ sơ về hội viên. Ví dụ: Tình trạng này xảy ra với những hội viên đã xóa kênh nhưng vẫn đang trả phí hội viên. Xin lưu ý rằng những thành viên này vẫn có thể hưởng các lợi ích của gói thành viên.

Phản hồi API bao gồm tài nguyên cho các thành viên đó để đảm bảo số lượng chính xác, mặc dù thông tin chi tiết về hồ sơ bên trong đối tượng memberDetails chưa được đặt. Chúng tôi vẫn cung cấp membershipsDetails cho các thành viên đó.
snippet.memberDetails.channelId string
Mã nhận dạng kênh YouTube của kênh hội viên. Nếu bạn đặt mã nhận dạng kênh thì mã nhận dạng kênh cũng có thể được coi là giá trị nhận dạng duy nhất cho hội viên. Nếu bạn không đặt giá trị này thì không thể xác định duy nhất thành viên, nhưng tài nguyên vẫn truyền tải thông tin chi tiết về tư cách thành viên, chẳng hạn như các cấp độ mà thành viên có thể truy cập và thời hạn thành viên của họ.
snippet.memberDetails.channelUrl string
URL của kênh.
snippet.memberDetails.displayName string
Tên hiển thị của kênh.
snippet.memberDetails.profileImageUrl string
URL hình đại diện của kênh.
snippet.membershipsDetails object
Đối tượng này chứa thông tin chi tiết về gói hội viên của kênh hội viên.
snippet.membershipsDetails.highestAccessibleLevel string
Mã của cấp độ hội viên cao nhất mà kênh hội viên hiện có thể truy cập. Giá trị này tương ứng với giá trị thuộc tính id trong tài nguyên membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Tên của cấp độ hội viên cao nhất mà kênh hội viên hiện có thể truy cập. Giá trị này tương ứng với giá trị thuộc tính displayName trong tài nguyên membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Danh sách mã nhận dạng cho tất cả các cấp độ thành viên mà người dùng hiện có thể truy cập. Danh sách này bao gồm cấp hiện đang hoạt động và tất cả các cấp bên dưới.
snippet.membershipsDuration object
Đối tượng này chứa thông tin về thời hạn chung của gói thành viên hiện tại mà không xét đến mức giá. Thuộc tính snippet.membershipsDetails.membershipsDurationAtLevel[] sau đó chứa danh sách các đối tượng chứa thông tin chi tiết về khoảng thời gian gói thành viên mà trong đó thành viên có quyền truy cập vào một cấp độ thành viên cụ thể.

Ví dụ sau đây cho thấy cách hoạt động của các thuộc tính này: Một thành viên mua gói thành viên mới vào tháng 1 ở cấp độ thành viên 1 và có gói thành viên đó đến tháng 3. Vào tháng 4 và tháng 5, hội viên không có gói hội viên. Vào tháng 6, hội viên bắt đầu lại chương trình hội viên ở cấp độ 1. Sau đó, vào tháng 8, hội viên nâng cấp gói hội viên lên cấp độ 2. Vì vậy, nếu thực hiện lệnh gọi API vào tháng 10, tài nguyên member sẽ chứa nội dung sau:
"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
Ngày và giờ bắt đầu sử dụng gói thành viên hiện tại. Nói cách khác, thành viên đã liên tục là thành viên kể từ ngày và giờ này. Xin lưu ý rằng các gói hội viên có thể đã được chi tiêu ở nhiều cấp độ.
snippet.membershipsDuration.memberTotalDurationMonths integer
Số tháng, được làm tròn đến số nguyên gần nhất mà người dùng đã là thành viên. Giá trị này thể hiện số tháng làm hội viên trọn vẹn mà hội viên có trong gói hội viên, nhưng không có nghĩa là hội viên đã liên tục làm hội viên trong nhiều tháng đó.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Danh sách đối tượng, trong đó mỗi đối tượng chứa thông tin chi tiết về một khoảng thời gian làm thành viên mà hội viên có thể sử dụng ở một cấp độ cụ thể. Danh sách này chứa một đối tượng cho mỗi cấp độ hội viên mà hội viên hiện có thể truy cập.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
Mã cấp độ hội viên. Giá trị này tương ứng với giá trị thuộc tính id trong tài nguyên membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Ngày và giờ mà hội viên có quyền sử dụng cấp độ hội viên cụ thể. Nói cách khác, thành viên này đã liên tục có quyền truy cập vào cấp độ kể từ ngày và giờ này. Xin lưu ý rằng các gói hội viên khác nhau có thể đã được dùng ở các cấp độ hội viên cao hơn.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Số tháng, được làm tròn đến số nguyên gần nhất mà người dùng có quyền truy cập vào cấp được chỉ định. Giá trị này phản ánh số tháng đầy đủ mà hội viên có thể tham gia cấp độ, nhưng không ngụ ý rằng hội viên liên tục có gói hội viên trong nhiều tháng đó.