API principale : mesurer l’acquisition d’utilisateurs via API

Premium

Recommandé pour

Marketeurs Développeurs

Dernière mise à jour : 12 septembre 2024 09:05

En bref : Pour obtenir une certaine partie de la LTV, l’activité, la rétention, la cohorte et des KPI de performance des campagnes Protect360 via API, au format CSV ou JSON. Sélectionner un ou plusieurs événements in-app.

API principale : mesurer l’acquisition d’utilisateurs via API

API principale :

Vous permet d’obtenir une certaine partie de la LTV, l’activité, la rétention, la cohorte et des KPI de performance des campagnes Protect360. Les KPI disponibles sont les mêmes KPI que ceux disponibles dans les tableaux de bord Général, d’Activité, de Rétention, de Cohorte et Protect360.
Le calcul se fait quotidiennement. Les données mises à jour sont disponibles au bout de 24 à 48 heures, en fonction du fuseau horaire spécifique à votre app.
Il s’agit de l’infrastructure sur laquelle le tableau croisé dynamique AppsFlyer est basé.

Pour utiliser l’API principale, vous devez définir les données que vous souhaitez afficher (comme lorsque vous implémentezl’API Pull). Le résultat est retourné sous forme de fichier CSV ou JSON.

Pour utiliser l’API principale :

Récupérez le jeton d’API. Seul un admin peut le faire.
Donnez à votre développeur le jeton d'API à utiliser dans l'en-tête d'authentification.
Transmettez à vos développeurs les paramètres à saisir lorsqu'ils effectuent l'appel d'API, cf détails dans les paragraphes suivants. Les paramètres déterminent les points clés du rapport, comment il est organisé, et ils fournissent un calendrier de rapport.
Demandez à votre développeur de suivre les instructions concernant l’API principale disponibles dans le dev hub.

Paramètres de l’API

Paramètre	Valeur	Obligatoire
app_id	Identifiant d'app, tel qu’il s’affiche dans AppsFlyer. Insérez l'ID d'app exactement tel qu’il s’affiche dans AppsFlyer. Ajoutez le préfixe id aux apps IOS Utilisez tous les ID d’apppour envoyer des requêtes à l’ensemble de vos apps	Oui
from	Seuil le plus bas de la période d'attribution LTV. Format : chaîne aaaa-mm-jj Exemple :	Oui
to	Seuil le plus élevé de la période d'attribution LTV Nombre de jours dans la période : 1-31 jours Pour une seule journée : les valeurs `from` et `to` sont identiques. Format : aaaa-mm-jj Exemple : `from: 2021-01-01, to: 2021-01-31` fait 31 jours.	Oui
Regroupements	Regroupez par paramètres, séparés par une virgule. Voir le tableau Regroupements pour la liste des éléments disponibles Exemple :`groupings=pid,geo`	Oui
KPIs	La liste des KPI à inclure, séparés par une virgule. Cf le tableau des KPI ci-dessous pour voir la liste des KPI. Exemple : `kpis=installs,clicks, impressions,sessions,retention_day_7`	Oui
Filtres	Les données peuvent être filtrées selon une ou plusieurs options de filtrage.	Non
Devise	Pour retourner des données avec la devise spécifique à l’app, indiquez currency=preferred	Non
Fuseau horaire	Pour retourner des données dans le fuseau horaire spécifique à l’app, indiquez timezone=preferred. Voir les règles de localisation	Non
Format	Par défaut, les données retournées sont reçues au format CSV. Si vous préférez obtenir les données au format JSON, sélectionnez `format=json`.	Non

Regroupements

Ces dimensions visent à regrouper les données collectées afin de permettre une lecture plus rapide et précise des informations. Vous trouverez la description de ces champs ici.

