Flux de données brutes des API Push

En bref : transmettez en temps réel les événements d'attribution des données brutes à vos points de terminaison côté serveur.

6970_Push_API_image.png

Lecture connexe : comparatif des outils de livraison de données brutes

API Push V2.0

L'API Push transmet à vos serveurs les événements de données brutes générés par l'attribution AppsFlyer ainsi que l'attribution SKAdNetwork (entités attributaires) sous forme de messages. Vous pouvez choisir le type et le contenu des messages, et définir les points de terminaison.

Les types de messages proposés, l'actualisation des données et les champs disponibles dépendent de l'entité attributaire (i.e. AppsFlyer ou SKAdNetwork), ce qui est détaillé dans les sections suivantes.

SelectAttributingEntity.png

Messages d'attribution AppsFlyer

Caractéristiques du message
Caractéristiques Détails
Segmentation des types de messages
  • Vous pouvez soit segmenter les messages par point de terminaison (6 points de terminaison maximum par app), soit déterminer le type de message en fonction de la valeur des champs disponibles :
    • event_name
    • conversion_type
    • campaign_type 
  • Les valeurs des champs, selon le type de message, sont indiquées dans le tableau suivant.

Exemple :

Un message contient les éléments suivants :

  • conversoin_type=install
  • campaign_type=organic
  • event_name=install

Utilisez le tableau pour définir si cet événement est l'événement d'installation d'un utilisateur organique. 

Actualisation des données

Les messages sont envoyés peu après l'enregistrement de l'événement sur la plateforme AppsFlyer. C'est en général une question de minutes.

Éléments du message (champs)
  • Les messages possèdent la structure key:value.
  • Consultez les champs d'API Push proposés pour l'attribution AppsFlyer.
  • Chaque clé représente un champ de données brutes. Voir la description des champs de données brutes dans AppsFlyer.
  • Les clés vides ou nulles ne sont jamais envoyées.
  • Les exemples qui suivent contiennent des champs « null » ou vides Les vrais postbacks n'ont pas de champs vides ou nuls.
Format des champs horodateur
  • Horodateurs en UTC : aaaa-mm-jj hh:mm:ss.sss.Exemple d'affichage : 2019-09-17 00:09:00.123. Un événement s'est produit à 18h00, heure de Tokyo. L'heure de l'événement est convertie en UTC, soit 05h00. L'heure qui est enregistrée est l'heure UTC.
  • Horodateur dans le fuseau horaire sélectionné (spécifique à l'app) : yyyy-mm-dd hh:mm:ss.sss±th:tm. Exemple : 2019-09-17 18:00:16.000+0900. Un événement s'est produit à 18h00, heure de Tokyo. L'heure de l'événement est enregistrée ainsi : 18:00+09:00. 09:00 étant le fuseau horaire de Tokyo. 
Types de messages disponibles

 

Attribution

contexte

Type de message

conversion_type field

champ campaign_type

champ event_name

Acquisition des utilisateurs Installation* sans rapport

Non organique : UA

Organique : organic

sans rapport

Acquisition d'utilisateurs  Événements in-app d'installation sans rapport

Non organique : UA

Organique : organic

Noms d'événement définis par l'annonceur

Retargeting

RÉENGAGEMENT RÉENGAGEMENT retargeting RÉENGAGEMENT
Retargeting  Évènements in-app de réengagement RÉENGAGEMENT retargeting Noms d'événement définis par l'annonceur
Retargeting  Réattribution  Réinstallation retargeting Réattribution
Acquisition d'utilisateurs  Réinstallation Réinstallation

Non organique : UA

Organique : organic

Réinstallation

Retargeting Évènements in-app de réattribution Réinstallation retargeting Noms d'événement définis par l'annonceur
* Certaines installations relatives à l'attribution post vue sont attribuées à la source média restreinte.
Champs uniques
Nom d'affichage Nom de l'API Push V2.0
Devise sélectionnée* selected_currency
Revenus dans la devise sélectionnée revenue_in_selected_
devise
Coût dans la devise sélectionnée cost_in_selected_
devise
Fuseau horaire sélectionné pour l'heure de téléchargement sur l'appareil device_download_time_selected_timezone
Fuseau horaire sélectionné pour l'heure d'attribution du touch attributed_touch_time_selected_timezone
Fuseau horaire sélectionné pour l'heure d'installation install_time_selected_
fuseau horaire
Fuseau horaire sélectionné pour l'heure d'évènement event_time_selected_
fuseau horaire

Fuseau horaire sélectionné(*)

selected_timezone
* Il s'agit du paramètre au niveau de l'app qui est en vigueur au moment de l'envoi du message API.

Messages d'attribution SKAdNetwork

Cette section décrit les messages (types de rapports) proposés pour SKAdNetwork, et explique comment identifier les messages. Une fois que vous aurez parcouru cette section, configurez le point de terminaison d'attribution SKAdNetwork.

Lecture connexe : les champs de données brutes SKAdNetwork. Les messages API Push ont la même structure et les mêmes champs.

Caractéristiques du message
Caractéristiques Détails
Segmentation des types de messages
  • Tous les messages sont envoyés au point de terminaison que vous avez défini.
  • Pour déterminer le type de message, utilisez les champs suivants :
    • event_name
    • skad_redownload
  • La valeur des champs, selon chaque type de message, est indiquée dans le tableau suivant

Exemple :

Un message contient les éléments suivants :

  • event_name: af_skad_install
  • skad_redownload: true

Comme « skad_redownload: true », vous déterminez qu'il s'agit d'un événement de re-téléchargement.

Actualisation des données
  • Installations, re-téléchargements et événements in-app :
    • Traitement quotidien
    • Envoyé à votre point de terminaison le jour qui suit la réception du postback iOS par AppsFlyer
    • Les messages d'événement arrivent entre 05:00 et 08:00 UTC (l'heure exacte est fluctuante)
    • Exemple : des postbacks reçus le lundi seront envoyés à compter du mardi à 05:00 UTC
  • Postbacks provenant d'iOS : les messages sont envoyés peu de temps après leur arrivée chez AppsFlyer
