Method: projects.searchApps

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

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

solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

O FirebaseProject pai para o qual listar Apps, no formato:

projects/ PROJECT_IDENTIFIER

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

Parâmetros de consulta

Parâmetros
pageToken

string

Token retornado de uma chamada anterior para projects.searchApps indicando onde no conjunto de aplicativos retomar a listagem.

pageSize

integer

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

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

Este valor não pode ser negativo.

filter

string

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

Use qualquer um dos seguintes campos em uma consulta:

Esta consulta também suporta os seguintes campos "virtuais". Esses são campos que não fazem parte do objeto de recurso retornado, mas podem ser consultados como se fossem pré-preenchidos com valores específicos.

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

boolean

Controla se os aplicativos no estado DELETED devem ser retornados.

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

Corpo da solicitação

O corpo da solicitação deve estar vazio.

corpo da resposta

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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 localizar o próximo grupo de aplicativos.

Os tokens de página têm vida curta e não devem ser mantidos.

Escopos de autorização

Requer um dos seguintes escopos 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 obter mais informações, consulte 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 aplicativo 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 Firebase.

platform

enum ( AppPlatform )

A plataforma do Firebase App.

appId

string

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

Esse identificador deve ser tratado como um token opaco, pois o formato dos dados não é especificado.

namespace

string

Somente saída. Imutável. O identificador específico da plataforma do aplicativo.

Observação: para a maioria dos casos de uso, use appId , que é o identificador canônico globalmente exclusivo para fazer referência a um aplicativo.

Essa string é derivada de um identificador nativo para cada plataforma: packageName para AndroidApp , bundleId para IosApp e webId para WebApp . Seu conteúdo deve ser tratado como opaco, pois o formato do identificador nativo pode mudar à medida que as plataformas evoluem. Essa string é exclusiva apenas dentro de um FirebaseProject e seus aplicativos associados.

apiKeyId

string

O identificador globalmente exclusivo atribuído pelo Google (UID) para a chave de API do Firebase associada ao aplicativo.

Esteja ciente de que esse valor é o UID da chave de API, não o keyString da chave de API. A keyString é o valor que pode ser encontrado no artefato de configuração do App ( AndroidApp | IosApp | WebApp ).

Se apiKeyId não for definido nas solicitações para criar o aplicativo ( AndroidApp | IosApp | WebApp ), o Firebase associará automaticamente um apiKeyId ao aplicativo. Essa chave autoassociada pode ser uma chave válida existente ou, se não existir nenhuma chave válida, uma nova será provisionada.

state

enum ( State )

Somente saída. O estado do ciclo de vida do aplicativo.

AppPlatform

Plataformas com as quais um aplicativo Firebase pode ser associado.

Enums
PLATFORM_UNSPECIFIED Estado desconhecido. Isso é usado apenas para distinguir valores não definidos.
IOS O aplicativo Firebase está associado ao iOS.
ANDROID O aplicativo Firebase está associado ao Android.
WEB O aplicativo Firebase está associado à web.