Regrouper par nom de l'API	Regrouper par nom d’affichage	KPI de LTV	KPI de rétention	KPI d'activité	Protect360	Cohorte
app_id	ID d'app	Oui	Oui	Oui	Oui	Oui
PID	Source média	Oui	Oui	Oui	Oui	Oui
af_prt	agences	Oui	Oui	Oui	Oui	Non
C	Campagne	Oui	Oui	Oui	Oui	Oui
af_adset	Adset	Oui	Oui	Oui	Non	Non
af_ad	Publicité	Oui	Oui	Oui	Non	Non
af_channel	Canal	Oui	Oui	Oui	Oui	Non
af_siteid	ID éditeur	Oui	Oui	Oui	Oui	Oui
af_keywords	Mots-clés	Oui	Oui	Oui	Non	Non
is_primary	Est une attribution principale	Oui	Non	Oui	Oui	Non
af_c_id	ID de campagne	Oui	Non	Oui	Oui	Non
af_adset_id	ID d’adset	Oui	Non	Oui	Non	Non
af_ad_id	ID publicitaire	Oui	Non	Oui	Non	Non
install_time	Temps d'installation	Oui	Oui	Oui*	Oui	Oui
attributed_touch_type	Type de touch	Oui	Oui	Oui	Oui	Non
geo	Géo	Oui	Oui	Oui	Oui	Oui
* Dans le cas des KPI d’activité, l’heure d’installation correspond à l’heure de l’événement.

Les KPI

Les KPI sont les métriques qui vous permettent d’obtenir des infos sur le comportement de votre application. Les KPI sont regroupés par type dans les onglets suivants.

Valeur Lifetime - Événements agrégés segmentés par jour d’installation jusqu’au jour présent

Nom de l'API de KPI	Description
impressions	Nombre d'impressions durant la période sélectionnée
Clics	Nombre de clics durant la période sélectionnée
installs	Nombre d'installations durant la période sélectionnée
cr	de l'installation à la première commande
Sessions	Nombre de sessions créées par les utilisateurs ont installé l'app durant la période sélectionnée
loyal_users	Nombre d'utilisateurs fidèles qui ont installé l'app durant la période sélectionnée
loyal_users_rate	Utilisateurs fidèles / Installations
cost	Coût total sur la période choisie. Voir les limitations
revenue	Revenu lifetime généré par les utilisateurs qui ont installé l'app durant la période sélectionnée
roi	Retour sur investissement sur une période donnée
arpu_ltv	Revenu moyen par utilisateur, pour les utilisateurs qui ont installé l'app durant la période sélectionnée
average_ecpi	Coût effectif par installation (eCPI) sur une certaine période. Disponible uniquement si le coût et les installations sont inclus dans l’appel.
Désinstallations	Les utilisateurs qui désinstallent l'app qu'ils ont installée sur la période sélectionnée
uninstalls_rate	Taux de désinstallation
event_counter_[event_name]	Nombre d'événements
unique_users_[event_name]	Nombre d'utilisateurs uniques qui ont effectué l'événement
sales_in_usd_[event_name]	Revenus rapportés parmi les événements rapportés

La rétention mesure combien d'utilisateurs sont actifs dans votre application.

Remarque :

Le nombre maximum de jours de rétention est de 30 jours après l’installation (jour 0 est le jour de l’installation). La valeur [x] ne peut donc pas dépasser 30.
Si vous lancez une requête pour retention_day_1, avant que les données de ce jour ne soient disponibles, le chiffre concernera les utilisateurs qui ont installé l’app le jour précédent. Exemple : le 2 janvier, vous demandez retention_day_1 pour les utilisateurs qui ont fait l’installation au 1er janvier. Comme la métrique n’est pas encore disponible, le résultat indique les utilisateurs qui ont installé le 31 décembre.

KPI	Description
retention_day_[x]	Nombre d'utilisateurs conservés au jour X
retention_rate_day_[x]	Nombre d'utilisateurs conservés au jour X sur le nombre total d'utilisateurs qui ont installé l'app

Activité de l'app au cours d'une période sélectionnée.

KPI	Description
activity_average_dau	Nombre moyen d'utilisateurs actifs quotidiens (DAU) sur la période sélectionnée
activity_average_mau	Moyenne mensuelle des utilisateurs actifs durant la période sélectionnée (un jour MAU représente les utilisateurs uniques sur les 30 jours précédents).
activity_average_dau_mau_rate	Taux moyen de DAU / MAU
activity_average_arpdau	Revenu moyen par utilisateur actif quotidien - le revenu moyen pour un jour donné sur l'ensemble des utilisateurs uniques
activity_sessions	Nombre de sessions réalisées sur la période sélectionnée
activity_revenue	Revenus rapportés sur la période sélectionnée
activity_event_counter_[event_name]	Nombre d'événements générés par les utilisateurs sur la période sélectionnée
activity_sales_in_usd_[event_name]	Revenus rapportés parmi les événements rapportés sur la période sélectionnée
activity_average_unique_users_[event_name]	Nombre moyen d'utilisateurs uniques ayant réalisé un événement donné sur la période sélectionnée

