API OneLink

En bref : l'API OneLink vous aide à engager les utilisateurs finaux et à tirer parti des médias propres en générant des liens personnalisés dans les campagnes à grande échelle, par SMS, etc. Nécessite une implémentation côté annonceur et côté développeur.

API OneLink

L'API OneLink est utilisée pour :

  • Créer, obtenir, mettre à jour et supprimer automatiquement les URL courtes OneLink avec des paramètres personnalisés.
    Les paramètres peuvent être les suivants :
    • Les paramètres liés à l'attribution, utilisés pour mesurer et surveiller les efforts marketing, comme la source média, la campagne et l'actif. Note : le paramètre (pid) de la source média est obligatoire. 
    • Les paramètres de personnalisation, qui vous permettent de configurer une expérience utilisateur personnalisée lorsque l'app est ouverte à partir du lien correspondant. Ces paramètres vous permettent de diriger des utilisateurs vers du contenu in-app personnalisé, par exemple, une page produit spécifique, un code coupon ou une promotion.
  • Permettre le partage du contenu des sites web et des apps directement avec les utilisateurs mobile (ce qui augmente l'engagement et les installations mobile).
  • Générer instantanément un grand nombre de liens d'attribution personnalisés OneLink.
    Remarque : pour les liens de parrainage, consultez l'article sur l'attribution des invitations utilisateurs.

 Exemple

Feed Me, un service de livraison de produits alimentaires, souhaite envoyer un lien personnalisé par SMS à ses clients existants pour les encourager à télécharger l'app Feed Me et à acheter des bananes. En fonction du pays du client, Feed Me utilise l'API REST OneLink pour construire une URL OneLink personnalisée qui contient des détails spécifiques pour le pays, l'identité de l'utilisateur et une offre spéciale pour les bananes en vente.

Procédures

Pour configurer l'API OneLink :

  1. Créez un modèle OneLink.
  2. Enregistrez l'ID OneLink. 

  3. Enregistrez la clé API OneLink. L'administrateur du compte doit récupérer la clé API. Les membres de l'équipe n'ont pas accès à la clé API. 
    • Dans le tableau de bord AppsFlyer, accédez à Intégration > Accès API et faites défiler jusqu'à la section API OneLink.
    • Si la clé API OneLink n'est pas disponible pour l'administrateur, cela signifie que vous n'avez pas le package requis et que vous devez contacter votre CSM.  

      OL_API_key.png

  4. Donnez l'ID OneLink et la clé API OneLink au développeur.
  5. Demandez au développeur de suivre les instructions du dev hub.

Limites

Limitation

Remarques

Taux d'API

  • Le taux limite de création de liens d'attribution OneLink via l'API est de 7,5 millions par jour (fuseau horaire UTC), par compte.
  • Toutes les requêtes effectuées une fois le quota de 7,5 millions atteint ne sont pas servies, et les liens ne sont pas créés. L'appel API reçoit le code d'état d'erreur 429 avec le message « Limitation dépassée ».
  • Les informations concernant les demandes utilisées/restantes ne sont actuellement pas disponibles. 

Visibilité des liens personnalisés

  • Les liens créés via l'API n'apparaissent pas dans la liste des liens personnalisés OneLink dans le tableau de bord AppsFlyer.
  • Aucune API ne répertorie tous les liens personnalisés OneLink créés avec l'API.
  • Bonne pratique : enregistrez les liens créés avec l'API dans un tableau local, afin de pouvoir accéder aux liens à tout moment. 

Durée de vie 

  • Chaque lien d'attribution OneLink créé par l'API a une durée de vie par défaut de 31 jours. Après 31 jours, cet enregistrement de lien d'attribution est supprimé de nos systèmes. Le fait de cliquer sur un tel lien une fois que la durée de vie a expiré entraîne toujours le comportement défini dans la configuration de base de OneLink, mais l'attribution ne fonctionnera pas.
  • La durée de vie maximum est de 31 jours. Toute valeur de durée de vie supérieure à 31 est remplacée par la valeur de durée de vie par défaut de 31.
  • La valeur de durée de vie peut être spécifiée en jours (par défaut), minutes ou heures (par exemple, 10 m, 20 h, 14 j).
  • Vous pouvez envoyer une demande de mise à jour pour spécifier la durée de vie. Toute demande de mise à jour réinitialise la durée de vie (pour les liens existants) à celui spécifié dans le corps de la demande.
    • Cela signifie que la durée de vie est remplacée. Par exemple, si vous effectuez un appel de mise à jour avec une durée de vie de 2 jours pour un lien qui possède actuellement une durée de vie 29 jours, il passera à TTL=2j (pas 31 j).
    • Un appel de mise à jour peut potentiellement prolonger la durée de vie du lien d'attribution. Par exemple, si vous effectuez un appel de mise à jour avec une durée de vie de 31 jours pour un lien qui possède actuellement une durée de vie 20 jours, mais que 5 jours se sont écoulés, la durée de vie passera à 31 jours au moment de la mise à jour.

Caractères spéciaux

Les caractères suivants doivent être encodés s'ils sont utilisés pour des liens créés par l'API : ;, , !, @, #, ?, $, ^, :, &, ~, `, =, +, ', >, <, /
Si vous n'encodez pas ces caractères, ils seront remplacés par un espace vide.

 

Cet article vous a-t-il été utile ?