REST Resource: projects

संसाधन: फायरबेसप्रोजेक्ट

FirebaseProject शीर्ष-स्तरीय फ़ायरबेस इकाई है। यह फायरबेस ऐप्स, फायरबेस होस्टिंग साइट्स, स्टोरेज सिस्टम (फायरबेस रियलटाइम डेटाबेस, क्लाउड फायरस्टोर, क्लाउड स्टोरेज बकेट) और अन्य फायरबेस और गूगल क्लाउड प्लेटफॉर्म (जीसीपी) संसाधनों के लिए कंटेनर है।

आप projects.addFirebase कॉल करके और मौजूदा GCP Project निर्दिष्ट करके एक FirebaseProject बनाते हैं। यह मौजूदा GCP Project में फ़ायरबेस संसाधन जोड़ता है।

चूँकि FirebaseProject वास्तव में एक GCP Project भी है, FirebaseProject में समान अंतर्निहित GCP पहचानकर्ता ( projectNumber और projectId ) होते हैं। यह Google API के साथ आसान इंटरऑप की अनुमति देता है।

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
Google के AIP 2510 मानक में प्रोजेक्ट पहचानकर्ताओं का उपयोग करने के बारे में और जानें।
ध्यान दें कि किसी भी प्रतिक्रिया निकाय में PROJECT_IDENTIFIER का मान ProjectId होगा।

projectId

string

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

यह पहचानकर्ता प्रोजेक्ट से जुड़े कुछ फायरबेस संसाधनों के यूआरएल या नामों में दिखाई दे सकता है, लेकिन इसे आम तौर पर प्रोजेक्ट को संदर्भित करने के लिए एक सुविधा उपनाम के रूप में माना जाना चाहिए।

projectNumber

string ( int64 format)

केवल आउटपुट. अपरिवर्तनीय. प्रोजेक्ट के लिए विश्व स्तर पर अद्वितीय, Google द्वारा निर्दिष्ट विहित पहचानकर्ता। एकीकरण कॉन्फ़िगर करते समय और/या फ़ायरबेस या तृतीय-पक्ष सेवाओं के लिए एपीआई कॉल करते समय इस पहचानकर्ता का उपयोग करें।

displayName

string

प्रोजेक्ट का उपयोगकर्ता द्वारा निर्दिष्ट प्रदर्शन नाम.

resources

object ( DefaultResources )

केवल आउटपुट. प्रोजेक्ट से जुड़े डिफ़ॉल्ट फ़ायरबेस संसाधन।

state

enum ( State )

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

annotations

map (key: string, value: string)

FirebaseProject के लिए उपयोगकर्ता-परिभाषित एनोटेशन का एक सेट।
Google के AIP-128 मानक में एनोटेशन के बारे में और जानें।

ये एनोटेशन केवल डेवलपर्स और क्लाइंट-साइड टूल के लिए हैं। फ़ायरबेस सेवाएँ इस एनोटेशन सेट को परिवर्तित नहीं करेंगी।

एक ऑब्जेक्ट जिसमें "key": value जोड़े। उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }

etag

string

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

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

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

डिफ़ॉल्टसंसाधन

प्रोजेक्ट से जुड़े डिफ़ॉल्ट संसाधन.

JSON प्रतिनिधित्व
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
खेत
hostingSite

string

केवल आउटपुट. डिफ़ॉल्ट फ़ायरबेस होस्टिंग साइट का नाम, प्रारूप में:

PROJECT_ID

हालांकि यह दुर्लभ है, आपका projectId पहले से ही किसी अन्य प्रोजेक्ट में मौजूदा होस्टिंग साइट के नाम के रूप में उपयोग किया जा सकता है (गैर-डिफ़ॉल्ट, अतिरिक्त साइट बनाने के बारे में और जानें)। इन मामलों में, आपका डिफ़ॉल्ट होस्टिंग साइट नाम बनाने के लिए आपके projectId एक हाइफ़न और फिर पांच अल्फ़ान्यूमेरिक वर्णों के साथ जोड़ा जाता है। उदाहरण के लिए, यदि आपका projectId myproject123 है, तो आपकी डिफ़ॉल्ट होस्टिंग साइट का नाम हो सकता है: myproject123-a5c16

