Method: projects.databases.collectionGroups.fields.patch

Aktualizuje konfigurację pola. Obecnie aktualizacje pól mają zastosowanie tylko do konfiguracji indeksu z jednym polem. Jednak wywołania funkcji FirestoreAdmin.UpdateField powinny zawierać maskę pola, aby uniknąć zmiany konfiguracji, której rozmówca nie wie. Maską pola należy określić jako: { paths: "indexConfig" }.

To wywołanie zwraca wartość google.longrunning.Operation, która może służyć do śledzenia stanu aktualizacji pola. Metadane tej operacji będą typu FieldOperationMetadata.

Aby skonfigurować domyślne ustawienia pola bazy danych, użyj specjalnego elementu Field o nazwie zasobu: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
field.name

string

Nazwa pola w formacie projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Ścieżka pola może być prostą nazwą pola, np. address, lub ścieżką do pól w obrębie mapValue , np. address.city, lub specjalną ścieżką pola. Jedyne prawidłowe pole specjalne to *, które reprezentuje dowolne pole.

Ścieżki pól można cytować za pomocą znaków (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),[,]oraz dowolnych znaków ASCII.

Przykłady: (uwaga: komentarze w tym miejscu są napisane w składni języka markdown, dlatego pojawia się dodatkowa warstwa znaków grawisowych reprezentujących blok kodu) \address.city`represents a field namedadres.miasto, not the map key miastoin the fieldadres. `*`represents a field named*`, a nie żadne pole.

Specjalny identyfikator Field zawiera domyślne ustawienia indeksowania wszystkich pól. Nazwa zasobu tego pola to: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Indeksy zdefiniowane w tym elemencie Field zostaną zastosowane do wszystkich pól, które nie mają własnej konfiguracji indeksów Field.

Parametry zapytania

Parametry
updateMask

string (FieldMask format)

Maska względem pola. Jeśli określisz wartość, tylko konfiguracja określona przez tę maskę pola zostanie zaktualizowana w tym polu.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera instancję Field.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała instancję Operation.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).