Method: projects.databases.collectionGroups.fields.patch

Aktualisiert eine Feldkonfiguration. Derzeit gelten Feldaktualisierungen nur für die Einzelfeldindexkonfiguration. Aufrufe von FirestoreAdmin.UpdateField sollten jedoch eine Feldmaske angeben, um eine Änderung von Konfigurationen zu vermeiden, die dem Aufrufer nicht bekannt sind. Die Feldmaske sollte so angegeben werden: { paths: "indexConfig" }.

Dieser Aufruf gibt ein google.longrunning.Operation zurück, mit dem der Status der Feldaktualisierung verfolgt werden kann. Die Metadaten für den Vorgang sind vom Typ FieldOperationMetadata.

Verwenden Sie zum Konfigurieren der Standardfeldeinstellungen für die Datenbank die spezielle Field mit dem Ressourcennamen projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
field.name

string

Erforderlich. Einen Feldnamen im Format projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Ein Feldpfad kann ein einfacher Feldname wie address, ein Pfad zu Feldern innerhalb von „mapValue“ (z. B. address.city) oder ein spezieller Feldpfad sein. Das einzige gültige Sonderfeld ist * und steht für ein beliebiges Feld.

Feldpfade können mit (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),[,]` sowie mit symbolischen ASCII-Zeichen in Anführungszeichen gesetzt werden.

Beispiele: (Hinweis: Kommentare hier sind in Markdown-Syntax geschrieben, es gibt also eine zusätzliche Ebene mit Graviszeichen, die einen Codeblock darstellen) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, keine Felder.

Eine spezielle Field enthält die Standardeinstellungen für die Indexierung für alle Felder. Der Ressourcenname dieses Felds lautet: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Indexe, die auf diesem Field definiert sind, werden auf alle Felder angewendet, die keine eigene Field-Indexkonfiguration haben.

Abfrageparameter

Parameter
updateMask

string (FieldMask format)

Eine Maske relativ zum Feld. Wenn angegeben, wird nur die von „field_mask“ angegebene Konfiguration im Feld aktualisiert.

Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von Field.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.