realtimeDatabaseInstance

string

केवल आउटपुट. डिफ़ॉल्ट फ़ायरबेस रीयलटाइम डेटाबेस इंस्टेंस नाम, प्रारूप में:

PROJECT_ID

हालांकि दुर्लभ, आपका projectId पहले से ही किसी अन्य प्रोजेक्ट में मौजूदा रीयलटाइम डेटाबेस इंस्टेंस के नाम के रूप में उपयोग किया जा सकता है ( डेटाबेस शार्डिंग के बारे में और जानें)। इन मामलों में, आपका डिफ़ॉल्ट रीयलटाइम डेटाबेस इंस्टेंस नाम बनाने के लिए आपके projectId एक हाइफ़न और फिर पांच अल्फ़ान्यूमेरिक वर्णों के साथ जोड़ा जाता है। उदाहरण के लिए, यदि आपका projectId myproject123 है, तो आपका डिफ़ॉल्ट डेटाबेस इंस्टेंस नाम हो सकता है: myproject123-a5c16

storageBucket

string

केवल आउटपुट. फ़ायरबेस स्टोरेज बकेट के लिए डिफ़ॉल्ट क्लाउड स्टोरेज, प्रारूप में:

PROJECT_ID .appspot.com

locationId

string

केवल आउटपुट. प्रोजेक्ट के डिफ़ॉल्ट GCP संसाधन स्थान की आईडी. स्थान उपलब्ध GCP संसाधन स्थानों में से एक है.

यदि डिफ़ॉल्ट GCP संसाधन स्थान को अभी तक अंतिम रूप नहीं दिया गया है तो यह फ़ील्ड छोड़ दिया गया है। किसी प्रोजेक्ट का डिफ़ॉल्ट GCP संसाधन स्थान सेट करने के लिए, प्रोजेक्ट में फ़ायरबेस संसाधन जोड़ने के बाद defaultLocation.finalize पर कॉल करें।

राज्य

परियोजना की संभावित जीवनचक्र स्थितियाँ। Google के AIP-216 मानक में राज्यों के बारे में और जानें।

एनम्स
STATE_UNSPECIFIED अनिर्दिष्ट अवस्था.
ACTIVE परियोजना सक्रिय है.
DELETED प्रोजेक्ट को सॉफ़्ट-डिलीट कर दिया गया है.

तरीकों

addFirebase

निर्दिष्ट मौजूदा Google क्लाउड प्लेटफ़ॉर्म (GCP) Project में फ़ायरबेस संसाधन जोड़ता है।

addGoogleAnalytics

निर्दिष्ट FirebaseProject मौजूदा Google Analytics खाते से लिंक करता है।

get

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

getAdminSdkConfig

निर्दिष्ट FirebaseProject से संबद्ध कॉन्फ़िगरेशन आर्टिफैक्ट प्राप्त करता है, जिसका उपयोग सर्वर द्वारा आरंभीकरण को सरल बनाने के लिए किया जा सकता है।

getAnalyticsDetails

वर्तमान में निर्दिष्ट FirebaseProject से संबद्ध Google Analytics विवरण प्राप्त करता है।

list

कॉलर के लिए पहुंच योग्य प्रत्येक FirebaseProject सूचीबद्ध करता है।

patch

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

removeAnalytics

निर्दिष्ट FirebaseProject उसके Google Analytics खाते से अनलिंक करता है।

searchApps

निर्दिष्ट FirebaseProject के लिए सभी उपलब्ध ऐप्स को सूचीबद्ध करता है।