En bref : transmettez en temps réel les événements d'attribution des données brutes à vos points de terminaison côté serveur.
API push
L'API Push transmet à vos serveurs les données brutes générés par l'attribution AppsFlyer ainsi que l'attribution SKAdNetwork (SKAN) 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'infrastructure d'attribution (i.e. AppsFlyer ou SKAdNetwork), ce qui est détaillé dans les sections suivantes.
Messages d'attribution AppsFlyer
Caractéristiques du message
Caractéristiques | Détails |
---|---|
Segmentation des types de messages |
Exemple : Un message contient les éléments suivants :
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) |
|
Format des champs horodateur |
|
Types de messages disponibles
Contexte d'attribution | Type de message | conversion_type field | champ campaign_type | champ event_name | event_type field |
---|---|---|---|---|---|
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 |
RÉENGAGEMENT |
Retargeting | Évènements in-app de réengagement | RÉENGAGEMENT | retargeting | Noms d'événement définis par l'annonceur |
re-engagement-in-app-event |
Retargeting | Réattribution | Réinstallation | retargeting | Réattribution |
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 |
re-attribution-in-app-event |
* 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 |
---|---|
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 SKAN
Cette section décrit les messages (types de rapports) proposés pour SKAN et explique comment identifier les messages. Une fois que vous aurez parcouru cette section, configurez le point de terminaison d'attribution SKAdNetwork.
Lecture connexe :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 |
Exemple : Un message contient les éléments suivants :
Comme « skad_redownload: true », vous déterminez qu'il s'agit d'un événement de re-téléchargement. |
Actualisation des données |
|
Exemples de messages | La feuille de calcul contient des exemples de messages. L'exemple présenté est au format JSON. Exemple de messages SKAN. |
Types de messages pour l'attribution SKAN
Type de message |
champ event_name |
champ skad_redownload |
event_type field |
---|---|---|---|
Installations | sans rapport |
|
skad-installs |
Re-téléchargements | sans rapport | true |
skad-re-downloads |
É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 |
skad-in-app-events |
Postbacks provenant d'iOS |
Jamais proposé dans ce message précis |
Parfois proposé |
skad-postbacks |
Copie des postbacks |
Jamais proposé dans ce message précis |
Parfois proposé |
skad-postbacks-copy |
Déterminer le type de message d'attribution SKAN
Remarque : ne s’applique pas aux messages de copie de postbacks acheminés directement depuis iOS.
Configurer les points de terminaison API Push
Attention
Vous ne devez pas utiliser l'API Push pour envoyer aux tiers des données attribuées par AppsFlyer, 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.
Exemple : Twitter, Snapchat, Pinterest.
Remarque : cette consigne ne s'applique pas aux données SKAN. Utilisez l'API Push pour envoyer des données SKAN à des points de terminaison tiers.
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 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 |
|
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
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 |
|
|
4 |
|
AvertissementSi vous cochez Sélectionner tout, les champs nouvellement ajoutés seront également sélectionnés automatiquement. Afin d'éviter tout problème, vérifiez que vous pouvez prendre en charge tous les nouveaux champs ajoutés automatiquement au schéma. Sélectionnez les champs requis.
|
|
5 |
Type d’événements in-app
|
Filtrez par événements in-app pour réduire le trafic envoyé à votre point de terminaison.
|
Configurez le point de terminaison d'attribution AppsFlyer
Remarque : seuls les propriétaires de compte AppsFlyer sont habilités à modifier les paramètres API. Les autres utilisateurs du compte peuvent quant à eux consulter les paramètres.
Pour ajouter un point de terminaison d'attribution AppsFlyer :- Rendez-vous dans Intégration > Accès API. Faites défiler jusqu'à la section API Push.
- Cliquez sur Ajouter un point de terminaison.
- Choisissez une méthode HTTP : POST ou GET
- Saisissez l'URL du point de terminaison.Si vous voyez le message cette URL n'est pas sécurisée, contactez l'assistance AppsFlyer.
- 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é.
- 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.
- 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.
- 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.
- Cliquez sur Enregistrer.
L'API Push est désormais active. Les données de conversion sont envoyées au point de terminaison. - Testez le point de terminaison à l'aide de la procédure suivante.
Pour tester le point de terminaison :
- 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 2 secondes, est suivi. Si AppsFlyer ne reçoit pas de message OK dans le délai imparti, AppsFlyer considère que le message est en échec d'envoi. - 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 : seuls les propriétaires de compte AppsFlyer sont habilités à modifier les paramètres API. Les autres utilisateurs du compte peuvent quant à eux consulter les paramètres.
Pour ajouter un point de terminaison API Push SKAdNetwork :- Rendez-vous dans Intégration > Accès API. Faites défiler jusqu'à la section API Push.
- Sélectionnez SKAdNetwork comme entité d'attribution.
- Cliquez sur Ajouter un point de terminaison.
Remarque : vous pouvez définir un seul point de terminaison SKAdNetwork par app. - Choisissez une méthode HTTP : POST ou GET
- Saisissez l'URL du point de terminaison. Si vous voyez le message cette URL n'est pas sécurisée, contactez l'assistance AppsFlyer.
- 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.
- 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 : seuls les propriétaires de compte AppsFlyer sont habilités à modifier les paramètres API. Les autres utilisateurs du compte peuvent quant à eux consulter les paramètres.
Pour modifier les paramètres de point de terminaison :
- Rendez-vous dans Intégration > Accès API.Faites défiler jusqu'à la section API Push.
- Localisez le point de terminaison à modifier.
- Faites les modifications.
- Cliquez sur Enregistrer.
Supprimer un point de terminaison
Remarque : seuls les propriétaires de compte AppsFlyer sont habilités à modifier les paramètres API. Les autres utilisateurs du compte peuvent quant à eux consulter les paramètres.
Pour supprimer un point de terminaison :
- Rendez-vous dans Intégration > Accès API.
Faites défiler jusqu'à la section Accès API Push. - Cliquez sur Supprimer le point de terminaison.
- Cliquez sur Enregistrer.
Le point de terminaison est supprimé.
Dépannage, caractéristiques et seuils
Échec 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
- 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.
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.
Caractéristiques et limitations
Caractéristique | 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. S'il vous manque des données, utilisez l'API Pull pour les obtenir. Dans le cadre de SKAN, vous pouvez accéder aux données historiques via Data Locker (limité par la fenêtre Data Locker Availability). |
Accès propriétaire / utilisateur du compte |
Seuls les propriétaires de compte AppsFlyer sont habilités à modifier les paramètres API.
Les autres utilisateurs du compte peuvent consulter les paramètres d'API Push, mais ils ne peuvent pas les modifier. |