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 |
stringAPI リソースのタイプを識別します。値は youtube#searchResult になります。 |
etag |
etagこのリソースの Etag。 |
id |
objectid オブジェクトには、検索リクエストに一致するリソースを一意に識別するために使用できる情報が含まれます。 |
id.kind |
stringAPI リソースのタイプ。 |
id.videoId |
stringid.type プロパティの値が youtube#video の場合、このプロパティが存在し、その値には、検索クエリに一致する動画を一意に識別するために YouTube が使用する ID が含まれます。 |
id.channelId |
stringid.type プロパティの値が youtube#channel の場合、このプロパティが存在し、その値には、検索クエリに一致するチャンネルを一意に識別するために YouTube が使用する ID が含まれます。 |
id.playlistId |
stringid.type プロパティの値が youtube#playlist の場合、このプロパティが存在し、その値には、検索クエリに一致する再生リストを一意に識別するために YouTube が使用する ID が含まれます。 |
snippet |
objectsnippet オブジェクトには、タイトルや説明など、検索結果に関する基本情報が含まれます。たとえば、検索結果が動画の場合、タイトルはその動画のタイトルで、説明はその動画の説明です。 |
snippet.publishedAt |
datetime検索結果で識別されるリソースの作成日時。値は ISO 8601 形式で指定します。 |
snippet.channelId |
stringYouTube が検索結果で識別されたリソースを公開したチャンネルを一意に識別するために使用する値。 |
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 |
stringvideo リソースまたは channel リソースにライブ配信コンテンツがあるかどうかを示す。有効なプロパティ値は upcoming、live、none です。video リソースの場合、値が upcoming であれば、動画がまだ開始されていないライブ配信であることを示します。値が live であれば、動画がアクティブなライブ配信であることを示します。channel リソースの場合、値 upcoming は、チャンネルにまだ開始されていないスケジュール設定されたブロードキャストがあることを示します。値 live は、チャンネルにアクティブなライブ配信があることを示します。 |