Method: projects.databases.documents.patch

Aggiorna o inserisce un documento.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
document.name

string

Il nome della risorsa del documento, ad esempio projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parametri di ricerca

Parametri
updateMask

object (DocumentMask)

I campi da aggiornare. Nessuno dei percorsi di campo nella maschera può contenere un nome riservato.

Se il documento esiste sul server e contiene campi a cui non viene fatto riferimento nella maschera, questi vengono lasciati invariati. I campi a cui viene fatto riferimento nella maschera, ma non presenti nel documento di input, vengono eliminati dal documento sul server.
mask

object (DocumentMask)

I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se il documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.
currentDocument

object (Precondition)

Una condizione preliminare facoltativa sul documento. La richiesta avrà esito negativo se questa impostazione viene impostata e non viene soddisfatta dal documento di destinazione.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Document.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Document.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.