Videos: list

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

割り当てへの影響: このメソッドを呼び出すと、割り当てコストは 1 単位になります。

一般的なユースケース

リクエスト

HTTP リクエスト

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

パラメータ

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

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

このパラメータで子プロパティを含むプロパティを指定すると、その子プロパティがレスポンスに含まれます。たとえば、video リソースでは、snippet プロパティに channelIdtitledescriptiontagscategoryId の各プロパティが含まれています。そのため、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 より短くてもかまいません。有効な値は 728192(指定した値を含む)です。
maxResults unsigned integer
maxResults パラメータは、結果セットで返される商品アイテムの最大数を指定します。

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

maxHeight パラメータも指定すると、最大の高さを損なわないよう、プレーヤーを maxWidth よりも狭くできます。有効な値は 728192(指定した値を含む)です。
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 リクエストに動画ファイルや処理情報にアクセスする権限がありません。fileDetailsprocessingDetailssuggestions の部分は、その動画の所有者だけが利用できます。
forbidden (403) forbidden リクエストは、ユーザー評価情報にアクセスできません。このエラーは、リクエストに myRating パラメータを使用する権限が適切に付与されていない場合に発生することがあります。
notFound (404) videoNotFound 取得しようとしている動画が見つかりません。リクエストの id パラメータの値が正しいことを確認してください。

実習

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