Cloud Search API

Cloud Search 提供雲端式搜尋功能，適用於 Google Workspace 資料。Cloud Search API 允許為 Cloud Search 以外的 Google Workspace 資料建立索引。

服務：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 和 Suggest 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/*} 個
取得搜尋應用程式的使用者統計資料。