REST Resource: projects

منبع: FirebaseProject

FirebaseProject موجودیت Firebase سطح بالا است. این محفظه برای برنامه‌های Firebase، سایت‌های میزبانی Firebase، سیستم‌های ذخیره‌سازی (پایگاه بی‌درنگ Firebase، Cloud Firestore، سطل‌های Cloud Storage) و سایر منابع Firebase و Google Cloud Platform (GCP) است.

با فراخوانی projects.addFirebase و مشخص کردن یک Project GCP موجود ، یک FirebaseProject ایجاد می‌کنید. این منابع Firebase را به Project GCP موجود اضافه می کند.

از آنجایی که FirebaseProject در واقع یک Project GCP نیز هست، یک FirebaseProject دارای شناسه‌های زیرین GCP است ( projectNumber و projectId ). این امکان تعامل آسان با API های Google را فراهم می کند.

نمایندگی JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
زمینه های
name

string

نام منبع پروژه، در قالب:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : ProjectNumber پروژه (توصیه شده) یا ProjectId آن.
درباره استفاده از شناسه‌های پروژه در استاندارد AIP 2510 Google بیشتر بیاموزید.
توجه داشته باشید که مقدار PROJECT_IDENTIFIER در هر بدنه پاسخی ProjectId خواهد بود.

projectId

string

فقط خروجی تغییرناپذیر. یک شناسه منحصر به فرد اختصاص داده شده توسط کاربر برای پروژه.

این شناسه ممکن است در URL ها یا نام برخی از منابع Firebase مرتبط با پروژه ظاهر شود، اما معمولاً باید به عنوان نام مستعار مناسب برای ارجاع به پروژه در نظر گرفته شود.

projectNumber

string ( int64 format)

فقط خروجی تغییرناپذیر. شناسه متعارف اختصاص داده شده توسط Google در سطح جهانی برای پروژه. هنگام پیکربندی ادغام ها و/یا برقراری تماس های API با Firebase یا خدمات شخص ثالث از این شناسه استفاده کنید.

displayName

string

نام نمایش داده شده توسط کاربر برای پروژه.

resources

object ( DefaultResources )

فقط خروجی منابع Firebase پیش فرض مرتبط با پروژه.

state

enum ( State )

فقط خروجی وضعیت چرخه حیات پروژه

annotations

map (key: string, value: string)

مجموعه ای از حاشیه نویسی های تعریف شده توسط کاربر برای FirebaseProject .
درباره حاشیه نویسی در استاندارد AIP-128 Google بیشتر بیاموزید.

این حاشیه نویسی فقط برای توسعه دهندگان و ابزارهای سمت مشتری در نظر گرفته شده است. سرویس‌های Firebase این مجموعه حاشیه‌نویسی را تغییر نمی‌دهند.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

etag

string

این چک‌سوم توسط سرور بر اساس مقدار فیلدهای دیگر محاسبه می‌شود و ممکن است با درخواست‌های به‌روزرسانی ارسال شود تا اطمینان حاصل شود که مشتری قبل از ادامه، یک مقدار به‌روز دارد.

درباره etag در استاندارد AIP-154 Google بیشتر بیاموزید.

این تگ به شدت تایید شده است.

منابع پیش فرض

منابع پیش فرض مرتبط با پروژه

نمایندگی JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
زمینه های
hostingSite

string

فقط خروجی نام پیش‌فرض سایت میزبانی Firebase، در قالب:

PROJECT_ID

اگرچه نادر است، اما projectId شما ممکن است قبلاً به عنوان نام یک سایت میزبان موجود در پروژه دیگری استفاده شود (در مورد ایجاد سایت های غیر پیش فرض و اضافی بیشتر بیاموزید). در این موارد، projectId شما با یک خط فاصله و سپس پنج کاراکتر الفبایی ضمیمه می شود تا نام سایت میزبانی پیش فرض شما ایجاد شود. به عنوان مثال، اگر projectId شما myproject123 است، نام سایت میزبانی پیش فرض شما ممکن است این باشد: myproject123-a5c16

realtimeDatabaseInstance

string

فقط خروجی نام نمونه پیش‌فرض Firebase Realtime Database، در قالب:

PROJECT_ID

اگرچه نادر است، projectId شما ممکن است قبلاً به عنوان نام یک نمونه پایگاه داده بیدرنگ موجود در پروژه دیگری استفاده شود (درباره اشتراک گذاری پایگاه داده بیشتر بیاموزید). در این موارد، projectId شما با یک خط فاصله و سپس پنج کاراکتر الفبایی ضمیمه می شود تا نام نمونه پایگاه داده بیدرنگ شما را ایجاد کند. برای مثال، اگر projectId شما myproject123 است، نام نمونه پایگاه داده پیش‌فرض شما ممکن است این باشد: myproject123-a5c16

storageBucket

string

فقط خروجی فضای ذخیره سازی ابری پیش فرض برای سطل ذخیره سازی Firebase، در قالب:

PROJECT_ID .appspot.com

locationId

string

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

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

حالت

وضعیت‌های چرخه حیات پروژه درباره ایالات در استاندارد AIP-216 Google بیشتر بیاموزید.

Enums
STATE_UNSPECIFIED وضعیت نامشخص
ACTIVE پروژه فعال است
DELETED پروژه به نرمی حذف شده است.

مواد و روش ها

addFirebase

 منابع Firebase را به Project Google Cloud Platform (GCP) مشخص شده اضافه می کند.

addGoogleAnalytics

 FirebaseProject مشخص شده را با یک حساب Google Analytics موجود پیوند می دهد.

get

 FirebaseProject مشخص شده را دریافت می کند.

getAdminSdkConfig

 مصنوع پیکربندی مرتبط با FirebaseProject مشخص شده را دریافت می کند، که می تواند توسط سرورها برای ساده سازی مقداردهی اولیه استفاده شود.

getAnalyticsDetails

 جزئیات Google Analytics در حال حاضر مرتبط با FirebaseProject مشخص شده را دریافت می کند.

list

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

patch

 ویژگی های FirebaseProject مشخص شده را به روز می کند.

removeAnalytics

 FirebaseProject مشخص شده را از حساب Google Analytics خود جدا می کند.

searchApps

 همه برنامه های موجود برای FirebaseProject مشخص شده را فهرست می کند.