Exemples de messages La feuille de calcul contient des exemples de messages. Ils sont au format JSON. Exemples de messages SKAdNetwork.

 

Types de messages pour l'attribution SKAdNetwork
Type de message 

champ event_name

champ skad_redownload

Installations  af_skad_install
  • Valeurs possibles : false, blank, null.
  • Si le champ ne figure pas dans le message, considérez sa valeur comme « false ».
Re-téléchargements  af_skad_install true
Évènements in-app 

Le nom de l'événement défini par l'annonceur

Le nom de l'événement défini par l'annonceur
Postbacks provenant d'iOS

Jamais proposé dans ce message précis

Parfois proposé


Déterminer le type de message d'attribution SKAdNetwork

Push_API__2_.png

Configurer les points de terminaison API Push

 Attention

Vous ne devez pas utiliser l'API Push pour envoyer des données à des tiers, et ce pour les raisons suivantes :

  • Vous risquez de violer les règles de protection de la vie privée (comme la CCPA) si l'utilisateur a refusé que ses données soient transmises à un tiers.
  • Certaines sources média appliquent des restrictions quant à la façon dont les données de niveau utilisateur qu'elles fournissent sont utilisées ou partagées avec des tiers. Veillez à bien respecter les conditions d'utilisation de la source média.
    Par exemple, Facebook, Twitter, Snapchat, Pinterest.

Pour configurer l'API Push, suivez les étapes suivantes.

Marche à suivre pour configurer l'API Push
Étape n° Attribution AppsFlyer Attribution SKAdNetwork 
1

Si vous avez déjà un point de terminaison API Push actif, vous pouvez ignorer cette étape.

Suivez la procédure requise du côté du serveur.

2

Pour l'attribution AppsFlyer, paramètrez les points de terminaison en suivant la marche à suivre pour configurer l'API Push.

Ne s'applique pas

3

Configurez le point de terminaison d'attribution AppsFlyer

Configurez le point de terminaison d'attribution SKAdNetwork

Exigences côté serveur (votre serveur)

Votre serveur doit suivre conformément les exigences suivantes :

Exigences côté serveur
URL du point de terminaison
  • Nom de domaine valide
  • Nombre maximum de points de terminaison :
    • Attribution AppsFlyer : 6 points de terminaison. Chaque point de terminaison doit être lié à une seule application.
    • Attribution SKAdNetwork : 1 point de terminaison. Le point de terminaison peut être identique à un point de terminaison d'attribution AppsFlyer, ou il peut être différent. 
Code retour du point de terminaison À la réception d'un message, le point de terminaison doit renvoyer un code d'état HTTP 200.
Liste des serveurs autorisés AppsFlyer

Allowlist AppsFlyer server Adresses IP des serveurs autorisés AppsFlyer dans vos pare-feux et systèmes de sécurité pour assurer la communication avec le point de terminaison.

Versions TLS
Ports 

Ports : 80, 443

Marche à suivre pour préparer l'API Push à l'attribution AppsFlyer

  • Suivez ces étapes pour organiser vos paramètres d'attribution AppsFlyer. Les numéros qui figurent dans l'illustration correspondent aux numéros de ligne de la marche à suivre.
  • Cette section ne concerne pas l'attribution SKAdNetwork. Veuillez consulter Configurer l'attribution SKAdNetwork.

Point de terminaison 

