REST Resource: projects

المرجع: FirebaseProject

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

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

بما أنّ FirebaseProject هو أيضًا Project في Google Cloud Platform، فإن FirebaseProject له معرِّفات GCP الأساسية نفسها (projectNumber وprojectId). ويتيح ذلك إمكانية التشغيل التفاعلي بسهولة مع Google APIs.

تمثيل 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 للمشروع. استخدِم هذا المعرّف عند ضبط عمليات الدمج و/أو إجراء طلبات بيانات من واجهة برمجة التطبيقات إلى 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 في الوقت الفعلي التلقائي بالتنسيق:

PROJECT_ID

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

string

النتائج فقط. حزمة التخزين التلقائية في Cloud Storage for Firebase بالتنسيق:

PROJECT_ID.appspot.com
locationId

string

النتائج فقط. رقم تعريف الموقع الجغرافي التلقائي لموارد Google Cloud Platform للمشروع. يكون الموقع الجغرافي أحد مواقع موارد GCP المتاحة.

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

الولاية

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

تعدادات
STATE_UNSPECIFIED حالة غير محدَّدة.
ACTIVE المشروع نشط.
DELETED تم حذف المشروع مبدئيًا.

الطُرق

addFirebase

 إضافة موارد Firebase إلى Google Cloud Platform (GCP) Project الحالي المحدّد.

addGoogleAnalytics

 ربط FirebaseProject المحدّد بحساب حالي على "إحصاءات Google"

get

 للحصول على قيمة FirebaseProject المحدّدة

getAdminSdkConfig

 الحصول على عنصر الإعداد المرتبط بـ FirebaseProject المحدد، والذي يمكن استخدامه بواسطة الخوادم لتبسيط الإعداد.

getAnalyticsDetails

 الحصول على تفاصيل "إحصاءات Google" المرتبطة حاليًا بقيمة FirebaseProject المحدّدة.

list

 يسرد كل FirebaseProject يمكن للمتصل الوصول إليه.

patch

 لتعديل سمات السمة FirebaseProject المحدّدة.

removeAnalytics

 إلغاء ربط FirebaseProject المحدّدة بحسابها على "إحصاءات Google".

searchApps

 يسرد جميع التطبيقات المتاحة لنطاق FirebaseProject المحدَّد.