Method: projects.databases.collectionGroups.fields.patch

フィールド構成を更新します。現在、フィールドの更新は単一フィールド インデックス構成にのみ適用されます。ただし、呼び出し元が認識していない構成の変更を避けるため、FirestoreAdmin.UpdateField の呼び出しではフィールド マスクを指定する必要があります。フィールド マスクは { paths: "indexConfig" } として指定する必要があります。

この呼び出しは google.longrunning.Operation を返します。これを使用して、フィールド更新のステータスを追跡できます。オペレーションのメタデータは FieldOperationMetadata タイプになります。

データベースのデフォルトのフィールド設定を構成するには、リソース名 projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* を持つ特別な Field を使用します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 記号を使用して引用符で囲むことができます。

例: （注: ここでのコメントはマークダウン構文で記述されるため、コードブロックを表すバッククォートの追加レイヤが存在します）\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)

フィールドに対するマスク。指定すると、この field_mask で指定された構成のみがフィールドで更新されます。

これは、フィールドの完全修飾名のカンマ区切りリストです。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Field のインスタンスが含まれています。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。