Search

検索結果には、API リクエストで指定した検索パラメータに一致する YouTube 動画、チャンネル、または再生リストに関する情報が含まれます。検索結果は、動画など一意に識別可能なリソースを出力しますが、検索結果自体は永続的なデータを持ちません。

メソッド

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

list
API リクエストで指定したクエリ パラメータに一致する検索結果のコレクションを返します。デフォルトでは、検索結果のセットでは一致する videochannelplaylist の各リソースが識別されますが、特定の種類のリソースだけを取得するようにクエリを設定することもできます。 今すぐ試す

リソース表現

下記の 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
  }
}

プロパティ

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

プロパティ
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 8601YYYY-MM-DDThh:mm:ss.sZ)形式で指定します。
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 です。
snippet.thumbnails.(key).url string
画像の URL。
snippet.thumbnails.(key).width unsigned integer
画像の幅。
snippet.thumbnails.(key).height unsigned integer
画像の高さ。
snippet.channelTitle string
検索結果が特定したリソースを発行したチャンネルのタイトル。