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/*}

URL は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 記号文字。

例: (注: ここのコメントはマークダウン構文で記述されているため、コード ブロックを表すバックティックの追加レイヤーがあります) \ address.city` はin the field address の, not the map key address.city represents a field named . `*` は、任意のフィールドではなく、*` represents a field named

特別なFieldは、すべてのフィールドのデフォルトのインデックス設定が含まれています。このフィールドのリソース名は次のとおりです。projects 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

詳細については、 「認証の概要」を参照してください。