Method: projects.databases.collectionGroups.fields.list

Bu veritabanı için alan yapılandırmasını ve meta verileri listeler.

FirestoreAdmin.ListFields şu anda yalnızca açıkça geçersiz kılınan giriş alanlarını desteklemektedir. Bu sorguyu göndermek için filtre indexConfig.usesAncestorConfig:false olarak ayarlanmış şekilde FirestoreAdmin.ListFields işlevini çağırın.

HTTP isteği

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields

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

Yol parametreleri

Parametreler
parent

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId} formunun üst adı

Sorgu parametreleri

Parametreler
filter

string

Liste sonuçlarına uygulanacak filtre. FirestoreAdmin.ListFields şu anda yalnızca açıkça geçersiz kılınan giriş alanlarını desteklemektedir. Bu sorguyu göndermek için filtre indexConfig.usesAncestorConfig:false olarak ayarlanmış şekilde FirestoreAdmin.ListFields işlevini çağırın.
pageSize

integer

Döndürülecek sonuçların sayısı.
pageToken

string

Önceki FirestoreAdmin.ListFields çağrısından döndürülen ve sonraki sonuç sayfasını almak için kullanılabilecek bir sayfa jetonu.

İstek içeriği

İsteğin gövdesi boş olmalıdır.

Yanıt gövdesi

FirestoreAdmin.ListFields için yanıt.

Başarılı olursa yanıt gövdesi aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
Alanlar
fields[]

object (Field)

İstenen alanlar.
nextPageToken

string

Başka bir sonuç sayfası istemek için kullanılabilecek sayfa jetonu. Boşsa bu son sayfadır.

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.