Données brutes en temps réel API Push V2.0 (version bêta ouverte)

En quelques mots : les données d'événement d'attribution vous sont transmises en temps réel pour les utiliser dans vos systèmes informatiques. Vous sélectionnez les événements d'attribution, et les données sont envoyées à votre point de terminaison web.

API Push V2.0

4409_Push_API_V2-01.png

  Push API news

  • Push API V2.0 is aligned with AppsFlyer raw data V5.0 specification used by other data delivery tools in AppsFlyer. It has over 40 additional attribution fields. As new fields are added they are made available rapidly in Push API V2.0.
  • Push API V1.0 will no longer be updated and will be discontinued.
  • Developer! Migration guide Push API V1.0 to Push API V2.0

Push API is used to get Attribution data in real-time so that you can combine in-house user data with the real-time attribution data from AppsFlyer. Use the data to follow user journeys and to perform real-time analytics and segmentation. 

If your app flow depends on attribution data in real-time (less than five seconds) consider using conversion data.

For more information about AppsFlyer data tools see: Choosing AppsFlyer data delivery tools, Using Push and Pull API together

Fonctionnalités de l'API Push

Event types supported by Push API
Type de campagne Type d'événement Non organique Trafic Retargeting
Acquisition des utilisateurs sans rapport  
Acquisition d'utilisateurs  Événements in-app d'installation  
Retargeting RÉENGAGEMENT    
Retargeting  Évènements in-app de réengagement    
Retargeting  Réattribution     
Retargeting  Évènements in-app de réattribution    

Actualisation des données

Push API messages are sent in real-time. 

technologie

    • RESTful API, POST and GET methods supported
    • Les réponses aux messages POST sont contenues dans un JSON

Attention

Some media sources, restrict the use of user-level data and the sharing of this data with third parties. Ensure that you comply with the media source terms of use.
For example, Facebook, Twitter, Snapchat, Pinterest.

Implémentation de l'API Push

Configuration de l'API Push

Implementation guidelines 

  • D'autres champs peuvent être ajoutés de temps à autre à la structure JSON, et sans préavis. Veuillez suivre cet article pour rester informé des modifications.
  • If your endpoint host fails to accept the Push API messages they can't be resent. If you lose Push API messages, use pull API to fill any gaps. 

Checklist

Complete this checklist before you setup Push API. 

  • Whitelist IPs: Whitelist AppsFlyer IP addresses so that they can communicate with the endpoint defined in the URL. List of AppsFlyer IP addresses.
  • TLS support:
  • Ports: 80, 443
  • Endpoint:
    • Is a valid domain name
    • Configured to return HTTP status code 200 indicating successful completion. Note: No other status code is allowed. This includes other 2XX codes. 
    • Le même point de terminaison ne peut être utilisé qu'une fois par application. 
    • When using the GET method, do not add query parameters to the URL if the endpoint is hosted by third-party providers.
    • API key parameters aren't supported.

Configuration de l'API Push

Pour ajouter un point de terminaison API Push :

  1. Dans AppsFlyer, allez dans Intégration > Accès API.
    La fenêtre d'Accès API s'ouvre.
  2. Scroll down to the Push API section.
    The Push API endpoint section displays.

    PushAPi.png

  3. Cliquez sur Ajouter un postback.
    Vous pouvez configurer jusqu'à 6 points de terminaison d'API Push.
  4. Select an HTTP method: POST or GET
  5. Saisissez l'URL dupostback.
  6. (Optionnel) Sélectionnez la version de l'API Push : (par défaut) 2.0
  7. Sélectionnez un ou plusieurs types d'événements à envoyer à l'URL du point de terminaison. 
  8. Cliquez sur Enregistrer
    L'API Push est maintenant 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.

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.
  2. Check that the endpoint received the test message.
    A copy of the message sent follows.

Exemples de messages d'API POST et GET

Exemple de message POST

