Aggregate data via Pull API in real-time

At a glance: Use URIs to get aggregate reports in CSV files.

PullAPIAggregateDate_us-en.jpg

 Are you looking for Pull API raw data?

Pull API raw data

Pull API aggregate data characteristics

  • Les rapports sont envoyés sous forme de fichiers CSV.
  • Les taux de rafraîchissement des données sont identiques à ceux du rapport équivalent sur la d'export des Données.
  • Les filtres par options sont les mêmes que ceux de la page d'Export des Données : source média, plage de dates, nom de l'événement in-app.
  • Les capacités supplémentaires de l'API Pull sont les suivantes :
    • Possibilité de filtrer par type de touch attribué
    • Fuseau horaire sélectionnable 
  • L'API Pull est adaptée aux membres de l'équipe et aux développeurs BI ;
    • Les membres d'équipe obtiennent les rapports en collant les URI dans leur navigateur. Les templates d'URI sont disponibles dans le tableau de bord. 
    • Les développeurs BI obtiennent des rapports en incorporant les URI dans les scripts. 

Example URI template TemplateURL_us-en.jpg

Catégorie UA agrégé (performances) et retargeting* Protect360**
Partenaires (source média)

Partenaires par date

Quotidien

Géo

Géo par date

* Pour les rapports de retargeting, ajoutez &reattr=true à l'URI.

** Fonctionnalité Premium. 

Aggregate reports, LTV based

 Lectures connexes :

Terminologie

Termes Description
API pull

Solution de téléchargement de rapports CSV à l'aide d'URI.

Appel API ou appel 

Envoi de l'URI à AppsFlyer en le collant dans la barre d'adresse du navigateur ou en utilisant des scripts.

URI
  • Identificateur de ressource uniforme (Uniform resource identifier) parfois similaire à l'adresse web (URL) contenant la spécification de rapport.
  • Les templates d'URI sont disponibles sur la page API dans le tableau de bord.

Guide pour les membres de l'équipe

À propos des modèles d'URI

  • Les modèles d'URI disponibles dans le tableau de bord sont remplis avec l'ID d'app et le type de rapport.
  • Ils ont des espaces réservés au jeton d'API et aux dates from/to, que vous devez modifier.
  • La partie de l'URI à droite du point d'interrogation (?) contient des paramètres. Chaque paramètre commence par une esperluette (&). Les paramètres sont utilisés pour régler des filtres, spécifier les champs supplémentaires à inclure, la devise et le fuseau horaire. Par exemple, dans les rapports agrégés pour limiter (filtrer) une source média donnée, utilisez le paramètre media_source : & media_source=facebook
  • Pour mieux comprendre l'API Pull, suivez le didacticiel qui suit.

Obtenez votre premier didacticiel de rapport sur l'API Pull

Avant de commencer :
  •  Ask the admin to provide you with the Pull API token available in the dashboard.

Pour télécharger un rapport depuis le tableau de bord : 

  1. Allez dans Intégration > Accès API.
    La page Accès API s'ouvre. PullAPIPartnersReport_us-en.jpg
  2. Sélectionnez un type de rapport. Par exemple, Rapport de performanceRapport quotidien des partenaires. 
    Le modèle d'URI s'affiche. 
  3. Copiez l'URI en cliquant dessus.
  4. Ouvrez un nouvel onglet dans votre navigateur, collez l'URI.
  5. Modifiez l'URI :
    1. Replace the token placeholder with the Pull API token provided by the admin.
      Example: Replace the token placeholder so that &api_token=12345678-1234-1234-1234-123456789012 Note! There are no spaces or other punctuation. 
    2. Remplacer les champs from/to par des dates.
      Exemple : &from=2020-01-20&to=2020-01-31 Attention ! N'ajoutez aucun espace. Ne supprimez pas le &. 
  6. Cliquez sur <Enter> pour envoyer l'appel API. 
    Le rapport est téléchargé.

Aggregate data Pull API parameters

URI et paramètres du rapport agrégé

Paramètres obligatoires des URI agrégés 
Paramètre Description
api_token Jeton d'autorisation d'API.Dans les exemples d'appels, ceci est indiqué comme suit : < API TOKEN HERE >. 
from
  • La plage de dates se compose des paramètres FROMet TO . La plage est la plage LTV, la date d'installation.
  • Format : aaaa-mm-jj, 
  • Exemple : 2010-01-01 ou 2010-01-01
to Date de fin. Comme pour from
Paramètres facultatifs de filtrage et d'affichage des données brutes agrégées, à l'exclusion des rapports Protect360.
Paramètre Description
media_source

À utiliser pour limiter (filtrer) à une source média donnée.

  • Example:media_source=facebook
 attributed_touch_type

