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/v1beta2/{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 包含所有欄位的預設索引設定。這個欄位的資源名稱為：這個 Field 中定義的 projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* 索引，會套用至所有沒有 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

詳情請參閱驗證總覽。