Method: projects.searchApps

Listet alle verfügbaren Apps für das angegebene FirebaseProject auf.

Dies ist eine bequeme Methode. Normalerweise sollte die Interaktion mit einer App über den plattformspezifischen Dienst erfolgen, aber einige Tool-Anwendungsfälle erfordern eine Zusammenfassung aller bekannten Apps (z. B. für App-Auswahlschnittstellen).

HTTP-Anfrage

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

Die URL verwendet die gRPC-Transcoding -Syntax.

Pfadparameter

Parameter
parent

string

Das übergeordnete FirebaseProject , für das Apps aufgelistet werden sollen, im Format:

projects/ PROJECT_IDENTIFIER

Einzelheiten zu PROJECT_IDENTIFIER Werten finden Sie im name FirebaseProject .

Abfrageparameter

Parameter
pageToken

string

Von einem vorherigen Aufruf von projects.searchApps zurückgegebenes Token, das angibt, an welcher Stelle im Satz von Apps die Auflistung fortgesetzt werden soll.

pageSize

integer

Die maximale Anzahl von Apps, die in der Antwort zurückgegeben werden sollen.

Der Server kann nach eigenem Ermessen weniger als diesen Wert zurückgeben. Wenn kein Wert angegeben wird (oder ein zu großer Wert angegeben wird), legt der Server sein eigenes Limit fest.

Dieser Wert darf nicht negativ sein.

filter

string

Eine Abfragezeichenfolge, die mit dem AIP-160-Standard von Google kompatibel ist.

Verwenden Sie in einer Abfrage eines der folgenden Felder:

Diese Abfrage unterstützt auch die folgenden „virtuellen“ Felder. Hierbei handelt es sich um Felder, die eigentlich nicht Teil des zurückgegebenen Ressourcenobjekts sind, aber sie können abgefragt werden, als wären sie mit bestimmten Werten vorab ausgefüllt.

  • sha1_hash oder sha1Hashes : Dieses Feld wird als wiederholtes string betrachtet, das mit der Liste aller SHA-1-Zertifikat-Fingerabdrücke gefüllt ist, die bei der AndroidApp registriert sind. Diese Liste ist leer, wenn die App keine AndroidApp ist.
  • sha256_hash oder sha256Hashes : Dieses Feld wird als wiederholtes string betrachtet, das mit der Liste aller SHA-256-Zertifikat-Fingerabdrücke gefüllt ist, die bei der AndroidApp registriert sind. Diese Liste ist leer, wenn die App keine AndroidApp ist.
  • appStoreId : Dieses Feld wird als einzelnes string betrachtet, das mit der Apple App Store-ID gefüllt ist, die bei der IosApp registriert ist. Dieses Feld ist leer, wenn die App keine IosApp ist.
  • teamId : Dieses Feld wird als einzelnes string betrachtet, das mit der bei der IosApp registrierten Apple-Team-ID gefüllt ist. Dieses Feld ist leer, wenn die App keine IosApp ist.
showDeleted

boolean

Steuert, ob Apps im DELETED Status zurückgegeben werden sollen.

Wenn nicht angegeben, werden nur ACTIVE Apps zurückgegeben.

Anforderungstext

Der Anfragetext muss leer sein.

Antwortkörper

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Felder
apps[]

object ( FirebaseAppInfo )

Eine Seite mit Ergebnissen eines Aufrufs von projects.searchApps .

nextPageToken

string

Wenn die Ergebnisliste zu groß ist, um in eine einzelne Antwort zu passen, wird ein Token zurückgegeben.

Dieses Token kann in nachfolgenden Aufrufen von projects.searchApps verwendet werden, um die nächste Gruppe von Apps zu finden.

Seitentokens sind von kurzer Dauer und sollten nicht beibehalten werden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie in der Authentifizierungsübersicht .

FirebaseAppInfo

Eine allgemeine Zusammenfassung einer App.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Felder
name

string

Der Ressourcenname der Firebase-App im Format:

projects/ PROJECT_ID /iosApps/ APP_ID

oder

projects/ PROJECT_ID /androidApps/ APP_ID

oder

projects/ PROJECT_ID /webApps/ APP_ID

displayName

string

Der vom Benutzer zugewiesene Anzeigename der Firebase-App.

platform

enum ( AppPlatform )

Die Plattform der Firebase App.

appId

string

Nur Ausgabe. Unveränderlich. Der weltweit eindeutige, von Firebase zugewiesene Bezeichner für die WebApp .

Dieser Bezeichner sollte als undurchsichtiges Token behandelt werden, da das Datenformat nicht angegeben ist.

namespace

string

Nur Ausgabe. Unveränderlich. Die plattformspezifische Kennung der App.

Hinweis: Verwenden Sie für die meisten Anwendungsfälle appId , die kanonische, global eindeutige Kennung zum Referenzieren einer App.

Diese Zeichenfolge wird von einem nativen Bezeichner für jede Plattform abgeleitet: packageName für eine AndroidApp , bundleId für eine IosApp und webId für eine WebApp . Der Inhalt sollte als undurchsichtig behandelt werden, da sich das native Kennungsformat mit der Weiterentwicklung der Plattformen ändern kann. Diese Zeichenfolge ist nur innerhalb eines FirebaseProject und der zugehörigen Apps eindeutig.

apiKeyId

string

Die weltweit eindeutige, von Google zugewiesene Kennung (UID) für den Firebase-API-Schlüssel, der mit der App verknüpft ist.

Beachten Sie, dass es sich bei diesem Wert um die UID des API-Schlüssels und nicht um den keyString des API-Schlüssels handelt. Der keyString ist der Wert, der im Konfigurationsartefakt der App ( AndroidApp | IosApp | WebApp ) zu finden ist.

Wenn apiKeyId in Anfragen zum Erstellen der App ( AndroidApp | IosApp | WebApp ) nicht festgelegt ist, ordnet Firebase der App automatisch eine apiKeyId zu. Bei diesem automatisch zugeordneten Schlüssel kann es sich um einen vorhandenen gültigen Schlüssel handeln. Wenn kein gültiger Schlüssel vorhanden ist, wird ein neuer bereitgestellt.

state

enum ( State )

Nur Ausgabe. Der Lebenszyklusstatus der App.

AppPlattform

Plattformen, denen eine Firebase-App zugeordnet werden kann.

Aufzählungen
PLATFORM_UNSPECIFIED Unbekannter Zustand. Dies wird nur zur Unterscheidung nicht gesetzter Werte verwendet.
IOS Die Firebase-App ist mit iOS verknüpft.
ANDROID Die Firebase-App ist mit Android verknüpft.
WEB Die Firebase-App ist mit dem Web verknüpft.