Method: projects.searchApps

Wyświetla listę wszystkich aplikacji dostępnych w przypadku określonego zasobu (FirebaseProject).

Jest to metoda zapewniająca wygodę. Zwykle interakcja z aplikacją powinna odbywać się przy użyciu usługi zależnej od platformy, ale w niektórych przypadkach użycia narzędzia wymagają podsumowania wszystkich znanych aplikacji (np. w przypadku interfejsów selektora aplikacji).

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Nadrzędny element FirebaseProject, dla którego ma zostać wyświetlona lista aplikacji, w formacie:

projects/PROJECT_IDENTIFIER

Szczegółowe informacje o wartościach PROJECT_IDENTIFIER znajdziesz w polu FirebaseProject name.

Parametry zapytania

Parametry
pageToken

string

Token zwrócony z poprzedniego wywołania projects.searchApps wskazujący miejsce w zestawie aplikacji do wznowienia.

pageSize

integer

Maksymalna liczba aplikacji, które mają zostać zwrócone w odpowiedzi.

Serwer może zwrócić mniej niż ta wartość według własnego uznania. Jeśli nie podasz żadnej wartości (lub podasz za dużą wartość), serwer nałoży własny limit.

Ta wartość nie może być ujemna.

filter

string

Ciąg zapytania zgodny ze standardem AIP-160 Google.

W zapytaniu użyj dowolnego z tych pól:

To zapytanie obsługuje też te zapytania „virtual” . Te pola w rzeczywistości nie są częścią zwróconego obiektu zasobu, ale można wykonywać dotyczące ich zapytania tak, jakby zostały wstępnie wypełnione określonymi wartościami.

  • sha1_hash lub sha1Hashes: to pole jest uznawane za powtarzane pole string i zawiera listę wszystkich odcisków cyfrowych certyfikatów SHA-1 zarejestrowanych w AndroidApp. Jeśli aplikacja nie ma typu AndroidApp, ta lista jest pusta.
  • sha256_hash lub sha256Hashes: to pole jest uznawane za powtarzane pole string i zawiera listę wszystkich odcisków cyfrowych certyfikatów SHA-256 zarejestrowanych w AndroidApp. Jeśli aplikacja nie ma typu AndroidApp, ta lista jest pusta.
  • appStoreId: to pole jest uznawane za pojedyncze pole string zawierające identyfikator Apple App Store zarejestrowany w IosApp. Jeśli aplikacja nie ma typu IosApp, to pole jest puste.
  • teamId: to pole jest uznawane za pojedyncze pole string wypełnione identyfikatorem zespołu Apple zarejestrowanym w IosApp. Jeśli aplikacja nie ma typu IosApp, to pole jest puste.
showDeleted

boolean

Określa, czy mają zostać zwrócone aplikacje w stanie DELETED.

Jeśli nie podasz żadnej wartości, zostanie zwróconych tylko tyle aplikacji: ACTIVE.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Pola
apps[]

object (FirebaseAppInfo)

Jedna strona wyników połączenia z numerem projects.searchApps.

nextPageToken

string

Jeśli lista wyników jest zbyt duża, aby zmieścić się w pojedynczej odpowiedzi, zwracany jest token.

Tego tokena można użyć w kolejnych wywołaniach projects.searchApps w celu znalezienia kolejnej grupy aplikacji.

Tokeny stron mają krótki czas życia i nie powinny być zachowywane.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).

Informacje o aplikacji Firebase

Ogólne podsumowanie aplikacji.

Zapis JSON
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Pola
name

string

Nazwa zasobu aplikacji Firebase w formacie:

projects/PROJECT_ID/iosApps/APP_ID

lub

projects/PROJECT_ID/androidApps/APP_ID

lub

projects/PROJECT_ID/webApps/APP_ID

displayName

string

Wyświetlana nazwa aplikacji Firebase przypisana przez użytkownika.

platform

enum (AppPlatform)

Platforma aplikacji Firebase.

appId

string

Tylko dane wyjściowe. Stały. Unikalny globalnie identyfikator przypisany przez Firebase dla platformy WebApp.

Ten identyfikator powinien być traktowany jako nieprzejrzysty token, ponieważ nie określono formatu danych.

namespace

string

Tylko dane wyjściowe. Stały. Identyfikator aplikacji właściwy dla platformy.

Uwaga: w większości przypadków używaj appId, czyli kanonicznego, globalnego unikalnego identyfikatora odwołującego się do aplikacji.

Ten ciąg jest generowany na podstawie natywnego identyfikatora każdej platformy: packageName dla platformy AndroidApp, bundleId dla platformy IosApp i webId dla platformy WebApp. Zawartość tego pola powinna być traktowana jako nieprzejrzysta, ponieważ format identyfikatora natywnego może się zmieniać wraz z rozwojem platformy. Ten ciąg jest unikalny tylko w ramach elementu FirebaseProject i powiązanych z nim aplikacji.

apiKeyId

string

Unikalny globalnie identyfikator przypisany przez Google (UID) klucza interfejsu API Firebase powiązanego z aplikacją.

Pamiętaj, że ta wartość to identyfikator UID klucza interfejsu API, a nie keyString klucza interfejsu API. keyString to wartość, którą można znaleźć w artefakcie konfiguracji aplikacji (AndroidApp | IosApp | WebApp).

Jeśli w żądaniach utworzenia aplikacji (AndroidApp | IosApp | WebApp) nie jest ustawiony apiKeyId, Firebase automatycznie wiąże apiKeyId z aplikacją. Ten automatycznie powiązany klucz może być istniejącym prawidłowym kluczem. Jeśli prawidłowy klucz nie istnieje, zostanie udostępniony nowy.

state

enum (State)

Tylko dane wyjściowe. Stan cyklu życia aplikacji.

Platforma aplikacji

Platformy, z którymi można powiązać aplikację Firebase.

Wartości w polu enum
PLATFORM_UNSPECIFIED Stan nieznany. Służy ona tylko do rozróżniania wartości nieskonfigurowanych.
IOS Aplikacja Firebase jest powiązana z iOS.
ANDROID Aplikacja Firebase jest powiązana z Androidem.
WEB Aplikacja Firebase jest powiązana z internetem.