Members

Tài nguyên member đại diện cho một hội viên của kênh YouTube. Hội viên là người thường xuyên ủng hộ tiền định kỳ cho nhà sáng tạo và nhận được 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 trong một cuộc trò chuyện.

Các quy định hạn chế sau đây về quyền truy cập sẽ được áp dụng:

  • Chỉ những nhà sáng tạo trên YouTube có Nhà quản lý đối tác YouTube riêng mới có quyền truy cập vào các điểm cuối members và membershipsLevels.
  • Quyền truy cập được cấp ở cấp kênh. Do danh sách cho phép ở cấp kênh này, phạm vi OAuth youtube.channel-memberships.creator không trải qua quy trình xác minh OAuth tiêu chuẩn của Google Cloud.

Phương thức

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

list
Liệt kê các hội viên (trước đây gọi là "người tài trợ") của một kênh. Chủ sở hữu kênh phải cấp quyền cho yêu cầu API.

Cách trình bày 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 của 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 gói 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 một kênh có thể có những hội viên không có dữ liệu hồ sơ. Ví dụ: trường hợp này xảy ra với những hội viên đã xoá kênh nhưng vẫn trả phí cho gói hội viên. Xin lưu ý rằng những thành viên này vẫn có thể sử dụng các lợi ích của gói thành viên.

Phản hồi của API bao gồm các tài nguyên cho những thành viên đó để đảm bảo số lượng chính xác ngay cả khi thông tin chi tiết về hồ sơ bên trong đối tượng memberDetails không được đặt. Các membershipsDetails vẫn được cung cấp cho những thành viên đó.
snippet.memberDetails.channelId string
Mã nhận dạng kênh YouTube của kênh thành viên. Nếu được đặt, mã nhận dạng kênh cũng có thể được coi là giá trị nhận dạng riêng biệt của thành viên. Nếu không được đặt, thành viên không thể được xác định duy nhất, nhưng tài nguyên vẫn truyền tải thông tin chi tiết về 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 thành viên.
snippet.membershipsDetails.highestAccessibleLevel string
Mã nhận dạng của cấp độ hội viên cao nhất mà kênh hội viên hiện có thể sử dụng. 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ể sử dụng. 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 độ hội 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ề tổng thời lượng gói thành viên hiện tại của thành viên mà không tính đến các cấp giá. Sau đó, thuộc tính snippet.membershipsDetails.membershipsDurationAtLevel[] sẽ chứa danh sách các đối tượng có thông tin chi tiết về một khoảng thời gian của gói hội viên mà trong đó hội viên có quyền sử dụng một cấp độ hội 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 đó cho đến tháng 3. Vào tháng 4 và tháng 5, thành viên này không có gói thành viên. Vào tháng 6, hội viên này bắt đầu lại gói hội viên, vẫn ở cấp độ 1. Sau đó, vào tháng 8, hội viên này nâng cấp gói hội viên lên cấp 2. Vì vậy, nếu một lệnh gọi API được thực hiện vào tháng 10, thì tài nguyên member sẽ chứa thông tin 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 gói thành viên hiện tại của thành viên. Nói cách khác, hội viên này đã liên tục có gói thành viên kể từ ngày và giờ này. Xin lưu ý rằng hội viên có thể đã sử dụng các cấp độ hội viên khác nhau trong các khoảng thời gian khác nhau.
snippet.membershipsDuration.memberTotalDurationMonths integer
Số tháng (làm tròn xuống số nguyên gần nhất) mà người dùng đã là thành viên. Giá trị này phản ánh số tháng hoàn chỉnh mà hội viên đã có gói hội viên, nhưng số này không có nghĩa là hội viên đã liên tục có gói hội viên trong số tháng đó.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Một danh sách các đố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 mà thành viên có quyền truy cập vào một cấp độ hội viên cụ thể. Danh sách này bao gồm một đối tượng cho mỗi cấp độ hội viên mà hội viên hiện có thể sử dụng.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
Mã nhận dạng 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ờ kể từ thời điểm hội viên có quyền sử dụng cấp độ hội viên được chỉ định. Nói cách khác, hội viên đã liên tục có quyền sử dụng cấp độ kể từ ngày và giờ này. Xin lưu ý rằng hội viên có thể đã dành thời gian ở các cấp hội viên cao hơn.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Số tháng (làm tròn xuống 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 hoàn chỉnh mà hội viên đã có quyền sử dụng cấp độ đó, nhưng số này không có nghĩa là hội viên đã liên tục có gói hội viên trong số tháng đó.