Method: projects.list

هر FirebaseProject قابل دسترسی برای تماس گیرنده را فهرست می کند.

عناصر بدون ترتیب خاصی برگردانده می شوند، اما زمانی که درخواست های اضافی با یک pageToken انجام می شود، یک نمای ثابت از پروژه ها خواهند بود.

این روش در نهایت با جهش‌های پروژه مطابقت دارد، به این معنی که پروژه‌های تازه ارائه شده و تغییرات اخیر در پروژه‌های موجود ممکن است در مجموعه پروژه‌ها منعکس نشوند. این لیست فقط شامل پروژه های فعال خواهد بود.

از projects.get برای خواندن مداوم و همچنین برای جزئیات بیشتر پروژه استفاده کنید.

درخواست HTTP

GET https://firebase.googleapis.com/v1beta1/projects

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

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

مولفه های
pageToken

string

توکن از تماس قبلی به projects.list بازگشت که نشان می‌دهد کجای مجموعه پروژه‌ها برای ازسرگیری فهرست قرار دارد.

pageSize

integer

حداکثر تعداد پروژه هایی که باید در پاسخ بازگردانده شوند.

سرور ممکن است به صلاحدید خود کمتر از این مقدار را برگرداند. اگر مقداری مشخص نشده باشد (یا مقدار بسیار بزرگی مشخص شده باشد)، سرور محدودیت خود را اعمال خواهد کرد.

این مقدار نمی تواند منفی باشد.

showDeleted

boolean

اختیاری. کنترل می کند که آیا پروژه های در حالت DELETED باید در پاسخ برگردانده شوند یا خیر.

اگر مشخص نشده باشد، فقط پروژه های ACTIVE برگردانده خواهند شد.

درخواست بدن

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

بدن پاسخگو

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

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

object ( FirebaseProject )

یک صفحه از لیست پروژه هایی که برای تماس گیرنده قابل دسترسی است.

nextPageToken

string

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

این نشانه را می توان در فراخوانی های بعدی به projects.list برای یافتن گروه بعدی پروژه ها استفاده کرد.

توکن های صفحه کوتاه مدت هستند و نباید ادامه پیدا کنند.

محدوده مجوز

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

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