API OneLink

Visão geral: a API do OneLink ajuda você a engajar os usuários finais e utilizar suas mídias próprias, gerando links personalizados em campanhas em grande escala, via SMS e muito mais. Requer anunciante e desenvolvedor para implementar.

API OneLink

A API do OneLink é usada para:

  • Criar, obter, atualizar e excluir URLs curtas do OneLink com parâmetros personalizados automaticamente.
    Os parâmetros podem ser:
    • Parâmetros relacionados à atribuição, usados para mensurar e monitorar esforços de marketing, como fonte de mídia, campanha e recurso. Observação: o parâmetro fonte de mídia (pid) é obrigatório.
    • Parâmetros de personalização, que permitem configurar uma experiência de usuário personalizada ao abrir o aplicativo a partir de um link relevante. Esses parâmetros permitem que você envie usuários para conteúdo personalizado no aplicativo, por exemplo uma página de produto específica, código de cupom ou promoção.
  • Permitir o compartilhamento de conteúdo do site e do aplicativo diretamente para usuários mobile (aumentando assim o engajamento e as instalações mobile).
  • Gere instantaneamente um grande número de links de atribuição personalizados do OneLink.
    Observação: para links de referência, consulte o artigo de atribuição de convites de usuários

 Exemplo

Feed Me, um serviço de entrega de supermercado, quer enviar um link personalizado via SMS para clientes existentes, incentivando-os a baixar o aplicativo Feed Me e comprar bananas. Com base no país do cliente, o Feed Me usa a API REST do OneLink para criar uma URL personalizada do OneLink que contém detalhes específicos para o país, a identidade do usuário e uma oferta especial para bananas na promoção.

Procedimentos

Para configurar a API do OneLink:

  1. Crie um template do OneLink.
  2. Registre o ID do OneLink.

  3. Grave a chave da API do OneLink. O administrador da conta precisa obter a chave da API. Os membros da equipe não têm acesso à chave da API. 
    • No dashboard da AppsFlyer, vá para Integração > Acesso à APIe desça até a seção API do OneLink.
    • Se a chave da API do OneLink não estiver presente para o administrador, isso significa que você não possui o pacote necessário e precisa entrar em contato com seu CSM.
        

      OL_API_key.png

  4. Forneça o ID do OneLink e a chave de API do OneLink ao desenvolvedor.
  5. Diga ao desenvolvedor para seguir as instruções no hub de dev.

Limitações

Limitação

Observações

Taxa de API

  • O limite de taxa de criação de links de atribuição do OneLink via API é de 7,5 milhões por mês (fuso horário UTC), por conta.
  • Todas as solicitações feitas após exceder 7,5 milhões não são atendidas e os links não são criados; a chamada de API recebe o código de status de erro 429 com a mensagem "limite de envio excedido".
  • Informações sobre quanto do limite de taxa foi usado/resta não estão disponíveis no momento.

Visibilidade de links personalizados

  • Os links criados por meio da API não aparecem na lista de links personalizados do OneLink no dashboard da AppsFlyer.
  • Não há nenhuma API que lista todos os links personalizados do OneLink criados com a API.
  • Prática recomendada: salve links criados por API em uma tabela local, para que você possa acessar os links para qualquer finalidade futura. 

TTL 

  • Cada link de atribuição do OneLink criado pela API tem um TTL (Time to Live) padrão de 31 dias. Após 31 dias, este registro de link de atribuição é removido de nossos sistemas. Clicar em no link assim que o TTL expirar ainda é a configuração padrão para o comportamento definido na configuração de base do OneLink, mas a atribuição não funcionará.
  • O TTL máximo é de 31 dias. Qualquer valor TTL maior que 31 é substituído com o TTL padrão de 31.
  • O valor TTL pode ser especificado em dias (padrão), minutos ou horas (por exemplo, 10m, 20h, 14d).
  • Você pode enviar uma solicitação de atualização para especificar o TTL. Qualquer solicitação de atualização redefine o TTL (para links existentes) para o valor especificado no corpo da solicitação.
    • Isso significa que o TTL é substituído. Por exemplo, se você fizer uma chamada de atualização com TTL de 2d (2 dias) para um link que atualmente tem TTL de 29d, ele mudará para TTL=2d (não 31d).
    • Uma chamada de atualização pode potencialmente prolongar a vida útil do link de atribuição. Por exemplo, se você fizer uma chamada de atualização com TTL de 31d para um link que atualmente tem TTL de 20d mas 5 dias se passaram, o TTL será de 31d a partir do momento da atualização.

Caracteres especiais

Os seguintes caracteres devem ser codificados se forem usados para links criados pela API: ;, , !, @, #, ?, $, ^, :, &, ~, `, =, +, ', >, <, /.
Se você não codificar esses caracteres, eles serão substituídos por um espaço em branco.

 

Este artigo foi útil?