Réglez ce paramètre comme indiqué dans l'exemple pour obtenir les KPI d'attribution post vue.

Example: attribution_touch_type=impression

devise

Devise des revenus et des coûts

Aggregate Pull API reports always use the app-specific currency. 

reattr

Obtenir les données d'attribution de retargeting.

  • Si [Default] est false, les campagnes de données d'acquisition d'utilisateurs (AU) sont renvoyées.
  • Si true, les données d'attribution de retargeting sont renvoyées.
  • Exemple :reattr=true
Fuseau horaire

[Default] Les données sont renvoyées en utilisant le fuseau horaire UTC.

  • Les URI du template sont remplis avec le paramètre de fuseau horaire réglé sur le fuseau horaire spécifique à l'app. 
  • [Default] Si le paramètre n'est pas envoyé, les données sont renvoyées en utilisant le fuseau horaire UTC.
  • Si vous envoyeztimezone=[Joda-Time], les données sont renvoyées en utilisant le fuseau horaire spécifique à l'app.

Remarques sur la sélection des fuseaux horaires

  • Le format de fuseau horaire Joda-Time tient compte de l'heure d'été.
  • La valeur Joda-Time doit être identique à la valeur définie à la page des paramètres de l'app. Par exemple, si le fuseau horaire sélectionné est Paris, la valeur du fuseau horaire de l'URL de l'API Pull doit être timezone=Europe%2fParis.
  • Le regroupement de données dans le fuseau horaire spécifié est uniquement disponible à partir de la date à laquelle le paramètre de fuseau horaire a été défini. Toutes les données antérieures à la date de la modification s'affichent selon le fuseau horaire UTC. 

Rapport Google Adwords filtré

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&media_source=googleadwords_int

Rapport Facebook filtré

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&&media_source=facebook
Paramètres facultatifs pour les rapports Protect360
Paramètre Description
 pid

Pour filtrer le rapport par une source média spécifique, utilisez le paramètre pid. Par exemple, pour obtenir les données de abc_net, pid=abc_net.

Fuseau horaire

Sélectionne le fuseau horaire utilisé pour renvoyer les données.

Si le paramètre timezonen'est pas envoyé, les données sont renvoyées en utilisant le fuseau horaire UTC.

Templates incluant le paramètre timezone

Exemple : timezone=preferred : permet d'obtenir des données en utilisant le fuseau horaire spécifique à l'app .

Indicateurs de performance clés

Les paramètres Protect360 sont les mêmes dans l'API Pull et l'API principale. 

KPI d'attribution post vue

  • Pour obtenir les KPI d'attribution post vue, ajoutez le paramètre attribution_touch_type=impression à l'URI du rapport agrégé de l'API Pull, comme indiqué dans l'exemple.
  • You can use the parameter with any of the aggregate reports available. Just copy the URI from the user interface, and append the &attributed_touch_type=impression
  • Vous pouvez également ajouter le paramètre &media_source pour limiter le rapport à une source média spécifique, comme illustré dans l'exemple qui suit.
  • Certains KPI d'attribution post vue, comme les clics, les impressions et les API de coût n'ont pas de valeurs associées et affichent la valeur N/A à la place.
Exemple Exemple d'URI
Attribution post vue uniquement https://hq.appsflyer.com/export/{app_id}/partners_report/v5?api_token={API token}&from=yyyy-mm-dd&to=yyyy-mm-dd&attribution_touch_type=impression

Attribution post vue et source media

https://hq.appsflyer.com/export/{app_id}/partners_report/v5?api_token={API token}&from=yyyy-mm-dd&to=yyyy-mm-dd&aattribution_touch_type=impression&media_source=example_ad_network

API Pull pour les développeurs

Principes de mise en œuvre

Conditions préalables :

Familiarisez-vous avec le guide API Pull pour les membres d'équipe.

À prendre en compte :

  • Il existe un template d'URI dans le tableau de bord pour chaque type de rapport disponible.
  • Modifiez le template pour obtenir les données dont vous avez besoin. Par exemple en définissant des plages de dates et en filtrant par paramètres.
  • Les paramètres des rapports de données brutes et de données agrégées diffèrent et sont détaillés dans les sections consacrées aux rapports.
Bases de l'API Pull
Chemin

https://hq.appsflyer.com/export/app_id/report_type/v5

Paramètres de chemin

app_id

  • Identifiant d'app tel que trouvé dans AppsFlyer.
  • Insérez l'ID d'app exactement comme dans AppsFlyer.
  • Ajoutez le préfixe id aux apps IOS

report_type 

  • Définit le type de rapport. La liste des rapports et les URI associés sont dans le tableau de bord. Allez dans Intégration > Accès API. 
