Method: projects.databases.collectionGroups.fields.list

پیکربندی فیلد و ابرداده را برای این پایگاه داده فهرست می کند.

در حال حاضر، FirestoreAdmin.ListFields فقط از فیلدهای فهرستی پشتیبانی می کند که به صراحت لغو شده اند. برای صدور این عبارت، FirestoreAdmin.ListFields با فیلتر تنظیم شده روی indexConfig.usesAncestorConfig:false or ttlConfig:*` فراخوانی کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
parent

string

ضروری. نام والد فرم projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

پارامترهای پرس و جو

مولفه های
filter

string

فیلتری که باید در نتایج فهرست اعمال شود. در حال حاضر، FirestoreAdmin.ListFields فقط از فیلدهای فهرستی پشتیبانی می کند که به صراحت لغو شده اند. برای صدور این عبارت، FirestoreAdmin.ListFields با فیلتری که شامل indexConfig.usesAncestorConfig:false است، فراخوانی کنید.

pageSize

integer

تعداد نتایج برای بازگشت.

pageToken

string

یک نشانه صفحه، که از تماس قبلی به FirestoreAdmin.ListFields بازگردانده شده است، که ممکن است برای دریافت صفحه بعدی نتایج استفاده شود.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ برای FirestoreAdmin.ListFields .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
زمینه های
fields[]

object ( Field )

فیلدهای درخواستی

nextPageToken

string

نشانه صفحه ای که ممکن است برای درخواست صفحه دیگری از نتایج استفاده شود. اگر خالی باشد، این آخرین صفحه است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.