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

  • Laporan kembali sebagai file CSV.
  • Tingkat kesegaran data sama dengan laporan ekuivalen di halaman Data Ekspor.
  • Filter berdasarkan opsi sama dengan yang di halaman Data Ekspor: Sumber media, rentang data, nama in-app event. 
  • Keunggulan tambahan dalam Pull API adalah:
    • Kemampuan menyaring berdasarkan attributed touch type
    • Zona waktu yang dapat dipilih 
  • Pull API cocok untuk digunakan oleh anggota tim dan pengembang BI;
    • Anggota tim mendapatkan laporan dengan melekatkan URI di browser mereka. Templat URI tersedia di Dashboard. 
    • Pengembang BI mendapatkan laporan dengan menyematkan URI dalam skrip. 

Example URI template TemplateURL_us-en.jpg

ketegori Agregat (kinerja) UA dan penargetan ulang* Protect360**
Partners (media source)

Partners by date

Harian

Geo

Geo berdasarkan tanggal

* Untuk laporan penargetan ulang, tambahkan &reattr=true ke URI. 

** Fitur premium. 

Aggregate reports, LTV based

 Bacaan terkait:

Terminologi

Istilah Deskripsi
Pull API

Solusi untuk mengunduh laporan CSV menggunakan URI.

Panggilan API atau panggilan 

Mengirimkan URI ke AppsFlyer dengan melekatkannya di bilah alamat browser atau dengan menggunakan skrip.

URI
  • Pengidentifikasi sumber seragam terkadang mirip dengan alamat web (URL) yang berisi spesifikasi laporan.
  • Templat URI tersedia di halaman API di Dashboard.

Panduan untuk anggota tim

Tentang templat URI

  • Templat URI yang tersedia di dashboard diisi dengan ID aplikasi dan tipe laporan.
  • Ini memiliki place holder untuk token API dan dari/hingga tanggal yang perlu Anda edit.
  • Bagian URI di sebelah kanan tanda pertanyaan (?) berisi parameter. Setiap parameter dimulai dengan tanda & (&). Parameter digunakan untuk mengatur filter, menentukan bidang tambahan untuk dimasukkan, mata uang, dan zona waktu. Misalnya, di laporan agregat untuk membatas (menyaring berdasarkan) sumber media tertentu, gunakan parameter sumber media: &media_source=facebook
  • Untuk mendapatkan pemahaman yang lebih baik tentang Pull API, lengkapi tutorial berikut.

Mendapatkan tutorial laporan Pull API pertama Anda

Sebelum Anda mulai:
  •  Ask the admin to provide you with the Pull API token available in the dashboard.

Untuk mengunduh laporan dari dashboard: 

  1. Buka Integrasi > Akses API.
    Halaman akses API dibuka. PullAPIPartnersReport_us-en.jpg
  2. Pilih jenis laporan. Misalnya, Laporan kinerjaLaporan harian mitra. 
    Templat URI ditampilkan. 
  3. Salin URI dengan mengkliknya.
  4. Buka tab baru di browser Anda, lekatkan URI.
  5. Edit 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. Ganti dari/to placeholder dengan tanggal.
      Contohnya: &dari=20-01-2020&hingga=31-01-2020 Catatan! Tidak ada spasi. Jangan hapus &. 
  6. Klik <Enter> untuk mengirimkan panggilan API. 
    Pengunduhan laporan.

Aggregate data Pull API parameters

URI laporan agregat dan parameter

Parameter wajib URI agregat 
Parameter Deskripsi
api_token Token otorisasi API.Contohnya panggilan ini ditampilkan sebagai: <TOKEN API DI SINI>. 
from
  • Rentang data terdiri dari dari parameterdan to . Rentang adalah rentang tanggal LTV (instalasi).
  • Format: yyyy-mm-dd, 
  • Contohnya: 01-01-2010 atau 01-01-2010
ke Tanggal selesai. Seperti untuk dari
Penyaringan opsional data agregat dan parameter tampilan tidak termasuk laporan Protect360
Parameter Deskripsi
media_source

Gunakan untuk membatasi (filter) ke sumber media tertentu.

  • Example:media_source=facebook
attributed_touch_type

Atur parameter ini seperti yang ditunjukkan pada contoh untuk mendapatkan atribusi lihat-tayang (VTA) KPI. 

Example: attribution_touch_type=impression

currency

Mata uang pendapatan dan biaya

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

atribusi ulang

Dapatkan data atribusi penargetan ulang

  • [Default] Jika salah, kampanye data akuisisi pengguna (UA) kembali.
  • Jika benar, data atribusi penargetan ulang kembali.
  • Contoh:reattr=true
zona waktu

[Default] Data kembali menggunakan UTC.

  • Templat URI diisi dengan parameter zona waktu yang diatur ke zona waktu khusus aplikasi. 
  • [Default] Jika parameter tidak dikirim, data kembali menggunakan.
  • Jika Anda mengirimkan zona waktu=[Joda-Time], data kembali menggunakan zona waktu khusus aplikasi.