Les cohortes AppsFlyer offrent aux annonceurs la possibilité d’afficher et de comparer différentes mesures pour plusieurs cohortes, sur des périodes différentes.

Remarque :

Erreurs d’arrondi : Les KPI de cohorte par utilisateur sont calculés au dix millième (4 chiffres après la virgule). Cela signifie que si la valeur par utilisateur est inférieure à 0,0001, le résultat affiche 0. Exemple : le nombre d’utilisateurs est 100 000 et le revenu total est 9 $. Le revenu par utilisateur est de 9/100000 = 0,00009. Comme 0,00009 < 0,0001, la valeur affichée sera de 0.
Jours de cohorte : Le nombre maximum de jours de cohorte est de 90 jours après l’installation (jour 0 est le jour de l’installation). La valeur [x] du jour de cohorte doit être comprise entre 1 et 90. Remarque : cohort_day_0 n’est pas pris en charge dans l’API Principale, même s’il est pris en charge dans le tableau de bord de Cohorte.
API principale V2 et API de cohorte dans le tableau de bord de cohorte : Les résultats peuvent varier en raison d’une gestion différente des réinstallations et des problèmes de synchronisation.

Sessions

KPI

Description

cohort_day_[x]_total_sessions_per_user

Cohorte Jour x - Nombre cumulé de sessions par utilisateur jusqu'au jour x (jour x inclus)

cohort_day_[x]_sessions_per_user

Jour x de la cohorte - Sessions du jour x pour la cohorte uniquement

cohort_[x]_days_total_sessions_per_user

Remplace dans l'URL Cohort_day_1_total_sessions_per_user par le Cohort_day_x_total_sessions_per_user du KPI.

Exemple : cohort_3_days_total_sessions_per_user dans l’URL génère 3 colonnes de rapport :
Cohort_day_1_total_sessions_per_user+ Cohort_day_2_total_sessions_per_user+Cohort_day_3_total_sessions_per_user

Revenus

KPI	Description
cohort_day_[x]_total_revenue_per_user	Cohorte Jour x - Total des revenus par utilisateur jusqu'au jour x (jour x inclus)
cohort_day_[x]_revenue_per_user	Jour x de la cohorte -ARPU accumulé au jour x pour la cohorte uniquement
cohort_[x]_days_total_revenue_per_user	Remplace Cohort_day_1_total_revenue_per_user des KPI spécifiées par Cohort_day_x_total_revenue_per_user. Exemple : cohort_3_days_total_revenue_per_user dans l’URL génère 3 colonnes de rapport : Cohort_day_1_total_revenue_per_user+ Cohort_day_2_total_revenue_per_user+Cohort_day_3_total_revenue_per_user
cohort_day_[x]_total_event_[eventname]_revenue_per_user	Somme des revenus par utilisateur au jour de cohorte x, selon un événement in-app donné
cohort_day_[x]_event_[eventname]_revenue_per_user	Revenu par utilisateur au jour de cohorte x, selon un événement in-app donné

Événements

KPI

Description

cohort_day_[x]_total_event_[eventname]_per_user

Cohorte Jour x - Total des événements par utilisateur jusqu'au jour x (jour x inclus)

cohort_day_[x]_event_[eventname]_per_user

Jour x de la cohorte - Événements accumulés au jour x pour la cohorte uniquement

cohort_[x]_days_total_event_[eventname]_per_user

Remplace les événements des KPI spécifiés par Cohort_day_x_total_events_per_user.

Exemple : cohort_3_days_total_events_per_user dans l’URL génère 3 colonnes de rapport :
Cohort_day_1_total_events_per_user+ Cohort_day_2_total_events_per_user+Cohort_day_3_total_events_per_user

Les KPI Protect360

