REST Resource: projects

संसाधन: FirebaseProject

FirebaseProject, टॉप-लेवल की Firebase इकाई है. यह कंटेनर, Firebase ऐप्लिकेशन, Firebase होस्टिंग साइट, स्टोरेज सिस्टम (Firebase रीयल टाइम डेटाबेस, Cloud Firestore, Cloud Storage बकेट), और दूसरे Firebase और Google Cloud Platform (GCP) रिसॉर्स के लिए है.

आपने projects.addFirebase को कॉल करके और मौजूदा GCP Project डालकर, FirebaseProject बनाया है. इससे मौजूदा GCP Project में Firebase के संसाधन जुड़ जाते हैं.

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 के एआईपी 2510 स्टैंडर्ड में प्रोजेक्ट आइडेंटिफ़ायर इस्तेमाल करने के बारे में ज़्यादा जानें.
ध्यान दें कि जवाब के किसी भी मुख्य भाग में PROJECT_IDENTIFIER का मान ProjectId होगा.

projectId

string

सिर्फ़ आउटपुट के लिए. इम्यूटेबल. प्रोजेक्ट के लिए, उपयोगकर्ता की ओर से असाइन किया गया यूनीक आइडेंटिफ़ायर.

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

projectNumber

string (int64 format)

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

displayName

string

प्रोजेक्ट के लिए, उपयोगकर्ता की ओर से असाइन किया गया डिसप्ले नेम.

resources

object (DefaultResources)

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

state

enum (State)

सिर्फ़ आउटपुट के लिए. प्रोजेक्ट की लाइफ़साइकल स्थिति.

annotations

map (key: string, value: string)

FirebaseProject के लिए, उपयोगकर्ता की ओर से तय किए गए एनोटेशन का सेट.
Google के AIP-128 स्टैंडर्ड में एनोटेशन के बारे में ज़्यादा जानें.

ये एनोटेशन सिर्फ़ डेवलपर और क्लाइंट-साइड टूल के लिए हैं. Firebase सेवाएं, एनोटेशन के इस सेट में बदलाव नहीं करेंगी.

एक ऑब्जेक्ट, जिसमें "key": value पेयर की सूची है. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

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

etag के बारे में ज़्यादा जानने के लिए, Google के AIP-154 स्टैंडर्ड में जाएं.

इस ईटैग की पुष्टि की गई है.

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

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

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 का इस्तेमाल पहले से ही किसी दूसरे प्रोजेक्ट में मौजूदा रीयलटाइम डेटाबेस इंस्टेंस के नाम के तौर पर किया जा रहा हो. डेटाबेस शार्डिंग के बारे में ज़्यादा जानें. इन मामलों में, आपका डिफ़ॉल्ट रीयल टाइम डेटाबेस इंस्टेंस नाम बनाने के लिए आपके projectId में हाइफ़न के साथ पांच अक्षर और अंक जोड़े जाते हैं. उदाहरण के लिए, अगर आपका projectId myproject123 है, तो आपके डेटाबेस के इंस्टेंस का डिफ़ॉल्ट नाम यह हो सकता है: myproject123-a5c16

storageBucket

string

सिर्फ़ आउटपुट के लिए. 'Firebase के लिए Cloud Storage' के डिफ़ॉल्ट स्टोरेज बकेट का फ़ॉर्मैट:

PROJECT_ID.appspot.com

locationId

string

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

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

राज्य

प्रोजेक्ट की लाइफ़साइकल की संभावित स्थितियां. Google के AIP-216 स्टैंडर्ड में राज्यों के बारे में ज़्यादा जानें.

एनम्स
STATE_UNSPECIFIED स्थिति सेट नहीं की गई है.
ACTIVE प्रोजेक्ट चालू है.
DELETED प्रोजेक्ट को अस्थायी रूप से हटा दिया गया है.

तरीके

addFirebase

बताए गए मौजूदा Google Cloud Platform (GCP) Project में Firebase संसाधन जोड़ता है.

addGoogleAnalytics

दिए गए FirebaseProject को किसी मौजूदा Google Analytics खाते से लिंक करता है.

get

बताए गए FirebaseProject को मिलता है.

getAdminSdkConfig

बताए गए FirebaseProject से जुड़ा कॉन्फ़िगरेशन आर्टफ़ैक्ट मिलता है, जिसका इस्तेमाल सर्वर शुरू करने की प्रक्रिया को आसान बनाने के लिए करता है.

getAnalyticsDetails

बताए गए FirebaseProject से जुड़ी Google Analytics की जानकारी हासिल करता है.

list

इसमें, हर FirebaseProject को कॉलर के लिए ऐक्सेस किया जा सकता है.

patch

बताए गए FirebaseProject के एट्रिब्यूट को अपडेट करता है.

removeAnalytics

बताए गए FirebaseProject को उसके Google Analytics खाते से अनलिंक करता है.

searchApps

तय किए गए FirebaseProject के लिए उपलब्ध सभी ऐप्लिकेशन की सूची बनाता है.