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

Você pode usar esta 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

Solicitar corpo

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

Para especificar os parâmetros do link dinâmico como um link dinâmico 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, salvo especificação em contrário.

Parâmetros gerais

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

link

Parâmetros gerais
domínioUriPrefix	Obrigatório se você não definiu um valor para o parâmetro `longDynamicLink` . O domínio 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 será aberto. Especifique um URL que seu aplicativo possa manipular, normalmente o conteúdo ou a carga útil do aplicativo, que inicia uma lógica específica do aplicativo (como creditar um cupom ao usuário ou exibir uma tela de boas-vindas). Este link deve ser um URL bem formatado, codificado corretamente em URL, usar HTTP ou HTTPS e não pode ser outro link dinâmico. Quando os usuários abrem um link dinâmico em um navegador de desktop, eles carregam esse URL (a menos que o parâmetro `ofl` seja especificado). Se você não tiver um equivalente da Web para o conteúdo vinculado, a URL não precisará apontar para um recurso da Web válido. Nesta situação, você deve configurar um redirecionamento deste URL para, por exemplo, sua página inicial.
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 sequências de caminho que tenham apenas 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 seriam expostas se um URL curto de link dinâmico fosse adivinhado. Omita este parâmetro ou defina-o como `{ "option": "UNGUESSABLE" }` para encurtar o caminho para uma string não adivinhada. Essas strings são criadas pela codificação base62 de números de 96 bits gerados aleatoriamente e consistem em 17 caracteres alfanuméricos. Use strings indecifráveis para evitar que seus links dinâmicos sejam rastreados, o que pode expor informações confidenciais.

Obrigatório se você não definiu um valor para o parâmetro longDynamicLink .

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

Quando os usuários abrem um link dinâmico em um navegador de desktop, eles carregam esse URL (a menos que o parâmetro ofl seja especificado). Se você não tiver um equivalente da Web para o conteúdo vinculado, a URL não precisará apontar para um recurso da Web válido. Nesta situação, você deve configurar um redirecionamento deste URL para, por exemplo, sua página inicial.

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 sequências de caminho que tenham apenas 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 seriam expostas se um URL curto de link dinâmico fosse adivinhado.

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

Parâmetros 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 que o Dynamic Link abra um aplicativo Android.
androidFallbackLink	O link a ser aberto 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 web móvel 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. Caso o app instalado seja de uma versão mais antiga, o usuário é levado à Play Store para atualizar o app.

Parâmetros 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 a ser aberto 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 móvel 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
ativarForcedRedirect	Se definido como '1', pule a página de visualização do aplicativo quando o link dinâmico for aberto e, em vez disso, redirecione para o aplicativo ou loja. A página de visualização do aplicativo (ativada por padrão) pode enviar os usuários de maneira mais confiável ao 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 maneira confiável sem essa página, você pode desativá-lo com este parâmetro. Este parâmetro afetará o comportamento do Dynamic Link somente no iOS.

Parâmetros de navegação

ativarForcedRedirect

Se definido como '1', pule a página de visualização do aplicativo quando o link dinâmico for aberto e, em vez disso, redirecione para o aplicativo ou loja. A página de visualização do aplicativo (ativada por padrão) pode enviar os usuários de maneira mais confiável ao 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 maneira confiável sem essa página, você pode desativá-lo com este parâmetro. Este parâmetro afetará o comportamento do Dynamic Link somente 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.
descrição social	A descrição a ser usada quando o link dinâmico é compartilhado em uma postagem social.
socialImageLink	O URL de uma imagem relacionada a este link.

Parâmetros analíticos
utmFonte utm Médio utmCampaign utmTermo utmConteúdo	Parâmetros analíticos do Google Play.
no ct mt ponto	Parâmetros analíticos do iTunes Connect.

Corpo de resposta

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

{
  "shortLink": string,
  "previewLink": string
}

Campos de resposta
ligação curta	O link dinâmico curto gerado.
visualizaçãoLink	Um link para um fluxograma do comportamento do Dynamic Link.