Method: projects.databases.collectionGroups.fields.patch

Aktualizuje konfigurację pola. Obecnie aktualizacje pól dotyczą tylko konfiguracji indeksu pojedynczego pola. Wywołania FirestoreAdmin.UpdateField powinny jednak dostarczać maskę pola, aby uniknąć zmiany konfiguracji, o której element wywołujący 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 operacji będą typu FieldOperationMetadata.

Aby skonfigurować domyślne ustawienia pola bazy danych, użyj specjalnego pola 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 formularza 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 obiekcie mapValue, np. address.city, lub specjalną ścieżką pola. Jedynym prawidłowym polem specjalnym jest *, które reprezentuje dowolne pole.

Ścieżki pól można podawać w cudzysłowach 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 symboli ASCII.

Przykłady: (uwaga: komentarze w tym miejscu są zapisywane w składni Markdown, dlatego istnieje dodatkowa warstwa lewików reprezentujących blok kodu) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, a nie żadne pole.

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

Parametry zapytania

Parametry
updateMask

string (FieldMask format)

Maska powiązana z polem. Jeśli określisz konfigurację, w polu zostanie zaktualizowana tylko konfiguracja określona przez tę maskę pola.

Jest to rozdzielona przecinkami lista pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Field.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.