Méthode HTTP

GET

Paramètres de requête obligatoires
Paramètre Description
Exemple d'URI

GET 'https://hq.appsflyer.com/export/app_id/installs_report/v5? from=2020-01-01?&to=2020-01-10&api_token=api_token&currency=preferred

api_token

api_token : jeton d'API Pull pour authentification

Autres paramètres

Les paramètres diffèrent selon 

 Exemple

L'exemple d'appel URI comprend des paramètres supplémentaires :

https://hq.appsflyer.com/export/example.app.com/installs_report/v5?
        api_token={Account owner API key should be used}&from=yyyy-mm-dd
&to=yyyy-mm-dd&additional_fields=keyword_id,store_reinstall,
deeplink_url,oaid,install_app_store,contributor1_match_type,
contributor2_match_type,contributor3_match_type,match_type

Exemples de scripts

Intégrez l'API Pull dans des scripts pour récupérer des données.

  • Au besoin, modifiez les scripts en termes de type de rapport, de plage de dates et de filtres. 
  • Ces exemples utilisent le rapport install.
JavaNode JSPythonC#PHP
import okhttp3.*;

import java.io.BufferedWriter;
import java.io.FileWriter;

import java.util.concurrent.TimeUnit;

public class PullApi {
  public static void main(String[] args){

    String appID = "<APP_ID>";
    String reportType = "<REPORT_TYPE>";
    String apiToken = "<API_TOKEN>";
    String from = "<FROM_DATE>";
    String to = "<TO_DATE>";
    String requestUrl = "https://hq.appsflyer.com/export/" + appID + "/" + reportType + "/v5?api_token=" + apiToken + "&from=" + from + "&to=" + to;

    OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(30, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)

        .build();

    Request request = new Request.Builder()
        .url(requestUrl)
        .addHeader("Accept", "text/csv")
        .build();

    try {
      Response response = client.newCall(request).execute();

      if(response.code() != 200) {
        if(response.code() == 404) {
          System.out.println("There is a problem with the request URL. Please make sure it is correct");
        }
        else {
          assert response.body() != null;
          System.out.println("There was a problem retrieving the data: " + response.body().string());
        }
      } else {
        assert response.body() != null;
        String data = response.body().string();
        BufferedWriter writer;

        writer = new BufferedWriter(new FileWriter(appID + "-" + reportType + "-" + from + "-to-" + to + ".csv"));
        writer.write("");
        writer.write(data);
        writer.close();
      }
      System.exit(0);
    } catch (Exception e) {
      e.printStackTrace();
      System.exit(1);
    }
  }
}

Informations supplémentaires

Différences entre Pull API V4 et V5. 

Données brutes : l'API V4 est toujours disponible pour utilisation. Aucune modification n'est apportée aux formats de fichier et aux en-têtes.

Données agrégées (V5) :

Dans la V5.0, les champs supplémentaires suivants sont fournis avec media_source=facebook :

  • Identifiant de la campagne
  • Nom d'adset
  • Identifiant de l'ensemble de publicités
  • Nom de publicité (Adgroup)
  • Id de publicité (Adgroup)

Particularités et limites

Particularité
Particularité Statut Commentaires 
Accès du ad network   
Autorisations de l'agence  
Transparence de l'agence  
Devise spécifique à l'app  
Fuseau horaire spécifique à l'app  
Actualisation des données temps réel.  
Données historiques  
Données non organiques  
Données organiques  
Limitation de taux

Limitations de l'API pour les données agrégées et les données brutes

Limitations de taille Oui
  • Les appels d'API renvoient un max. de 200 000 lignes.
  • Si un rapport contient exactement 200 000 lignes, supposez que des lignes sont manquantes.
  • Effectuez plusieurs appels d'API, en utilisant des paramètres from/to qui incluent l'heure de la journée.  
Accès des membres de l'équipe

Seul l'administrateur peut obtenir un jeton d'API Pull.

Code d'erreurs API et dépannage

Codes d'erreur et solutions
Statut Code Symtom/message SOLUTION
OK 200 Fichier CSV vide

addtional_fields apparaît plus d'une fois dans l'URI

OK

200

Fichier CSV vide

Ensure that both from and to dates have the format yyyy-mm-dd

Bad request

400

Raw Reports historical lookback is limited to 90 days.

Utilisez to et from pour limiter la plage de dates à 3 mois ou moins.

Bad request

400

Your API calls limit has been reached for report type

-
Non autorisé

401

Le jeton d'API fourni est invalide 

Ask the admin for the current token
Non autorisé

401

Le compte peut être suspendu.

Log in to the dashboard and check the account status. 

Not found

404

 

The token doesn't match the app. Ask the admin to give you the current token. 

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