Method: projects.databases.collectionGroups.fields.patch

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

Cet appel renvoie un google.longrunning.Operation qui peut être utilisé pour suivre l'état de la mise à jour du champ. Les métadonnées de l'opération sont de 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 ressource projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
field.name

string

Un nom de champ au format projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

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

Les chemins d'accès des champs peuvent être indiqués à l'aide de (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 de n'importe quel caractère symbolique ASCII.

Exemples: (Remarque: Les commentaires sont rédigés dans la syntaxe markdown, ce qui implique qu'un bloc de code représente une couche supplémentaire d'accents graves.) \address.city`represents a field namedaddress.city, not the map key villein the fieldadresse. `*`represents a field named*`, et non un champ.

Un Field spécial contient les paramètres d'indexation par défaut de tous les champs. Le nom de 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 ne possèdent pas leur propre configuration d'index Field.

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

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

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.