このページは 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`呼び出しごとに最大 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 を超えるチャネルを指定している場合に発生します。