Pull API - Kéo Báo cáo AppsFlyer bằng API

Báo cáo Dữ liệu thô cung cấp tất cả dữ liệu cho các lượt cài đặt và sự kiện trong ứng dụng.

Các tham số API - Bắt buộc

api_token

Là Khóa Ủy quyền API bên ngoài của người dùng: "{Account owner API Key should be used}"

từ

Ngày báo cáo ở dạng "yyyy-mm-dd" hoặc "yyyy-mm-dd hh:mm". Ví dụ: 2010-01-01 hoặc 2010-01-01%2000%3A15 - (Tham số giờ chỉ dành cho báo cáo thô).

tới

Ngày kết thúc báo cáo. Định dạng giống với từ

Thông số Lọc API - Tùy chọn

Lọc theo Nguồn phương tiện Truyền thông

Lọc các báo cáo để chỉ liệt kê một nguồn phương tiện cụ thể có sẵn bằng cách thêm tham số danh mục và nguồn phương tiện vào URL yêu cầu:

danh mục

Để nhận dữ liệu Facebook, thiết lập category=facebook trên URL. Để nhận dữ liệu Twitter, thiết lập category=twitter trên URL. Đối với bất kỳ nguồn phương tiện truyền thông nào, thiết lập category=standard

media_source

Cung cấp tên của một nguồn phương tiện truyền thông (media_source=[SOURCE_NAME]) như xuất hiện trên bảng điều khiển của AppsFlyer.

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

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

Lọc theo Tên Sự kiện

Lọc dữ liệu báo cáo sự kiện trong ứng dụng thô để chỉ bao gồm một sự kiện cụ thể, bằng cách sử dụng tham số event_name. Để lọc nhiều sự kiện, hãy sử dụng danh sách các sự kiện được phân tách bằng dấu phẩy.

Ví dụ: event_name=af_purchase,ftd

Đối với Xuất báo cáo Nhắm mục tiêu lại

Sử dụng reattr=true để nhận được kết quả được phân bổ tới nhứng chiến dịch nhắm mục tiêu lại.

Các Trưởng Bổ Sung

Thông qua API Pull, bạn có thể thêm một số trường, hoàn thành toàn cảnh dữ liệu thô và các sự kiện trong ứng dụng trong một số trường hợp.

Để thêm các trường mới, hãy thêm "&additional_fields=" vào liên kết theo dõi, theo sau bởi danh sách các sự kiện được phân tách bởi dấu phẩy. Xem các ví dụ về API Pull ở bên dưới.

Kết quả là một báo cáo CSV có các cột được thêm vào, có chứa thông tin khi có liên quan.

Múi giờ và Tiền tệ

timezone (tùy chọn)

Bạn có thể lấy dữ liệu thô API Pull trong MỌI múi giờ hợp lệ:

1. Thêm &timezone=[Joda-Time] trong liên kết API Pull để nhận được báo cáo trong múi giờ ưa thích (xem lưu ý bên dưới)
2. Thêm &timezone=[Giá trị số] trong liên kết API Pull để nhận được báo cáo trong múi giờ số đã chỉ định. Ví dụ: đối với múi giờ UTC+10: 00 thêm vào liên kết &timezone=%2B10:00
   Chỉ có thể sử dụng giá trị số cho múi giờ khi kéo báo cáo dữ liệu thô. Không hoạt động với báo cáo tổng hợp như báo cáo hiệu suất.
3. Nếu không, dữ liệu được nhận trong múi giờ UTC mặc định.

tiền tệ (tùy chọn)

Được sử dụng để nhận dữ liệu Doanh thu và Chi phí bằng loại tiền bạn đã chọn, thay vì bằng USD, là tùy chọn mặc định. Điều này được cài đặt bởi quản trị viên tài khoản.

Để nhận dữ liệu bằng loại tiền bạn muốn, vui lòng thêm thông tin sau vào liên kết yêu cầu của bạn: &currency=preferred

được sử dụng để nhận dữ liệu Doanh thu và Chi phí bằng tiền tệ bạn đã chọn.

Chính sách và Giới hạn Sử dụng API

Chính sách API của AppsFlyer đảm bảo chất lượng dịch vụ cao cho người dùng API Pull bằng cách giới hạn tổng số yêu cầu hàng ngày và ngăn chặn lạm dụng dịch vụ.

