このページは Cloud Translation API によって翻訳されました。

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 個のチャンネルを指定できます。

リクエスト本文

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

レスポンス

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

{
  "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 チャンネルを超えている場合に発生します。