Sơ lược: API báo cáo Nhóm người cung cấp cho nhà quảng cáo theo cách có lập trình để lấy dữ liệu Nhóm người. Sử dụng API để tích hợp dữ liệu Nhóm người vào BI và hệ thống tự động hóa tiếp thị.
API báo cáo Nhóm người
API báo cáo Nhóm người được sử dụng để lấy dữ liệu hiệu suất chiến dịch theo nhóm từ nền tảng AppsFlyer. API này có chức năng tương đương với bảng điều khiển Nhóm người.
Những điều cần lưu ý dành cho nhà phát triển
- Ngày: Ngày hoặc phạm vi ngày đề cập đến ngày có giá trị lâu dài (LTV), nghĩa là ngày mà người dùng phân bổ (chuyển đổi) chứ không phải ngày của chính hoạt động.
- Giá trị Boolean: true hoặc false (phân biệt chữ hoa chữ thường).
- Lưu lượng truy cập của đại lý minh bạch và không minh bạch: Nguồn truyền thông của lưu lượng truy cập do đại lý kiểm soát luôn là đại lý chứ không phải nguồn truyền thông ban đầu. Hiện tại, phiên bản UI của nhóm người hoạt động khác.
- Ứng dụng duy nhất: API Nhóm người là một giải pháp ứng dụng duy nhất. Điều này trái ngược với bảng điều khiển Nhóm người hỗ trợ nhiều ứng dụng trong một lệnh gọi duy nhất.
- Tính cập nhật của dữ liệu: Xem phần các đặc điểm và hạn chế.
Hướng dẫn API
Các phần này chứa thông tin cần thiết để bạn tạo và sử dụng API Nhóm người.
Dữ kiện về API Nhóm người
Tổng quan | Lệnh gọi API bao gồm đường dẫn, tiêu đề và JSON chứa truy vấn dữ liệu. Dữ liệu được trả về theo mặc định trong tệp CSV. |
Đường dẫn |
|
Thông số đường dẫn (bắt buộc) |
|
Thông số truy vấn (tùy chọn) |
Kết quả trả về dưới dạng CSV hoặc JSON. Cấu trúc tệp CSV ở dạng bảng trong khi cấu trúc của bản ghi JSON được định hướng. |
Phương thức HTTP | POST |
Loại nội dung được chấp nhận | application/json |
Ủy quyền |
|
Giới hạn ngày |
|
Giới hạn tỷ lệ |
|
Giá trị Boolean | Luôn viết thường: true, false |
Tiêu đề yêu cầu
Mã khóa |
Giá trị | Bắt buộc |
---|---|---|
Content-Type | application/json |
Có |
Authorization | Truy cập api_token_placeholder |
Có |
Chấp nhận | application/json |
Có |
Lọc và nhóm thông số
Sử dụng các thông số bộ lọc sau để có được dữ liệu cần thiết.
Tên thông số |
Mô tả | Bắt buộc |
---|---|---|
cohort _type |
Loại phân bổ nhóm người (chuyển đổi) là một trong những loại sau:
|
Có |
min_cohort_size |
Kích thước nhóm người tối thiểu được sử dụng để giảm số lượng bản ghi được trả về bằng cách loại trừ các nhóm người có ít người dùng. Điều này có nghĩa là KPI người dùng có giá trị bằng hoặc lớn hơn giá trị được chỉ định.
|
Không |
bắt đầu |
Giới hạn thấp hơn của phạm vi ngày phân bổ LTV. Ngày sớm nhất được hỗ trợ là 720 ngày trước ngày hiện tại.
|
Có |
tới |
Giới hạn cao hơn của phạm vi ngày phân bổ LTV
|
Có |
tính chi tiết |
Mức độ chi tiết hàng giờ trong 72 giờ trước đó bằng cách đặt
"granularity": "hour",
"from": "2021-12-01 14:00:00", "to": "2021-12-03 11:00:00",
|
Không |
partial_data |
Để tránh làm sai lệnh dữ liệu và hiểu sai Nhóm người trả về dữ liệu của những ngày đầy đủ. Tuy nhiên, dữ liệu của các ngày một phần có thể hữu ích. Số ngày nhóm người hoàn chỉnh cho một truy vấn được tính bằng chênh lệch giữa ngày hôm nay và ngày kết thúc.
Ví dụ: Vào ngày 10 tháng 5, số ngày nhóm người hoàn chỉnh cho người dùng chuyển đổi trong khoảng thời gian từ ngày 1 đến ngày 30 tháng 4 là 10.
Lưu ý: Dữ liệu một phần chỉ được phép khi loại tổng hợp là tích lũy. |
Không |
bộ lọc |
Lọc dữ liệu và số ngày theo khoảng thời gian sẽ được trả về. Chọn bộ lọc từ danh sách phương diện bộ lọc.
|
Không |
Sử dụng các thông số nhóm sau để gộp các cột bổ sung và giúp báo cáo của bạn ít chi tiết hơn.
Tham số |
Giá trị | Bắt buộc |
---|---|---|
nhóm |
|
Có |
Lựa chọn và định dạng KPI
- Bảng liệt kê các KPI có sẵn và các chức năng liên quan của chúng. Khi bạn gọi ra một KPI, tất cả các chức năng của API đó sẽ trả về.
- Các KPI sau luôn trả về: người dùng, ecpi và chi phí
- Chọn một KPI bổ sung cho mỗi lệnh gọi.
Hàm | ||||||
---|---|---|---|---|---|---|
Mặc định/ Tùy chọn | KPI (Tên phương diện) | Số đếm | cvr (tỷ lệ chuyển đổi) | Xếp hạng | Tổng | Người dùng duy nhất |
Số | Tỷ lệ phần trăm | Tỷ lệ phần trăm | Số | Số | ||
Luôn luôn | người dùng | Y | - | - | - | - |
Luôn luôn | ecpi | - | - | Y | - | - |
Luôn luôn | cost | - | - | - | Y | - |
Tùy chọn | "event_name" (4) |
Y | Y | - | Y (3) | Y |
Tùy chọn | revenue | Y | - | - | Y | - |
Tùy chọn | ROAS | - | - | Y | - | - |
Tùy chọn | roi | - | - | Y | - | - |
Tùy chọn | sessions | Y | - | Y | - | Y(1) |
Tùy chọn | lượt gỡ cài đặt (2) | Y | - | Y | - | - |
(1) Các phiên duy nhất trả về khi aggregation_type=on_day (2) Không khả dụng khi cohort_type=unified (3) Tổng có nghĩa là tổng doanh thu do sự kiện tạo ra. Trong báo cáo, điều này được biểu thị bằng (4) Lưu ý! Tên sự kiện có phân biệt chữ hoa chữ thường |
Tham số |
Giá trị | Thông số bắt buộc |
---|---|---|
kpi |
Chọn một KPI từ các KPI có sẵn. Trong tương lai, chúng tôi dự định cho phép lựa chọn nhiều KPI.
|
Có |
Trình bày các hàm KPI
Các thông số định dạng KPI sau đây đặt định dạng của KPI được trả về.
Tham số |
Giá trị | Bắt buộc |
---|---|---|
preferred_currency |
Đơn vị tiền tệ doanh thu KPI
|
Không |
preferred_timezone |
Múi giờ của phạm vi dữ liệu
|
Không |
aggregation_type |
|
Có |
per_user |
Chia chức năng KPI theo số lượng người dùng ứng dụng. Chỉ áp dụng cho các KPI có liên quan.
|
Không |
Danh sách nhóm theo và lọc theo phương diện
Tên phương diện |
Giá trị API phương diện |
Nhóm |
Bộ lọc |
---|---|---|---|
Quảng cáo |
af_ad |
Y |
Y |
ID Quảng cáo |
af_ad_id |
Y |
Y |
Chiến dịch |
c |
Y |
Y |
ID Chiến dịch |
af_c_id |
Y |
Y |
Kênh |
af_channel |
Y |
Y |
Nguồn Truyền thông |
pid |
Y |
Y |
Thông số Phụ 1 |
af_sub1 |
Y |
Y |
Từ khóa |
af_keywords |
Y |
Y |
Đại lý |
af_prt |
Y |
Y |
Loại Chuyển đổi (1) |
cohort_type |
Y |
Y |
ID Trang |
site_id |
Y |
Y |
Loại Doanh thu (2) |
revenue_type |
x |
Y |
Loại Tương tác Được phân bổ (3) |
attributed_touch_type |
Y |
Y |
Bộ quảng cáo |
af_adset |
Y |
Y |
ID Bộ quảng cáo |
af_adset_id |
Y |
Y |
Quốc gia |
geo |
Y |
Y |
Ngày (ngày cài đặt/phân bổ lại/tương tác lại trong ngữ cảnh của cohort_type đã chọn) |
date |
Y |
x |
Khoảng thời gian |
period
|
x |
Y |
Lưu ý: Tùy chọn phương diện: (1) Loại Chuyển đổi:
(2) Loại Doanh thu: click , impression , TV , pre-installed
|
Ví dụ về Curl
Ví dụ này chứa lệnh gọi API hoàn chỉnh.
curl -L -X POST 'https://hq1.appsflyer.com/api/cohorts/v1/data/app/<insert your app_id here>?format=<insert results format here>' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <cohort_api_token_placeholder. Note the token has more than 700 characters.>' \
-H 'Accept: application/json' \
--data-raw '{
"cohort_type": "user_acquisition",
"min_cohort_size": 1,
"preferred_timezone": false,
"from": "2020-01-01",
"to": "2020-01-31",
"filters": {
"period": [
0,
1,
2,
10,
30,
60
],
"geo": [
"US",
"CN"
],
"pid": [
"Meta ads",
"googleadwords_int"
]
},
"preferred_currency": true,
"aggregation_type": "on_day",
"per_user": false,
"groupings": [
"pid",
"date"
],
"kpis": [
"sessions"
]
}'
Các tệp mẫu được trả về: CSV, JSON
Ví dụ về Python
import http.client
import mimetypes
conn = http.client.HTTPSConnection("hq1.appsflyer.com")
payload = "{\r\n \"cohort_type\": \"user_acquisition\",\r\n \"min_cohort_size\": 1,\r\n \"preferred_timezone\": false,\r\n \"from\": \"2020-05-01\",\r\n \"to\": \"2020-05-10\",\r\n \"preferred_currency\": true,\r\n \"aggregation_type\": \"cumulative\",\r\n \"per_user\": false, \r\n \"groupings\": [\r\n \"pid\",\r\n \"date\"\r\n ],\r\n \"kpis\": [\r\n \"roas\"\r\n ]\r\n}"
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer [Enter token here]',
'Accept': 'application/json',
'Content-Type': 'application/json'
}
conn.request("POST", "/api/cohorts/v1/data/app/[My App ID here]?format=csv", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Ví dụ về trường hợp sử dụng
Ví dụ 1: Giữ chân
Tỷ lệ giữ chân nguồn phương tiện (phiên) của người dùng đã cài đặt ứng dụng trong tháng 1 vào ngày 7, 14 và 28
{
"per_user": false,
"groupings": [
"pid"
],
"filters": {
"period": [
7, 14, 28
]
},
"partial_data": false,
"aggregation_type": "on_day",
"min_cohort_size": 1,
"cohort_type": "user_acquisition",
"from": "2021-01-01",
"to": "2021-01-30",
"kpis": [
"sessions"
]
}
Ví dụ 2: Giao dịch mua trong chiến dịch
Doanh thu sau cài đặt nhóm người của ngày 3 trên mỗi chiến dịch
{
"per_user": false,
"groupings": [
"c"
],
"filters": {
"period": [
3
],
"c":[
"example_campaign_name"
]
},
"partial_data": false,
"aggregation_type": "cumulative",
"min_cohort_size": 1,
"cohort_type": "user_acquisition",
"from": "2021-01-01",
"to": "2021-01-30",
"kpis": [
"Checkout Start"
]
}
Ví dụ 3: Hoạt động ngày hôm qua
Người dùng đã chuyển đổi (cài đặt, tương tác lại, phân bổ lại) trong khoảng thời gian chuyển đổi nhất định đã thực hiện hoạt động gì vào ngày hôm qua?
Dữ liệu sử dụng có sẵn qua Nhóm người cho Data Locker. Khoảng thời gian chuyển đổi được giới hạn trong 360 ngày trước đó.
Thông tin bổ sung
Mã phản hồi và khắc phục sự cố
Mã phản hồi |
Nội dung |
Nhận xét |
---|---|---|
200 | OK |
Dữ liệu hợp lệ được trả về |
200 | OK |
|
401 | Không được phép |
|
404 | Không tìm thấy |
|
422 | Thực thể không thể xử lý |
Những lý do phổ biến đối với mã lỗi này là:
|
Cấu trúc tên tệp CSV
Tên được phân bổ cho tệp CSV trả về được tạo từ truy vấn API. Cấu trúc được trình bày chi tiết trong bảng sau.
Tên tệp CSV mẫu
cohort_aggregation_type_per_user_kpi_report_app_id_from_to_timezone_currency_hash.csv
Biến | Những giá trị có thể có |
---|---|
aggregation_type |
|
per_user |
|
kpi | Ví dụ: sessions |
app_id | Id ứng dụng được yêu cầu |
từ | Ngày bắt đầu: định dạng yyyy-mm-dd |
tới | Ngày kết thúc: định dạng yyyy-mm-dd |
múi giờ | Mặc định múi giờ UTC |
tiền tệ | Mặc định mã tiền tệ USD |
hash |
Độ dài chuỗi băm chữ và số=5 |
Sử dụng bộ lọc khoảng thời gian
Khoảng thời gian đề cập đến ngày sau phân bổ, trong đó khoảng thời gian 0 là ngày phân bổ. Ví dụ, người dùng cài đặt ứng dụng vào ngày 1 tháng 1. Đây là ngày phân bổ. Giao dịch mua được thực hiện vào khoảng thời gian 0 có nghĩa là giao dịch được thực hiện vào ngày 1 tháng 1. Giao dịch mua được thực hiện vào khoảng thời gian 3 có nghĩa là giao dịch mua đó được thực hiện vào ngày 4 tháng 1. Tương tự, người dùng cài đặt vào ngày 11 tháng 1 thì đây là khoảng thời gian 0. Giao dịch mua được thực hiện vào ngày 14 tháng 1 sẽ là khoảng thời gian 3.
Nếu phạm vi ngày báo cáo của bạn là từ ngày 1 tháng 1 đến ngày 11 tháng 1 thì những người dùng được phân bổ (đã cài đặt) trong khoảng thời gian này sẽ được đưa vào báo cáo. Không đưa vào các dữ liệu khác.
- Giá trị của khoảng thời gian có thể là một hoặc nhiều giá trị từ 0-180 sau đây. Ví dụ: 0, 1, 2, 30, 180.
- Nếu không có khoảng thời gian nào được chỉ định, thì các giá trị mặc định là 0, 1, 2, v.v. cho đến 30, 60, 90 và 180 sẽ được trả về.
Ví dụ về bộ lọc khoảng thời gian
- Ví dụ này chứa các thông số truy vấn JSON, dữ liệu thô và tệp CSV kết quả.
- Truy vấn lọc khoảng thời gian 0, 1 và 2 và KPI được chọn là revenue.
- Kết quả là dữ liệu trả về chứa:
- Các thước đo về người dùng, chi phí và ecpi luôn trả về
- Các phép đo doanh thu bao gồm tổng và số lượng cho từng khoảng thời gian, nghĩa là các khoảng thời gian 0, 1 và 2.
Truy vấn
{
"cohort_type": "user_acquisition",
"min_cohort_size": 1,
"preferred_timezone": false,
"from": "2019-12-01",
"to": "2020-01-01",
"filters": {
"period": [
0,
1,
2
]
},
"aggregation_type": "on_day",
"per_user": false,
"groupings": [
"pid"
],
"kpis": [
"revenue"
]
}
Dữ liệu thô
Kết quả
Ánh xạ giao diện người dùng tới các thông số API
Các số liệu tiếp theo ánh xạ giao diện người dùng phân tích Nhóm người với các thông số API. Hai giải pháp - API và giao diện người dùng tương tự nhau nhưng không tương đồng.
Phiên bản API có các tùy chọn bổ sung sau:
- Lựa chọn tiền tệ
- Lựa chọn múi giờ
- Lọc theo khoảng thời gian
Điểm khác biệt giữa các loại tổng hợp
Đặc điểm và hạn chế
Đặc điểm | Nhận xét |
---|---|
Truy cập mạng quảng cáo |
Không. Đối tác quản lý chiến dịch có thể sử dụng API nếu nhà quảng cáo cấp quyền. |
Truy cập đại lý | Không |
Tính minh bạch của đại lý | Không được hỗ trợ |
Múi giờ cụ thể theo ứng dụng | Có |
Tiền tệ cụ thể theo ứng dụng | Có |
Hạn chế về kích thước | Không |
Giới hạn tỷ lệ |
Giới hạn tần suất lệnh gọi API: 60 lệnh gọi mỗi phút cho mỗi tài khoản |
Dữ liệu tự nhiên | Có sẵn |
Dữ liệu không tự nhiên | Có sẵn |
Giới hạn dữ liệu chi phí |
|
Tính cập nhật của dữ liệu |
Tính cập nhật của dữ liệu phụ thuộc vào partial_data như sau:
|
Dữ liệu lịch sử | Nhóm người hàng ngày: 2 năm |
Quyền truy cập tài khoản của người dùng | Mã thông báo ủy quyền có sẵn cho người dùng quản trị viên trong bảng điều khiển |
Doanh thu quảng cáo |
Đối với sự kiện af_ad_revenue, số liệu người dùng duy nhất không khả dụng khi loại dữ liệu hợp nhất là "on day" cho các ngày từ ngày 5 tháng 10 năm 2022-ngày 16 tháng 2 năm 2023. |
Nhóm hàng tuần và hàng tháng |
Nhóm phương diện hàng tuần và hàng tháng không có sẵn đối với API Nhóm người. Sử dụng bảng điều khiển Nhóm người. |
API Nhóm người |
|