Search

search 結果には、API リクエストで指定された検索パラメータに一致する YouTube 動画、チャンネル、または再生リストに関する情報が含まれます。検索結果は、動画などの特定可能なリソースを指しますが、独自の永続データはありません。

メソッド

この API では、検索について以下のメソッドがサポートされています。

list
API リクエストで指定されたクエリ パラメータに一致する検索結果のコレクションを返します。デフォルトでは、検索結果セットは一致する video、channel、playlist リソースを識別しますが、特定のタイプのリソースのみを取得するようにクエリを構成することもできます。ぜひ、こちらからお試しください。

リソース表現

次の JSON 構造は、検索結果の形式を示しています。

{
  "kind": "youtube#searchResult",
  "etag": etag,
  "id": {
    "kind": string,
    "videoId": string,
    "channelId": string,
    "playlistId": string
  },
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "liveBroadcastContent": string
  }
}

プロパティ

次の表は、検索結果で使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#searchResult になります。
etag etag
このリソースの Etag。
id object
id オブジェクトには、検索リクエストに一致するリソースを一意に識別するために使用できる情報が含まれています。
id.kind string
API リソースのタイプ。
id.videoId string
id.type プロパティの値が youtube#video の場合、このプロパティが存在し、その値には、検索クエリに一致する動画を一意に識別するために YouTube が使用する ID が含まれます。
id.channelId string
id.type プロパティの値が youtube#channel の場合、このプロパティが存在し、その値には、検索クエリに一致するチャンネルを一意に識別するために YouTube が使用する ID が含まれます。
id.playlistId string
id.type プロパティの値が youtube#playlist の場合、このプロパティが存在し、その値には、検索クエリに一致する再生リストを一意に識別するために YouTube が使用する ID が含まれます。
snippet object
snippet オブジェクトには、検索結果のタイトルや説明など、基本的な詳細情報が含まれます。たとえば、検索結果が動画の場合、タイトルはその動画のタイトルで、説明はその動画の説明です。
snippet.publishedAt datetime
検索結果が識別するリソースの作成日時。値は ISO 8601 形式で指定します。
snippet.channelId string
検索結果が特定したリソースを公開したチャンネルを一意に識別するために YouTube が使用する値。
snippet.title string
検索結果のタイトル。
snippet.description string
検索結果の説明。
snippet.thumbnails object
検索結果に関連付けられたサムネイル画像のマップ。マップ内の各オブジェクトでは、キーはサムネイル画像の名前で、値はサムネイルに関するその他の情報を含むオブジェクトになります。
snippet.thumbnails.(key) object
有効なキー値は次のとおりです。
  • default - デフォルトのサムネイル画像。動画（または、再生リストのアイテムや検索結果など、動画を参照するリソース）のデフォルト サムネイルは幅 120px、高さ 90px です。チャンネルのデフォルト サムネイルは幅 88px、高さ 88px です。
  • medium - サムネイル画像の高解像度版。動画（または動画を参照するリソース）の場合、この画像は幅 320px、高さ 180px です。チャンネルの場合は、幅 240px、高さ 240px です。
  • high - サムネイル画像の高解像度版。動画（または動画を参照するリソース）の場合、この画像は幅 480px、高さ 360px です。チャンネルの場合、幅 800px、高さ 800px です。
  • standard - high 解像度の画像よりもさらに高解像度のサムネイル画像。この画像は、一部の動画や、動画を参照する他のリソース（再生リスト アイテムや検索結果など）で利用できます。この画像のサイズは、幅 640 ピクセル、高さ 480 ピクセルです。
  • maxres - サムネイル画像の最高解像度バージョン。この画像サイズは、一部の動画や、動画を参照する他のリソース（再生リスト アイテムや検索結果など）で利用できます。この画像のサイズは幅 1,280 ピクセル、高さ 720 ピクセルです。

注: 1080p+ のサムネイル画像（fhd、qhd、uhd）は検索結果ではサポートされていません。高解像度のサムネイルを取得するには、リソースの ID を使用してリソース固有のエンドポイント（videos.list など）を呼び出します。
snippet.thumbnails.(key).url string
画像の URL。
snippet.thumbnails.(key).width unsigned integer
画像の幅。
snippet.thumbnails.(key).height unsigned integer
画像の高さ。
snippet.channelTitle string
検索結果が識別するリソースを公開したチャンネルのタイトル。
snippet.liveBroadcastContent string
video リソースまたは channel リソースにライブ配信コンテンツがあるかどうかを示す。有効なプロパティ値は upcoming、live、none です。

video リソースの場合、値が upcoming の場合は、動画がまだ開始されていないライブ配信であることを示し、値が live の場合は、動画がアクティブなライブ配信であることを示します。channel リソースの場合、値 upcoming は、チャンネルにまだ開始されていないスケジュール設定済みのブロードキャストがあることを示し、値 live は、チャンネルにアクティブなライブ配信があることを示します。