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
傳回使用者可用於搜尋和建議 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/*}
取得搜尋應用程式的使用者統計資料。