{
  "device_model":"GT-I9300",
  "fb_adgroup_id":"6032793211234",
  "download_time":"2015-10-28 00:18:00",
  "operator":"Vodafone IN",
  "click_time":"2015-10-28 12:17:37",
  "agency":null,
  "ip":"115.98.114.125",
  "cost_per_install":null,
  "fb_campaign_id":"6032793121234",
  "imei":"358422050231234",
  "is_retargeting":false,
  "app_name":"[App Name Comes Here]",
  "re_targeting_conversion_type":null,
  "android_id":"449021d533061234",
  "city":"London",
  "af_sub1":null,
  "af_sub2":null,
  "event_value":null,
  "af_sub3":null,
  "fb_adset_name":"FACEBOOK_ADSET_TEST",
  "af_sub4":null,
  "customer_user_id":"1234-5678",
  "mac":null,
  "af_sub5":null,
  "campaign":"FACEBOOK_CAMPAIGN_TEST",
  "event_name":null,
  "currency":null,
  "install_time":"2015-10-28 12:18:36",
  "fb_adgroup_name":"FACEBOOK_ADGROUP_TEST",
  "event_time":"2015-10-28 12:18:36",
  "platform":"android",
  "sdk_version":"1.17",
  "appsflyer_device_id":"1446034686662-8619927357095541234",
  "wifi":true,
  "advertising_id":"95e55150-1111-2222-3333-3e0c8c1d9978",
  "media_source":"Facebook Ads",
  "country_code":"GB",
  "http_referrer":null,
  "fb_campaign_name":"FACEBOOK_CAMPAIGN_TEST",
  "click_url":null,
  "carrier":"Vodafone",
  "language":"English",
  "app_id":"[App ID Comes Here]",
  "app_version":"4.4.1",
  "attribution_type":"regular",
  "af_siteid":null,
  "os_version":"4.3",
  "fb_adset_id":"6032793131234",
  "device_brand":"samsung",
  "event_type":"install",
  "af_ad": "a86721874",
  "af_ad_id": "123245353",
  "af_ad_type":"Banner_210X600",
  "af_adset":"3gvow",
  "af_adset_id":"3gvow",
  "af_c_id":"3e025",
  "af_channel":"youtube",
  "af_cost_currency":"USD",
  "af_cost_model":"cpi",
  "af_cost_value":"0.0750",
  "af_keywords":"key1 key2 key3"
}

Exemple de message GET

?mac%3D%26af_sub1%3D%26customer_user_id%3D1234-5678%26af_cost_value%3D0.0750%26
app_version%3D4.4.1%26city%3DLondon%26fb_campaign_id%3D6032793121234%26device_model%3DGT-I9300%26af_cost_model%3Dcpi%26af_c_id%3D3e025%26app_name%3D%5BApp%20Name%20Comes%20Here%5D%26wifi%3Dtrue%26install_time%3D2015-10-28%2012%3A18%3A36%26operator%3DVodafone%20IN%26fb_adgroup_id%3D6032793211234%26currency%3D%26af_adset_id%3D3gvow%26re_targeting_conversion_type%3D%26is_retargeting%3Dfalse%26country_code%3DGB%26event_type%3Dinstall%26appsflyer_device_id%3D1446034686662-8619927357095541234%26http_referrer%3D%26af_sub5%3D%26fb_campaign_name%3DFACEBOOK_CAMPAIGN_TEST%26click_url%3D%26media_source%3DFacebook%20Ads%26campaign%3DFACEBOOK_CAMPAIGN_TEST%26af_keywords%3Dkey1%20key2%20key3%26event_value%3D%26ip%3D115.98.114.125%26event_time%3D2015-10-28%2012%3A18%3A36%26click_time%3D2015-10-28%2012%3A17%3A37%26af_sub4%3D%26imei%3D358422050231234%26fb_adgroup_name%3DFACEBOOK_ADGROUP_TEST%26af_sub2%3D%26attribution_type%3Dregular%26android_id%3D449021d533061234%26af_adset%3D3gvow%26fb_adset_id%3D6032793131234%26af_ad%3Da86721874%26agency%3D%26fb_adset_name%3DFACEBOOK_ADSET_TEST%26cost_per_install%3D%26af_channel%3Dyoutube%26af_cost_currency%3DUSD%26device_brand%3Dsamsung%26download_time%3D2015-10-28%2000%3A18%3A00%26af_siteid%3D%26language%3DEnglish%26app_id%3D%5BApp%20ID%20Comes%20Here%5D%26af_ad_type%3DBanner_210X600%26carrier%3DVodafone%26event_name%3D%26advertising_id%3D95e55150-1111-2222-3333-3e0c8c1d9978%26os_version%3D4.3%26platform%3Dandroid%26af_sub3%3D%26af_ad_id%3D123245353%26sdk_version%3D1.17

