検索結果には、API リクエストで指定された検索パラメータに一致する YouTube 動画、チャンネル、または再生リストに関する情報が含まれます。検索結果は動画などの一意に識別可能なリソースを指していますが、検索結果には固有の永続データはありません。
Methods
この API では、検索について以下のメソッドがサポートされています。
リソース表現
次の 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 有効なキー値は次のとおりです。
|
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 はチャンネルにアクティブなライブ配信があることを示します。 |