Referência da API de links curtos do Firebase Dynamic Links

Você pode usar essa API REST para gerar links dinâmicos curtos. Consulte o guia do desenvolvedor para começar.

solicitação HTTP

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

request_body

Corpo da solicitação

O corpo da solicitação se parece com um dos seguintes, dependendo se você deseja especificar os parâmetros do Dynamic Link como um link dinâmico longo ou como um objeto JSON.

Para especificar os parâmetros do Dynamic Link como um Dynamic Link longo:

{
  "longDynamicLink": string,
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

Para especificar os parâmetros do Dynamic Link como um objeto JSON:

{
  "dynamicLinkInfo": {
    "domainUriPrefix": string,
    "link": string,
    "androidInfo": {
      "androidPackageName": string,
      "androidFallbackLink": string,
      "androidMinPackageVersionCode": string
    },
    "iosInfo": {
      "iosBundleId": string,
      "iosFallbackLink": string,
      "iosCustomScheme": string,
      "iosIpadFallbackLink": string,
      "iosIpadBundleId": string,
      "iosAppStoreId": string
    },
    "navigationInfo": {
      "enableForcedRedirect": boolean,
    },
    "analyticsInfo": {
      "googlePlayAnalytics": {
        "utmSource": string,
        "utmMedium": string,
        "utmCampaign": string,
        "utmTerm": string,
        "utmContent": string
      },
      "itunesConnectAnalytics": {
        "at": string,
        "ct": string,
        "mt": string,
        "pt": string
      }
    },
    "socialMetaTagInfo": {
      "socialTitle": string,
      "socialDescription": string,
      "socialImageLink": string
    }
  },
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

Parâmetros

Todos os parâmetros são opcionais, a menos que especificado de outra forma.

Parâmetros gerais
domínioUriPrefix Obrigatório se você não definiu um valor para o parâmetro longDynamicLink . O domínio do Dynamic Links do seu projeto do Firebase. Você pode encontrar esse valor na seção Dynamic Links do console do Firebase .
link Obrigatório se você não definiu um valor para o parâmetro longDynamicLink .

O link que seu aplicativo abrirá. Especifique uma URL que seu aplicativo pode manipular, normalmente o conteúdo ou carga útil do aplicativo, que inicia a lógica específica do aplicativo (como creditar o usuário com um cupom ou exibir uma tela de boas-vindas). Esse link deve ser um URL bem formatado, ser codificado em URL corretamente, usar HTTP ou HTTPS e não pode ser outro Link dinâmico.

sufixo

Especifica como criar o componente de caminho de um link dinâmico curto. Por padrão, o Firebase Dynamic Links gera sufixos de string de 17 caracteres.

Defina o parâmetro como { "option": "SHORT" } para gerar strings de caminho que tenham o comprimento necessário para serem exclusivas, com um comprimento mínimo de 4 caracteres. Use este método se informações confidenciais não forem expostas se um URL de link dinâmico curto for adivinhado.

Omita este parâmetro ou defina o parâmetro como { "option": "UNGUESSABLE" } para encurtar o caminho para uma string inimaginável. Essas cadeias são criadas por números de 96 bits gerados aleatoriamente com codificação base62 e consistem em 17 caracteres alfanuméricos. Use strings inimagináveis ​​para evitar que seus links dinâmicos sejam rastreados, o que pode expor informações confidenciais.

Parâmetros do Android
androidPackageName O nome do pacote do aplicativo Android a ser usado para abrir o link. O aplicativo deve estar conectado ao seu projeto na página Visão geral do console do Firebase. Necessário para o Dynamic Link abrir um aplicativo Android.
androidFallbackLink O link para abrir quando o aplicativo não estiver instalado. Especifique isso para fazer algo diferente de instalar seu aplicativo da Play Store quando o aplicativo não estiver instalado, como abrir a versão da Web para dispositivos móveis do conteúdo ou exibir uma página promocional para seu aplicativo.
androidMinPackageVersionCode O versionCode da versão mínima do seu aplicativo que pode abrir o link. Se o aplicativo instalado for uma versão mais antiga, o usuário será direcionado à Play Store para atualizar o aplicativo.
Parâmetros do iOS
iosBundleId O ID do pacote do aplicativo iOS a ser usado para abrir o link. O aplicativo deve estar conectado ao seu projeto na página Visão geral do console do Firebase. Necessário para o Dynamic Link abrir um aplicativo iOS.
iosFallbackLink O link para abrir quando o aplicativo não estiver instalado. Especifique isso para fazer algo diferente de instalar seu aplicativo da App Store quando o aplicativo não estiver instalado, como abrir a versão da Web para dispositivos móveis do conteúdo ou exibir uma página promocional para seu aplicativo.
iosCustomScheme O esquema de URL personalizado do seu aplicativo, se definido como algo diferente do ID do pacote do seu aplicativo
iosIpadFallbackLink O link para abrir em iPads quando o aplicativo não estiver instalado. Especifique isso para fazer algo diferente de instalar seu aplicativo da App Store quando o aplicativo não estiver instalado, como abrir a versão web do conteúdo ou exibir uma página promocional para seu aplicativo.
iosIpadBundleId O ID do pacote do aplicativo iOS a ser usado em iPads para abrir o link. O aplicativo deve estar conectado ao seu projeto na página Visão geral do console do Firebase.
iosAppStoreId O ID da App Store do seu aplicativo, usado para enviar usuários à App Store quando o aplicativo não está instalado
Parâmetros de navegação
enableForcedRedirect Se definido como '1', ignore a página de visualização do aplicativo quando o link dinâmico for aberto e redirecione para o aplicativo ou loja. A página de visualização do aplicativo (ativada por padrão) pode enviar usuários de forma mais confiável para o destino mais apropriado quando eles abrem links dinâmicos em aplicativos; no entanto, se você espera que um link dinâmico seja aberto apenas em aplicativos que podem abrir links dinâmicos de forma confiável sem esta página, você pode desativá-lo com este parâmetro. Este parâmetro afetará o comportamento do Dynamic Link apenas no iOS.
Parâmetros de metatag social
título social O título a ser usado quando o Link dinâmico é compartilhado em uma postagem social.
socialDescrição A descrição a ser usada quando o Link dinâmico é compartilhado em uma postagem social.
socialImageLink O URL para uma imagem relacionada a este link.
Parâmetros de análise
utmSource
utmMedium
utmCampanha
utmTermo
utmConteúdo		 Parâmetros de análise do Google Play.
no
ct
monte
pt		 Parâmetros de análise do iTunes Connect.

Corpo de resposta

A resposta a uma solicitação é um objeto JSON como o seguinte:

{
  "shortLink": string,
  "previewLink": string
}
Campos de resposta
ligação curta O link dinâmico curto gerado.
previewLink Um link para um fluxograma do comportamento do Dynamic Link.