Description	KPI
Installations
Total	protect360_total_installs
Bloqué	blocked_installs
% bloqué	blocked_installs_rate
Post-attribution	post_attribution_installs
% post-attribution	post_attribution_installs_rate
Nombre total d'installations frauduleuses	total_fraudulent_installs
% d'installations frauduleuses	fraudulent_installs_rate
Fausses installations
Blocage en temps réel	real_time_fake_installs
Fraude post-attribution	post_attribution_fake_installs
Installations détournées
Blocage en temps réel	real_time_hijacked_installs
Fraude post-attribution	post_attribution_installs_hijacked_installs
Règles de validation
Installations bloquées	validation_rules_blocked_installs
Attribution bloquée	validation_rules_blocked_attribution
Répartition des blocages de fausses installations
Liste noire des ID de site bloqués	blocked_installs_siteid_blacklist
Liste noire des ID de site post-attribution	post_attribution_installs_siteid_blacklist
Bots bloqués	blocked_installs_bots
Bots post-attribution	post_attribution_installs_bots
Anomalies comportementales bloquées	blocked_installs_behavioral_anomalies
Anomalies comportementales post-attribution	post_attribution_installs_behavioral_anomalies
Validation des installations bloquées	blocked_installs_install_validation
Les installations piratées bloquent la répartition
Piratage d'installations bloquées	blocked_installs_install_hijacking
Piratage d'installations post-attribution	post_attribution_installs_installs_hijacking
Anomalies CTIT bloquées	blocked_installs_ctit_anomalies
Anomalies CTIT en post-attribution	post_attribution_installs_ctit_anomalies
Click flooding bloqué	blocked_installs_click_flood
Click flooding post-attribution	post_attribution_installs_click_flood
Clics
Total	protect360_total_clicks
Bloqué	blocked_clicks
%	blocked_clicks_rate
Évènement in-app
Total	protect360_total_in_apps
Bloqué	blocked_in-app-events
%	blocked_in-app-events_rate
Indicateurs de ferme d'appareils - nouveaux appareils
Installations	install_fraud_new_devices_total
% installations	install_fraud_new_devices_total_installs_rate
% d'utilisateurs fidèles	install_fraud_new_devices_total_loyal_user_rate
Indicateurs de ferme d'appareils - Appareils LAT
Installations	install_fraud_lat_devices_total
% installations	install_fraud_lat_devices_total_installs_rate
% d'utilisateurs fidèles	install_fraud_lat_devices_total_loyal_user_rate
Indicateurs de click flooding
de l'installation à la première commande	conversion_rate
Indicateurs de click flooding - CTIT
Plus de 60 minutes	click_flood_over_1_hour_rate
Plus de 5 heures	click_flood_over_5_hours_rate

Calcul des KPI

En plus des KPI décrits précédemment, vous pouvez ajouter des calculs de KPI à vos rapports de l'API principale. Cela vous permet d'inclure vos propres calculs de rapports dans les rapports de l'API principale.

Vous pouvez insérer autant d’objets KPI intégrés que vous le souhaitez dans les formules de KPI. Chaque objet KPI du calcul contient une clé et une valeur. La clé est le nom que vous donnez au KPI, la valeur est la formule du KPI.

Les opérateurs de calcul standard sont pris en charge : l'addition (+) dont le code est %2b, la soustraction (-), la multiplication (X), la division (/) dont le code est %2f.

Les clés des champs de KPI calculés doivent commencer par «calculated_kpi_», suivi de n’importe quelle chaîne valide, par exemple «calculated_kpi_purchaserate».

Exemple

Somme des trois premiers jours de rétention

kpis=installs,loyal_users_rate&calculated_kpi_3days_retention=
retention_day_1%2Bretention_day_2%2Bretention_day_3

Revenu moyen par impression

kpis=installs&calculated_kpi_rev_per_impression=revenue%2Fimpression

ROI au jour 7 de la cohorte

kpis=installs,roi,arpu_ltv,cost,revenue&calculated_kpi_roi_day_7=
(cohort_day_7_total_revenue_per_user-average_ecpi)%2Faverage_ecpi

Filtres (facultatif)

