Method: projects.databases.collectionGroups.fields.patch

Aggiorna la configurazione di un campo. Attualmente, gli aggiornamenti dei campi si applicano solo alla configurazione dell'indice a campo singolo. Tuttavia, le chiamate a FirestoreAdmin.UpdateField devono fornire una maschera di campo per evitare di modificare qualsiasi configurazione di cui il chiamante non è a conoscenza. La maschera del campo deve essere specificata come: { paths: "indexConfig" }.

Questa chiamata restituisce un google.longrunning.Operation che può essere utilizzato per monitorare lo stato dell'aggiornamento dei campi. I metadati per l'operazione saranno di tipo FieldOperationMetadata.

Per configurare le impostazioni predefinite dei campi per il database, utilizza lo speciale Field con nome risorsa: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
field.name

string

Obbligatoria. Un nome di campo nel modulo projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Un percorso di campo può essere un nome di campo semplice (ad es. address) o un percorso dei campi all'interno di mapValue (ad es. address.city) oppure un percorso di campo speciale. L'unico campo speciale valido è *, che rappresenta qualsiasi campo.

I percorsi dei campi possono essere racchiusi tra virgolette utilizzando (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),[,]", nonché qualsiasi carattere simbolico ASCII.

Esempi: (nota: i commenti qui sono scritti con la sintassi di markdown, quindi è presente un ulteriore livello di apici inversi per rappresentare un blocco di codice) \address.city"represents a field namedaddress.city, not the map key cityin the fieldaddress. "*"represents a field named*", non un campo.

Un elemento Field speciale contiene le impostazioni di indicizzazione predefinite per tutti i campi. Il nome della risorsa di questo campo è: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Gli indici definiti in questo Field verranno applicati a tutti i campi che non hanno una propria configurazione degli indici Field.

Parametri di ricerca

Parametri
updateMask

string (FieldMask format)

Una maschera relativa al campo. Se specificato, solo la configurazione specificata da questa maschera di campo verrà aggiornata nel campo.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Field.

Corpo della risposta

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

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.