PushAPI_us-en.png

Table de planification des points de terminaison

Non.

Réglage

Détails Utilisez cette colonne pour noter les paramètres réglés
1

Méthode

POST ou GET

 

2

URL du point de terminaison

-  
3 Types de messages d'événement
  • Sélectionnez au moins un type de message d'événement.
  • Pour sélectionner des messages d'événement in-app, vous devez enregistrer un événement in-app. Tant que vous ne le faites pas, vous ne pouvez pas sélectionner de messages d'événement in-app.

InappSelectionDisabled_us-en.png

 

4

  • Champs 
  • La liste des champs est commune à tous les types de messages

Sélectionnez les champs requis.

  • Les champs les plus courants sont présélectionnés par défaut.
  • Nous n'envoyons pas de champ vide/nul
 
5

Type d’événements in-app

 

Filtrez par événements in-app pour réduire le trafic envoyé à votre point de terminaison.

  • Sélectionnez un, plusieurs ou tous les événements in-app. Attention ! Si l'événement ne s'affiche pas dans la liste, vous devez le rechercher. 
  • Si vous sélectionnez tout, les nouveaux événements in-app sont ajoutés automatiquement.
  • Vous ne pouvez sélectionner un évènement in-app qu'après qu'il ait été enregistré une fois minimum. 
  • mceclip1.png
 
Facebook Avez-vous l'intention d'envoyer des données d'utilisateurs attribuées à Facebook ? 
  • Pour recevoir des données Facebook, assurez-vous d'avoir accepté les conditions d'utilisation de Facebook.

 

Configurez le point de terminaison d'attribution AppsFlyer

  • Seul l'administrateur peut modifier les paramètres API. Les membres d'équipe peuvent consulter les paramètres API.
AppsFlyerAdmin_us-en.png Pour ajouter un point de terminaison d'attribution AppsFlyer :
  1. Rendez-vous dans Intégration > Accès API. Faites défiler jusqu'à la section API Push.
  2. Cliquez sur Ajouter un point de terminaison.
  3. Choisissez une méthode HTTP : POST ou GET
  4. Saisissez l'URL du point de terminaison.Si vous voyez le message cette URL n'est pas sécurisée, contactez l'assistance AppsFlyer.
  5. Sélectionnez un ou plusieurs types d'événements. Remarque : si les messages d'événements in-app sont désactivés, cela signifie qu'aucun événement in-app n'a encore été enregistré.
  6. Sélectionnez les champs à remplir avec le message de l'API Push. Remarque :
    • Les champs obligatoires sont toujours envoyés. Ce sont les suivants : l'ID d'app, le nom de l'événement, l'heure de l'événement, l'IDFA (iOS) ou l'ID Advertising (Android)
    • Utilisez les commandes illustrées dans l'illustration suivante pour sélectionner des champs facultatifs. 

      PushAPIFieldSelect1.jpg

      • Les champs les plus courants sont présélectionnés par défaut. Vous pouvez effacer les sélections.
      • Sélectionnez les champs facultatifs selon vos besoins.
      • Utilisez Tout effacer pour effacer tous les champs facultatifs.
      • Nous n'envoyons pas les champs nuls/vides et la clé associée. Merci de le prendre en compte lorsque vous prévoyez vos procédures d'importation et de préparation. 
  7. Sélectionnez un ou plusieurs événements in-app (52 max) ou Tous les événements in-app.
    • La liste est remplie par les types d'événements qui ont déjà été enregistrés. Si un événement manque, envoyez un événement de ce type à l'aide d'un périphérique de test. 
  8. Cliquez sur Enregistrer.
    L'API Push est désormais active. Les données de conversion sont envoyées au point de terminaison.
  9. Testez le point de terminaison à l'aide de la procédure suivante.
  10. Si vous souhaitez recevoir des évènements attribuées à Facebook, vous devez d'abord accepter les conditions d'utilisation de Facebook.  (Requis pour l'attribution AppsFlyer mais pas pour l'attribution SKAdNetwork).

Pour tester le point de terminaison :

  1. Cliquez sur Envoyer le test.  Un message contenant le résultat du test s'affiche sous le bouton Envoyer le test
    Un message de test est envoyé au point de terminaison. Si le test échoue, vérifiez que les adresses IP AppsFlyer sont bien autorisées.Important ! Un compte-à-rebours, d'une durée de 3 secondes, est utilisé. Si AppsFlyer ne reçoit pas le message OK dans le délai imparti, AppsFlyer considère que le message est en échec d'envoi.
  2. Vérifiez que votre point de terminaison a bien reçu le message de test.
    Affichez une copie du message envoyé.

Configurez le point de terminaison d'attribution SKAdNetwork

