REST Resource: projects.webApps

संसाधन: वेबएप

वेब के लिए फायरबेस ऐप का विवरण।

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 । Google के AIP 2510 मानक में प्रोजेक्ट पहचानकर्ताओं का उपयोग करने के बारे में और जानें।
    ध्यान दें कि किसी भी प्रतिक्रिया निकाय में PROJECT_IDENTIFIER का मान ProjectId होगा।
  • APP_ID : ऐप के लिए विश्व स्तर पर अद्वितीय, फ़ायरबेस-निर्दिष्ट पहचानकर्ता ( appId देखें)।
appId

string

केवल आउटपुट. अपरिवर्तनीय. WebApp के लिए विश्व स्तर पर अद्वितीय, फायरबेस-निर्दिष्ट पहचानकर्ता।

इस पहचानकर्ता को एक अपारदर्शी टोकन के रूप में माना जाना चाहिए, क्योंकि डेटा प्रारूप निर्दिष्ट नहीं है।

displayName

string

WebApp के लिए उपयोगकर्ता द्वारा निर्दिष्ट प्रदर्शन नाम।

projectId

string

केवल आउटपुट. अपरिवर्तनीय. WebApp के लिए मूल FirebaseProject का उपयोगकर्ता द्वारा निर्दिष्ट अद्वितीय पहचानकर्ता।

appUrls[]

string

वे URL जहां WebApp होस्ट किया गया है।

webId
(deprecated)

string

केवल आउटपुट. अपरिवर्तनीय. WebApp के लिए एक अद्वितीय, फ़ायरबेस-निर्दिष्ट पहचानकर्ता।

इस पहचानकर्ता का उपयोग केवल WebApp के लिए namespace मान को पॉप्युलेट करने के लिए किया जाता है। अधिकांश उपयोग के मामलों में, ऐप को पहचानने या संदर्भित करने के लिए appId उपयोग करें। webId मान केवल FirebaseProject और उससे जुड़े ऐप्स के भीतर अद्वितीय है।

apiKeyId

string

WebApp से जुड़ी फायरबेस एपीआई कुंजी के लिए विश्व स्तर पर अद्वितीय, Google द्वारा निर्दिष्ट पहचानकर्ता (यूआईडी)।

ध्यान रखें कि यह मान एपीआई कुंजी का यूआईडी है, एपीआई कुंजी की keyString नहींkeyString वह मान है जो ऐप के कॉन्फ़िगरेशन आर्टिफैक्ट में पाया जा सकता है।

यदि apiKeyId webApps.Create अनुरोधों में सेट नहीं किया गया है, तो Firebase स्वचालित रूप से एक apiKeyId WebApp के साथ जोड़ देता है। यह स्वतः-संबद्ध कुंजी एक मौजूदा वैध कुंजी हो सकती है या, यदि कोई वैध कुंजी मौजूद नहीं है, तो एक नई कुंजी का प्रावधान किया जाएगा।

पैच अनुरोधों में, apiKeyId खाली मान पर सेट नहीं किया जा सकता है, और नए UID पर कोई प्रतिबंध नहीं होना चाहिए या केवल ऐसे प्रतिबंध होने चाहिए जो संबंधित WebApp के लिए मान्य हों। हम एपीआई कुंजियों को प्रबंधित करने के लिए Google क्लाउड कंसोल का उपयोग करने की अनुशंसा करते हैं।

state

enum ( State )

केवल आउटपुट. ऐप की जीवनचक्र स्थिति।

etag

string

इस चेकसम की गणना सर्वर द्वारा अन्य फ़ील्ड के मूल्य के आधार पर की जाती है, और इसे आगे बढ़ने से पहले यह सुनिश्चित करने के लिए अद्यतन अनुरोधों के साथ भेजा जा सकता है कि क्लाइंट के पास अद्यतन मूल्य है।

Google के AIP-154 मानक में etag के बारे में और जानें।

यह ईटैग दृढ़ता से मान्य है।

तरीकों

create

निर्दिष्ट FirebaseProject में एक नए WebApp के निर्माण का अनुरोध करता है।

get

निर्दिष्ट WebApp प्राप्त करता है।

getConfig

निर्दिष्ट WebApp से संबद्ध कॉन्फ़िगरेशन आर्टिफैक्ट प्राप्त करता है।

list

निर्दिष्ट FirebaseProject से संबद्ध प्रत्येक WebApp सूचीबद्ध करता है।

patch

निर्दिष्ट WebApp की विशेषताओं को अद्यतन करता है।

remove

FirebaseProject से निर्दिष्ट WebApp हटा देता है।

undelete

निर्दिष्ट WebApp FirebaseProject पर पुनर्स्थापित करता है।