Bạn có thể sử dụng API tóm tắt dữ liệu của Nhà phát hành quảng cáo để lấy dữ liệu hiệu suất. Tìm hiểu cách tạo báo cáo dữ liệu hiệu suất. 

Bước 1: Xác thực bằng mã thông báo truy cập.

Bạn cần có mã thông báo truy cập để bắt đầu sử dụng API tóm tắt dữ liệu của Nhà phát hành quảng cáo. Để nhận được mã thông báo truy cập, bạn phải chuẩn bị địa chỉ email và mật khẩu để đăng nhập vào Cổng thông tin nhà phát hành quảng cáo Moloco cũng như ID nền tảng của bạn. 

Chuẩn bị địa chỉ email và mật khẩu

Sau khi đăng ký, bạn sẽ nhận được email từ Moloco để tạo mật khẩu cho tài khoản của mình. Nếu bạn chưa nhận được email này trong hộp thư đến của địa chỉ email dùng để đăng ký tài khoản với chúng tôi, hãy liên hệ với đại diện Moloco để được hỗ trợ. Làm theo hướng dẫn trong email để tạo mật khẩu. 

Tìm và sao chép ID nền tảng của bạn trong Cổng thông tin nhà phát hành quảng cáo Moloco

Để tìm ID nền tảng, hãy đăng nhập vào Cổng thông tin nhà phát hành quảng cáo Moloco và nhấp vào Publisher setting trên thanh bên trái. Tìm và sao chép ID nền tảng cho tài khoản của bạn.

Tạo yêu cầu API để tạo mã thông báo truy cập

Sau khi có địa chỉ email, mật khẩu và ID nền tảng, bạn phải tạo yêu cầu API để tạo mã thông báo truy cập. Trong mẫu yêu cầu sau, bạn phải nhập địa chỉ email của mình vào email, mật khẩu vào password và ID nền tảng vào workplace_id. 

curl --request POST \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/auth/tokens \
--header 'accept: application/json' \
--header 'content-type: application/json' \

--data @- <<EOF
{
"email": "<your-email-address-here>",
"password": "<your-password-here>",
"workplace_id": "<your-platform-id-here>"
}
EOF

Phản hồi trả về bao gồm ID mã thông báo truy cập mà bạn cần đưa vào tiêu đề khi sử dụng điểm cuối API tóm tắt dữ liệu của Nhà phát hành quảng cáo. Mã thông báo truy cập có hiệu lực trong vòng 60 phút và sau khi hết hạn, bạn phải tạo yêu cầu API mới để tạo mã thông báo truy cập mới.

{
"token": "your-token-here"
}

Trước khi mã thông báo truy cập hết hạn, bạn có thể làm mới bằng cách tạo yêu cầu API sau với mã thông báo truy cập hiện có, yêu cầu này sẽ trả về mã thông báo truy cập mới trong phản hồi. Như bạn có thể thấy trong yêu cầu mẫu sau, bạn phải bao gồm mã thông báo truy cập của mình dưới dạng mã thông báo cấp quyền truy cập cho người giữ mã khi tạo yêu cầu API cần ủy quyền. 

curl --request PUT \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/auth/tokens \
--header 'Authorization: Bearer <your-token-here>' \
--header 'accept: application/json'

Bước 2: Tạo yêu cầu API cho điểm cuối API tóm tắt dữ liệu của Nhà phát hành quảng cáo.

Bạn phải sử dụng điểm cuối API sau.

POST https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/sdk/summary

Thuộc tính bắt buộc

Các thuộc tính sau đây phải được đưa vào nội dung yêu cầu.

"date_range": {
"start": "YYYY-MM-DD",
"end": "YYYY-MM-DD"
}

"dimension_filters": [
{
"dimension": "<DIMENSION_NAME>",
"values": ["string"]
}
]

"order_by": [
{
"dimension" | "metric": "<DIMENSION_NAME> | <METRIC_NAME>",
"is_descending": true|false
}
]

Chỉ số có sẵn

Bạn phải bao gồm một hoặc nhiều chỉ số sau đây trong nội dung yêu cầu. 

Thuộc tính dữ liệu có sẵn

Bạn phải bao gồm một hoặc nhiều thuộc tính dữ liệu sau đây trong nội dung yêu cầu.

YYYY-MM-DD HH:mm:SS +0000 UTC

Nội dung yêu cầu

Nội dung yêu cầu phải được định dạng như sau.

{
"publisher_id": "<MOLOCO-PUBLISHER-ID>",
"date_range": {
"start": "YYYY-MM-DD",
"end": "YYYY-MM-DD"
},
"dimensions": ["<DIMENSION_NAME>"],
3
"metrics": ["<METRIC_NAME>"],
"dimension_filters": [
{
"dimension": "<DIMENSION_NAME>",
"values": ["string"]
}
],
"order_by": [
{
"dimension" | "metric": "<DIMENSION_NAME> | <METRIC_NAME>",
"is_descending": true|false
}
]
}

Yêu cầu mẫu sau đây trả về trong phản hồi tổng doanh thu theo ngày từ ngày 10/6/2023 đến ngày 11/6/2023.

