更新 Item
ACL、元数据和内容。如果 Item
不存在,它将插入。此方法不支持部分更新。未提供值的字段会在 Cloud Search 索引中清除。
此 API 需要管理员或服务账号才能执行。所使用的服务账号是相应数据源中已列入白名单的服务账号。
HTTP 请求
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
item.name |
商品的名称。格式:datasources/{sourceId}/items/{itemId} 这是必填字段。长度上限为 1536 个字符。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
字段 | |
---|---|
item.acl |
此项的访问控制列表。 |
item.metadata |
元数据信息。 |
item.structuredData |
商品的结构化数据,应符合数据源架构中已注册的对象定义。 |
item.content |
商品内容将编入索引并使文本可搜索。 |
item.version |
必需。索引系统将数据源中的版本存储为字节字符串,并使用词法排序将索引中的项版本与排队项的版本进行比较。 如果已加入队列的项的版本值小于或等于当前编入索引的项的版本,Cloud Search Indexing 不会将该项编入索引,也不会将其删除。此字段的最大长度为 1024 字节。 如需了解内容版本对删除流程有何影响,请参阅在手动删除后处理修订版本。 使用 base64 编码的字符串。 |
item.status |
商品的状态。仅限输出字段。 |
item.queue |
此内容所属的队列。长度上限为 100 个字符。 |
item.payload |
连接器可以为此项存储其他状态。最大长度为 10000 字节。 使用 base64 编码的字符串。 |
item.itemType |
此项目的类型。 |
connectorName |
进行此调用的连接器的名称。 格式:datasources/{sourceId}/connectors/{ID} |
mode |
必需。此请求的 RequestMode。 |
debugOptions |
常用调试选项。 |
indexItemOptions |
|
响应正文
如果成功,则响应正文包含一个 Operation
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
有关详情,请参阅授权指南。
IndexItemOptions
JSON 表示法 |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
字段 | |
---|---|
allowUnknownGsuitePrincipals |
指定索引请求是否应允许不存在或已被删除的 Google Workspace 主账号。 |