Channels: list

注: channel リソースの statistics.subscriberCount プロパティ値が更新され、チャンネル登録者数の表示方法に影響する YouTube ポリシーの変更が反映されました。詳しくは、リビジョン履歴または 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
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータの値を true に設定すると、認証されたユーザーが所有するチャンネルのみを返すように API に指示します。
オプション パラメータ
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 プロパティには、取得可能な他のページが指定されています。

リクエスト本文

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

Response

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

{
  "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 から返される可能性のあるエラー メッセージを示します。詳細については、YouTube Data API - エラーをご覧ください。

エラーのタイプ エラーの詳細 説明
badRequest (400) invalidCriteria 指定できるフィルタは、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 リクエストとレスポンスを確認します。