フィールド構成を更新します。現在、フィールドの更新は単一フィールドのインデックス構成にのみ適用されます。ただし、 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/*}
URL はgRPC トランスコーディング構文を使用します。
パスパラメータ
パラメーター | |
---|---|
field.name | 必須。 フィールド パスは、単純なフィールド名 (例: フィールド パスは、 例: (注: ここのコメントはマークダウン構文で記述されているため、コード ブロックを表すバックティックの追加レイヤーがあります) 特別な |
クエリパラメータ
パラメーター | |
---|---|
updateMask | フィールドに対する相対的なマスク。指定した場合、この field_mask で指定された構成のみがフィールドで更新されます。 これは、フィールドの完全修飾名のカンマ区切りのリストです。例: |
リクエストボディ
リクエスト本文にはField
のインスタンスが含まれます。
レスポンスボディ
成功した場合、応答本文にはOperation
のインスタンスが含まれます。
認可範囲
次の OAuth スコープのいずれかが必要です。
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
詳細については、 「認証の概要」を参照してください。