Method: projects.databases.collectionGroups.fields.patch

Met à jour une configuration de champ. Actuellement, les mises à jour de champs s'appliquent uniquement à la configuration d'index à champ unique. Cependant, les appels à FirestoreAdmin.UpdateField doivent fournir un masque de champ pour éviter de modifier une configuration dont l'appelant n'est pas conscient. Le masque de champ doit être spécifié comme : { paths: "indexConfig" } .

Cet appel renvoie une google.longrunning.Operation qui peut être utilisée pour suivre l'état de la mise à jour du champ. Les métadonnées de l'opération seront du type FieldOperationMetadata .

Pour configurer les paramètres de champ par défaut de la base de données, utilisez le Field spécial avec le nom de la ressource : projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* .

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC .

Paramètres du chemin

Paramètres
field.name

string

Requis. Un nom de champ du projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Un chemin de champ peut être un simple nom de champ, par exemple address ou un chemin vers des champs dans mapValue , par exemple address.city , ou un chemin de champ spécial. Le seul champ spécial valide est * , qui représente n'importe quel champ.

Les chemins de champ peuvent être cités en utilisant (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), [ , ]`, ainsi que tous les caractères symboliques ascii.

Exemples : (Remarque : les commentaires ici sont écrits dans une syntaxe markdown, il y a donc une couche supplémentaire de backticks pour représenter un bloc de code) \ address.city` represents a field named adresse.city , not the map key city in the field adresse . `*` represents a field named *`, pas n'importe quel champ.

Un Field spécial contient les paramètres d'indexation par défaut pour tous les champs. Le nom de la ressource de ce champ est : projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Les index définis sur ce Field seront appliqués à tous les champs qui n'ont pas leur propre configuration d'index Field .

Paramètres de requête

Paramètres
updateMask

string ( FieldMask format)

Un masque, relatif au champ. Si spécifié, seule la configuration spécifiée par ce field_mask sera mise à jour dans le champ.

Il s'agit d'une liste de noms de champs entièrement qualifiés, séparés par des virgules. Exemple : "user.displayName,photo" .

Corps de la demande

Le corps de la requête contient une instance de Field .

Corps de réponse

En cas de succès, le corps de la réponse contient une instance de Operation .

Portées des autorisations

Nécessite l'une des étendues OAuth suivantes :

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

Pour plus d'informations, consultez la Présentation de l'authentification .