REST Resource: projects.webApps

منبع: WebApp

جزئیات یک برنامه Firebase برای وب.

نمایندگی JSON
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
زمینه های
name

string

نام منبع WebApp ، در قالب:

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID

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

string

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

این شناسه باید به عنوان یک نشانه غیر شفاف در نظر گرفته شود، زیرا قالب داده مشخص نشده است.

displayName

string

نام نمایشی اختصاص داده شده توسط کاربر برای WebApp .

projectId

string

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

appUrls[]

string

نشانی‌های اینترنتی که WebApp در آن میزبانی می‌شود.

webId
(deprecated)

string

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

این شناسه فقط برای پر کردن مقدار namespace برای WebApp استفاده می شود. برای بیشتر موارد استفاده، از appId برای شناسایی یا ارجاع برنامه استفاده کنید. مقدار webId فقط در FirebaseProject و برنامه های مرتبط با آن منحصر به فرد است.

apiKeyId

string

شناسه (UID) منحصربفرد جهانی و اختصاص داده شده توسط Google برای کلید Firebase API مرتبط با WebApp .

توجه داشته باشید که این مقدار UID کلید API است، نه keyString کلید API. keyString مقداری است که در آرتیفکت پیکربندی برنامه یافت می‌شود.

اگر apiKeyId در درخواست های webApps.Create تنظیم نشده باشد، Firebase به طور خودکار یک apiKeyId را با WebApp مرتبط می کند. این کلید مرتبط خودکار ممکن است یک کلید معتبر موجود باشد یا اگر کلید معتبری وجود نداشته باشد، یک کلید جدید ارائه خواهد شد.

در درخواست‌های وصله، apiKeyId نمی‌توان روی یک مقدار خالی تنظیم کرد، و UID جدید باید هیچ محدودیتی نداشته باشد یا فقط دارای محدودیت‌هایی باشد که برای WebApp مرتبط معتبر هستند. توصیه می کنیم از Google Cloud Console برای مدیریت کلیدهای API استفاده کنید.

state

enum ( State )

فقط خروجی وضعیت چرخه حیات برنامه

etag

string

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

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

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

مواد و روش ها

create

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

get

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

getConfig

 مصنوع پیکربندی مرتبط با WebApp مشخص شده را دریافت می کند.

list

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

patch

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

remove

 WebApp مشخص شده را از FirebaseProject حذف می کند.

undelete

 WebApp مشخص شده را به FirebaseProject بازیابی می کند.