Xem chi tiết về chính sách API dành cho dữ liệu tổng hợp qua API Pull và dành cho dữ liệu thô qua API Pull.

Số lượng bản ghi tối đa cho mỗi báo cáo là 200K. Nếu bạn nhận được một báo cáo có 200K hàng thì bạn có một số kết quả bị bỏ sót.

Bảo mật API

Tất cả các liên kết Pull API sử dụng các kết nối https được mã hóa an toàn.

Để biết thêm chi tiết, hãy truy cập tại đây.

Ví dụ về Liên kết Pull API

Phiên bản API (V5)

• Không thay đổi:

  • API hiện tại (v4) vẫn có sẵn để sử dụng

  • Phiên bản không áp dụng bất kỳ thay đổi nào đối với định dạng tệp hoặc tiêu đề

Báo cáo Hiệu suất cung cấp thông tin chi tiết về hiệu quả của các chiến dịch quảng cáo.

Các tham số API - Bắt buộc

api_token

Là Khóa Ủy quyền API bên ngoài của người dùng: "{Account owner API Key should be used}". Mã thông báo API chỉ được hiển thị cho chủ tài khoản

Thông số Lọc API - Tùy chọn

Lọc theo nguồn phương tiện truyền thông

Lọc các báo cáo để chỉ liệt kê một nguồn phương tiện cụ thể có sẵn bằng cách thêm tham số danh mục và nguồn phương tiện vào URL yêu cầu:

danh mục

Để nhận dữ liệu Facebook, thiết lập category=facebook trên URL. Đối với bất kỳ nguồn phương tiện truyền thông nào, thiết lập category=standard

media_source

Cung cấp tên của một nguồn phương tiện truyền thông (media_source=[SOURCE_NAME]) như xuất hiện trên bảng điều khiển của AppsFlyer.

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

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

Múi giờ và Tiền tệ

timezone (tùy chọn)

Bạn có thể nhận dữ liệu tổng hợp thông qua API Pull trong UTC hoặc múi giờ ưa thích của ứng dụng, được thiết lập trong trang Cài đặt ứng dụng:

1. Thêm &timezone=[selected Joda-Time] trong liên kết API Pull để nhận được báo cáo trong múi giờ ưa thích của ứng dụng (xem lưu ý bên dưới)

2. Nếu không, dữ liệu được nhận trong múi giờ UTC mặc định.

tiền tệ (tùy chọn)

Được sử dụng để nhận dữ liệu Doanh thu và Chi phí bằng loại tiền bạn đã chọn, thay vì bằng USD, là tùy chọn mặc định. Điều này được cài đặt bởi quản trị viên tài khoản.

currency=preferred

được sử dụng để nhận dữ liệu Doanh thu và Chi phí bằng tiền tệ bạn đã chọn.

Chính sách API

Chính sách API của AppsFlyer đảm bảo chất lượng dịch vụ cao cho người dùng API Pull bằng cách giới hạn tổng số yêu cầu hàng ngày và ngăn chặn lạm dụng dịch vụ.

Số lượng bản ghi tối đa cho mỗi báo cáo là 200K. Nếu bạn nhận được một báo cáo có 200K hàng thì bạn có một số kết quả bị bỏ sót.

Bảo mật API

Tất cả các liên kết Pull API sử dụng các kết nối https được mã hóa an toàn.

Để biết thêm chi tiết, hãy truy cập tại đây.

Ví dụ về Liên kết Pull API

Phiên bản API (V5)

• Thay đổi:

  • Trong các báo cáo hiệu suất Phiên bản (v5) có chứa nhiều đối tác, chỉ nhóm dữ liệu Facebook theo chiến dịch. Báo cáo hiệu suất chỉ chứa dữ liệu Facebook (bằng cách chỉ định &category=facebook), hãy nhóm dữ liệu theo chiến dịch và nhóm quảng cáo.

  • Trang xuất dữ liệu cho các báo cáo tổng hợp sử dụng phiên bản API (v5)

• Không thay đổi:

  • API hiện tại (v4) vẫn có sẵn để sử dụng

  • Phiên bản không áp dụng bất kỳ thay đổi nào đối với định dạng tệp hoặc tiêu đề

