カスタム検索リクエストに対するレスポンス。
| JSON 表現 |
|---|
{ "kind": string, "url": { "type": string, "template": string }, "queries": { "previousPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "request": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "nextPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ] }, "promotions": [ { object ( |
| フィールド | |
|---|---|
kind |
現在のオブジェクト タイプの一意の識別子。この API では customsearch#search です。 |
url |
この API のテンプレートを定義する OpenSearch URL 要素。 |
url.type |
Custom Search JSON API の OpenSearch URL テンプレートの MIME タイプ。 |
url.template |
この API の実際の OpenSearch テンプレート。 |
queries |
ロール名をキーとする、1 つ以上のクエリ メタデータのセットが含まれます。可能なロール名には、OpenSearch クエリのロールによって定義される |
queries.previousPage[] |
結果の前のページを表すメタデータ(該当する場合)。 |
queries.previousPage[].title |
クエリの説明。 |
queries.previousPage[].totalResults |
検索結果の推定合計数。正確でない場合があります。 |
queries.previousPage[].searchTerms |
ユーザーが入力した検索キーワード。 |
queries.previousPage[].count |
このセットで返された検索結果の数。 |
queries.previousPage[].startIndex |
結果セット全体に対する現在の検索結果セットのインデックス。最初の結果のインデックスは 1 です。 |
queries.previousPage[].startPage |
この結果セットのページ番号。ページの長さは |
queries.previousPage[].language |
検索結果の言語。 |
queries.previousPage[].inputEncoding |
検索リクエストでサポートされている文字エンコード。 |
queries.previousPage[].outputEncoding |
検索結果でサポートされている文字エンコード。 |
queries.previousPage[].safe |
アダルト コンテンツの検索結果を除外するために使用するセーフサーチ レベルを指定します。これは、OpenSearch 仕様で定義されていないカスタム プロパティです。有効なパラメータ値は次のとおりです。
|
queries.previousPage[].cx |
プログラム可能検索エンジンのコントロール パネルを使用して作成されたエンジンの識別子。これは、OpenSearch 仕様で定義されていないカスタム プロパティです。このパラメータは必須です。 |
queries.previousPage[].sort |
指定した式に従って結果を並べ替えるよう指定します。たとえば、日付順に並べ替えることができます。 |
queries.previousPage[].filter |
Google の検索結果の自動フィルタを有効または無効にします。Google の検索結果フィルタについて詳しくは、自動フィルタリングをご覧ください。このパラメータで有効な値は次のとおりです。
注: デフォルトでは、検索結果の品質を高めるため、すべての検索結果にフィルタが適用されます。 |
queries.previousPage[].gl |
検索元の国がパラメータ値と一致する検索結果を優先します。有効な値の一覧については国コードをご覧ください。 WebSearch リクエストで |
queries.previousPage[].cr |
検索結果を、特定の国で作成されたドキュメントに限定します。 Google ウェブ検索では、次の情報を分析してドキュメントの国を特定します。
このパラメータの有効な値の一覧については、国(cr)パラメータ値をご覧ください。 |
queries.previousPage[].googleHost |
検索を制限する Google ドメイン(google.com、google.de、google.fr など)を指定します。 |
queries.previousPage[].disableCnTwTranslation |
中国語(簡体字と繁体字)の検索機能を有効または無効にします。 サポートされている値は次のとおりです。
|
queries.previousPage[].hq |
指定されたクエリ語句を |
queries.previousPage[].hl |
ユーザー インターフェースの言語(ホスト言語)を指定します。このパラメータを明示的に設定すると、検索結果のパフォーマンスと品質が向上します。 詳しくは、クエリと結果の表示の国際化のインターフェース言語セクションをご覧ください。また、サポートされている言語の一覧については、サポートされているインターフェース言語をご覧ください。 |
queries.previousPage[].siteSearch |
検索結果を指定したサイトの URL に限定します。 |
queries.previousPage[].siteSearchFilter |
|
queries.previousPage[].exactTerms |
検索結果内のすべてのドキュメントに含まれる必要があるフレーズを識別します。 |
queries.previousPage[].excludeTerms |
検索結果のドキュメントに含めてはならない単語またはフレーズを識別します。 |
queries.previousPage[].linkSite |
すべての結果に特定の URL へのリンクを含めるように指定します。 |
queries.previousPage[].orTerms |
ドキュメントで照合する追加の検索キーワードを指定します。検索結果の各ドキュメントには、追加の検索キーワードが少なくとも 1 つ含まれている必要があります。このタイプのクエリには、ブール値 OR クエリ語句を使用することもできます。 |
queries.previousPage[].relatedSite |
指定した URL に関連するページの検索結果をすべて表示するように指定します。パラメータ値には URL を指定します。 |
queries.previousPage[].dateRestrict |
日付に基づいて、検索結果を URL に限定します。次の値がサポートされています。
|
queries.previousPage[].lowRange |
検索範囲の開始値を指定します。 |
queries.previousPage[].highRange |
検索範囲の終了値を指定します。 |
queries.previousPage[].fileType |
結果を指定した拡張子のファイルのみに制限します。Google がサポートしているファイル形式は次のとおりです。
今後、他のファイル形式が追加される可能性があります。最新のリストは、Google のファイル形式に関するよくある質問でいつでも確認できます。 |
queries.previousPage[].rights |
ライセンスに基づくフィルタ。次の値がサポートされています。
|
queries.previousPage[].searchType |
使用できる値は |
queries.previousPage[].imgSize |
結果を指定したサイズの画像に制限します。サポートされている値は次のとおりです。
|
queries.previousPage[].imgType |
結果を指定されたタイプの画像に制限します。サポートされている値は次のとおりです。
|
queries.previousPage[].imgColorType |
結果を指定した色のタイプの画像に制限します。指定できる値は次のとおりです。
|
queries.previousPage[].imgDominantColor |
結果を特定のドミナント カラーの画像に限定します。サポートされている値は次のとおりです。
|
queries.request[] |
現在のリクエストを表すメタデータ。 |
queries.request[].title |
クエリの説明。 |
queries.request[].totalResults |
検索結果の推定合計数。正確でない場合があります。 |
queries.request[].searchTerms |
ユーザーが入力した検索キーワード。 |
queries.request[].count |
このセットで返された検索結果の数。 |
queries.request[].startIndex |
結果セット全体に対する現在の検索結果セットのインデックス。最初の結果のインデックスは 1 です。 |
queries.request[].startPage |
この結果セットのページ番号。ページの長さは |
queries.request[].language |
検索結果の言語。 |
queries.request[].inputEncoding |
検索リクエストでサポートされている文字エンコード。 |
queries.request[].outputEncoding |
検索結果でサポートされている文字エンコード。 |
queries.request[].safe |
アダルト コンテンツの検索結果を除外するために使用するセーフサーチ レベルを指定します。これは、OpenSearch 仕様で定義されていないカスタム プロパティです。有効なパラメータ値は次のとおりです。
|
queries.request[].cx |
プログラム可能検索エンジンのコントロール パネルを使用して作成されたエンジンの識別子。これは、OpenSearch 仕様で定義されていないカスタム プロパティです。このパラメータは必須です。 |
queries.request[].sort |
指定した式に従って結果を並べ替えるよう指定します。たとえば、日付順に並べ替えることができます。 |
queries.request[].filter |
Google の検索結果の自動フィルタを有効または無効にします。Google の検索結果フィルタについて詳しくは、自動フィルタリングをご覧ください。このパラメータで有効な値は次のとおりです。
注: デフォルトでは、検索結果の品質を高めるため、すべての検索結果にフィルタが適用されます。 |
queries.request[].gl |
検索元の国がパラメータ値と一致する検索結果を優先します。有効な値の一覧については国コードをご覧ください。 WebSearch リクエストで |
queries.request[].cr |
検索結果を、特定の国で作成されたドキュメントに限定します。 Google ウェブ検索では、次の情報を分析してドキュメントの国を特定します。
このパラメータの有効な値の一覧については、国(cr)パラメータ値をご覧ください。 |
queries.request[].googleHost |
検索を制限する Google ドメイン(google.com、google.de、google.fr など)を指定します。 |
queries.request[].disableCnTwTranslation |
中国語(簡体字と繁体字)の検索機能を有効または無効にします。 サポートされている値は次のとおりです。
|
queries.request[].hq |
指定されたクエリ語句を |
queries.request[].hl |
ユーザー インターフェースの言語(ホスト言語)を指定します。このパラメータを明示的に設定すると、検索結果のパフォーマンスと品質が向上します。 詳しくは、クエリと結果の表示の国際化のインターフェース言語セクションをご覧ください。また、サポートされている言語の一覧については、サポートされているインターフェース言語をご覧ください。 |
queries.request[].siteSearch |
検索結果を指定したサイトの URL に限定します。 |
queries.request[].siteSearchFilter |
|
queries.request[].exactTerms |
検索結果内のすべてのドキュメントに含まれる必要があるフレーズを識別します。 |
queries.request[].excludeTerms |
検索結果のドキュメントに含めてはならない単語またはフレーズを識別します。 |
queries.request[].linkSite |
すべての結果に特定の URL へのリンクを含めるように指定します。 |
queries.request[].orTerms |
ドキュメントで照合する追加の検索キーワードを指定します。検索結果の各ドキュメントには、追加の検索キーワードが少なくとも 1 つ含まれている必要があります。このタイプのクエリには、ブール値 OR クエリ語句を使用することもできます。 |
queries.request[].relatedSite |
指定した URL に関連するページの検索結果をすべて表示するように指定します。パラメータ値には URL を指定します。 |
queries.request[].dateRestrict |
日付に基づいて、検索結果を URL に限定します。次の値がサポートされています。
|
queries.request[].lowRange |
検索範囲の開始値を指定します。 |
queries.request[].highRange |
検索範囲の終了値を指定します。 |
queries.request[].fileType |
結果を指定した拡張子のファイルのみに制限します。Google がサポートしているファイル形式は次のとおりです。
今後、他のファイル形式が追加される可能性があります。最新のリストは、Google のファイル形式に関するよくある質問でいつでも確認できます。 |
queries.request[].rights |
ライセンスに基づくフィルタ。次の値がサポートされています。
|
queries.request[].searchType |
使用できる値は |
queries.request[].imgSize |
結果を指定したサイズの画像に制限します。サポートされている値は次のとおりです。
|
queries.request[].imgType |
結果を指定されたタイプの画像に制限します。サポートされている値は次のとおりです。
|
queries.request[].imgColorType |
結果を指定した色のタイプの画像に制限します。指定できる値は次のとおりです。
|
queries.request[].imgDominantColor |
結果を特定のドミナント カラーの画像に限定します。サポートされている値は次のとおりです。
|
queries.nextPage[] |
結果の次のページを表すメタデータ(該当する場合)。 |
queries.nextPage[].title |
クエリの説明。 |
queries.nextPage[].totalResults |
検索結果の推定合計数。正確でない場合があります。 |
queries.nextPage[].searchTerms |
ユーザーが入力した検索キーワード。 |
queries.nextPage[].count |
このセットで返された検索結果の数。 |
queries.nextPage[].startIndex |
結果セット全体に対する現在の検索結果セットのインデックス。最初の結果のインデックスは 1 です。 |
queries.nextPage[].startPage |
この結果セットのページ番号。ページの長さは |
queries.nextPage[].language |
検索結果の言語。 |
queries.nextPage[].inputEncoding |
検索リクエストでサポートされている文字エンコード。 |
queries.nextPage[].outputEncoding |
検索結果でサポートされている文字エンコード。 |
queries.nextPage[].safe |
アダルト コンテンツの検索結果を除外するために使用するセーフサーチ レベルを指定します。これは、OpenSearch 仕様で定義されていないカスタム プロパティです。有効なパラメータ値は次のとおりです。
|
queries.nextPage[].cx |
プログラム可能検索エンジンのコントロール パネルを使用して作成されたエンジンの識別子。これは、OpenSearch 仕様で定義されていないカスタム プロパティです。このパラメータは必須です。 |
queries.nextPage[].sort |
指定した式に従って結果を並べ替えるよう指定します。たとえば、日付順に並べ替えることができます。 |
queries.nextPage[].filter |
Google の検索結果の自動フィルタを有効または無効にします。Google の検索結果フィルタについて詳しくは、自動フィルタリングをご覧ください。このパラメータで有効な値は次のとおりです。
注: デフォルトでは、検索結果の品質を高めるため、すべての検索結果にフィルタが適用されます。 |
queries.nextPage[].gl |
検索元の国がパラメータ値と一致する検索結果を優先します。有効な値の一覧については国コードをご覧ください。 WebSearch リクエストで |
queries.nextPage[].cr |
検索結果を、特定の国で作成されたドキュメントに限定します。 Google ウェブ検索では、次の情報を分析してドキュメントの国を特定します。
このパラメータの有効な値の一覧については、国(cr)パラメータ値をご覧ください。 |
queries.nextPage[].googleHost |
検索を制限する Google ドメイン(google.com、google.de、google.fr など)を指定します。 |
queries.nextPage[].disableCnTwTranslation |
中国語(簡体字と繁体字)の検索機能を有効または無効にします。 サポートされている値は次のとおりです。
|
queries.nextPage[].hq |
指定されたクエリ語句を |
queries.nextPage[].hl |
ユーザー インターフェースの言語(ホスト言語)を指定します。このパラメータを明示的に設定すると、検索結果のパフォーマンスと品質が向上します。 詳しくは、クエリと結果の表示の国際化のインターフェース言語セクションをご覧ください。また、サポートされている言語の一覧については、サポートされているインターフェース言語をご覧ください。 |
queries.nextPage[].siteSearch |
検索結果を指定したサイトの URL に限定します。 |
queries.nextPage[].siteSearchFilter |
|
queries.nextPage[].exactTerms |
検索結果内のすべてのドキュメントに含まれる必要があるフレーズを識別します。 |
queries.nextPage[].excludeTerms |
検索結果のドキュメントに含めてはならない単語またはフレーズを識別します。 |
queries.nextPage[].linkSite |
すべての結果に特定の URL へのリンクを含めるように指定します。 |
queries.nextPage[].orTerms |
ドキュメントで照合する追加の検索キーワードを指定します。検索結果の各ドキュメントには、追加の検索キーワードが少なくとも 1 つ含まれている必要があります。このタイプのクエリには、ブール値 OR クエリ語句を使用することもできます。 |
queries.nextPage[].relatedSite |
指定した URL に関連するページの検索結果をすべて表示するように指定します。パラメータ値には URL を指定します。 |
queries.nextPage[].dateRestrict |
日付に基づいて、検索結果を URL に限定します。次の値がサポートされています。
|
queries.nextPage[].lowRange |
検索範囲の開始値を指定します。 |
queries.nextPage[].highRange |
検索範囲の終了値を指定します。 |
queries.nextPage[].fileType |
結果を指定した拡張子のファイルのみに制限します。Google がサポートしているファイル形式は次のとおりです。
今後、他のファイル形式が追加される可能性があります。最新のリストは、Google のファイル形式に関するよくある質問でいつでも確認できます。 |
queries.nextPage[].rights |
ライセンスに基づくフィルタ。次の値がサポートされています。
|
queries.nextPage[].searchType |
使用できる値は |
queries.nextPage[].imgSize |
結果を指定したサイズの画像に制限します。サポートされている値は次のとおりです。
|
queries.nextPage[].imgType |
結果を指定されたタイプの画像に制限します。サポートされている値は次のとおりです。
|
queries.nextPage[].imgColorType |
結果を指定した色のタイプの画像に制限します。指定できる値は次のとおりです。
|
queries.nextPage[].imgDominantColor |
結果を特定のドミナント カラーの画像に限定します。サポートされている値は次のとおりです。
|
promotions[] |
プロモーションのセット。カスタム検索エンジンの構成ファイルで、指定されたクエリのプロモーションが定義されている場合にのみ存在します。 |
context |
指定した検索エンジンに関連付けられたメタデータと絞り込み。以下が含まれます。
|
searchInformation |
この検索に関するメタデータ(検索時間と合計結果など)。 |
searchInformation.searchTime |
サーバーが検索結果を返すまでにかかる時間。 |
searchInformation.formattedSearchTime |
サーバーが言語 / 地域スタイルに従ったフォーマットで検索結果を返すのにかかる時間。 |
searchInformation.totalResults |
クエリによって返された検索結果の合計数。 |
searchInformation.formattedTotalResults |
検索結果の合計数。言語 / 地域スタイルに沿った形式になっています。 |
spelling |
修正されたクエリをカプセル化します。 |
spelling.correctedQuery |
修正されたクエリ。 |
spelling.htmlCorrectedQuery |
修正されたクエリ(HTML 形式)。 |
items[] |
カスタム検索結果の現在のセット。 |
プロモーション
プロモーションの結果。
| JSON 表現 |
|---|
{ "title": string, "htmlTitle": string, "link": string, "displayLink": string, "bodyLines": [ { "title": string, "htmlTitle": string, "url": string, "link": string } ], "image": { "source": string, "width": integer, "height": integer } } |
| フィールド | |
|---|---|
title |
プロモーションのタイトル。 |
htmlTitle |
プロモーションのタイトル(HTML)。 |
link |
プロモーションの URL。 |
displayLink |
この検索結果 URL の要約版。例:www.example.com |
bodyLines[] |
このプロモーションのブロック オブジェクトの配列。 |
bodyLines[].title |
ブロック オブジェクトのテキスト(テキストがある場合)。 |
bodyLines[].htmlTitle |
HTML ブロック オブジェクトのテキスト(テキストがある場合)。 |
bodyLines[].url |
ブロック オブジェクトのリンクの URL(存在する場合)。 |
bodyLines[].link |
ブロック オブジェクトのリンクのアンカー テキスト(リンクがある場合)。 |
image |
このプロモーションに関連付けられている画像(ある場合)。 |
image.source |
このプロモーション リンクの画像の URL。 |
image.width |
ピクセル単位の画像の幅です。 |
image.height |
画像の高さ(ピクセル単位)。 |
結果
カスタム検索結果。
| JSON 表現 |
|---|
{ "kind": string, "title": string, "htmlTitle": string, "link": string, "displayLink": string, "snippet": string, "htmlSnippet": string, "cacheId": string, "formattedUrl": string, "htmlFormattedUrl": string, "pagemap": { object }, "mime": string, "fileFormat": string, "image": { "contextLink": string, "height": integer, "width": integer, "byteSize": integer, "thumbnailLink": string, "thumbnailHeight": integer, "thumbnailWidth": integer }, "labels": [ { "name": string, "displayName": string, "label_with_op": string } ] } |
| フィールド | |
|---|---|
kind |
現在のオブジェクト タイプの一意の識別子。この API の場合は、 |
title |
検索結果のタイトル(書式なしテキスト)。 |
htmlTitle |
検索結果のタイトル(HTML)。 |
link |
検索結果に表示される完全な URL(例:http://www.example.com/foo/bar. |
displayLink |
この検索結果の URL の簡約版。例:www.example.com |
snippet |
検索結果のスニペット(書式なしテキスト)。 |
htmlSnippet |
検索結果のスニペット(HTML)。 |
cacheId |
Google がキャッシュしている検索結果の ID を示します。 |
formattedUrl |
各検索結果のスニペットの後に表示される URL。 |
htmlFormattedUrl |
各検索結果のスニペットの後に表示される HTML 形式の URL。 |
pagemap |
この検索結果の PageMap 情報が含まれます。 |
mime |
検索結果の MIME タイプ。 |
fileFormat |
検索結果のファイル形式。 |
image |
検索結果で返される画像に関するすべての情報をカプセル化します。 |
image.contextLink |
画像をホストするウェブページの URL。 |
image.height |
ピクセル単位の画像の高さです。 |
image.width |
画像の幅(ピクセル単位)。 |
image.byteSize |
画像のサイズ(バイト単位)。 |
image.thumbnailLink |
サムネイル画像の URL。 |
image.thumbnailHeight |
サムネイル画像の高さ(ピクセル単位)。 |
image.thumbnailWidth |
サムネイル画像の幅(ピクセル単位)。 |
labels[] |
絞り込みラベルに関するすべての情報をカプセル化します。 |
labels[].name |
絞り込みラベルの名前。検索を絞り込むために使用できます。ユーザー インターフェースには表示しないでください。代わりに displayName を使用してください。 |
labels[].displayName |
絞り込みラベルの表示名。この名前がユーザー インターフェースに表示されます。 |
labels[].label_with_op |
絞り込みラベルと、関連する絞り込み操作。 |