curl --request POST \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/sdk/summary \
4
--header 'content-type: application/json' \
--header 'Authorization: Bearer <your-token-here>' \
--data @- <<EOF
{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-11"
},
"dimensions": ["UTC_DATE"],
"metrics": ["REVENUE"]
}
EOF

Lọc dữ liệu

Bạn có thể áp dụng bộ lọc cho dữ liệu để chỉ truy xuất một tập hợp con dữ liệu. Bạn có thể chỉ định bất kỳ thuộc tính dữ liệu nào có sẵn làm bộ lọc như trong ví dụ sau. 

{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-15"
6
},
"dimensions": ["UTC_DATE", "AD_UNIT_ID"],
"metrics": ["REVENUE", "IMPRESSIONS"],
"dimension_filters":[
{
"dimension": "PUBLISHER_APP_ID",
"values": [ "<moloco-app-id>"]
},{
"dimension": "GEO_COUNTRY",
"values": ["USA", "CAN"]
}]
}

Yêu cầu mẫu này trả về trong phản hồi tổng doanh thu và tổng số lượt hiển thị từ ngày 10/6/2023 đến ngày 15/6/2023 từ Canada và Hoa Kỳ cho một ứng dụng có App Key <moloco-app-id>, được nhóm theo ngày và ID Đơn vị quảng cáo. 

Nhóm và sắp xếp dữ liệu theo một hoặc nhiều thuộc tính dữ liệu và/hoặc chỉ số

Bạn có thể nhóm dữ liệu theo một hoặc nhiều thuộc tính dữ liệu và/hoặc chỉ số có sẵn. Yêu cầu mẫu sau đây trả về tỷ lệ lấp đầy quảng cáo và tổng số lần nhấp theo ngày và App Key trong phản hồi, với ngày hiển thị từ gần đây nhất đến mới nhất và tỷ lệ lấp đầy hiển thị từ lớn nhất đến nhỏ nhất.

{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-11"
},
"dimensions": ["UTC_DATE", "PUBLISHER_APP_ID"],
"metrics": ["FILL_RATE", "CLICKS"],
"order_by": [{
"dimension": "TIME_BUCKET",
"is_descending": false
}, {
"metric": "FILL_RATE",
"is_descending": true
}]
}

Nội dung phản hồi

Phản hồi trả về từ yêu cầu API được định dạng như sau. Chỉ các thuộc tính dữ liệu và/hoặc chỉ số được chỉ định trong yêu cầu API mới được trả về trong phản hồi.

{
"rows": [
{
"utc_time_bucket": "YYYY-MM-DD",
"app": {
"app_id": "<moloco-app-id-in-inventory-sheet>",
"app_title": "<pretty-app-name>"
},
"ad_unit": {
"ad_unit_id": "<moloco-ad-unit-id-in-inventory-sheet>",
"ad_unit_title": "<pretty-ad-unit-name>",
"inventory_type": "BANNER" | "INTERSTITIAL" | "REWARD_VIDEO",
"bidfloor": string
},
"device": {
"os": "IOS" | "ANDROID"
},
"geo": {
"country": "<ISO 3166-1 alpha-3 country code>"
},
"metric": {
"revenue": float64,
"impressions": int64,
"requests": int64,
"clicks": int64,
"ecpm": float64,
"fill_rate": float64
}
}
]
}

Chỉ số

Thuộc tính dữ liệu

YYYY-MM-DD HH:mm:SS +0000 UTC

Sau đây là yêu cầu mẫu về doanh thu theo ngày và loại hệ điều hành kể từ ngày 10/6/2023.

curl --request POST \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/sdk/summary \
--header 'content-type: application/json' \
--header 'Authorization: Bearer <your-token-here>' \
--data @- <<EOF
{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-10"
},
"dimensions": ["UTC_DATE", "DEVICE_OS"],
"metrics": ["REVENUE"]
}
EOF

Phản hồi trả về chỉ bao gồm thông tin được yêu cầu. 

{
"rows": [
{
"utc_time_bucket": "2023-06-10 00:00:00 +0000 UTC",
"device": {
"os": "IOS"
},
"metric": {
"revenue": 100.01
}
}, {
"utc_time_bucket": "2023-06-10 00:00:00 +0000 UTC",
"device": {
"os": "ANDROID"
},
"metric": {
"revenue": 99.99
}
}
]
}

Múi giờ và tính khả dụng

Chúng tôi sử dụng múi giờ UTC để lấy và hiển thị tập dữ liệu. Dù hầu hết dữ liệu có sẵn theo thời gian thực, nhưng có thể mất vài giờ để cung cấp một số dữ liệu. Do đó, dữ liệu của cả ngày sẽ được cung cấp chậm nhất là 6 giờ sau nửa đêm theo giờ UTC của ngày dữ liệu được ghi lại. 

Thỏa thuận mức dịch vụ

Chúng tôi sẽ phát hành các bản sửa lỗi cho các vấn đề do các nhà phát hành quảng cáo nêu ra trong vòng ba ngày làm việc kể từ ngày vấn đề được báo cáo lần đầu.