Method: cse.siterestrict.list

傳回執行搜尋的相關中繼資料、用於搜尋的搜尋引擎相關中繼資料,以及搜尋結果。使用少量網址模式。

HTTP 要求

GET https://customsearch.googleapis.com/customsearch/v1/siterestrict

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
c2coff

string

啟用或停用簡體中文和繁體中文版搜尋

這項參數的預設值是 0,表示這項功能已啟用。支援的值如下:

  • 1:已停用

  • 0:已啟用 (預設)

cr

string

將搜尋結果限制為來自特定國家/地區的文件。您可以在 cr 參數的值中使用 Boolean 運算子

Google 搜尋透過以下方式判斷文件的國家/地區:

  • 文件網址的頂層網域 (TLD)

  • 網路伺服器 IP 位址的地理位置

如需這個參數的有效值清單,請參閱國家/地區參數值

cx

string

要用於此要求的程式化搜尋引擎 ID。

dateRestrict

string

根據日期限制搜尋結果範圍。支援的值包括:

  • d[number]:要求指定過去幾天的結果。

  • w[number]:要求指定過去幾週的結果。

  • m[number]:要求指定過去一個月內的結果。

  • y[number]:要求指定過去幾年的結果。

exactTerms

string

用於識別詞組中所有文件都必須包含的詞組。

excludeTerms

string

識別不應在搜尋結果中出現在任何文件中的字詞或詞組。

fileType

string

限制結果,只能在指定擴充功能的檔案中顯示。您可以在 Google Search Console 的說明中心查看 Google 可建立索引的檔案類型清單。

filter

string

開啟或關閉重複內容篩選器。

  • 若要進一步瞭解 Google 的搜尋結果篩選器,請參閱自動篩選。請注意,主機擁擠篩選功能僅適用於多網站搜尋。

  • 根據預設,Google 會對所有搜尋結果套用篩選條件,以提升搜尋結果的品質。

可接受的值為:

  • 0:關閉重複的內容篩選器。

  • 1:開啟重複內容篩選器。

gl

string

使用者的地理位置。

  • gl 參數值為兩個字母的國家/地區代碼。gl 參數可增強來源國家/地區與參數值相符的搜尋結果。如需有效值的清單,請參閱國家/地區代碼頁面。

  • 指定 gl 參數值可以產生更相關的結果。這一點對國際客戶來說更是如此,尤其是在英文以外的美國客戶。

googlehost

string

已淘汰。請使用 gl 參數來達到類似的效果。

用來執行搜尋的當地 Google 網域 (例如 google.com、google.de 或 google.fr)。

highRange

string

指定搜尋範圍的結束值。

  • 使用 lowRangehighRangelowRange...highRange 的內含搜尋範圍附加到查詢。
hl

string

設定使用者介面語言。

hq

string

將指定的查詢字詞附加至查詢,就像將字詞與邏輯 AND 運算子合併一樣。

imgColorType

enum (ImgColorType)

傳回黑白、灰階、透明或彩色圖片。可接受的值為:

  • "color"

  • "gray"

  • "mono":黑白

  • "trans":透明背景

imgDominantColor

enum (ImgDominantColor)

傳回特定主色圖像的圖片。可接受的值為:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"

imgSize

enum (ImgSize)

傳回指定大小的圖片。可接受的值為:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"

imgType

enum (ImgType)

傳回類型的圖片。可接受的值為:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"

lowRange

string

指定搜尋範圍的起始值。使用 lowRangehighRangelowRange...highRange 的內含搜尋範圍附加到查詢。

lr

string

將搜尋範圍限定為以特定語言 (例如lr=lang_ja)。

可接受的值為:

  • "lang_ar":阿拉伯文

  • "lang_bg":保加利亞文

  • "lang_ca":加泰隆尼亞文

  • "lang_cs":捷克文

  • "lang_da":丹麥文

  • "lang_de":德文

  • "lang_el":希臘文

  • "lang_en":英文

  • "lang_es":西班牙文

  • "lang_et":愛沙尼亞文

  • "lang_fi":芬蘭文

  • "lang_fr":法文

  • "lang_hr":克羅埃西亞文

  • "lang_hu":匈牙利文

  • "lang_id":印尼語

  • "lang_is":冰島文

  • "lang_it":義大利文

  • "lang_iw":希伯來文

  • "lang_ja":日文

  • "lang_ko":韓文

  • "lang_lt":立陶宛文

  • "lang_lv":拉脫維亞文

  • "lang_nl":荷蘭文

  • "lang_no":挪威文

  • "lang_pl":波蘭文

  • "lang_pt":葡萄牙文

  • "lang_ro":羅馬尼亞文

  • "lang_ru":俄文

  • "lang_sk":斯洛伐克文

  • "lang_sl":斯洛維尼亞文

  • "lang_sr":塞爾維亞文

  • "lang_sv":瑞典文

  • "lang_tr":土耳其文

  • "lang_zh-CN":中文 (簡體)

  • "lang_zh-TW":中文 (繁體)

num

integer

要傳回的搜尋結果數量。

  • 有效值是介於 1 到 10 (含首尾) 之間的整數。
orTerms

string

提供其他文件可供查看的文件,文件中的每份文件都必須含有至少一個其他搜尋字詞。

q

string

查詢

relatedSite

string

指定所有搜尋結果都必須是與指定網址相關的網頁。

rights

string

根據授權篩選。支援的值包括:cc_publicdomaincc_attributecc_sharealikecc_noncommercialcc_nonderived,以及這些值的組合。請參閱一般組合

safe

enum (Safe)

搜尋安全層級。可接受的值為:

  • "active":啟用安全搜尋篩選功能。

  • "off":停用安全搜尋篩選功能。(預設)

searchType

enum (SearchType)

指定搜尋類型:image。如果未指定,則結果範圍僅限於網頁。

可接受的值為:

  • "image":自訂圖片搜尋。
siteSearchFilter

enum (SiteSearchFilter)

控制是否要在 siteSearch 參數中納入或排除來自網站的結果。

可接受的值為:

  • "e":排除

  • "i":包含

sort

string

要套用至結果的排序運算式。排序參數會指定結果是依照指定的運算式排序,即依日期排序。範例:sort=date

start

integer (uint32 format)

第一個要傳回的結果的索引。每頁的預設結果數為 10,因此 &start=11 將顯示在搜尋結果第二頁的頂端。注意:即使 API 有超過 100 份文件符合查詢條件,JSON API 絕對不會傳回超過 100 筆結果,因此將 start + num 的總和設為 100 以上會導致錯誤發生。另請注意,num 的最大值為 10。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體會包含 Search 的執行例項。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cse

詳情請參閱 OAuth 2.0 總覽