REST Resource: projects

المصدر: مشروع Firebase

FirebaseProject هو كيان Firebase ذو المستوى الأعلى. إنها حاوية لتطبيقات Firebase، ومواقع استضافة Firebase، وأنظمة التخزين (قاعدة بيانات Firebase Realtime، وCloud Firestore، ومستودعات Cloud Storage)، وموارد Firebase وGoogle Cloud Platform (GCP) الأخرى.

يمكنك إنشاء FirebaseProject عن طريق استدعاء projects.addFirebase وتحديد Project GCP موجود . يؤدي هذا إلى إضافة موارد Firebase إلى Project Google Cloud Platform الحالي.

نظرًا لأن FirebaseProject هو في الواقع أيضًا Project GCP، فإن FirebaseProject له نفس معرفات GCP الأساسية ( projectNumber و projectId ). يتيح ذلك سهولة التفاعل مع Google APIs.

تمثيل جيسون
{
  "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.

تم التحقق من صحة هذه العلامة بقوة.

الموارد الافتراضية

الموارد الافتراضية المرتبطة بالمشروع.

تمثيل جيسون
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
مجالات
hostingSite

string

الإخراج فقط. اسم موقع استضافة Firebase الافتراضي، بالتنسيق:

PROJECT_ID

على الرغم من ندرته، قد يتم استخدام معرف projectId الخاص بك بالفعل كاسم لموقع استضافة موجود في مشروع آخر (تعرف على المزيد حول إنشاء مواقع إضافية غير افتراضية). في هذه الحالات، يتم إلحاق projectId الخاص بك بواصلة ثم خمسة أحرف أبجدية رقمية لإنشاء اسم موقع الاستضافة الافتراضي الخاص بك. على سبيل المثال، إذا كان projectId الخاص بك هو myproject123 ، فقد يكون اسم موقع الاستضافة الافتراضي الخاص بك هو: myproject123-a5c16

realtimeDatabaseInstance

string

الإخراج فقط. اسم مثيل قاعدة بيانات Firebase Realtime الافتراضي، بالتنسيق:

PROJECT_ID

على الرغم من ندرته، قد يتم استخدام projectId الخاص بك بالفعل كاسم لمثيل قاعدة بيانات Realtime موجود في مشروع آخر (تعرف على المزيد حول تقسيم قاعدة البيانات ). في هذه الحالات، يتم إلحاق projectId الخاص بك بواصلة ثم خمسة أحرف أبجدية رقمية لإنشاء اسم مثيل قاعدة بيانات Realtime الافتراضي الخاص بك. على سبيل المثال، إذا كان projectId الخاص بك هو myproject123 ، فقد يكون اسم مثيل قاعدة البيانات الافتراضية لديك هو: myproject123-a5c16

storageBucket

string

الإخراج فقط. مجموعة تخزين Cloud Storage الافتراضية لـ Firebase، بالتنسيق:

PROJECT_ID .appspot.com

locationId

string

الإخراج فقط. معرف موقع مورد GCP الافتراضي للمشروع. يعد الموقع أحد مواقع موارد Google Cloud Platform المتوفرة.

يتم حذف هذا الحقل إذا لم يتم الانتهاء من موقع مورد Google Cloud Platform الافتراضي بعد. لتعيين موقع مورد Google Cloud Platform الافتراضي للمشروع، اتصل بـ defaultLocation.finalize بعد إضافة موارد Firebase إلى المشروع.

ولاية

حالات دورة الحياة المحتملة للمشروع. تعرف على المزيد حول الحالات الواردة في معيار Google AIP-216 .

التعدادات
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 المحدد.