Referência da API Firebase Dynamic Links Short Links

É possível usar essa API REST para gerar um Dynamic Links curto. Consulte o guia para desenvolvedores 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 será semelhante a um dos exemplos a seguir, dependendo se você quer para especificar os parâmetros Dynamic Link como uma Dynamic Link longa ou um objeto JSON.

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

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

Para especificar os parâmetros Dynamic Link como um objeto JSON, faça o seguinte:

{
  "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.

Parameters gerais

domínioUriPrefixo Obrigatório se você não tiver definido um valor para longDynamicLink . O domínio Dynamic Links do seu projeto do Firebase. Esse valor pode ser encontrado na seção Dynamic Links do console do Firebase.

link

Parameters gerais
domínioUriPrefixo	Obrigatório se você não tiver definido um valor para `longDynamicLink` . O domínio Dynamic Links do seu projeto do Firebase. Esse valor pode ser encontrado na seção Dynamic Links do console do Firebase.
link	Obrigatório se você não tiver definido um valor para `longDynamicLink` . O link que será aberto pelo app. É possível especificar um URL que pode ser processado pelo seu app, geralmente o conteúdo ou payload de um app, que pode iniciar uma lógica específica do app, como creditar o usuário com um cupom ou exibir uma tela de boas-vindas. Esse link precisa ser um URL formatado corretamente, ter a codificação de URL adequada e usar HTTP ou HTTPS. Além disso, ele não pode ser outro link dinâmico. Quando os usuários abrem uma Dynamic Link em um navegador da Web para computadores, eles carregam este URL (a menos que o parâmetro `ofl` seja especificado). Se você não tiver um equivalente da Web para o conteúdo vinculado, o URL não precisará direcionar para um recurso da Web válido. Nesse caso, é preciso configurar um redirecionamento deste URL para, por exemplo, sua página inicial.
sufixo	Especifica como criar o componente de caminho de um Dynamic Link curto. De 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 sejam longas somente o necessário para serem exclusivas, com um tamanho mínimo de 4 caracteres. Use este método se houver informações sensíveis não seria exposto se um URL Dynamic Link curto fosse adivinhado. Omita esse parâmetro ou o defina como `{ "option": "UNGUESSABLE" }` para encurtar o caminho para um que não pode ser adivinhada. Tais strings são criadas por codificação base62 aleatoriamente números de 96 bits gerados por 17 caracteres alfanuméricos. Usar strings não detectáveis para evitar que o Dynamic Links seja rastreado, o que podem expor informações sensíveis.

Obrigatório se você não tiver definido um valor para longDynamicLink .

O link que será aberto pelo app. É possível especificar um URL que pode ser processado pelo seu app, geralmente o conteúdo ou payload de um app, que pode iniciar uma lógica específica do app, como creditar o usuário com um cupom ou exibir uma tela de boas-vindas. Esse link precisa ser um URL formatado corretamente, ter a codificação de URL adequada e usar HTTP ou HTTPS. Além disso, ele não pode ser outro link dinâmico.

Quando os usuários abrem uma Dynamic Link em um navegador da Web para computadores, eles carregam este URL (a menos que o parâmetro ofl seja especificado). Se você não tiver um equivalente da Web para o conteúdo vinculado, o URL não precisará direcionar para um recurso da Web válido. Nesse caso, é preciso configurar um redirecionamento deste URL para, por exemplo, sua página inicial.

sufixo

Especifica como criar o componente de caminho de um Dynamic Link curto. De 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 sejam longas somente o necessário para serem exclusivas, com um tamanho mínimo de 4 caracteres. Use este método se houver informações sensíveis não seria exposto se um URL Dynamic Link curto fosse adivinhado.

Omita esse parâmetro ou o defina como { "option": "UNGUESSABLE" } para encurtar o caminho para um que não pode ser adivinhada. Tais strings são criadas por codificação base62 aleatoriamente números de 96 bits gerados por 17 caracteres alfanuméricos. Usar strings não detectáveis para evitar que o Dynamic Links seja rastreado, o que podem expor informações sensíveis.

Parâmetros do Android
Nome do pacote android	O nome do pacote do app do Android a ser usado para abrir o link. O app precisa estar conectado ao seu projeto na página de visão geral do console do Firebase. Obrigatório para o Dynamic Link abrir um app Android.
androidFallbackLink	O link a ser aberto quando o app não estiver instalado. Especifique isso para realizar outra ação que não seja instalar o app da Play Store quando ele não estiver instalado, como abrir a versão Web para dispositivos móveis com o conteúdo ou exibir uma página promocional para o app.
Código androidMinPackageVersion	O `versionCode` da versão mínima do app que pode abrir o link. Se o app instalado for uma versão mais antiga, o usuário será direcionado para a Play Store para atualizá-lo.

Parâmetros do iOS
ID do pacote	O código do pacote do app para iOS a ser usado para abrir o link. O app precisa estar conectado ao seu projeto na página de visão geral do console do Firebase. Obrigatório para Dynamic Link abrir um app iOS.
Link de fallback	O link a ser aberto quando o app não estiver instalado. Especifique isso para realizar outra ação que não seja instalar o app da App Store quando ele não estiver instalado. A ação pode ser abrir a versão Web para dispositivos móveis com o conteúdo ou exibir uma página promocional para o app.
iosCustomScheme	O esquema de URL personalizado do seu app, se definido de modo diferente do ID do pacote do seu app.
iosIpadFallbackLink	O link a ser aberto em iPads quando o app não estiver instalado. Especifique isso para realizar outra ação, que não seja instalar o app da App Store quando ele não estiver instalado. A ação pode ser abrir a versão Web com o conteúdo ou exibir uma página promocional para o app.
iosIpadBundleId	O ID do pacote do app para iOS que é usado em iPads para abrir o link. O app precisa estar conectado ao seu projeto na página de visão geral do console do Firebase.
ID da AppStore	O código do seu app na App Store, usado para direcionar os usuários à App Store quando o app não estiver instalado.

Parâmetros de navegação
enableForcedRedirect	Se definido como "1", ignore a página de visualização do app quando o Dynamic Link for aberto e redirecione para o app ou a loja. A página de visualização do app (ativada por padrão) pode enviar os usuários de maneira mais confiável ao destino mais apropriado quando eles abrem o Dynamic Links nos apps. No entanto, se você espera que uma Dynamic Link seja aberta apenas em apps que possam abrir Dynamic Links de forma confiável sem essa página, desative-a com este parâmetro. Esse parâmetro afetará o comportamento da Dynamic Link somente no iOS.

Parâmetros de navegação

enableForcedRedirect

Se definido como "1", ignore a página de visualização do app quando o Dynamic Link for aberto e redirecione para o app ou a loja. A página de visualização do app (ativada por padrão) pode enviar os usuários de maneira mais confiável ao destino mais apropriado quando eles abrem o Dynamic Links nos apps. No entanto, se você espera que uma Dynamic Link seja aberta apenas em apps que possam abrir Dynamic Links de forma confiável sem essa página, desative-a com este parâmetro. Esse parâmetro afetará o comportamento da Dynamic Link somente no iOS.

Parâmetros de meta tags de mídias sociais
título_social	O título a ser usado quando a Dynamic Link é compartilhada em uma postagem em rede social.
descrição social	A descrição a ser usada quando a Dynamic Link é compartilhada em uma postagem em rede social.
Link da imagem social	O URL para uma imagem relacionada a este link.

Parâmetros do Analytics
utmOrigem utmMedium utmCampaign utmTerm utmContent	Parâmetros de análise para o Google Play.
at ct mt pt	Parâmetros de análise para o iTunes Connect.

Corpo da resposta

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

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

Campos de resposta
link curto	O Dynamic Link curto gerado.
link de visualização	Um link para um fluxograma do comportamento do Dynamic Link.