Method: projects.searchApps

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

यह एक आसान तरीका है. आम तौर पर, किसी ऐप्लिकेशन के साथ इंटरैक्शन किसी खास प्लैटफ़ॉर्म की सेवा का इस्तेमाल करके किया जाना चाहिए. हालांकि, कुछ टूल के इस्तेमाल के मामलों में, उन सभी ऐप्लिकेशन की खास जानकारी की ज़रूरत होती है जिन्हें पहले से जाना जाता है. जैसे, ऐप्लिकेशन चुनने वाले इंटरफ़ेस के लिए.

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

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}:searchApps

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

पाथ पैरामीटर

पैरामीटर
parent

string

वह पैरंट FirebaseProject जिसके लिए ऐप्लिकेशन की सूची बनानी है, इस फ़ॉर्मैट में:

projects/PROJECT_IDENTIFIER

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

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

पैरामीटर
pageToken

string

पिछले कॉल के बाद projects.searchApps पर भेजा गया टोकन, जो बताता है कि स्टोर पेज को फिर से शुरू करने के लिए, ऐप्लिकेशन सेट में कहां पर जाना है.

pageSize

integer

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

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

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

filter

string

Google के AIP-160 स्टैंडर्ड के साथ काम करने वाली क्वेरी स्ट्रिंग.

क्वेरी में इनमें से किसी भी फ़ील्ड का इस्तेमाल करें:

यह क्वेरी इस "वर्चुअल" के साथ भी काम करती है फ़ील्ड. ये ऐसे फ़ील्ड होते हैं जो असल में, लौटाए गए रिसॉर्स ऑब्जेक्ट का हिस्सा नहीं होते. हालांकि, इन पर इस तरह से क्वेरी की जा सकती है, जैसे कि किसी वैल्यू से पहले से ही जानकारी भरी गई हो.

  • sha1_hash या sha1Hashes: इस फ़ील्ड को दोहराया गया string फ़ील्ड माना जाता है, जिसमें AndroidApp के साथ रजिस्टर किए गए सभी SHA-1 सर्टिफ़िकेट फ़िंगरप्रिंट की सूची होती है. अगर ऐप्लिकेशन AndroidApp नहीं है, तो यह सूची खाली होगी.
  • sha256_hash या sha256Hashes: इस फ़ील्ड को दोहराया गया string फ़ील्ड माना जाता है और इसमें AndroidApp के साथ रजिस्टर किए गए सभी SHA-256 सर्टिफ़िकेट फ़िंगरप्रिंट की सूची होती है. अगर ऐप्लिकेशन AndroidApp नहीं है, तो यह सूची खाली होगी.
  • appStoreId: इस फ़ील्ड को एकवचन string फ़ील्ड माना जाता है और इसमें IosApp के साथ रजिस्टर किए गए Apple App Store आईडी से जानकारी अपने-आप भर जाती है. अगर ऐप्लिकेशन IosApp नहीं है, तो यह फ़ील्ड खाली होता है.
  • teamId: इस फ़ील्ड को एकवचन string फ़ील्ड माना जाता है. इसमें IosApp के साथ रजिस्टर किए गए Apple टीम आईडी से जानकारी अपने-आप भर जाती है. अगर ऐप्लिकेशन IosApp नहीं है, तो यह फ़ील्ड खाली होती है.
showDeleted

boolean

यह नीति कंट्रोल करती है कि DELETED स्थिति में ऐप्लिकेशन को दिखाया जाना चाहिए या नहीं.

अगर इसके बारे में तय नहीं किया गया है, तो सिर्फ़ ACTIVE ऐप्लिकेशन लौटाए जाएंगे.

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

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

जवाब का लेख

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

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

object (FirebaseAppInfo)

projects.searchApps को किए गए कॉल के नतीजों का एक पेज.

nextPageToken

string

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

