Method: projects.searchApps

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

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

HTTP अनुरोध

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

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

पथ पैरामीटर

पैरामीटर
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 के साथ पंजीकृत ऐप्पल ऐप स्टोर आईडी से भरा हुआ है। यदि ऐप 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

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।

फायरबेसऐपइन्फो

किसी ऐप का उच्च-स्तरीय सारांश।

JSON प्रतिनिधित्व
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
खेत
name

string

फ़ायरबेस ऐप का संसाधन नाम, प्रारूप में:

projects/ PROJECT_ID /iosApps/ APP_ID

या

projects/ PROJECT_ID /androidApps/ APP_ID

या

projects/ PROJECT_ID /webApps/ APP_ID

displayName

string

फ़ायरबेस ऐप का उपयोगकर्ता द्वारा निर्दिष्ट प्रदर्शन नाम।

platform

enum ( AppPlatform )

फायरबेस ऐप का प्लेटफॉर्म.

appId

string

केवल आउटपुट. अपरिवर्तनीय. WebApp के लिए विश्व स्तर पर अद्वितीय, फायरबेस-निर्दिष्ट पहचानकर्ता।

इस पहचानकर्ता को एक अपारदर्शी टोकन के रूप में माना जाना चाहिए, क्योंकि डेटा प्रारूप निर्दिष्ट नहीं है।

namespace

string

केवल आउटपुट. अपरिवर्तनीय. ऐप का प्लेटफ़ॉर्म-विशिष्ट पहचानकर्ता।

नोट: अधिकांश उपयोग के मामलों के लिए, appId उपयोग करें, जो किसी ऐप को संदर्भित करने के लिए विहित, विश्व स्तर पर अद्वितीय पहचानकर्ता है।

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

apiKeyId

string

ऐप से जुड़ी फायरबेस एपीआई कुंजी के लिए विश्व स्तर पर अद्वितीय, Google द्वारा निर्दिष्ट पहचानकर्ता (यूआईडी)।

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

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

state

enum ( State )

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

ऐपप्लेटफॉर्म

वे प्लेटफ़ॉर्म जिनके साथ फ़ायरबेस ऐप संबद्ध किया जा सकता है।

एनम्स
PLATFORM_UNSPECIFIED अज्ञात अवस्था. इसका उपयोग केवल अनसेट मानों को अलग करने के लिए किया जाता है।
IOS फायरबेस ऐप iOS से जुड़ा है।
ANDROID फायरबेस ऐप एंड्रॉइड से जुड़ा है।
WEB फायरबेस ऐप वेब से जुड़ा है।