REST Resource: projects

משאב: FirebaseProject

FirebaseProject הוא ישות Firebase ברמה העליונה. זהו המיכל עבור אפליקציות Firebase, אתרי אירוח של Firebase, מערכות אחסון (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), ומשאבים אחרים של Firebase ו-Google Cloud Platform (GCP).

אתה יוצר FirebaseProject על ידי קריאה ל- projects.addFirebase וציון Project GCP קיים . זה מוסיף משאבי 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 של גוגל.

איטאג זה מאומת מאוד.

DefaultResources

משאבי ברירת המחדל המשויכים לפרויקט.

ייצוג 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 שלך מצורף עם מקף ולאחר מכן חמישה תווים אלפאנומריים כדי ליצור את שם המופע שלך ברירת המחדל של Realtime Database. לדוגמה, אם projectId שלך הוא myproject123 , שם מופע מסד הנתונים המוגדר כברירת מחדל עשוי להיות: myproject123-a5c16

storageBucket

string

פלט בלבד. ברירת המחדל של דלי האחסון בענן עבור Firebase, בפורמט:

PROJECT_ID .appspot.com

locationId

string

פלט בלבד. המזהה של מיקום ברירת המחדל של משאב GCP של הפרויקט. המיקום הוא אחד ממיקומי המשאבים הזמינים של GCP .

שדה זה מושמט אם מיקום ברירת המחדל של משאב GCP עדיין לא סוכם. כדי להגדיר את מיקום ברירת המחדל של משאב GCP של פרויקט, קרא defaultLocation.finalize לאחר הוספת משאבי Firebase לפרויקט.

מדינה

מצבי מחזור החיים האפשריים של הפרויקט. למידע נוסף על מדינות בתקן AIP-216 של Google.

תקצירים
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 שצוין.