このページは Cloud Translation API によって翻訳されました。
Switch to English

メソッド:projects.databases.collectionGroups.fields.patch

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

この呼び出しは、フィールドの更新のステータスを追跡するために使用できるgoogle.longrunning.Operationを返します。操作のメタデータはFieldOperationMetadataタイプにFieldOperationMetadataます。

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

HTTPリクエスト

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

URLはgRPCトランスコーディング構文を使用します。

パスパラメータ

パラメーター
field.name

string

projects/{project_id}/databases/{database_id}/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). 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シティin the field , not the map key address.city represents a field namedます. `*` represents a field named * ` represents a field namedどのフィールドもrepresents a field namedません。

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

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