Características e limitações

Característica

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 são exibidas no painel da API do OneLink.

Visibilidade do link

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

TTL 

  • O TTL (time to live) padrão para os URLs curtos OneLink criados via API OneLink é de 31 dias. Ele é estendido por 31 dias cada vez que o link é clicado. Clicar em um 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.
  • Você pode alterar a TTL padrão adicionando o parâmetro ttl={value} e especificando quantos dias, horas ou minutos. Por exemplo ttl=7d, |ttl=12h, ou ttl=10m.
  • Você pode enviar um pedido de atualização para especificar o TTL. Qualquer solicitação de atualização redefine o TTL (para links existentes) para o 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.
  • Se você não quiser que os TTLs do link se estendam automaticamente, adicione o parâmetro renew_ttl=false aos seus links. O valor para este parâmetro é booleano: verdadeiro (padrão) ou falso.
  • O parâmetro renew_ttl não é exibido no URL real.

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.

Payload

A string de consulta do payload não pode exceder 2.048 caracteres.

ID do URL

O ID do URL (ou ID do link curto) pode ser editado para destacar a oferta da sua campanha. Por exemplo: https://meuapp.onelink.com/abc123/maçãs. O ID do URL não deve ultrapassar 50 caracteres e pode ser uma combinação de letras e números. Por padrão, são 8 caracteres.

Observação:

  • Você só pode editar o ID do URL se o ID atual ainda não estiver em uso.
  • Se o ID do URL já estiver em uso, a criação do link falhará e retornará uma resposta de erro (400). Você e seu desenvolvedor precisam decidir e configurar o que acontece nesse evento.
  • A chamada com falha ainda conta para sua cota mensal de API.