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

Channels: list

注: チャンネル登録者数の表示方法に影響する YouTube ポリシーの変更を反映するため、channel リソースの statistics.subscriberCount プロパティ値が更新されました。詳しくは、変更履歴または YouTube ヘルプセンターをご覧ください。

リクエスト条件に一致する 0 個以上の channel リソースのコレクションを返します。

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

channel リソースの auditDetails パートを取得するリクエストでは、https://www.googleapis.com/auth/youtubepartner-channel-audit スコープを含む認証トークンを指定する必要があります。また、そのスコープを使用するトークンは、MCN がチャンネルの承認または拒否を決定したとき、またはトークンの発行日から 2 週間以内に取り消す必要があります。

パラメータ

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

パラメータ
必須パラメータ
`part`	`string` `part` パラメータは、API レスポンスに含める 1 つ以上の `channel` リソースプロパティのカンマ区切りのリストを指定します。子プロパティを含むプロパティがパラメータで識別される場合、子プロパティはレスポンスに含まれます。たとえば、`channel` リソースでは、`contentDetails` プロパティに `uploads` プロパティなどの他のプロパティが含まれています。そのため、`part=contentDetails` を設定すると、API レスポンスにはネストされたプロパティもすべて含まれます。次のリストは、パラメータ値に含めることができる `part` 名を示します。 `auditDetails` `brandingSettings` `contentDetails` `contentOwnerDetails` `id` `localizations` `snippet` `statistics` `status` `topicDetails`
フィルタ（次のパラメータのいずれか 1 つのみを指定）
`categoryId`	`string` このパラメータは非推奨になりました。 `categoryId` パラメータは YouTube ガイドカテゴリを指定し、そのカテゴリに関連付けられている YouTube チャンネルをリクエストするために使用できます。
`forHandle`	`string` `forHandle` パラメータは YouTube ハンドルを指定します。これにより、そのハンドルに関連付けられたチャンネルがリクエストされます。パラメータ値の先頭に `@` 記号を付けることができます。たとえば、「Google for Developers」チャネルのリソースを取得するには、`forHandle` パラメータ値を `GoogleDevelopers` または `@GoogleDevelopers` に設定します。
`forUsername`	`string` `forUsername` パラメータには YouTube ユーザー名を指定します。これにより、そのユーザー名に関連付けられているチャンネルがリクエストされます。
`id`	`string` `id` パラメータは、取得するリソースの YouTube チャンネル ID のカンマ区切りのリストを指定します。`channel` リソースの `id` プロパティには、チャンネルの YouTube チャンネル ID を指定します。
`managedByMe`	`boolean` このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツパートナー専用です。このパラメータの値を `true` に設定すると、`onBehalfOfContentOwner` パラメータで指定されたコンテンツ所有者が管理するチャンネルのみを返すように API に指示できます。ユーザーは、指定したコンテンツ所有者にリンクされている CMS アカウントとして認証され、`onBehalfOfContentOwner` を指定する必要があります。
`mine`	`boolean` このパラメータは、適切に承認されたリクエストでのみ使用できます。認証されたユーザーが所有するチャンネルのみを返すように API に指示するには、このパラメータの値を `true` に設定します。
オプションパラメータ
`hl`	`string` `hl` パラメータは、YouTube ウェブサイトがサポートする特定のアプリケーション言語用にローカライズされたリソースメタデータを取得するよう API に指示します。パラメータ値には、`i18nLanguages.list` メソッドから返されるリストに含まれている言語コードを指定する必要があります。ローカライズされたリソースの詳細がその言語で利用可能な場合、リソースの `snippet.localized` オブジェクトにはローカライズされた値が含まれます。ただし、ローカライズされた詳細を利用できない場合、`snippet.localized` オブジェクトには、リソースのデフォルトの言語でリソースの詳細が含まれます。
`maxResults`	`unsigned integer` `maxResults` パラメータは、結果セットで返されるアイテムの最大数を指定します。有効な値は `0`～`50` です。デフォルト値は `5` です。
`onBehalfOfContentOwner`	`string` このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツパートナー専用です。 `onBehalfOfContentOwner` パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の代理である YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツパートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネルデータにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。
`pageToken`	`string` `pageToken` パラメータは、結果セットの特定のページを返します。API レスポンスでは、`nextPageToken` プロパティと `prevPageToken` プロパティは取得可能な他のページを示します。

リクエスト本文

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

レスポンス

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

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

プロパティ

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

プロパティ
`kind`	`string` API リソースのタイプを識別します。値は `youtube#channelListResponse` です。
`etag`	`etag` このリソースの Etag。
`nextPageToken`	`string` 結果セットで次のページを取得するために、`pageToken` パラメータの値として使用できるトークン。
`prevPageToken`	`string` 結果セット内の前のページを取得するために、`pageToken` パラメータの値として使用できるトークン。対応する API リクエストで `managedByMe` パラメータが `true` に設定されている場合、このプロパティは API レスポンスに含まれません。
`pageInfo`	`object` `pageInfo` オブジェクトは、結果セットのページング情報をカプセル化します。
`pageInfo.totalResults`	`integer` 結果セット内の結果の合計数。
`pageInfo.resultsPerPage`	`integer` API レスポンスに含まれる結果の数。
`items[]`	`list` リクエスト条件に一致するチャンネルのリスト。

エラー

次の表に、このメソッドの呼び出しに対して API から返されるエラーメッセージを示します。詳細については、エラーメッセージのドキュメントを参照してください。

エラーのタイプ	エラーの詳細	説明
`badRequest (400)`	`invalidCriteria`	次のフィルタのいずれか 1 つまでを指定できます:`id`、`categoryId`、`mine`、`managedByMe`、`forHandle`、`forUsername`。`onBehalfOfContentOwner` パラメータでコンテンツ所有者の認証を行う場合、指定できるのは `id` または `managedByMe` のみです。
`forbidden (403)`	`channelForbidden`	`id` パラメータで指定されたチャネルがリクエストをサポートしていないか、リクエストが適切に承認されていません。
`notFound (404)`	`categoryNotFound`	`categoryId` パラメータで指定されたカテゴリが見つかりません。guideCategories.list メソッドを使用して、有効な値のリストを取得します。
`notFound (404)`	`channelNotFound`	`id` パラメータで指定されたチャンネルが見つかりません。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。