Cloud Search API

Cloud Search 提供雲端搜尋功能,而非 Google Workspace 資料。Cloud Search API 可讓您將非 Google Workspace 資料編入索引至 Cloud Search。

服務:cloudsearch.googleapis.com

如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用自己的程式庫來呼叫此服務,請在發出 API 要求時提供下列資訊。

探索文件

探索文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件:

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:

  • https://cloudsearch.googleapis.com

REST 資源:v1

方法
initializeCustomer POST /v1:initializeCustomer
在 Google Cloud Search 中啟用 third party 支援。

REST 資源:v1.debug.datasources.items

方法
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
檢查項目是否可由指定主體存取。
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
擷取 viewUrl 與要求中提供的網址完全相符的項目。

REST 資源:v1.debug.datasources.items.unmappedids

方法
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
列出特定項目的所有未對應的身分。

REST 資源:v1.debug.identitysources.items

方法
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
列出與未對應的識別資訊相關聯的項目名稱。

REST 資源:v1.debug.identitysources.unmappedids

方法
list GET /v1/debug/{parent=identitysources/*}/unmappedids
列出識別資訊來源的未對應使用者身分。

REST 資源:v1.indexing.datasources

方法
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
刪除資料來源的結構定義。
getSchema GET /v1/indexing/{name=datasources/*}/schema
取得資料來源的結構定義。
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
更新資料來源的結構定義。

REST 資源:v1.indexing.datasources.items

方法
delete DELETE /v1/indexing/{name=datasources/*/items/*}
刪除指定資源名稱的Item resource
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
刪除佇列中的所有項目。
get GET /v1/indexing/{name=datasources/*/items/*}
按項目名稱取得 Item resource
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
更新 Item ACL、中繼資料和內容。
list GET /v1/indexing/{name=datasources/*}/items
列出 Item resources 的所有或部分值。
poll POST /v1/indexing/{name=datasources/*}/items:poll
將索引佇列中未保留的項目輪詢並標示為已保留,並從優先順序最高的 ItemStatus 項目開始。
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
將項目推送到佇列中,以供日後輪詢和更新。
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
保留佇列中的所有項目,讓所有項目都有機會接受意見調查。
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
建立上傳項目內容的上傳工作階段。

REST 資源:v1.media

方法
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
上傳要建立索引的媒體。

REST 資源:v1.operations

方法
get GET /v1/{name=operations/**}
取得長時間執行的作業的最新狀態。

REST 資源:v1.query

方法
search POST /v1/query/search
Cloud Search Query API 提供搜尋方法,可根據使用者查詢傳回最相關的結果。
suggest POST /v1/query/suggest
提供自動完成查詢的建議。

REST 資源:v1.query.sources

方法
list GET /v1/query/sources
傳回可供 Search 和 Suggestion API 使用的來源清單。

REST 資源:v1.settings

方法
getCustomer GET /v1/settings/customer
取得客戶設定。
updateCustomer PATCH /v1/settings/customer
更新客戶設定。

REST 資源:v1.settings.datasources

方法
create POST /v1/settings/datasources
建立資料來源。
delete DELETE /v1/settings/{name=datasources/*}
刪除資料來源。
get GET /v1/settings/{name=datasources/*}
取得資料來源。
list GET /v1/settings/datasources
列出資料來源。
patch PATCH /v1/settings/{source.name=datasources/*}
更新資料來源。
update PUT /v1/settings/{source.name=datasources/*}
更新資料來源。

REST 資源:v1.settings.searchapplications

方法
create POST /v1/settings/searchapplications
建立搜尋應用程式。
delete DELETE /v1/settings/{name=searchapplications/*}
刪除搜尋應用程式。
get GET /v1/settings/{name=searchapplications/*}
取得指定的搜尋應用程式。
list GET /v1/settings/searchapplications
列出所有搜尋應用程式。
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
更新搜尋應用程式。
reset POST /v1/settings/{name=searchapplications/*}:reset
將搜尋應用程式重設為預設設定。
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
更新搜尋應用程式。

REST 資源:v1.stats

方法
getIndex GET /v1/stats/index
取得所有資料來源的索引索引統計資料匯總。
getQuery GET /v1/stats/query
取得客戶的查詢統計資料。
getSearchapplication GET /v1/stats/searchapplication
取得客戶的搜尋應用程式統計資料。
getSession GET /v1/stats/session
查看搜尋工作階段數、成功點擊的成功工作階段百分比。
getUser GET /v1/stats/user
取得客戶的使用者統計資料。

REST 資源:v1.stats.index.datasources

方法
get GET /v1/stats/index/{name=datasources/*}
取得單一資料來源的索引項目統計資料。

REST 資源:v1.stats.query.searchapplications

方法
get GET /v1/stats/query/{name=searchapplications/*}
取得搜尋應用程式的查詢統計資料。

REST 資源:v1.stats.session.searchapplications

方法
get GET /v1/stats/session/{name=searchapplications/*}
查看搜尋工作階段的數量,以及搜尋應用程式中點擊查詢統計資料的成功工作階段百分比。

REST 資源:v1.stats.user.searchapplications

方法
get GET /v1/stats/user/{name=searchapplications/*}
取得搜尋應用程式的使用者統計資料。