Cloud Search 可针对 Google Workspace 数据提供基于云的搜索功能。借助 Cloud Search API,您可以将非 Google Workspace 数据编入 Cloud Search 索引。
- REST 资源:v1
- REST 资源:v1.debug.datasources.items
- REST 资源:v1.debug.datasources.items.unmappedids
- REST 资源:v1.debug.identitysources.items
- REST 资源:v1.debug.identitysources.unmappedids
- REST 资源:v1.indexing.datasources
- REST 资源:v1.indexing.datasources.items
- REST 资源:v1.media
- REST 资源:v1.operations
- REST 资源:v1.query
- REST 资源:v1.query.sources
- REST 资源:v1.settings
- REST 资源:v1.settings.datasources
- REST 资源:v1.settings.searchapplications
- REST 资源:v1.stats
- REST 资源:v1.stats.index.datasources
- REST 资源:v1.stats.query.searchapplications
- REST 资源:v1.stats.session.searchapplications
- REST 资源:v1.stats.user.searchapplications
服务: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
| 方法 | |
|---|---|
removeActivity |
POST /v1/query:removeActivity 提供用于移除用户已记录活动的函数。 |
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/*} 获取搜索应用的用户统计信息。 |