Remarque : seul l'admin est habilité à modifier les paramètres API. Les membres d'équipe peuvent consulter les paramètres API.

AppsFlyerAdmin_us-en.png Pour ajouter un point de terminaison Push API SKAdNetwork :
  1. Rendez-vous dans Intégration > Accès API. Faites défiler jusqu'à la section API Push.
  2. Sélectionnez SKAdNetwork comme entité d'attribution.
  3. Cliquez sur Ajouter un point de terminaison.
    Remarque
    : vous pouvez définir un seul point de terminaison SKAdNetwork par application.
  4. Choisissez une méthode HTTP : POST ou GET
  5. Saisissez l'URL du point de terminaison.  Si vous voyez le message cette URL n'est pas sécurisée, contactez l'assistance AppsFlyer.
  6. Nous n'envoyons pas les champs nuls/vides et la clé associée. Merci de le prendre en compte lorsque vous prévoyez vos procédures d'importation et de préparation. 
  7. Cliquez sur Enregistrer.
    L'API Push est désormais active. Les données sont envoyées au point de terminaison.

Procédures supplémentaires - gestion des points de terminaison

Modifier un point de terminaison

Remarque : seul l'admin est habilité à modifier les paramètres API. Les membres d'équipe peuvent consulter les paramètres API.

AppsFlyerAdmin_us-en.png Pour modifier les paramètres de point de terminaison :

  1. Rendez-vous dans Intégration > Accès API.Faites défiler jusqu'à la section API Push.
  2. Localisez le point de terminaison à modifier.
  3. Faites les modifications.
  4. Cliquez sur Enregistrer.

Supprimer un point de terminaison

Remarque : seul l'admin est habilité à modifier les paramètres API. Les membres d'équipe peuvent consulter les paramètres API.

AppsFlyerAdmin_us-en.pngPour supprimer un point de terminaison :

  1. Rendez-vous dans Intégration > Accès API.
    Faites défiler jusqu'à la section Accès API Push. 
  2. Cliquez sur Supprimer le point de terminaison.
  3. Cliquez sur Enregistrer.
    Le point de terminaison est supprimé. 

Dépannage, caractéristiques et seuils

Échec de l'envoi du message de test

Si vous ne recevez pas le message de test et que vous limitez l'accès à vos serveurs selon les adresses IP : vérifiez que toutes les adresses IP AppsFlyer sont bien autorisées.

Duplication des événements in-app de retargeting

Les événements de retargeting in-app sont dupliqués lorsqu'un événement d'achat a lieu dans le cadre d'une campagne de retargeting et sur la durée de la fenêtre de réengagement UA. Cette opération permet d'attribuer des revenus aussi bien à la source média UA qu'à la source média de retargeting.

Vous ne recevrez des événements dupliqués que si vous avez activé ces deux options :

  • Événements in-app d'installation
  • événements in-app de retargeting

Identifier et dédupliquer les événements in-app

 

La sélection des messages d'événement in-app est désactivée

InappSelectionDisabled_us-en.png

  • Les messages d'événement in-app peuvent être sélectionnés uniquement lorsqu'ils ont été enregistrés.
  • Utilisez un appareil de test pour générer un événement in-app, ou utilisez l'API S2S pour le faire manuellement. 

Données Facebook manquantes

Par défaut, Facebook ne publie pas les données brutes de niveau utilisateur, sauf si vous acceptez les Conditions d'utilisation de Facebook.

Une fois que vous avez accepté les conditions, les données utilisateur issues de Facebook sont envoyées via l'API Push.

Messages push et CloudFront manquants

Vous utilisez Amazon CloudFront comme point de terminaison ? Vérifiez si CloudFront rejette le message avec le code de rejet 421. Si tel est le cas, reportez-vous à la rubrique Choisir comment CloudFront sert les requêtes HTTPS.

Messages d'erreur des points de terminaison

Problème : le message cette URL n'est pas sécurisée s'affiche lorsque vous définissez l'URL du point de terminaison.

Action requise : contactez l'assistance AppsFlyer ; renseignez l'ID de l'app, l'URL du point de terminaison et ajoutez une capture d'écran du message d'erreur.  

Particularités et limites

Particularités
Particularité Remarques 
Réseaux publicitaires Non disponible
Agences Non disponible
Fuseau horaire spécifique à l'app Prise en charge
Devise spécifique à l'app  Prise en charge
Limitations de taille Ne s'applique pas
Organique  Oui
Non organique Oui
Actualisation des données En continu 
Données historiques Pas de prise en charge. Pour obtenir des données historiques, utilisez l'API Pull.
Accès des membres de l'équipe Les membres d'équipe peuvent afficher les paramètres de l'API Push, mais ils ne peuvent pas les modifier.
Cet article vous a-t-il été utile ?