Tencent new delivery daily report
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 |
|---|---|---|---|---|---|---|---|---|
| New delivery daily report | API | Aggregated data | ✅ | ✅ | ✅ | ✅ | ✅ |
The Tencent Ads new delivery daily report supports sending back aggregated data, including metrics such as spend, clicks, and impressions
Integration process
The data integration process with Tencent Ads is as follows:
- Log in to the AE backend, go to the Third-party Integration module, add a Tencent new delivery daily report integration plan, complete the related configuration, and copy the authorization callback URL
- Go to the Tencent Ads developer platform, register as a developer, create an app, and get the Client ID and Client Secret
- Go back to the AE backend, edit the Tencent new delivery daily report integration plan you created earlier to use the app's Client ID and Secret, and open the authorization link to complete authorization
- Check whether the AE system receives the data successfully, and build reports
1. Plan configuration
Before connecting Tencent Ads data, create the corresponding integration plan in the AE backend and get the authorization callback URL. Follow this document to create the integration plan
1.1 Enter temporary authorization information
First, click Configure authorization information in the authorization information section. In the authorization information dialog that appears, enter any authorization information as temporary authorization information. You need to adjust it after you create the app on the Tencent Ads developer platform.
1.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull Tencent new delivery daily report data on a schedule. You can choose to pull data for a period of time at a specific time every day. Because pulled data also counts toward the data volume, avoid pulling data for overly long periods on a schedule
1.3 Receive Settings
You can control whether the data is written as events. If you turn this off, the data is not written to the event table, so do not turn off this setting.
1.4 Configuration
Finally, in the Configuration module, you can control the detailed settings of data pulling, including the time aggregation granularity of the data, the metric fields and dimensions to pull, 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 |
| source | metrics | Fields of the pulled data. List type. Customizable |
| group_by | Aggregation conditions of the pulled data. List type. Customizable | |
| transfer | double_columns | Fields among the pulled data fields (that is, source.metrics) that need to be converted to numbers. Fields not in this list are ingested as strings. List type. Customizable |
| extra_params | level | Report type level of the pulled data. Customizable |
- Report type levels and aggregation conditions
The report type level and aggregation conditions determine the data granularity of the daily report, for example, whether data is aggregated by ad or by creative. Each query can use only one report type level, and different report type levels support different aggregation conditions. The following are some commonly used levels and the aggregation conditions they support. To adjust them, enter the report type level in extra_params and the aggregation conditions in source.group_by:
| Report type level | Description | Default | Supported aggregation conditions |
|---|---|---|---|
| REPORT_LEVEL_ADVERTISER | Advertiser-level report | "date" | |
| REPORT_LEVEL_ADGROUP | Ad-level report | "date", "adgroup_id" | |
| REPORT_LEVEL_DYNAMIC_CREATIVE | Ad creative-level report | Yes | "date", "dynamic_creative_id" |
- Pulled fields
The following are the grouping fields that the new delivery daily report pulls by default. Note that grouping fields are affected by the pulled dimensions: a fine-grained aggregation condition supports the grouping fields of its coarser-grained aggregation conditions. For example, with "dynamic_creative_id" as the aggregation condition, you can pull coarser-grained grouping fields such as "account_id" and "adgroup_id". To adjust them, enter the names of the grouping fields you need in source.metrics:
| Grouping field | Description |
|---|---|
| adgroup_id | Ad ID |
| dynamic_creative_name | Creative name |
| dynamic_creative_id | Creative ID |
| account_id | Ad account ID |
The following are some of the metrics supported by the daily report. Because this report has a very large number of metrics, only some commonly used ones are shown here. To learn about all metrics, see the official documentation (make sure to select the level you set in the plan). To adjust them, enter the field names in source.metrics:
| Field | Description |
|---|---|
| view_count | Impressions |
| view_user_count | Impression users |
| valid_click_count | Clicks |
| click_user_count | Click users |
| ctr | Click-through rate |
| cpc | Average cost per click |
| cost | Spend |
| conversion_count | Target conversions |
| conversion_rate | Target conversion rate |
| conversion_cost | Target conversion cost |
| download_count | App download completions |
| activated_count | Total app activations |
| activated_rate | App download-to-activation rate |
| activated_cost | App activation cost |
| thousand_display_price | Average cost per 1,000 impressions |
| download_rate | App download rate |
| download_cost | App download cost |
| install_count | App installs |
| install_rate | App install rate |
| install_cost | App install cost |
| click_activated_rate | App click-to-activation rate |
1.5 Get the authorization callback URL
After completing the above configuration, click Save and authorize in the upper-right corner to get the authorization information. Copy the authorization callback URL from the first step and keep it safe. Then click Reject authorization. to close the pop-up:
The plan is saved when you click Save and authorize, so you do not need to save it separately. You have now temporarily completed the configuration in the AE backend. Next, complete the related configuration in the Tencent Ads backend.
2. Register as a developer and create an app
Next, log in to the Tencent Ads developer backend and register as a developer with another QQ account.
After registering as a developer, click Create New App on the app management dashboard.
Then, create the app on the Create App page:
- For the app type, select Third-party Application
- The app icon, app name, and app description can be customized
- For the callback URL, enter the authorization information URL you got in the AE system
In Permission Selection, select at least the Ads Insight permission
After creating the app, get the app's client id and client_secret and write them down
3. Go back to the AE backend and complete authorization
After creating the Tencent app, go back to the AE backend, open the Tencent integration plan you created earlier, and click Configure authorization information under Authorization Information:
Next, enter the Client ID and Client Secret of your Tencent app in the corresponding fields. In Login ID, enter the QQ number or WeChat ID you plan to log in with during authorization. In Account ID List, you can enter the IDs of the ad accounts to pull data from. Separate multiple IDs with ",". If you leave it empty, data for all authorized ad accounts is pulled. After editing, click the save button:
Then click Save and authorize in the upper-right corner to open the authorization information dialog again. Click Go to authorization to open the Tencent authorization page. If the plan has been saved but authorization isn't complete, the top of the plan page shows the tip bar "The current plan hasn't completed authorization, and data can't be connected. Go to authorization". You can also click Go to authorization in the tip bar to open the authorization information dialog
On the authorization page, log in to your ad account, select at least the Ads Insight data permission, and click the agree button to complete authorization
Note that if you log in and authorize with a QQ direct customer account, you only get data permissions for the current customer's promotion account. If you log in and authorize with a QQ Business Manager account, you get data permissions for all promotion accounts under the manager account.
After completing authorization, in Authorization Information, click I have completed the above two steps in the lower-left corner, and then click Complete Authorization in the lower-right corner to finish the configuration. You have now completed the data integration for the Tencent platform.
4. Data ingestion
4.1 Ingestion rules
- The start_date field in the data, that is, the aggregation time of the data, is used as the event's #event_time
- The default event name is —— tencent_ads_daily_report_v3
- All other fields are ingested
4.2 Standardized fields
The AE system standardizes some fields in the Tencent new delivery daily report data:
| Original field | Standardized | Description |
|---|---|---|
| adgroup_id | te_ads_object.ad_group_id | Ad group ID |
| dynamic_creative_name | te_ads_object.ad_name | Ad name |
| dynamic_creative_id | te_ads_object.ad_id | Ad ID |
| account_id | te_ads_object.account_id | Ad account ID |
| view_count | te_ads_object.impressions | Impressions |
| valid_click_count | te_ads_object.clicks | Clicks |
| cost | te_ads_object.cost | Spend |
| install_count | te_ads_object.installs | App installs |