Method: projects.databases.collectionGroups.fields.patch

Bir alan yapılandırmasını günceller. Alan güncellemeleri şu anda yalnızca tekli alan dizin yapılandırması için geçerlidir. Ancak FirestoreAdmin.UpdateField için yapılan çağrılar, çağrıyı yapanın farkında olmadığı yapılandırmaların değiştirilmesini önlemek için alan maskesi sağlamalıdır. Alan maskesi şu şekilde belirtilmelidir: { paths: "indexConfig" }.

Bu çağrı, alan güncellemesinin durumunu izlemek için kullanılabilecek bir google.longrunning.Operation döndürür. İşlemin meta verileri FieldOperationMetadata türünde olur.

Veritabanının varsayılan alan ayarlarını yapılandırmak için kaynak adına sahip özel Field öğesini kullanın: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
field.name

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} biçiminde bir alan adı

Alan yolu, basit bir alan adı (ör. address) veya MapValue içindeki alanların yolu (ör. address.city) ya da özel bir alan yolu olabilir. Geçerli tek özel alan, herhangi bir alanı temsil eden * alanıdır.

Alan yolları, (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),[,]" ve ASCII sembolik karakterleri kullanılarak tırnak içine alınabilir.

Örnekler: (Not: Buradaki yorumlar markdown söz dizimiyle yazıldığından kod bloğunu temsil eden ek vurgu işareti katmanı bulunur) \address.city`represents a field namedaddress.city, not the map key şehirin the fieldadres. `*`represents a field named*`, herhangi bir alan değil.

Özel bir Field, tüm alanlar için varsayılan dizine ekleme ayarlarını içerir. Bu alanın kaynak adı: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Bu Field üzerinde tanımlanan dizinler, kendi Field dizin yapılandırmasına sahip olmayan tüm alanlara uygulanacak.

Sorgu parametreleri

Parametreler
updateMask

string (FieldMask format)

Alana göre bir maske. Belirtilirse alanda yalnızca bu Field_mask tarafından belirtilen yapılandırma güncellenir.

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek gövdesi, Field öğesinin bir örneğini içerir.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, Operation öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleye bakın.