Channels: list

リクエスト条件に一致するゼロ個以上の channel リソースを返します。 今すぐ試す

リクエスト

HTTP リクエスト

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

パラメータ

下記の表は、このクエリでサポートされているパラメータの一覧です。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
part パラメータには、API レスポンスに含める 1 つまたは複数の channel リソース プロパティをカンマ区切りリストの形式で指定します。このパラメータに指定できる part 名は idsnippetbrandingSettingscontentDetailsinvideoPromotionstatisticstopicDetails です。

このパラメータに子プロパティを持つプロパティが指定されている場合、その子プロパティもレスポンスに含まれます。たとえば、channel リソースで、contentDetails プロパティに uploads プロパティなど、他のプロパティが含まれているとします。この場合、part=contentDetails と設定すると、API レスポンスには、これらのネストされたプロパティもすべて含まれることになります。
フィルタ(以下のパラメータのいずれか 1 つのみを指定します)
categoryId string
categoryId パラメータには YouTube ガイド カテゴリを指定します。これにより、そのカテゴリに関連付けられている YouTube チャンネルがリクエストされます。
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 に指示が送られます。
mySubscribers boolean
このパラメータのサポートは終了しました。このパラメータは、適切に承認されたリクエストでのみ使用できます。認証されたユーザーのチャンネルへの登録者リストを取得するには、subscriptions.list メソッドとその mySubscribers パラメータを使用します。
省略可能なパラメータ
maxResults unsigned integer
maxResults パラメータには、結果セットで返されるアイテムの最大数を指定します。{0/} 以上 50 以下の値を指定できます。デフォルト値は 5 です。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの承認用認証情報が、パラメータ値で指定されたコンテンツ所有者の代理人である YouTube CMS ユーザーのものであることを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。
pageToken string
pageToken パラメータには、返される結果セットに含める特定のページを指定します。API レスポンスでは、nextPageTokenprevPageToken プロパティは取得可能な他のページを表します。

リクエストの本文

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

レスポンス

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

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    チャンネル リソース
  ]
}

プロパティ

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

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

エラー

次の表は、このメソッドを呼び出したときに API からレスポンスとして返される可能性のあるエラー メッセージの一覧です。詳細については、エラー メッセージのドキュメントを参照してください。

エラー タイプ エラーの詳細 説明
forbidden channelForbidden id パラメータで指定されたチャンネルは、リクエストをサポートしていません。または、リクエストが適切に認証されていません。
notFound categoryNotFound categoryId パラメータにより特定されているカテゴリが見つかりません。guideCategories.list メソッドを使用して、有効な値のリストを取得してください。
notFound channelNotFound id パラメータで指定されたチャンネルが見つかりません。

実際に試してみる

API Explorer を使用し、ライブ データに対してこのメソッドを呼び出して、API リクエストとレスポンスを確認してください。