注: 2020 年 3 月 31 日をもって、
このエンドポイントは、個々のクリエイターがチャンネル メンバーシップに対応した YouTube チャンネルに対してリクエストを行う場合にのみ使用できます。Google または YouTube の担当者に連絡してアクセス権をリクエストしてください。
members
エンドポイントは sponsors
エンドポイントに置き換わりました。このエンドポイントは非推奨となり、2020 年 9 月 30 日以降はサポートされなくなります。API クライアントは、members.list
メソッドを使用するように sponsors.list
メソッドの呼び出しを更新する必要があります。このエンドポイントは、個々のクリエイターがチャンネル メンバーシップに対応した YouTube チャンネルに対してリクエストを行う場合にのみ使用できます。Google または YouTube の担当者に連絡してアクセス権をリクエストしてください。
member
リソースは、YouTube チャンネルのチャンネル メンバーを表します。クリエイターはクリエイターに継続的に金銭的なサポートを行い、特別な特典を利用できます。たとえば、クリエイターがメンバー限定モードをオンにしている場合、メンバーはチャットできます。
Methods
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 チャンネル ID。 |
snippet.memberDetails |
object このオブジェクトには、メンバーシップの料金を支払う YouTube チャンネルに関するプロフィール データが含まれます。 利用不可のプロフィール データを含むメンバーが含まれる場合もあります。たとえば、チャンネルを削除した後、まだメンバーシップの料金が支払われている場合です。ただし、これらのメンバーはメンバーシップの特典を引き続き利用できます。 API オブジェクト レスポンスには、 memberDetails オブジェクト内のプロファイルの詳細が設定されていなくてもメンバーを正確にカウントするためのリソースが含まれています。このようなメンバーには、引き続き membershipsDetails が提供されます。 |
snippet.memberDetails.channelId |
string メンバー チャンネルの YouTube チャンネル ID。設定すると、チャンネル ID はメンバーの一意の識別子として扱うこともできます。設定されていない場合、メンバーは一意に識別できませんが、メンバーがアクセスできるレベルやメンバーシップ期間など、メンバーシップの詳細が引き続きリソースから伝えられます。 |
snippet.memberDetails.channelUrl |
string チャンネルの URL。 |
snippet.memberDetails.displayName |
string チャンネルの表示名。 |
snippet.memberDetails.profileImageUrl |
string チャンネルのアバター URL。 |
snippet.membershipsDetails |
object このオブジェクトには、メンバー チャンネルのメンバーシップの詳細が含まれます。 |
snippet.membershipsDetails.highestAccessibleLevel |
string メンバー チャンネルが現在アクセスできる最上位のメンバーシップ レベルの ID。この値は、 membershipsLevel リソースの id プロパティ値に対応します。 |
snippet.membershipsDetails.highestAccessibleLevelDisplayName |
string メンバー チャンネルが現在アクセスできる最上位のメンバーシップ レベルの名前。この値は、 membershipsLevel リソースの displayName プロパティ値に対応します。 |
snippet.membershipsDetails.accessibleLevels[] |
list (of strings) ユーザーが現在アクセスできるすべてのメンバーシップ レベルの ID のリスト。このリストには、現在アクティブなレベルとその下のすべてのレベルが表示されます。 |
snippet.membershipsDuration |
object このオブジェクトには、現在のメンバー メンバーシップの有効期間に関する、レベルに関係なくの情報が含まれます。 snippet.membershipsDetails.membershipsDurationAtLevel[] プロパティには、メンバーが特定のメンバーシップ レベルにアクセスしたメンバーシップ期間の詳細を含むオブジェクトのリストが含まれます。これらのプロパティの仕組みを次に示します。メンバーは、1 月にメンバーシップ レベル 1 で新しいメンバーシップを購入し、3 月までメンバーシップを所有します。4 月と 5 月にメンバーにメンバーシップが割り当てられていない。6 月に、メンバーはメンバーシップ レベル 1 で再開します。その後、8 月にメンバーはレベル 2 にアップグレードされます。たとえば、10 月に 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 リソースの id プロパティ値に対応します。 |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince |
datetime メンバーが指定されたメンバーシップ レベルにアクセスした日時。つまり、メンバーはこの日時以降、引き続きこのレベルにアクセスできます。なお、メンバーシップの期間が長いと、メンバーシップ レベルが高い場合があります。 |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths |
integer 指定したレベルにユーザーがアクセスできる整数(最も近い整数の切り捨て)この値は、メンバーがレベルにアクセスできた月数を反映したものですが、この数字はメンバーがその月にメンバーシップを継続していることを示しています。 |