Method: projects.databases.documents.patch

Met à jour ou insère un document.

Requête HTTP

PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
document.name

string

Nom de ressource du document (par exemple, projects/{projectId}/databases/{databaseId}/documents/{document_path}).

Paramètres de requête

Paramètres
updateMask

object (DocumentMask)

Champs à mettre à jour. Aucun des chemins d'accès des champs du masque ne peut contenir de nom réservé.

Si le document existe sur le serveur et qu'il comporte des champs non référencés dans le masque, ils ne sont pas modifiés. Les champs référencés dans le masque, mais non présents dans le document d'entrée, sont supprimés du document sur le serveur.
mask

object (DocumentMask)

Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si le document comporte un champ qui n'est pas présent dans ce masque, il ne sera pas renvoyé dans la réponse.
currentDocument

object (Precondition)

Une condition préalable facultative sur le document. La requête échoue si ce champ est défini et que le document cible n'y répond pas.

Corps de la requête

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

Corps de la réponse

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

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.