Method: projects.searchApps

Lista todos os apps disponíveis para o FirebaseProject especificado.

Esse é um método de conveniência. Normalmente, a interação com um aplicativo precisa ser feita usando o serviço específico da plataforma, mas alguns casos de uso das ferramentas exigem um resumo de todos os aplicativos conhecidos, como as interfaces do seletor de aplicativos.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

O FirebaseProject pai para listar apps, no formato:

projects/PROJECT_IDENTIFIER

Consulte o campo FirebaseProject name para saber detalhes sobre os valores PROJECT_IDENTIFIER.

Parâmetros de consulta

Parâmetros
pageToken

string

Token retornado de uma chamada anterior para projects.searchApps que indica de onde no conjunto de apps a listagem será retomada.
pageSize

integer

O número máximo de aplicativos a serem retornados na resposta.

O servidor pode retornar menos que isso a seu critério. Se nenhum valor for especificado (ou um valor muito grande for especificado), o servidor impõe um limite próprio.

Esse valor não pode ser negativo.
filter

string

Uma string de consulta compatível com o padrão AIP-160 do Google.

Use um dos seguintes campos em uma consulta:

Essa consulta também aceita os seguintes tipos de campos. Esses campos não fazem parte do objeto de recurso retornado, mas podem ser consultados como se estivessem pré-preenchidos com valores específicos.

  • sha1_hash ou sha1Hashes: este campo é considerado um campo string repetido, preenchido com a lista de todas as impressões digitais do certificado SHA-1 registradas com o AndroidApp. Esta lista vai ficar vazia se o app não for um AndroidApp.
  • sha256_hash ou sha256Hashes: este campo é considerado um campo string repetido, preenchido com a lista de todas as impressões digitais de certificado SHA-256 registradas com o AndroidApp. Esta lista vai ficar vazia se o app não for um AndroidApp.
  • appStoreId: este campo é considerado string singular, preenchido com o ID da App Store da Apple registrado no IosApp. Este campo ficará vazio se o app não for um IosApp.
  • teamId: este campo é considerado string singular, preenchido com o ID da equipe da Apple registrado no IosApp. Este campo ficará vazio se o app não for um IosApp.
showDeleted

boolean

Controla se os apps no estado DELETED precisam ser retornados.

Se não for especificado, apenas apps ACTIVE serão retornados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Campos
apps[]

object (FirebaseAppInfo)

Uma página de resultados de uma chamada para projects.searchApps.
nextPageToken

string

Se a lista de resultados for muito grande para caber em uma única resposta, um token será retornado.

Esse token pode ser usado em chamadas subsequentes para projects.searchApps para encontrar o próximo grupo de apps.

Os tokens de página são de curta duração e não devem ser persistidos.

Escopos de autorização

Requer um dos seguintes escopos do 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

Para saber mais, consulte a Visão geral da autenticação.

FirebaseAppInfo

Um resumo de alto nível de um aplicativo.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string,
  "namespace": string,
  "apiKeyId": string,
  "state": enum (State)
}
Campos
name

string

O nome do recurso do app do Firebase, no formato:

projects/PROJECT_ID/iosApps/APP_ID

ou

projects/PROJECT_ID/androidApps/APP_ID

ou

projects/PROJECT_ID/webApps/APP_ID
displayName

string

O nome de exibição atribuído pelo usuário do aplicativo do Firebase.
platform

enum (AppPlatform)

A plataforma do app do Firebase.
appId

string

Apenas saída. Imutável. O identificador globalmente exclusivo atribuído pelo Firebase para o WebApp.

Esse identificador precisa ser tratado como um token opaco, porque o formato de dados não é especificado.
namespace

string

Apenas saída. Imutável. O identificador específico da plataforma do app.

Observação:na maioria dos casos de uso, utilize appId, que é o identificador canônico e globalmente exclusivo para se referir a um app.

Essa string é derivada de um identificador nativo para cada plataforma: packageName para um AndroidApp, bundleId para um IosApp e webId para um WebApp. O conteúdo precisa ser tratado como opaco, já que o formato do identificador nativo pode mudar conforme as plataformas evoluem. Essa string só é exclusiva em um FirebaseProject e nos apps associados a ele.
apiKeyId

string

O identificador globalmente exclusivo atribuído pelo Google (UID, na sigla em inglês) para a chave de API do Firebase associada ao aplicativo.

Esse valor é o UID da chave de API, não o keyString dela. O keyString é o valor que pode ser encontrado no artefato de configuração do app (AndroidApp | IosApp | WebApp).

Se apiKeyId não estiver definido nas solicitações para criar o app (AndroidApp | IosApp | WebApp), o Firebase vai associar automaticamente um apiKeyId ao app. Essa chave associada automaticamente pode ser uma chave válida atual ou, se não existir uma chave válida, uma nova será provisionada.
state

enum (State)

Apenas saída. O estado do ciclo de vida do app.

AppPlatform

Plataformas com que um aplicativo do Firebase pode ser associado.

Enums
PLATFORM_UNSPECIFIED Estado desconhecido. Usado apenas para distinguir valores não definidos.
IOS O app do Firebase está associado ao iOS.
ANDROID O app do Firebase está associado ao Android.
WEB O app do Firebase está associado à Web.