自訂搜尋要求的回應。
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 |
目前物件類型的專屬 ID。這個 API 就是 customsearch#search。 |
url |
定義此 API 範本的 OpenSearch 網址元素。 |
url.type |
Custom Search JSON API 的 OpenSearch 網址範本 MIME 類型。 |
url.template |
這個 API 的實際 OpenSearch 範本。 |
queries |
包含一或多組查詢中繼資料,各角色名稱的索引鍵。可能的角色名稱包括 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 的搜尋結果篩選器,請參閱自動篩選。這個參數的有效值如下:
注意:根據預設,Google 會對所有搜尋結果套用篩選功能,以改善這些搜尋結果的品質。 |
queries.previousPage[].gl |
針對來源國家/地區與參數值相符的搜尋結果提升排名。如需有效值的清單,請參閱國家/地區代碼。 在 WebSearch 要求中指定 |
queries.previousPage[].cr |
限制顯示來自特定國家/地區的文件搜尋結果。您可以在 Google WebSearch 會分析下列項目,判斷文件的國家/地區:
如需這個參數的有效值清單,請參閱國家/地區 (cr) 參數值。 |
queries.previousPage[].googleHost |
指定應限制搜尋的 Google 網域 (例如 google.com、google.de 或 google.fr)。 |
queries.previousPage[].disableCnTwTranslation |
支援的值如下:
|
queries.previousPage[].hq |
將指定查詢字詞附加至查詢,如同與邏輯 |
queries.previousPage[].hl |
指定使用者介面的介面語言 (主機語言)。明確設定這個參數可改善搜尋結果的效能和品質。 詳情請參閱國際化查詢和結果呈現的介面語言一節;如需支援的語言清單,請參閱「支援的語言介面語言」。 |
queries.previousPage[].siteSearch |
限制系統只顯示來自指定網站的網址結果。 |
queries.previousPage[].siteSearchFilter |
指定要納入或排除
|
queries.previousPage[].exactTerms |
識別搜尋結果中所有文件都必須包含的詞組。 |
queries.previousPage[].excludeTerms |
識別不應出現在任何文件文件的字詞或詞組。 |
queries.previousPage[].linkSite |
指定所有結果都應包含特定網址的連結。 |
queries.previousPage[].orTerms |
提供要在文件中尋找的其他搜尋字詞,讓搜尋結果中的每份文件必須包含至少一個其他搜尋字詞。您也可以透過「Boolean OR」查詢字詞執行這類查詢。 |
queries.previousPage[].relatedSite |
指定所有搜尋結果應為與指定網址相關的網頁。參數值必須是網址。 |
queries.previousPage[].dateRestrict |
以日期來限制系統顯示網址的結果。支援的值包括:
|
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 的搜尋結果篩選器,請參閱自動篩選。這個參數的有效值如下:
注意:根據預設,Google 會對所有搜尋結果套用篩選功能,以改善這些搜尋結果的品質。 |
queries.request[].gl |
針對來源國家/地區與參數值相符的搜尋結果提升排名。如需有效值的清單,請參閱國家/地區代碼。 在 WebSearch 要求中指定 |
queries.request[].cr |
限制顯示來自特定國家/地區的文件搜尋結果。您可以在 Google WebSearch 會分析下列項目,判斷文件的國家/地區:
如需這個參數的有效值清單,請參閱國家/地區 (cr) 參數值。 |
queries.request[].googleHost |
指定應限制搜尋的 Google 網域 (例如 google.com、google.de 或 google.fr)。 |
queries.request[].disableCnTwTranslation |
支援的值如下:
|
queries.request[].hq |
將指定查詢字詞附加至查詢,如同與邏輯 |
queries.request[].hl |
指定使用者介面的介面語言 (主機語言)。明確設定這個參數可改善搜尋結果的效能和品質。 詳情請參閱國際化查詢和結果呈現的介面語言一節;如需支援的語言清單,請參閱「支援的語言介面語言」。 |
queries.request[].siteSearch |
限制系統只顯示來自指定網站的網址結果。 |
queries.request[].siteSearchFilter |
指定要納入或排除
|
queries.request[].exactTerms |
識別搜尋結果中所有文件都必須包含的詞組。 |
queries.request[].excludeTerms |
識別不應出現在任何文件文件的字詞或詞組。 |
queries.request[].linkSite |
指定所有結果都應包含特定網址的連結。 |
queries.request[].orTerms |
提供要在文件中尋找的其他搜尋字詞,讓搜尋結果中的每份文件必須包含至少一個其他搜尋字詞。您也可以透過「Boolean OR」查詢字詞執行這類查詢。 |
queries.request[].relatedSite |
指定所有搜尋結果應為與指定網址相關的網頁。參數值必須是網址。 |
queries.request[].dateRestrict |
以日期來限制系統顯示網址的結果。支援的值包括:
|
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 的搜尋結果篩選器,請參閱自動篩選。這個參數的有效值如下:
注意:根據預設,Google 會對所有搜尋結果套用篩選功能,以改善這些搜尋結果的品質。 |
queries.nextPage[].gl |
針對來源國家/地區與參數值相符的搜尋結果提升排名。如需有效值的清單,請參閱國家/地區代碼。 在 WebSearch 要求中指定 |
queries.nextPage[].cr |
限制顯示來自特定國家/地區的文件搜尋結果。您可以在 Google WebSearch 會分析下列項目,判斷文件的國家/地區:
如需這個參數的有效值清單,請參閱國家/地區 (cr) 參數值。 |
queries.nextPage[].googleHost |
指定應限制搜尋的 Google 網域 (例如 google.com、google.de 或 google.fr)。 |
queries.nextPage[].disableCnTwTranslation |
支援的值如下:
|
queries.nextPage[].hq |
將指定查詢字詞附加至查詢,如同與邏輯 |
queries.nextPage[].hl |
指定使用者介面的介面語言 (主機語言)。明確設定這個參數可改善搜尋結果的效能和品質。 詳情請參閱國際化查詢和結果呈現的介面語言一節;如需支援的語言清單,請參閱「支援的語言介面語言」。 |
queries.nextPage[].siteSearch |
限制系統只顯示來自指定網站的網址結果。 |
queries.nextPage[].siteSearchFilter |
指定要納入或排除
|
queries.nextPage[].exactTerms |
識別搜尋結果中所有文件都必須包含的詞組。 |
queries.nextPage[].excludeTerms |
識別不應出現在任何文件文件的字詞或詞組。 |
queries.nextPage[].linkSite |
指定所有結果都應包含特定網址的連結。 |
queries.nextPage[].orTerms |
提供要在文件中尋找的其他搜尋字詞,讓搜尋結果中的每份文件必須包含至少一個其他搜尋字詞。您也可以透過「Boolean OR」查詢字詞執行這類查詢。 |
queries.nextPage[].relatedSite |
指定所有搜尋結果應為與指定網址相關的網頁。參數值必須是網址。 |
queries.nextPage[].dateRestrict |
以日期來限制系統顯示網址的結果。支援的值包括:
|
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 |
促銷活動的網址。 |
displayLink |
這筆搜尋結果的精簡版本網址,例如 www.example.com。 |
bodyLines[] |
此促銷活動的區塊物件陣列。 |
bodyLines[].title |
區塊物件的文字 (如果包含文字)。 |
bodyLines[].htmlTitle |
區塊物件在 HTML 中的文字 (如果包含文字)。 |
bodyLines[].url |
區塊物件連結的網址 (如有)。 |
bodyLines[].link |
區塊物件連結的錨定文字 (如有連結)。 |
image |
與這個促銷活動相關聯的圖片 (如有)。 |
image.source |
這個促銷活動連結的圖片網址。 |
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 |
目前物件類型的專屬 ID。這個 API 為 |
title |
以純文字顯示的搜尋結果標題。 |
htmlTitle |
HTML 中的搜尋結果標題。 |
link |
搜尋結果指向的完整網址,例如 http://www.example.com/foo/bar。 |
displayLink |
這項搜尋結果的精簡版本,例如 www.example.com。 |
snippet |
以純文字顯示的搜尋結果摘要。 |
htmlSnippet |
搜尋結果的摘要 (在 HTML 中)。 |
cacheId |
指出 Google 搜尋結果的快取版本 ID。 |
formattedUrl |
每筆搜尋結果在摘要後方顯示的網址。 |
htmlFormattedUrl |
每個搜尋結果的摘要後方所顯示的 HTML 格式網址。 |
pagemap |
包含這個搜尋結果的 PageMap 資訊。 |
mime |
搜尋結果的 MIME 類型。 |
fileFormat |
搜尋結果的檔案格式。 |
image |
封裝搜尋結果中傳回的圖片的所有資訊。 |
image.contextLink |
指向代管該圖片網頁的網址。 |
image.height |
圖片的高度,以像素為單位。 |
image.width |
圖片的寬度,以像素為單位。 |
image.byteSize |
圖片大小,以像素為單位。 |
image.thumbnailLink |
縮圖網址。 |
image.thumbnailHeight |
縮圖的高度,以像素為單位。 |
image.thumbnailWidth |
縮圖的寬度 (以像素為單位)。 |
labels[] |
封裝有關修正標籤的所有資訊。 |
labels[].name |
修正標籤的名稱,可用來縮小搜尋範圍。請勿在使用者介面中顯示這項資訊,請改用 displayName。 |
labels[].displayName |
修正標籤的顯示名稱。這是您在使用者介面中顯示的名稱。 |
labels[].label_with_op |
修正標籤和相關的修正作業。 |