Dữ liệu tổng hợp P360 như xuất hiện trong bảng phát hiện nâng cao trong bảng điều khiển.

Các tham số API - Bắt buộc

api_token

Là Khóa Ủy quyền API bên ngoài của người dùng: "{Account owner API Key should be used}"

từ

Ngày báo cáo ở dạng "yyyy-mm-dd" hoặc "yyyy-mm-dd hh:mm". Ví dụ: 2010-01-01 hoặc 2010-01-01%2000%3A15 - (Tham số giờ chỉ dành cho báo cáo thô).

tới

Ngày kết thúc báo cáo. Định dạng giống như từ

KPI - Bắt buộc

Tham số Protect360 ở API kéo và API chính là giống nhau. 

Để biết danh sách KPI có sẵn và mô tả về chúng, truy cập vào đây.

Thông số Lọc API - Tùy chọn

Lọc theo nguồn phương tiện truyền thông

Lọc các báo cáo để chỉ liệt kê một nguồn phương tiện cụ thể có sẵn bằng cách thêm:
pid=tên nguồn phương tiện truyền thông.

Múi giờ và Tiền tệ

timezone (tùy chọn)

Bạn có thể nhận dữ liệu tổng hợp P360 thông qua API Pull trong UTC hoặc múi giờ ưa thích của ứng dụng, được thiết lập trong trang Cài đặt ứng dụng:

1. Thêm &timezone=preferred trong liên kết API Pull để nhận được báo cáo trong múi giờ ưa thích của ứng dụng

2. Nếu không, dữ liệu được nhận trong múi giờ UTC mặc định.

tiền tệ (tùy chọn)

Được sử dụng để nhận dữ liệu Doanh thu và Chi phí bằng loại tiền bạn đã chọn, thay vì bằng USD, là tùy chọn mặc định. Điều này được cài đặt bởi quản trị viên tài khoản.

currency=preferred

được sử dụng để nhận dữ liệu Doanh thu và Chi phí bằng tiền tệ bạn đã chọn.

Bảo mật API

Tất cả các liên kết Pull API sử dụng các kết nối https được mã hóa an toàn.

Để biết thêm chi tiết, hãy truy cập tại đây.

Ví dụ về Liên kết Pull API

Phiên bản API (V5)

• Thay đổi:

  • Trong các báo cáo hiệu suất Phiên bản (v5) có chứa nhiều đối tác, chỉ nhóm dữ liệu Facebook theo chiến dịch. Báo cáo hiệu suất chỉ chứa dữ liệu Facebook (bằng cách chỉ định &category=facebook), hãy nhóm dữ liệu theo chiến dịch và nhóm quảng cáo.

  • Trang xuất dữ liệu cho các báo cáo tổng hợp sử dụng phiên bản API (v5)

• Không thay đổi:

  • API hiện tại (v4) vẫn có sẵn để sử dụng

  • Phiên bản không áp dụng bất kỳ thay đổi nào đối với định dạng tệp hoặc tiêu đề

Các tập lệnh để truy xuất dữ liệu từ API Pull

Thông thường, sẽ thuận tiện hơn khi thiết lập các tập lệnh tự động để lấy dữ liệu theo định kỳ.

Dưới đây bạn có thể tìm thấy các tập lệnh để lấy dữ liệu từ API Pull. Các tập lệnh mẫu kéo dữ liệu từ báo cáo cài đặt. Chỉnh sửa tập lệnh để phù hợp với yêu cầu của bạn về mặt báo cáo và dữ liệu mà bạn muốn truy xuất.

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);
    }
  }
}

request = require('request');
const fs = require('fs');

const appID = '<APP_ID>';
const reportType = '<REPORT_TYPE>';
const apiToken = '<API_TOKEN>';
const from = '<FROM_DATA>';
const to = '<T0_DATE>';
const requestUrl = `https://hq.appsflyer.com/export/${appID}/${reportType}/v5?api_token=${apiToken}&from=${from}&to=${to}`;

