Kuaishou advertiser data
Note that data generated by third-party data integration counts toward the cluster's data consumption
Summary
Interface overview
| Interface | Type | Granularity | Attribution | Cost | Revenue | Impressions | Clicks | Conversions |
|---|---|---|---|---|---|---|---|---|
| Advertiser data | API | Aggregated metrics | ✅ | ✅ | ✅ | ✅ |
Advertiser data provides various metrics at the advertiser level, including ad impressions, clicks, conversions, user acquisition cost, and many other metrics.
Integration process
- Register a Kuaishou developer account and create an app
- Log in to the AE backend, go to the Third-party Integration module, add a Kuaishou advertiser data plan, and complete the related configuration
- Get the authorization callback URL from the AE backend, log in to the Kuaishou Open Platform, and enter the callback URL in the app you created earlier
- Open the authorization URL in the AE backend to complete authorization
- Check whether the AE system receives the data successfully, and build reports
1. Get the information required for authorization
1.1 Register a Kuaishou developer account
Before you call the Kuaishou Marketing API, you need a Kuaishou developer account. First, log in to the Magnetic Engine Open Platform
Next, click Register as developer:
Enter the contact's name and other information to complete the contact information:
Next, complete the developer qualifications. Either the company's legal representative or an agent can apply for registration, but in both cases the applicant must complete real-name identity verification
For the developer role, select Advertiser
1.2 Create an app
After registering the Kuaishou developer account, create a new app in App Management
To create an app, provide the following:
- App name, app icon, and app description: can be customized
- Callback URL: use www.thinkingdata.cn for now. You need to change it after the app is created and the plan is created on the AE platform
Next, get the APP ID and Secret marked by the green box and green arrow in the image below
1.3 Get the Kuaishou ID of the account to authorize
Finally, get the Kuaishou ID of the Kuaishou account from which you want to pull ad data. You can usually find it in the upper-right corner of the Kuaishou backend:
2. Plan configuration
After creating the app, log in to the AE system backend and configure the Kuaishou advertiser data plan in the Third-party Integration module. The image below shows the configuration page for Kuaishou Ads data:
2.1 Authorization information configuration
Click the Configure authorization information button under Authorization Information, and enter the information you obtained during authorization in the pop-up
Enter the APP ID and Secret you got when creating the app, and the Kuaishou ID of the account to authorize, in APP ID, Secret, and User ID respectively
In Advertiser ID List, enter the list of ad account IDs you want to pull data from. Separate multiple IDs with ",". If you leave it empty, the AE system gets data for all the ad accounts you authorized. If you fill it in, the AE system only gets data for the ad accounts you entered
2.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull Kuaishou advertiser data on a schedule. You can choose to pull data for a period of time at a specific time every day or every hour. Because pulled data also counts toward the data volume, avoid pulling data for overly long periods on a schedule
2.3 Event Data Configuration
After you turn on the Event Data Configuration switch, all data sent back is written to the event table. We recommend that you enable event data ingestion.
2.4 Configuration
Finally, in the Configuration module, you can control the details of data pulling, including the time aggregation granularity of the data and the event name after ingestion.
The content of the configuration is a JSON, which you can customize as follows:
| Module | Name | Description |
|---|---|---|
| sink_event | event_name | Event name after ingestion. Customizable; string type. All received data uses this name as the event name. |
| source | time_granularity | Time aggregation granularity of the data, that is, whether the pulled data is aggregated by day or by hour Valid values: DAILY / HOURLY |
| transfer | double_columns | Metric fields. Do not modify |
The metrics of advertiser data cover multiple business types (such as online stores and live-stream selling). The following are some commonly used metrics. For the complete list of metrics, see the Advertiser data documentation. By default, we ingest all data
- Metric fields
| Metric | Description |
|---|---|
| charge | Spend (CNY) |
| show | Cover impressions |
| photo_click | Cover clicks |
| aclick | Material impressions |
| bclick | Actions |
| photo_click_ratio | Cover click-through rate |
| impression_1k_cost | Average cost per 1,000 impressions (CNY) |
| photo_click_cost | Average cost per click (CNY) |
| action_cost | Average cost per action (CNY) |
| share | Shares |
| comment | Comments |
| like | Likes |
| follow | New follows |
| cancel_follow | Unfollows |
| report | Reports |
| block | Blocks |
| negative | "Show fewer like this" count |
| download_started | App download data - Android download starts |
| download_completed | App download data - Android download completions |
| activation | App download data - Activations |
| event_pay_first_day | App download data - First-day purchases |
| event_pay_purchase_amount_first_day | App download data - First-day purchase amount |
| event_pay_first_day_roi | App download data - First-day ROI |
| event_pay | App download data - Purchases |
| event_pay_purchase_amount | App download data - Purchase amount |
| event_pay_roi | App download data - ROI |
| event_register | App download data - Registrations |
| event_register_cost | App download data - Registration cost |
| event_register_ratio | App download data - Registration rate |
| event_order_paid | App download data - Successful payments |
| event_order_paid_purchase_amount | App download data - Successful payment amount |
| event_order_paid_cost | App download data - Cost per payment |
| played_end | Completed plays |
| played_three_seconds | Valid plays |
| click_1k_cost | Average cost per 1,000 material impressions (CNY) |
| event_button_click | Button clicks |
| event_button_click_cost | Button click cost: same-day spend / button clicks |
| event_button_click_ratio | Button click-through rate: button clicks / actions |
| play_end_ratio | Completion rate |
| event_watch_app_ad | Ad views |
| event_ad_watch_times | Ad view count |
| event_ad_watch_times_ratio | Ad view count conversion rate |
| event_ad_watch_times_cost | Ad view count cost |
| ad_show | Ad impression |
| click_conversion_ratio | Click-to-activation rate |
| conversion_cost | Cost per activation |
| download_completed_cost | Cost per Android download completion (CNY) |
| download_completed_ratio | Android download completion rate |
| download_conversion_ratio | Download-completion-to-activation rate |
| download_started_cost | Cost per Android download start (CNY) |
| download_started_ratio | Android download start rate |
| conversion_num | Conversions (attributed by postback time) |
| conversion_num_cost | Conversion cost (attributed by postback time) |
| conversion_ratio | Conversion rate (attributed by postback time) |
- Dimension fields
| Dimension | Description |
|---|---|
| advertiser_id | Ad account ID |
| campaign_id | Campaign ID |
| campaign_name | Campaign name |
| unit_id | Ad group ID |
| unit_name | Ad group name |
| creative_id | Ad creative ID |
| creative_name | Ad creative name |
| status | 1 - Delivering; 2 - Paused; 3 - Deleted |
2.5 Event ingestion rules
- The stat_date and stat_hour fields in the data, that is, the concatenation of the date and the hour, are used as the data's #event_time
- The event name is kuaishou_ads_account_report
- All other fields are stored
2.6 Complete authorization
After completing the configuration, click Save and authorize in the upper right corner to save the plan configuration. Next, you need to complete the final authorization:
First, in the Authorization Information page that pops up, copy the URL in the first step
Next, log in to the Magnetic Engine Open Platform, open the app you created earlier, and enter the authorization callback URL in the callback URL field shown in the image below
Then go back to the AE interface and click Go to authorization. This opens the Magnetic Engine authorization page
The authorization page appears. Select User-based authorization, and make sure the Kuaishou ID shown on the authorization page matches the User ID in the plan you configured in the AE system. Then select Agree to the terms of use and click Confirm authorization to complete authorization
2.7 Standardized fields
The AE system standardizes some fields in Kuaishou advertiser data:
| Field name | Standardized field | Description |
|---|---|---|
| advertiser_id | te_ads_object.ad_account_id | Advertiser ID |
| campaign_name | te_ads_object.campaign_name | Campaign name |
| campaign_id | te_ads_object.campaign_id | Campaign ID |
| unit_name | te_ads_object.ad_group_name | Ad group name |
| unit_id | te_ads_object.ad_group_id | Ad group ID |
| creative_name | te_ads_object.ad_name | Creative name |
| creative_id | te_ads_object.ad_id | Creative ID |
| CNY (fixed value) | te_ads_object.currency | Currency of the cost or revenue |
| show | te_ads_object.impressions | Number of impressions |
| photo_click | te_ads_object.clicks | Clicks |
| conversion_num | te_ads_object.installs | Click installs |
| charge | te_ads_object.cost | Total spend |