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 עבור מפתח ה-API של Firebase המשויך ל- WebApp .

שים לב שערך זה הוא ה-UID של מפתח ה-API, לא ה- keyString של מפתח ה-API. ה- keyString הוא הערך שניתן למצוא ב- Artifact של התצורה של האפליקציה.

אם apiKeyId לא מוגדר בבקשות ל- webApps.Create , Firebase משייך אוטומטית apiKeyId ל- WebApp . המפתח המשויך האוטומטי הזה עשוי להיות מפתח חוקי קיים או, אם לא קיים מפתח חוקי, מפתח חדש יסופק.

בבקשות תיקון, לא ניתן להגדיר apiKeyId לערך ריק, ול-UID החדש לא חייבות להיות הגבלות או רק הגבלות שתקפות עבור ה- WebApp המשויך. אנו ממליצים להשתמש ב- Google Cloud Console לניהול מפתחות API.

state

enum ( State )

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

etag

string

סכום בדיקה זה מחושב על ידי השרת בהתבסס על הערך של שדות אחרים, והוא עשוי להישלח עם בקשות עדכון כדי לוודא שללקוח יש ערך מעודכן לפני שתמשיך.

למידע נוסף על etag בתקן AIP-154 של גוגל.

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

שיטות

create

מבקש יצירה של WebApp חדש ב- FirebaseProject שצוין.

get

מקבל את ה- WebApp שצוין.

getConfig

מקבל את חפץ התצורה המשויך ל- WebApp שצוין.

list

מפרט כל WebApp המשויך ל- FirebaseProject שצוין.

patch

מעדכן את התכונות של WebApp שצוין.

remove

מסיר את WebApp שצוין מה- FirebaseProject .

undelete

משחזר את WebApp שצוין ל- FirebaseProject .