request(requestUrl, (error, response, body) => {
  if (error) {
    console.log('There was a problem retrieving data:', error);
  }
  else if (response.statusCode != 200) {
    if (response.statusCode === 404) {
      console.log('There is a problem with the request URL. Make sure that it is correct');
    } else {
      console.log('There was a problem retrieving data:', response.body);
    }
  } else {
    fs.writeFile(`${appID}-${reportType}-${from}-to-${to}.csv`, response.body, (err) => {
      if (err) {
        console.log('There was a problem writing to file: ', err);
      } else {
        console.log('File was saved');
      }
    });
  }
  
});

import requests

app_id = '<APP_ID>'
report_type = '<REPORT_TYPE>'

params = {
  'api_token': '<API_TOKEN>',
  'from': 'FROM_DATE',
  'to': 'TO_DATE'
}

request_url = 'https://hq.appsflyer.com/export/{}/{}/v5'.format(app_id, report_type)

res = requests.request('GET', request_url, params=params)

if res.status_code != 200:
  if res.status_code == 404:
    print('There is a problem with the request URL. Make sure that it is correct')
  else:
    print('There was a problem retrieving data: ', res.text)
else:
  f = open('{}-{}-{}-to-{}.csv'.format(app_id, report_type, params['from'], params['to']), 'w', newline='', encoding="utf-8")
  f.write(res.text)
  f.close()

using System;
using RestSharp;
using System.Text;
using System.Net;
using System.IO;
namespace Pull_API
{
  class PullAPi
  {
    static void Main(string[] args)
    {
      var appID = "<APP_ID>";
      var reportType = "<REPORT_TYPE>";
      var apiToken = "<API_TOKEN>";
      var from = "<FROM_DATE>";
      var to = "<TO_DATE>";

      var requestUrl = "https://hq.appsflyer.com/export/" + appID + "/" + reportType + "/v5?api_token=" + apiToken + "&from=" + from + "&to=" + to;
      
      var client = new RestClient(requestUrl);
      var request = new RestRequest(Method.GET);
      request.AddHeader("Accept", "text/csv; charset=UTF-8");

      IRestResponse response = client.Execute(request);
      HttpStatusCode statusCode = response.StatusCode;
      int numericStatusCode = (int)statusCode;

      if(numericStatusCode != 200){

        if(numericStatusCode == 404){
          Console.WriteLine("There is a problem with the request URL. Make sure that it is correct.");
        } else {
          Console.WriteLine("There was a problem retrieving data: " + response.Content); 
        }
      } else {
        System.IO.File.WriteAllText(@"" + appID + "-" + reportType + "-" + from + "-to-" + to + ".csv", response.Content);
        Console.WriteLine("Data retrieved succesfully"); 
      }
    }
  }
}

<?

$appID = '<APP_ID>';
$reportType = '<REPORT_TYPE>';
$apiToken = '<API_TOKEN>';
$from = '<FROM_DATE>';
$to = '<TO_DATE>';
$query = http_build_query([
'api_token' => $apiToken,
'from' => $from,
'to' => $to
]);
$requestUrl = 'https://hq.appsflyer.com/export/' . $appID . '/' . $reportType . '/v5?'.$query;
$report = $appID . '-' . $report . '-' . $from . '-to-' . $to; 

$curl = curl_init($requestUrl);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_ENCODING, "");
curl_setopt($curl, CURLOPT_NOSIGNAL, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_MAXREDIRS, 10);
curl_setopt($curl, CURLOPT_FAILONERROR, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 100);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
 "cache-control: no-cache",
 "Accept: text/csv; charset=UTF-8"
));


$response = curl_exec($curl);
$info = curl_getinfo($curl);
$err = curl_error($curl);
curl_close($curl);

var_dump($response);
if ($err) {
 echo $info['http_code']; 
 echo "cURL Error #: " . $err . '. ';
 if ($info['http_code'] == 404) {
  echo 'There is a problem with the request URL. Make sure that it is correct';
 } 
 if ($info['http_code'] == 401) {
  echo 'There was a problem retrieving data: authentication failed.';
 }
 
 echo PHP_EOL;

} else {
 $fp = fopen($report, 'w+');
 fwrite($fp, $response);
 fclose($fp);
 echo $response;
}
?>

Lỗi API và Khắc phục sự cố

Phần này thảo luận về các lỗi API phổ biến và cách xử lý chúng.