Method: projects.databases.collectionGroups.fields.patch

更新字段配置。目前，字段更新仅适用于单字段索引配置。不过，调用 FirestoreAdmin.UpdateField 时应提供字段掩码，以避免更改调用方不知道的任何配置。应按如下方式指定字段掩码：{ paths: "indexConfig" }。

此调用会返回一个 google.longrunning.Operation，它可用于跟踪字段更新的状态。操作的元数据将类型为 FieldOperationMetadata。

如需为数据库配置默认字段设置，请使用特殊的 Field，其资源名称为：projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*。

HTTP 请求

PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

网址采用 gRPC 转码语法。

路径参数

参数
field.name

string

必需。格式为 projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} 的字段名称

字段路径可以是简单的字段名称（如 address），也可以是指向 mapValue 中字段的路径（如 address.city）或特殊字段路径。唯一有效的特殊字段是 *，它表示任何字段。

可以使用 (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` 以及任何 ASCII 符号字符引用字段路径。

示例：（注意：此处的注释采用 Markdown 语法编写，因此还有一层额外的反引号来表示代码块）\address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`，而不是任何字段。

特殊的 Field 包含所有字段的默认索引编制设置。此字段的资源名称为：projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*。在此 Field 中定义的索引将应用于自身没有 Field 索引配置的所有字段。

查询参数

参数
updateMask

string (FieldMask format)

相对于字段的掩码。如果指定，则仅在字段中更新此字段_mask 指定的配置。

这是以英文逗号分隔的完全限定字段名称列表。示例："user.displayName,photo"。

请求正文

请求正文包含一个 Field 实例。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。