Suppression des postbacks

Pour supprimer un postback :

  1. Go to Integration > API Access.
    Scroll down to the Push API access section. 
  2. Cliquez sur Supprimer le postback.
  3. Cliquez sur Enregistrer. Le postback est supprimé. 

Structures de message de l'API push

La réponse de l'API Push dépend de la méthode HTTP :

  • GET: data parameters are appended to the URL string
  • POST : les paramètres de données sont contenus dans le corps du message au format JSON

Champs de l'API Push

Push API messages contain the fields as described here. Additional fields will be added from time to time as these are added to the AppsFlyer platform Your import/parsing mechanisms should take this into account. 

Champs de l'API uniques
Nom d'affichage Nom V2.0 Remarques 
La 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 d'heure de téléchargement download_time_selected_
fuseau horaire
 
Fuseau horaire d'heure où le toucher est attribué attributed_touch_time_
selected_timezone
 
Fuseau horaire d'heure d'installation install_time_selected_
fuseau horaire
 
Fuseau horaire d'heure d'événement event_time_selected_
fuseau horaire
 
Fuseau horaire sélectionné selected_timezone  
URL de deep link deeplink_url Disponible à partir du T4 2019
OAID OAID Disponible à partir du T4 2019
ID de mot clé keyword_id Disponible à partir du T4 2019
Réinstallation du store store_reinstall (False=Download, True=Redownload) Disponible à partir du T4 2019

Liste complète des champs de l'API Push

Nom de l'API Push V2.0 Nom d'affichage de l'API Push Commentaires
advertising_id ID publicitaire  
af_ad publicité  
af_ad_id Identifiant de publicité  
af_ad_type Type de publicité  
af_adset Ensemble de publicités  
af_adset_id Identifiant de l'ensemble de publicités  
af_attribution_lookback Fenêtre d'attribution rétrospective  
af_c_id Identifiant de la campagne  
af_channel Canal  
af_cost_currency Devise des coûts  
af_cost_model Modèle de coût  
af_cost_value Valeur des coûts  
af_keywords Mots-clés  
af_prt Partenaire  
af_reengagement_window Fenêtre de réengagement  
af_siteid ID site  
af_sub_siteid Identifiant du sous-site  
af_sub1 Sous-paramètre 1  
af_sub2 Sous-paramètre 2  
af_sub3 Sous-paramètre 3  
af_sub4 Sous-paramètre 4  
af_sub5 Sous-paramètre 5  
amazon_aid ID Amazon Fire  
android_id ID Android   
api_version Version de l'API  
app_id ID d'app  
app_name Nom de l'app  
app_version Version de l'app  
appsflyer_id ID AppsFlyer  
attributed_touch_time Temps de touch attribué  
attributed_touch_time_selected_timezone Fuseau horaire d'heure où le toucher est attribué Caractéristiques de l'API Push
attributed_touch_type Type de touch attribué  
bundle_id ID de groupe  
campagne Campagne  
carrier carrier  
city city  
contributor_1_af_prt Partenaire du contributeur 1  
contributor_1_campaign Campagne du contributeur 1  
contributor_1_match_type Type de correspondance du contributeur 1  
contributor_1_media_source Source média du contributeur 1  
contributor_1_touch_time Heure de touch du contributeur 1  
contributor_1_touch_type Type de touch du contributeur 1  
contributor_2_af_prt Partenaire du contributeur 2  
contributor_2_campaign Campagne du contributeur 2  
contributor_2_match_type Type de correspondance du contributeur 2  
contributor_2_media_source Source média du contributeur 2  
contributor_2_touch_time Heure de touch du contributeur 2  
contributor_2_touch_type Type de touch du contributeur 2  
contributor_3_af_prt Partenaire du contributeur 3  
contributor_3_campaign Campagne du contributeur 3  
contributor_3_match_type Type de correspondance du contributeur 3  
contributor_3_media_source Source média du contributeur 3  
contributor_3_touch_time Heure de touch du contributeur 3  
contributor_3_touch_type Type de touch du contributeur 3  
cost_in_selected_currency Coût dans la devise sélectionnée Caractéristiques de l'API Push
country_code Code pays  
custom_data Données personnalisées  
customer_user_id ID utilisateur du client  
deeplink_url URL de deep link Disponible à partir du T4 2019
device_category Catégorie d'appareil  
device_download_time Temps de téléchargement de l'appareil  
device_type Type d'appareil  
dma DMA  
download_time_selected_timezone Fuseau horaire d'heure de téléchargement Caractéristiques de l'API Push
event_name Nom de l'événement  
event_revenue Revenu de l'évènement  
event_revenue_currency Devise du revenu des évènements  
event_revenue_usd Revenu de l'évènement en USD  
event_source Source de l'évènement  
event_time Heure de l'évènement  
event_time_selected_timezone Fuseau horaire d'heure d'événement Caractéristiques de l'API Push
event_value Valeur de l'événement  
gp_broadcast_referrer Référent de diffusion GP  
gp_click_time Heure du clic Google Play  
gp_install_begin Heure de début d'installation Google Play  
gp_referrer Google Play Referrer  
http_referrer Référent HTTP  
idfa idfa  
idfv IDFV  
imei imei  
install_app_store App store d'installation  
install_time Temps d'installation  
install_time_selected_timezone Fuseau horaire d'heure d'installation Caractéristiques de l'API Push
ip IP  
is_LAT Is LAT Disponible à partir du T4 2019
is_primary_attribution Est une attribution principale  
is_receipt_validated Possède une validation de reçu  
is_retargeting Retargeting en cours  
keyword_id ID de mot clé Disponible à partir du T4 2019
keyword_match_type Type de correspondance de mots-clés  
language langue  
match_type Type de correspondance  
media_source Source média  
network_account_id ID de compte réseau  
OAID OAID Disponible à partir du T4 2019
operator operator  
original_url URL d'origine  
os_version Version du système d'exploitation  
platform Plate-forme  
postal_code Code postal  
Région Région  
retargeting_conversion_type Type de conversion de retargeting  
revenue_in_selected_currency Revenus dans la devise sélectionnée Caractéristiques de l'API Push
sdk_version Version du SDK  
selected_currency La devise sélectionnée. Caractéristiques de l'API Push
selected_timezone Fuseau horaire sélectionné Caractéristiques de l'API Push
État État  
store_reinstall (False=Download, True=Redownload) Réinstallation du store Disponible à partir du T4 2019
user_agent Agent utilisateur  
wifi wifi  

