Videos: list

API リクエストのパラメータに一致する動画のリストを返します。

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

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

パラメータ
必須パラメータ
part string
part パラメータは、API レスポンスに含める 1 つ以上の video リソース プロパティのカンマ区切りのリストを指定します。

子プロパティを含むプロパティがパラメータで識別される場合、子プロパティはレスポンスに含まれます。たとえば、video リソースでは、snippet プロパティに channelId、title、description、tags、categoryId の各プロパティが含まれています。そのため、part=snippet を設定すると、API レスポンスにはこれらのプロパティがすべて含まれます。

次のリストは、パラメータ値に含めることができる part 名を示します。
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
フィルタ（次のパラメータのいずれか 1 つのみを指定）
chart string
chart パラメータは、取得するグラフを指定します。

有効な値は次のとおりです。
id string
id パラメータは、取得するリソースの YouTube 動画 ID のカンマ区切りのリストを指定します。video リソースでは、id プロパティに動画の ID を指定します。
myRating string
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータの値を like または dislike に設定して、認証されたユーザーが高く評価または低く評価した動画のみを返すように API に指示します。

有効な値は次のとおりです。
  • dislike – 認証されたユーザーが低く評価した動画のみを返します。
  • like – 認証されたユーザーが高く評価した動画のみを返します。
オプション パラメータ
hl string
hl パラメータは、YouTube ウェブサイトがサポートする特定のアプリケーション言語用にローカライズされたリソース メタデータを取得するよう API に指示します。パラメータ値には、i18nLanguages.list メソッドから返されるリストに含まれている言語コードを指定する必要があります。

ローカライズされたリソースの詳細がその言語で利用可能な場合、リソースの snippet.localized オブジェクトにはローカライズされた値が含まれます。ただし、ローカライズされた詳細を利用できない場合、snippet.localized オブジェクトには、リソースのデフォルトの言語でリソースの詳細が含まれます。
maxHeight unsigned integer
maxHeight パラメータは、player.embedHtml プロパティで返される埋め込みプレーヤーの最大の高さを指定します。このパラメータを使用すると、デフォルトのディメンションの代わりに、アプリのレイアウトに適した高さを埋め込みコードで指定するように指定できます。maxWidth パラメータも指定されている場合は、最大幅を超えないように、プレーヤーの長さを maxHeight より短くすることができます。有効な値は 72～8192 です。
maxResults unsigned integer
maxResults パラメータは、結果セットで返されるアイテムの最大数を指定します。

注: このパラメータは myRating パラメータと組み合わせて使用できますが、id パラメータと併用することはできません。有効な値は 1～50 です。デフォルト値は 5 です。
maxWidth unsigned integer
maxWidth パラメータは、player.embedHtml プロパティで返される埋め込みプレーヤーの最大幅を指定します。このパラメータを使用すると、デフォルトのサイズではなく、アプリのレイアウトに適した幅を埋め込みコードで指定するように指定できます。

maxHeight パラメータも指定すると、最大高を超えないようにプレーヤーの幅を maxWidth より狭くすることができます。有効な値は 72～8192 です。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。

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

注: このパラメータは myRating パラメータと組み合わせて使用できますが、id パラメータと組み合わせて使用することはできません。
regionCode string
regionCode パラメータは、指定されたリージョンで利用可能な動画チャートを選択するように API に指示します。このパラメータは、chart パラメータと組み合わせるとのみ使用できます。このパラメータの値は ISO 3166-1 alpha-2 の国コードです。
videoCategoryId string
videoCategoryId パラメータは、グラフを取得する動画のカテゴリを指定します。このパラメータは、chart パラメータと組み合わせるとのみ使用できます。デフォルトでは、グラフは特定のカテゴリに制限されていません。デフォルト値は 0 です。

リクエスト本文

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

レスポンス

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

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

プロパティ

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

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

エラー

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

エラーのタイプ エラーの詳細 説明
badRequest (400) videoChartNotFound リクエストされた動画チャートはサポートされていないか、使用できません。
forbidden (403) forbidden このリクエストには、動画ファイルまたは処理情報へのアクセス許可が適切に付与されていません。fileDetails、processingDetails、suggestions の部分を利用できるのは、その動画の所有者のみです。
forbidden (403) forbidden リクエストは、ユーザー評価情報にアクセスできません。このエラーは、リクエストが適切に承認されていないため、myRating パラメータを使用できない場合に発生することがあります。
notFound (404) videoNotFound 取得しようとしている動画が見つかりません。リクエストの id パラメータの値が正しいことを確認してください。

試してみよう:

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