Method: indexing.datasources.items.index

更新 Item ACL、元数据和内容。它将插入不存在的 Item。此方法不支持部分更新。系统会在 Cloud Search 索引中清除没有提供任何值的字段。

此 API 需要管理员或服务帐号来执行。使用的服务帐号是在相应数据源中列入白名单的帐号。

HTTP 请求

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index

网址采用 gRPC 转码语法。

路径参数

参数
item.name

string

商品的名称。格式:datasources/{source_id}/items/{itemId}
这是必填字段。长度上限为 1536 个字符。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "title": string,
      "sourceRepositoryUrl": string,
      "containerName": string,
      "objectType": string,
      "createTime": string,
      "updateTime": string,
      "interactions": [
        {
          object (Interaction)
        }
      ],
      "contentLanguage": string,
      "mimeType": string,
      "searchQualityMetadata": {
        object (SearchQualityMetadata)
      },
      "keywords": [
        string
      ],
      "hash": string,
      "contextAttributes": [
        {
          object (ContextAttribute)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "contentFormat": enum (ItemContent.ContentFormat),
      "hash": string,

      // Union field content can be only one of the following:
      "inlineContent": string,
      "contentDataRef": {
        object (UploadItemRef)
      }
      // End of list of possible types for union field content.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
字段
item.acl

object (ItemAcl)

此项目的访问控制列表。

item.metadata

object (ItemMetadata)

元数据信息。

item.structuredData

object (ItemStructuredData)

相应项的结构化数据,应符合数据源架构中已注册的对象定义。

item.content

object (ItemContent)

要编入索引且可供搜索的内容项内容。

item.version

string (bytes format)

必需。索引系统以字节字符串的形式存储数据源中的版本,并使用词法排序技术将索引中的“商品版本”与已排队的“商品”版本进行比较。

Cloud Search Indexing 不会将版本值低于或等于当前编入索引项的队列中的任何项编入索引或删除这些项。此字段的最大长度为 1024 字节。

base64 编码的字符串。

item.status

object (ItemStatus)

商品的状态。仅限输出字段。

item.queue

string

此内容所属的队列。长度上限为 100 个字符。

item.payload

string (bytes format)

可存储此项的其他状态连接器。长度不超过 10000 个字节。

base64 编码的字符串。

item.itemType

enum (Item.ItemType)

此内容的类型。

connectorName

string

进行此调用的连接器的名称。
格式:datasources/{source_id}/connectors/{ID}

mode

enum (RequestMode.Mode)

必需。此请求的 RequestMode。

debugOptions

object (DebugOptions)

常见的调试选项。

indexItemOptions

object (IndexItemOptions)

响应正文

如果成功,响应正文将包含一个 Operation 实例。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

有关详情,请参阅 OAuth 2.0 概览

IndexItemOptions 类中的方法

JSON 表示法
{
  "allowUnknownGsuitePrincipals": boolean
}
字段
allowUnknownGsuitePrincipals

boolean

指定索引请求是否应允许索引请求中不存在或删除的 G Suite 正文。