會傳回所執行搜尋的相關中繼資料、搜尋用引擎的中繼資料,以及搜尋結果。
HTTP 要求
GET https://customsearch.googleapis.com/customsearch/v1
這個網址使用 gRPC 轉碼語法。
查詢參數
| 參數 | |
|---|---|
c2coff | 
                
                   
 這個參數的預設值為 0 (零),表示這項功能已啟用。支援的值如下: 
  | 
              
cr | 
                
                   
 限制顯示來自特定國家/地區的文件搜尋結果。您可以在 cr 參數值中使用布林運算子。 Google 搜尋會分析以下項目,判斷文件所屬國家/地區: 
 如需這個參數的有效值清單,請參閱國家/地區參數值頁面。  | 
              
cx | 
                
                   
 要用於這項要求的程式化搜尋引擎 ID。  | 
              
dateRestrict | 
                
                   
 以日期來限制系統顯示網址的結果。支援的值包括: 
  | 
              
exactTerms | 
                
                   
 識別搜尋結果中所有文件都必須包含的詞組。  | 
              
excludeTerms | 
                
                   
 識別不應出現在任何文件文件的字詞或詞組。  | 
              
fileType | 
                
                   
 限制系統只傳回指定擴充功能檔案的結果。你可以在 Search Console 說明中心找到 Google 可建立索引的檔案類型清單。  | 
              
filter | 
                
                   
 控管是否開啟重複內容篩選器。 
 可接受的值為: 
  | 
              
gl | 
                
                   
 使用者的地理位置。 
  | 
              
googlehost | 
                
                   
 已淘汰。使用  執行搜尋時所用的當地 Google 網域 (例如 google.com、google.de 或 google.fr)。  | 
              
highRange | 
                
                   
 指定搜尋範圍的結束值。 
  | 
              
hl | 
                
                   
 設定使用者介面語言。 
  | 
              
hq | 
                
                   
 將指定查詢字詞附加至查詢,如同與邏輯 AND 運算子合併一樣。  | 
              
imgColorType | 
                
                   
 傳回黑白、灰階、透明或彩色圖片。可接受的值為: 
  | 
              
imgDominantColor | 
                
                   
 傳回特定主色的圖片。可接受的值為: 
  | 
              
imgSize | 
                
                   
 傳回指定大小的圖片。可接受的值為: 
  | 
              
imgType | 
                
                   
 傳回特定類型的圖片。可接受的值為: 
  | 
              
linkSite | 
                
                   
 指定所有搜尋結果應包含特定網址的連結。  | 
              
lowRange | 
                
                   
 指定搜尋範圍的起始值。使用   | 
              
lr | 
                
                   
 僅搜尋特定語言 (例如 可接受的值為: 
  | 
              
num | 
                
                   
 要傳回的搜尋結果數量。 
  | 
              
orTerms | 
                
                   
 提供要在文件中尋找的其他搜尋字詞,讓搜尋結果中的每份文件必須包含至少一個其他搜尋字詞。  | 
              
q | 
                
                   
 查詢  | 
              
relatedSite | 
                
                   
 已淘汰。  | 
              
rights | 
                
                   
 依授權建立的篩選器。支援的值包括:  | 
              
safe | 
                
                   
 搜尋安全層級。可接受的值為: 
  | 
              
searchType | 
                
                   
 指定搜尋類型: 可接受的值為: 
  | 
              
siteSearch | 
                
                   
 指定要一律納入或從結果中排除的網站 (請參閱下方的   | 
              
siteSearchFilter | 
                
                   
 控管要納入或排除  可接受的值為: 
  | 
              
sort | 
                
                   
 要套用至結果的排序運算式。排序參數會指定根據指定運算式 (例如按日期排序) 排序結果。範例:Sort=date。  | 
              
start | 
                
                   
 要傳回的第一個結果的索引。每頁的預設結果數為 10,因此   | 
              
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體會包含 Search 的執行例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/cse
詳情請參閱 OAuth 2.0 總覽。