Method: projects.webApps.getConfig

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

درخواست HTTP

GET https://firebase.googleapis.com/v1beta1/{name=projects/*/webApps/*/config}

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

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

مولفه های
name

string

نام منبع پیکربندی WebApp برای دانلود، در قالب:

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID /config


از آنجایی که یک APP_ID یک شناسه منحصربه‌فرد است، می‌توان از الگوی دسترسی به منبع منحصربه‌فرد از مجموعه فرعی در قالب زیر استفاده کرد:

projects/-/webApps/ APP_ID


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

درخواست بدن

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

بدن پاسخگو

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

فراداده پیکربندی یک برنامه Firebase برای وب.

نمایندگی JSON
{
  "projectId": string,
  "appId": string,
  "databaseURL": string,
  "storageBucket": string,
  "locationId": string,
  "apiKey": string,
  "authDomain": string,
  "messagingSenderId": string,
  "measurementId": string
}
زمینه های
projectId

string

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

appId

string

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

databaseURL

string

نشانی وب پیش‌فرض پایگاه داده بیدرنگ Firebase.

storageBucket

string

نام پیش‌فرض Cloud Storage برای سطل ذخیره‌سازی Firebase.

locationId

string

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

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

apiKey

string

keyString کلید API مرتبط با WebApp .

توجه داشته باشید که این مقدار apiKeyId (UID) کلید API مرتبط با WebApp نیست .

authDomain

string

دامنه Firebase Auth برای تغییر مسیرهای OAuth، در قالب:

PROJECT_ID .firebaseapp.com

messagingSenderId

string

شناسه فرستنده برای استفاده با Firebase Cloud Messaging.

measurementId

string

شناسه منحصر به فرد اختصاص داده شده توسط Google جریان وب Google Analytics مرتبط با WebApp . Firebase SDK از این شناسه برای تعامل با APIهای Google Analytics استفاده می کند.

این فیلد فقط در صورتی وجود دارد که WebApp به یک جریان وب در یک برنامه Google Analytics + ویژگی وب مرتبط باشد. درباره این شناسه و جریان های وب Google Analytics در اسناد Analytics بیشتر بیاموزید.

برای ایجاد measurementId و پیوند WebApp با یک جریان وب Google Analytics، با projects.addGoogleAnalytics تماس بگیرید.

برای برنامه‌هایی که از Firebase JavaScript SDK نسخه 7.20.0 و جدیدتر استفاده می‌کنند، Firebase زمانی که برنامه شما Analytics را مقداردهی اولیه می‌کند، به صورت پویا measurementId واکشی می‌کند. داشتن این شناسه در شیء پیکربندی شما اختیاری است، اما در موارد نادری که واکشی پویا با شکست مواجه می‌شود، به عنوان یک بک گراند عمل می‌کند.

محدوده مجوز

به یکی از حوزه های 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

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