Method: projects.databases.collectionGroups.fields.patch

Alan yapılandırmasını günceller. Şu anda alan güncellemeleri yalnızca tek alanlı dizin yapılandırmasına uygulanmaktadır. Ancak FirestoreAdmin.UpdateField çağrılarında, arayanın farkında olmadığı yapılandırmaların değiştirilmesini önlemek için bir alan maskesi sağlanmalı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 türü FieldOperationMetadata olacaktır.

Veritabanının varsayılan alan ayarlarını yapılandırmak için kaynak adına sahip özel Field özelliğini 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çimindeki alan adı

Alan yolu, basit bir alan adı (ör. address) veya matchValue içindeki alanlara giden bir yol (ör. address.city) ya da özel bir alan yolu olabilir. Geçerli tek özel alan, herhangi bir alanı temsil eden *'dir.

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),[,]` ifadeleri ve ASCII sembolik karakterleri kullanılarak alıntılanabilir.

Örnekler: (Not: Buradaki yorumlar, markdown söz dizimiyle yazılır. Bu nedenle, bir kod bloğunu temsil eden ek bir vurgu işareti katmanı vardır) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, herhangi bir alan değildir.

Ö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 politikasında tanımlanan dizinler, kendi Field dizin yapılandırmasına sahip olmayan tüm alanlara uygulanır.

Sorgu parametreleri

Parametreler
updateMask

string (FieldMask format)

Alana göre bir maske. Belirtilirse alanda yalnızca bu field_mask ile 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 metni, Field öğesinin bir örneğini içerir.

Yanıt gövdesi

Başarılıysa yanıt metni, 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ış sayfasına göz atın.