Dépannage, restrictions et particularités

Duplication of retargeting events

In some cases, retargeting events are duplicated. This occurs when an in-app purchase event takes place as a result of a retargeting campaign during the UA re-engagement window.

In this case, two attribution events are generated to attribute the revenue to the media source that brought the install and the media source that brought the re-engagement. 

You will only get two Push API's if you have enabled Push APIs for both

  • install in-app events
  • retargeting in-app events

 Exemple

  • A user installs example_app, which is attributed to ua_network
  • Later the user re-engages with example_app's retargeting campaign on retar_network and makes a purchase.

The event is sent twice with the following details:

Champs de l'API uniques
Type d'événement Media source is_retargeting re_targeting conversion_type
Non organique ua_network False null (no value)
Retargeting  retar_network True RÉENGAGEMENT


How do I identify duplicate retargeting events?

Use the is_primary_attribution boolean field which indicates the primary and secondary media sources as follows. 

  • In UA campaigns the value can only be true because the UA media source is the only media source.
  • In retargeting campaigns:
    • True: identifies the re-engagement media source 
    • False: identifies the original UA media source

This reason for this is as follows: If a user, as a result of a retargeting campaign,  engages with the campaign, a re-engagement window opens. The re-engagement media source is regarded as the primary media source when the re-engagement window is open. After the window closes, the original UA media source reverts to being primary. 

Missing Facebook data

By default, Facebook does not release raw user-level data, until you accept Facebook's Terms of Service.
By doing so, you enable the sending of user-level data of installs coming from Facebook, via Push API (and to other raw data resources, as well).

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, consultez Choisir comment CloudFront répond aux requêtes HTTPS

Restrictions et particularités

Particularités
Particularité Remarques 
Réseaux publicitaires Non utilisé pour les ad networks.
Agences Non utilisé pour les agences.
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 temps réel
Données historiques Not supported. Event data is sent after configuring Push API. If you need historical raw data use Pull API. 
Team member access Team members can view Push API settings but aren't able to make changes. 
Cet article vous a-t-il été utile ?