Paramètre	Description	Exemple	Obligatoire ?
pid	Permet de sélectionner les lignes dans lesquelles s’affiche la (ou les) source média spécifiée. Il est possible de sélectionner plusieurs lignes (séparées par des virgules).	pid=organic,applovin_int	Non
c	Utilisé pour filtrer par nom de campagne. Il est possible de sélectionner plusieurs lignes (séparées par des virgules).	c=my_sample_campaign	Non
af_prt	Utilisé pour filtrer par nom d’agence. Il est possible de sélectionner plusieurs lignes (séparées par des virgules).	af_prt=moburst	Non
af_channel	Utilisé pour filtrer par nom de canal. Il est possible de sélectionner plusieurs canaux (séparés par des virgules).	af_channel=Instagram	Non
af_siteid	Utilisé pour le filtrage par ID d’éditeur. Il est possible de sélectionner plusieurs ID (séparés par des virgules).	af_siteid=12345678	Non
geo	Utilisé pour filtrer par pays. Il est possible de sélectionner plusieurs pays (séparés par des virgules).	geo=US,DE	Non

Localisation

La devise locale et le fuseau horaire spécifique à l’app sont définis sur la page des paramètres de l’app. Les données de l’API principale peuvent extraire les données en suivant la devise et le fuseau horaire par défaut du système, ou bien le fuseau horaire et la devise spécifiques à l’app.

Ce qui suit s’applique :

L’utilisation du fuseau horaire ou de la devise spécifique à l’app n’est prise en charge que si toutes les applications ont le même fuseau horaire ou la même devise. Dans le cas contraire, UTC et USD seront utilisés. Le fuseau horaire et la devise sont séparés. Cela signifie que si la devise de toutes les apps est la même, mais que les fuseaux horaires sont différents, vous pouvez utiliser la devise spécifique à l’app, mais pas le fuseau horaire spécifique à l’app.
Si le fuseau horaire préféré a été modifié dans le tableau de bord pour la période demandée, le rapport généré contient les valeurs produites après le dernier changement de fuseau horaire.

Utilisez les paramètres suivants pour sélectionner le paramètre spécifique à l’app. Remarque : Si vous n’utilisez pas de paramètres préférés, vous obtenez les paramètres par défaut, soit USD comme devise et UTC comme fuseau horaire.

Paramètre	Description	Exemple	Obligatoire ?
devise	Les valeurs monétaires s'affichent dans la devise de l'app	currency=preferred	Non
Fuseau horaire	Le fuseau horaire utilisé est celui du fuseau horaire spécifique à l’app	timezone=preferred	Non

Informations supplémentaires

Caractéristiques et limitations

Caractéristique	Remarques
Données de coûts	La disponibilité de certaines dimensions de coût, soit l’adset, la publicité, le géo, le canal et l’ID de site dépendent du réseau publicitaire. Pour obtenir l’eCPI : Si les données de coût sont disponibles, incluez autant les installations que le coût dans l’appel. En général, toutes les sources (y compris les médias propriétaires) qui utilisent des liens AppsFlyer et qui incluent le paramètre de coût dans les liens, prennent entièrement en charge les données de coût, quelles que soient les dimensions demandées. Les réseaux auto-reporting, avec leur propre API, prennent généralement en charge les données de coût, mais avec certaines des dimensions disponibles. Par exemple, les Meta ads ne prennent pas en charge le regroupement par géo et par chaîne dans le même appel. Le regroupement par l’un OU l’autre est par contre pris en charge. Les campagnes qui ont des données de coût, mais aucune donnée d’installation dans un passé récent (environ 7 jours), ne sont pas disponibles via l’API principale.
Regroupements	Les regroupements spécifiques ne sont disponibles que pour les KPI LTV, les KPI d’activité ou de rétention. L’API renvoie N/A lorsque les données d’un KPI spécifique ne sont pas disponibles. Exemple, la demande de retention_rate_day_7 regroupé par af_channel renverra N/A.
Nombre maximal de lignes par rapport	200K
Noms d'événement	L’API principale ne prend actuellement pas en charge les noms d’événements qui incluent un slash (/)`/`. Pour contourner cette limitation, évitez l’utilisateur de dans les noms d’événements `/`.
Délai de traitement	La sélection de plusieurs applications augmente le temps de traitement, la réponse peut donc prendre plus de temps.
Période	La granularité temporelle est quotidienne.
Agences	API principale non disponible
Réseaux publicitaires	API principale non disponible
Données historiques	Données LTV : 5 ans Données de cohorte (cohorte quotidienne) : 2 ans Données d'activité : 3 ans
Retargeting	Non pris en charge