Members: list

注: このエンドポイントは、個々のクリエイターが自分のチャンネル メンバーシップが有効になっている YouTube チャンネルのリクエストを行う場合にのみ使用できます。アクセス権をリクエストするには、Google または YouTube の担当者にお問い合わせください。

チャンネルのメンバー（旧称「スポンサー」）を一覧表示します。API リクエストは、 チャンネル オーナーによって承認される必要があります。

割り当てへの影響: このメソッドの呼び出しには、 割り当てコストが 2 ユニットかかります。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/youtube/v3/members

承認

このリクエストには、次のスコープによる認証が必要です。

スコープ
https://www.googleapis.com/auth/youtube.channel-memberships.creator

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータは、API レスポンスに含める member リソース プロパティを指定します。パラメータ値を snippet に設定します。
オプション パラメータ
mode string
mode パラメータは、API レスポンスに含めるメンバーを示します。パラメータ値を次のいずれかの値に設定します。
  • all_current（デフォルト）- 現在のメンバーを新しい順に一覧表示します。この値を使用すると、API レスポンスに nextPageToken が含まれていない場合にリストの末尾に達します。
  • updates - 前回の API 呼び出し以降に加入またはアップグレードしたメンバーのみを一覧表示します。最初の呼び出しでは、新しい更新ストリームが開始されますが、実際には メンバーは返されません。メンバーシップの更新の取得を開始するには、目的の頻度で nextPageToken を使用してエンドポイントをポーリングする必要があります。

    この値を使用すると、API レスポンスには常に nextPageTokenが含まれます。
maxResults unsigned integer
maxResults パラメータは、結果セットで返されるアイテムの最大数を指定します。使用できる値は 0～1000（両端を含む）です。デフォルト値は 5 です。
pageToken string
pageToken パラメータは、返される結果セット内の特定のページを識別します。トークンは元の API リクエストで使用された modeに固有であるため、あるモードで取得したページトークンを使用して別のモードに切り替えることはできません。
hasAccessToLevel string
hasAccessToLevel パラメータ値は、結果セット内のメンバーが持つ必要のある最小レベルを指定するレベル ID です。
filterByMemberChannelId string
filterByMemberChannelId パラメータは、特定のユーザーのメンバーシップ登録状況を確認するために使用できるチャンネル ID のカンマ区切りのリストを指定します。例: UC_1,UC_2,UC_3。1 回の呼び出しで指定できるチャンネルは最大 100 個です。

リクエストの本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

Response

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#memberListResponse になります。
etag etag
このリソースの Etag。
nextPageToken string
結果セットの次のページを取得するために pageToken パラメータの値として使用できるトークン。ページトークンは期限切れになる可能性があります。アプリケーションはトークンを削除し、 pageToken なしで API を呼び出して新しいリクエストを開始する必要があります。
pageInfo object
pageInfo オブジェクトは、結果セットのページング情報をカプセル化します。
pageInfo.totalResults integer
結果セット内の結果の総数です。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数。
items[] list
リクエスト条件に一致するメンバーのリスト。

エラー

次の表に、このメソッドの呼び出しに応じて API が返す可能性があるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
badRequest (400) channelMembershipsNotEnabled リクエストを承認するクリエイター チャンネルでチャンネル メンバーシップが有効になっていません。
badRequest (400) invalidMode mode パラメータの値が無効です。 このエラーは、pageToken パラメータ で指定されたモードとは異なるモードを使用して取得されたトークンを指定した場合に発生することがあります。
badRequest (400) invalidPageToken pageToken パラメータの値は 無効です。このエラーは、リクエストで使用されたページトークンが期限切れになっているか、認識されていない場合に発生することがあります。
badRequest (400) invalidHasAccessToLevel hasAccessToLevel パラメータの値が無効です。指定された idのレベルはありません。
badRequest (400) invalidFilterByMemberChannelId filterByMemberChannelId パラメータの値が無効です。このエラーは、 filterByMemberChannelId パラメータ値 で 100 を超えるチャネルを指定した場合に発生します。