इस टोकन का इस्तेमाल, projects.searchApps को किए जाने वाले अगले कॉल में किया जा सकता है, ताकि ऐप्लिकेशन का अगला ग्रुप ढूंढा जा सके.

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

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

इनमें से किसी एक 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

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

FirebaseAppInfo

ऐप्लिकेशन की खास जानकारी.

JSON के काेड में दिखाना
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
फ़ील्ड
name

string

Firebase ऐप्लिकेशन के संसाधन का नाम, फ़ॉर्मैट में:

projects/PROJECT_ID/iosApps/APP_ID

या

projects/PROJECT_ID/androidApps/APP_ID

या

projects/PROJECT_ID/webApps/APP_ID

displayName

string

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

platform

enum (AppPlatform)

Firebase ऐप्लिकेशन का प्लैटफ़ॉर्म.

appId

string

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

इस आइडेंटिफ़ायर को ओपेक टोकन माना जाना चाहिए, क्योंकि डेटा फ़ॉर्मैट की जानकारी नहीं दी गई है.

namespace

string

सिर्फ़ आउटपुट के लिए. इम्यूटेबल. ऐप्लिकेशन का खास प्लैटफ़ॉर्म आइडेंटिफ़ायर.

ध्यान दें: इस्तेमाल के ज़्यादातर उदाहरणों में, appId का इस्तेमाल करें. यह किसी ऐप्लिकेशन का रेफ़रंस देने के लिए, दुनिया भर में इस्तेमाल होने वाला कैननिकल आइडेंटिफ़ायर है.

यह स्ट्रिंग, हर प्लैटफ़ॉर्म के नेटिव आइडेंटिफ़ायर से ली जाती है: AndroidApp के लिए packageName, IosApp के लिए bundleId, और WebApp के लिए webId. इसका कॉन्टेंट ओपेक के तौर पर होना चाहिए, क्योंकि प्लैटफ़ॉर्म में बदलाव होने पर नेटिव आइडेंटिफ़ायर फ़ॉर्मैट में बदलाव हो सकता है. यह स्ट्रिंग सिर्फ़ FirebaseProject और उससे जुड़े ऐप्लिकेशन में ही यूनीक होती है.

apiKeyId

string

ऐप्लिकेशन से जुड़ी Firebase API कुंजी के लिए, दुनिया भर में इस्तेमाल होने वाला यूनीक आइडेंटिफ़ायर (यूआईडी).

ध्यान रखें कि यह वैल्यू, एपीआई पासकोड का यूआईडी है, न कि keyString का एपीआई पासकोड. keyString वह वैल्यू है जो ऐप्लिकेशन के कॉन्फ़िगरेशन आर्टफ़ैक्ट में मिल सकती है (AndroidApp | IosApp | WebApp).

अगर ऐप्लिकेशन (AndroidApp | IosApp | WebApp) बनाने के अनुरोधों में apiKeyId सेट नहीं है, तो Firebase अपने-आप apiKeyId को ऐप्लिकेशन के साथ जोड़ देता है. अपने-आप जुड़ी यह कुंजी मौजूदा मान्य कुंजी हो सकती है. अगर कोई मान्य कुंजी मौजूद नहीं है, तो एक नई कुंजी का प्रावधान किया जाएगा.

state

enum (State)

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

ऐप्लिकेशन प्लेटफ़ॉर्म

वे प्लैटफ़ॉर्म जिनसे Firebase ऐप्लिकेशन को जोड़ा जा सकता है.

एनम्स
PLATFORM_UNSPECIFIED अनजान स्थिति. इसका इस्तेमाल सिर्फ़ सेट नहीं की गई वैल्यू को अलग करने के लिए किया जाता है.
IOS Firebase ऐप्लिकेशन, iOS से जुड़ा हुआ है.
ANDROID Firebase ऐप्लिकेशन, Android से जुड़ा हुआ है.
WEB Firebase ऐप्लिकेशन, वेब से जुड़ा होता है.