Menggunakan data agregat Pull API

Sekilas: Gunakan URI untuk mendapatkan laporan gabungan AppsFlyer Anda dalam file CSV.

PullAPIAverage_us-en.png

  Apakah Anda mencari data lengkap Pull API?

Data lengkap Pull API

Karakteristik data agregat Pull API

  • Laporan kembali sebagai file CSV.
  • Tingkat kesegaran data sama dengan laporan ekuivalen di halaman Data Ekspor.
  • Filter menurut opsi yang tersedia: Sumber media dan rentang tanggal.
  • Keunggulan tambahan dalam Pull API adalah:
    • Kemampuan memfilter 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. Buka Integration > API Access.
    • Pengembang BI mendapatkan laporan dengan menyematkan URI dalam skrip. 

Contoh templat URI

ketegori  UA Penargetan Ulang* Protect360
Partners (media source)

Partners by date

Harian

Geo

Geo berdasarkan tanggal

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

Laporan kinerja agregat tersedia melalui Pull API

 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 V1.0 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:

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. Ganti token placeholder dengan token Pull API yang disediakan oleh admin.
      Contoh: Ganti token placeholder sehingga &api_token=12345678-1234-1234-1234-123456789012 Catatan! Tidak ada spasi atau tanda baca lainnya. 
    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.
    Parameter tambahan dapat diatur untuk menyesuaikan laporan, misalnya, memilih sumber media tertentu, untuk menghasilkan data penargetan ulang, dll. Bagian berikutnya berisi daftar parameter yang tersedia. 

Parameter Pull API data agregat

URI laporan agregat dan parameter

Parameter wajib URI agregat 
Parameter Deskripsi
api_token Token API V1.0. Pada contoh 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.

  • Contoh: media_source=facebook
attribution_touch_type

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

Contoh: attribution_touch_type=impression

currency

Mata uang pendapatan dan biaya

Laporan Pull API agregat selalu menggunakan mata uang khusus aplikasi.

atribusi ulang

Dapatkan data konversi penargetan ulang.

  • [Default] Jika salah, kampanye data akuisisi pengguna (UA) kembali.
  • Jika benar, penargetan ulang konversi akan menghasilkan.
  • 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
URI
  • Dapatkan URI Protect360 dari dashboard.
  • Ubah URI seperti yang dijelaskan di sini. 
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.
  • Anda dapat menggunakan parameter dengan laporan agregat apa pun yang tersedia. Cukup salin URI dari antarmuka pengguna, dan tambahkan parameter.
  • 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&attribution_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. Buka Integrasi > Akses API.
  • 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? dari= 01-01-2020 ?&ke= 10-01-2020 &api_token=api_token&currency= lebih disukai

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 Komentar 
Jenis token API diperlukan AppsFlyerAdmin_us-en.pngToken API V1.0
Akses jaringan iklan N
Akses agensi Y
Transparansi agensi Y
Mata uang khusus aplikasi  Y
Zona waktu khusus aplikasi Y
Kesegaran data Waktuaktual
Data historis Y
Data non-organik Y
Data organik Y
Batasan tingkat

Batasan

Keterbatasan ukuran
  • 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.  
Perubahan nama kampanye Laporan Pull API tidak mendukung perubahan nama kampanye

Kode kesalahan dan penyelesaian masalah API

Kode kesalahan dan solusi
Status Kode Petunjuk/pesan Solusi
OK 200 File CSV kosong
  • addtional_fieldsmuncul lebih dari sekali di URI
  • Pastikan bahwa baik tanggal dari dan sampai memiliki format yyyy-mm-dd
OK

200

 

Tidak ada token API yang ditemukan di URI

Bad request (permintaan bermasalah).

400

Lookback historis Raw Reports (Laporan Lengkap) dibatasi sampai 90 hari.

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

Bad request (permintaan bermasalah).

400

Batas panggilan API Anda telah tercapai untuk jenis laporan yang diberikan

-
Tidak berwenang

401

Token API yang disediakan tidak valid 

Tanyakan admin untuk token saat ini.
Tidak berwenang

401

Akun dapat ditangguhkan

Masuk ke dashboard dan periksa status akun. 

Tidak ditemukan

404

Halaman pesan kesalahan AppsFlyer 404 ditampilkan

  • Pastikan id aplikasi sudah benar. Aplikasi iOS harus dimulai dengan id
  • Token tidak sesuai dengan aplikasi. Apakah Anda menggunakan token yang benar? 
Apakah artikel ini membantu?