Method: availableProjects.list

यह सूची, हर उस Google Cloud Platform (GCP) Project की जानकारी देती है जिसमें Firebase के संसाधन जोड़े जा सकते हैं.

किसी प्रोजेक्ट को सिर्फ़ तब शामिल किया जाएगा, जब:

  • projects.addFirebase को कॉल करने के लिए, कॉलर के पास काफ़ी Google IAM अनुमतियां हैं.
  • प्रोजेक्ट पहले से एक FirebaseProject नहीं है.
  • प्रोजेक्ट ऐसे संगठन में नहीं है जिसकी नीतियां Firebase के संसाधनों को जोड़े जाने से रोकती हैं.

एचटीटीपी अनुरोध

GET https://firebase.googleapis.com/v1beta1/availableProjects

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
pageToken

string

पिछले कॉल के बाद availableProjects.list को दिखाया गया टोकन, इससे पता चलता है कि प्रोजेक्ट के सेट में उसे फिर से कहां दिखाना है.

pageSize

integer

जवाब में दिए जाने वाले प्रोजेक्ट की ज़्यादा से ज़्यादा संख्या.

सर्वर अपने विवेक के आधार पर इस वैल्यू से कम वैल्यू दिखा सकता है. अगर कोई वैल्यू तय नहीं की गई है या बहुत बड़ी वैल्यू दी गई है, तो सर्वर अपनी सीमा खुद तय करेगा.

यह मान शून्य से कम नहीं हो सकता.

अनुरोध का मुख्य भाग

अनुरोध का लेख खाली होना चाहिए.

जवाब का लेख

अगर इंडेक्सिंग सही से हाे जाती है, ताे जवाब के लेख में नीचे दिए गए स्ट्रक्चर का डेटा शामिल होता है.

JSON के काेड में दिखाना
{
  "projectInfo": [
    {
      object (ProjectInfo)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
projectInfo[]

object (ProjectInfo)

GCP Projects की सूची, जिसमें Firebase के संसाधन जोड़े जा सकते हैं.

nextPageToken

string

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

इस टोकन का इस्तेमाल, availableProjects.list को किए जाने वाले अगले कॉल में किया जा सकता है, ताकि प्रोजेक्ट का अगला ग्रुप खोजा जा सके.

पेज टोकन थोड़े समय के लिए होते हैं और उन्हें ज़्यादा समय तक नहीं रखना चाहिए.

अनुमति की संभावना

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

प्रोजेक्ट की जानकारी

Google Cloud Platform (GCP) Project का रेफ़रंस.

JSON के काेड में दिखाना
{
  "project": string,
  "displayName": string,
  "locationId": string
}
फ़ील्ड
project

string

GCP Project का संसाधन नाम, जिसमें Firebase के संसाधन जोड़े जा सकते हैं. नाम इस फ़ॉर्मैट में होना चाहिए:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER वैल्यू के बारे में जानकारी के लिए, FirebaseProject name फ़ील्ड देखें.

displayName

string

GCP Project का उपयोगकर्ता की ओर से असाइन किया गया डिसप्ले नेम. उदाहरण के लिए: My App

locationId

string

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

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