Method: availableProjects.list

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

किसी प्रोजेक्ट को केवल तभी सूचीबद्ध किया जाएगा यदि:

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

HTTP अनुरोध

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

यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।

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

पैरामीटर
pageToken

string

टोकन पिछले कॉल से availableProjects.list पर लौटा है, जो दर्शाता है कि लिस्टिंग को फिर से शुरू करने के लिए प्रोजेक्ट्स के सेट में कहां है।

pageSize

integer

प्रतिक्रिया में लौटने वाली परियोजनाओं की अधिकतम संख्या.

सर्वर अपने विवेक से इस मान से कम लौटा सकता है। यदि कोई मान निर्दिष्ट नहीं किया गया है (या बहुत बड़ा मान निर्दिष्ट किया गया है), तो सर्वर अपनी स्वयं की सीमा लगाएगा।

यह मान ऋणात्मक नहीं हो सकता.

निकाय से अनुरोध करें

अनुरोध का मुख्य भाग खाली होना चाहिए.

प्रतिक्रिया निकाय

सफल होने पर, प्रतिक्रिया निकाय में निम्नलिखित संरचना वाला डेटा शामिल होता है:

JSON प्रतिनिधित्व
{
  "projectInfo": [
    {
      object (ProjectInfo)
    }
  ],
  "nextPageToken": string
}
खेत
projectInfo[]

object ( ProjectInfo )

जीसीपी Projects की सूची जिसमें फायरबेस संसाधन जोड़े जा सकते हैं।

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 क्लाउड प्लेटफ़ॉर्म (GCP) Project का एक संदर्भ।

JSON प्रतिनिधित्व
{
  "project": string,
  "displayName": string,
  "locationId": string
}
खेत
project

string

GCP Project का संसाधन नाम जिसमें फ़ायरबेस संसाधन जोड़े जा सकते हैं, प्रारूप में:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER मानों के बारे में विवरण के लिए FirebaseProject name फ़ील्ड देखें।

displayName

string

जीसीपी Project का उपयोगकर्ता द्वारा निर्दिष्ट प्रदर्शन नाम, उदाहरण के लिए: My App

locationId

string

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

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