Catatan tentang pemilihan zona waktu

  • Format zona waktu Joda-Time memperhitungkan waktu musim panas.
  • Nilai Waktu Joda harus identik dengan nilai di halaman pengaturan aplikasi. Contohnya, jika pengaturan zona waktunya adalah paris, nilai zona waktu di URL Pull API harus timezone=Europe%2fParis.
  • Menarik data di zona waktu yang dipilih hanya tersedia dari tanggal saat pengaturan zona waktu dibuat. Data apa pun sebelum tanggal perubahan menggunakan YTC sebagai zona waktu. 

Laporan Google Ads yang difilter

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

Laporan Facebook yang difilter

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&&media_source=facebook
Parameter opsional untuk laporan Protect360
parameter Deskripsi
 pid

Untuk menyaring laporan berdasarkan sumber media tertentu gunakan parameter pid. Contohnya, untuk mendapatkan data abc_net, pid=abc_net.

zona waktu

Pilih zona waktu yang dipilih untuk mengembalikan data.

Jika zona waktu tidak dikirim, data dikembalikan menggunakan UTC.

Templat termasuk parameter zona waktu

Contohnya: zona waktu=dipilih: Gunakan untuk mendapatkan data menggunakan zona waktu khusus aplikasi .

KPI

Parameter Protect360 adalah sama antara Pull API dan Master API. 

Atribusi view-through (VTA) KPI

  • Untuk mendapatkan VTA KPI, tambah parameter attribution_touch_type=impression ke URI laporan agregat Pull API seperti yang diperinci pada contoh.
  • 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
  • Anda juga dapat menambahkan parameter &media_source untuk membatasi laporan ke sumber media tertentu seperti yang digambarkan pada contoh berikut.
  • Beberapa VTA KPI, seperti klik, tayangan iklan, dan API biaya, tidak memiliki nilai terkait dengannya dan menampilkan nilai N/A. 
Contoh Contoh URI
Khusus VTA  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

VTA dan sumber 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

Pull API untuk pengembang

Prinsip implementasinya

Prasyarat:

Biasakan diri Anda dengan Panduan Pull API untuk anggota tim.

Pertimbangkan:

  • Untuk setiap jenis laporan yang tersedia, ada templat URI di dashboard.
  • Anda mengubah templat untuk mendapatkan data yang Anda perlukan. Contohnya, dengan mengatur rentang tanggal dan filter berdasarkan parameter.
  • Parameter untuk data lengkap dan laporan data agregat berbeda dan diperinci di sesi laporan.
Dasar-Dasar Pull API
Jalur

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

Parameter jalur

app_id

  • Pengenal aplikasi seperti ditemukan di AppsFlyer.
  • Masukkan ID aplikasi persis seperti yang ditemukan di AppsFlyer.
  • Awalan aplikasi iOS dengan id

report_type 

  • Tentukan jenis laporan. Daftar laporan dan URI terkait ada di dashboard. Buka Integrasi > Akses API. 
Metode HTTP

DAPATKAN

Parameter kueri wajib
Parameter Deskripsi
Contoh 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: Token Pull API untuk autentikasi

Parameter lainnya

Parameter berbeda-beda tergantung 

 Contoh

Contoh panggilan URI termasuk parameter tambahan: 

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

Contoh skrip

Integrasikan Pull API ke dalam skrip untuk mengambil data.

  • Sesuai kebutuhan, edit skrip dalam hal jenis laporan, rentang data, dan filter. 
  • Contoh ini menggunakan laporan instalasi.
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);
    }
  }
}

Informasi Tambahan

Perbedaan antara Pull API V4 dan V5. 

Data lengkap: API V4 masih tersedia untuk digunakan. Tidak ada perubahan yang dilakukan pada format file dan header.

Data agregat (V5):

Pada V5.0, bidang tambahan berikut disediakan ketika media_source=facebook:

  • ID kampanye
  • Nama Adset
  • ID adset
  • Nama Ad (Adgroup)
  • ID Ad (Adgroup)

Karakteristik dan batasan

Sifat
Sifat Status Komentar 
Akses jaringan iklan   
Akses agensi  
Transparansi agensi  
Mata uang khusus aplikasi   
Zona waktu khusus aplikasi  
Kesegaran data Waktuaktual  
Data historis  
Data non-organik  
Data organik  
Batasan tingkat

Batasan API untuk data agregat and data lengkap

Keterbatasan ukuran Ya
  • Maksimal pengembalian panggilan API 200 ribu baris.
  • Jika laporan memiliki tepat 200 ribu baris, maka anggaplah baris tidak ada.
  • Lakukan beberapa panggilan API, menggunakan parameter dari/hingga yang mencakup waktu dalam satu hari.  
Akses anggota tim

Hanya admin yang bisa mendapatkan token Pull API.

Kode kesalahan dan penyelesaian masalah API

Kode kesalahan dan solusi
Status Kode Symtom/message Solusi
OK 200 File CSV kosong

addtional_fieldsmuncul lebih dari sekali di URI

OK

200

File CSV kosong

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.

Gunakan hingga dan dari untuk membatasi rentang tanggal ke 3 bulan atau kurang.

Bad request

400

Your API calls limit has been reached for report type

-
Tidak berwenang

401

Token API yang disediakan tidak valid 

Ask the admin for the current token
Tidak berwenang

401

Akun dapat ditangguhkan.

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. 

Apakah artikel ini membantu?

Artikel dalam bagian ini