Method: availableProjects.list

هر Project Google Cloud Platform (GCP) را فهرست می کند که می تواند منابع Firebase را به آن اضافه کند.

یک پروژه فقط در صورتی فهرست می شود که:

  • تماس‌گیرنده دارای مجوزهای Google IAM کافی برای تماس با projects.addFirebase است.
  • این پروژه قبلاً یک FirebaseProject نیست.
  • پروژه در سازمانی نیست که دارای سیاست هایی باشد که از اضافه شدن منابع Firebase جلوگیری کند.

درخواست HTTP

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

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

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

مولفه های
pageToken

string

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

pageSize

integer

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

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

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

درخواست بدن

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

بدن پاسخگو

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

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

object ( ProjectInfo )

فهرست Projects GCP که می‌توانند منابع Firebase را به آن‌ها اضافه کنند.

nextPageToken

string

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

این نشانه را می توان در تماس های بعدی به availableProjects.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

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

ProjectInfo

ارجاع به Project Google Cloud Platform (GCP).

نمایندگی JSON
{
  "project": string,
  "displayName": string,
  "locationId": string
}
زمینه های
project

string

نام منبع Project GCP که منابع Firebase را می توان به آن اضافه کرد، در قالب:

projects/ PROJECT_IDENTIFIER

برای جزئیات بیشتر در مورد مقادیر PROJECT_IDENTIFIER به قسمت name FirebaseProject مراجعه کنید.

displayName

string

نام نمایشی اختصاص داده شده توسط کاربر برای Project GCP، به عنوان مثال: My App

locationId

string

شناسه مکان پیش‌فرض منبع GCP پروژه. مکان یکی از مکان‌های موجود منبع GCP است.

همه پروژه ها این فیلد را پر نمی کنند. اگر پر نشده باشد، به این معنی است که پروژه هنوز یک منبع پیش فرض GCP ندارد. برای تنظیم مکان پیش‌فرض منبع GCP پروژه، پس از افزودن منابع Firebase به پروژه defaultLocation.finalize فراخوانی کنید.