Ocean Engine all-in-one report
Note that data generated by third-party data integration counts toward the cluster's data consumption
The Ocean Engine all-in-one report is deprecated and appears as All-in-one Report (Deprecated) in the AE backend. To create a new integration plan, use the Ocean Engine upgraded ad data report.
Summary
Interface overview
| Interface | Type | Granularity | Attribution | Cost | Revenue | Impressions | Clicks | Conversions |
|---|---|---|---|---|---|---|---|---|
| All-in-one report | API | Aggregated data | ✅ | ✅ | ✅ | ✅ |
The all-in-one data report supports ad data at each ad granularity and at the material and keyword levels, with rich analysis dimensions and metrics.
Integration process
- Log in to the Ocean Engine Open Platform and create a developer account and an app
- Get the app's APP_ID and Secret, and the login user ID
- Log in to the AE backend, go to the Third-party Integration module, and add an integration plan for the Ocean Engine all-in-one report
- Open the authorization link, log in to the Ocean Engine account that owns the ad accounts you want to pull data from, and complete authorization
- Check whether the AE system receives the data successfully, and build reports
1. Get the authorization information
1.1 Create a developer account and an app
Before connecting Ocean Engine data, you need to apply for an Ocean Engine developer account and create an app
- First, log in to or register an Ocean Engine account. Click this link to open the login and registration page. If you already have an Ocean Engine account, choose to log in at the lower-left corner and log in to that account. If you don't have an account, register an Ocean Engine account with your email address or mobile number
- After logging in, you are redirected to the Ocean Engine Open Platform. Click the Developer Management Console button in the upper-right corner of the page to open the developer console
-
If you haven't created a developer account, you need to enter developer information and pass the qualification review at this point. Because one company can register and verify only one developer account, make sure to apply with your company email address and keep the account safe. For the detailed application process, see the official documentation.
- For the developer type, select either advertiser or agency based on your situation. The differences between the two are as follows:
- Advertiser: can only apply for authorization of Zongheng organization accounts that belong to the same company entity as the developer account
- Agency: can only apply for authorization of agency accounts that belong to the same company entity as the developer account
-
After the developer account is verified, go to the developer website, open the APPID Management page, and choose to create an app of the Ad Management type
- You can write the app name, app icon, and app description as needed. Describe the app's purpose as sending Ocean Engine ad campaign data back to your own platform
- For the callback URL, enter www.thinkingdata.cn. This is only a temporary URL, and you need to change it after the plan is configured
- For the requested permissions, select at least the Data Reports permission
-
After you submit the application, Ocean Engine reviews your app creation (APPID) application within one business day
1.2 Get the App ID and App Secret
After the app application is complete, go to the developer console, find App Management > Basic Apps in the left sidebar, select the app you created, and click Edit to open the Basic Information page. Find the APP_ID and Secret and write them down.
1.3 Get the login user ID
Next, get the ID of the login user. Go to the Ocean Engine Open Platform, click the hexagon icon in the upper-right corner, click Ocean Engine Zongheng to enter the backend, click Account Information and Security in the upper-right corner, find the login user ID, and write it down
1.4 Summary
You have now obtained all the authorization information you need. You should now have the following information:
- App ID
- App Secret
- Login user ID
2. Plan configuration
After you get all the authorization information, log in to the AE system and configure the new plan in the Third-party Integration module. The image below shows the configuration page of the Ocean Engine all-in-one report. Follow this section to create the plan:
2.1 Authorization information configuration
Click the Configure authorization information button under Authorization Information and enter the information you obtained in the previous step in the pop-up:
Where:
- APP ID: the app's APP ID
- APP Secret: the app's APP Secret
- Login ID: the login user ID
- Account ID List: the IDs of the ad accounts you want to pull data from. If you leave it empty, data for all ad accounts under the authorized user is pulled
2.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull the Ocean Engine all-in-one report 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
2.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.
2.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; string type. All received data uses this name as the event name. |
| source | metrics | Metrics in the data; list type; customizable |
| group_by | Grouping dimensions in the data; list type; customizable |
You can modify the configuration as needed
2.4.1 Analysis dimensions
The following tables list the analysis dimensions supported by the all-in-one data report. The default grouping conditions are:
- STAT_GROUP_BY_TIME_HOUR
- STAT_GROUP_BY_CREATIVE_ID
The all-in-one report has the following three types of dimensions. You can select at most one dimension of each type. To adjust them, enter the selected grouping conditions in source.group_by
- Time dimensions
Select one of the four grouping conditions. To change it, enter the grouping condition in source.group_by
| Grouping condition | Field name | Description | Default |
|---|---|---|---|
| STAT_GROUP_BY_TIME_MONTH | stat_datetime | Time | |
| STAT_GROUP_BY_TIME_WEEK | |||
| STAT_GROUP_BY_TIME_DAY | |||
| STAT_GROUP_BY_TIME_HOUR | Yes |
- ID dimensions
Select one of the four grouping conditions. To change it, enter the grouping condition in source.group_by
| Grouping condition | Field name | Description | Default |
|---|---|---|---|
| STAT_GROUP_BY_ADVERTISER_ID | advertiser_id | Advertiser ID | |
| STAT_GROUP_BY_CAMPAIGN_ID | advertiser_id | Advertiser ID | |
| campaign_name | Ad group name | ||
| campaign_id | Ad group ID | ||
| STAT_GROUP_BY_AD_ID | advertiser_id | Advertiser ID | |
| campaign_name | Ad group name | ||
| campaign_id | Ad group ID | ||
| ad_name | Campaign name | ||
| ad_id | Campaign ID | ||
| STAT_GROUP_BY_CREATIVE_ID | advertiser_id | Advertiser ID | Yes |
| campaign_name | Ad group name | ||
| campaign_id | Ad group ID | ||
| ad_name | Campaign name | ||
| ad_id | Campaign ID | ||
| creative_id | Creative ID |
- Breakdown - basic dimensions
You can select at most one of them. To change it, enter the grouping condition in source.group_by
| Grouping condition | Field name | Description | Default |
|---|---|---|---|
| STAT_GROUP_BY_PRICING | pricing | Bidding method | |
| STAT_GROUP_BY_IMAGE_MODE | image_mode | Creative type | |
| STAT_GROUP_BY_INVENTORY | inventory | Preferred ad placement | |
| STAT_GROUP_BY_CAMPAIGN_TYPE | campaign_type | Ad group type | |
| STAT_GROUP_BY_CREATIVE_MATERIAL_MODE | creative_material_mode | Creative type | |
| STAT_GROUP_BY_EXTERNAL_ACTION | external_action | Conversion type | |
| STAT_GROUP_BY_LANDING_TYPE | landing_type | Promotion type | |
| STAT_GROUP_BY_PRICING_CATEGORY | pricing_category | Ad type |
2.4.2 Included metrics
The following table shows some commonly used metrics supported by the all-in-one data report. There are too many metrics in total to show them all here. If needed, see the official documentation for descriptions of all metrics. To change the metrics, enter the metric names in source.metrics
| Metric name | Display name | Default |
|---|---|---|
| active | Activations | Yes |
| active_cost | Activation cost | Yes |
| active_pay_cost | First payment cost | Yes |
| active_pay_rate | First payment rate | Yes |
| active_rate | Activation rate | Yes |
| active_register_cost | Registration cost | Yes |
| active_register_rate | Registration rate | Yes |
| attribution_active_pay_7d_per_count | 7-day average purchases per user | Yes |
| attribution_convert | Conversions (billing time) | Yes |
| attribution_convert_cost | Conversion cost (billing time) | Yes |
| attribution_deep_convert | Deep conversions (billing time) | Yes |
| attribution_deep_convert_cost | Deep conversion cost (billing time) | Yes |
| attribution_game_pay_7d_cost | 7-day payment cost | |
| attribution_game_pay_7d_count | 7-day purchases | |
| attribution_next_day_open_cnt | Next-day retained users | |
| attribution_next_day_open_cost | Next-day retention cost | |
| attribution_next_day_open_rate | Next-day retention rate | |
| avg_click_cost | Average cost per click | Yes |
| avg_show_cost | Average cost per 1,000 impressions | Yes |
| click | Clicks | Yes |
| click_install | Click installs | Yes |
| convert | Conversions | Yes |
| convert_cost | Conversion cost | Yes |
| convert_rate | Conversion data - Conversion rate | Yes |
| cost | Total spend | Yes |
| ctr | Click-through rate | Yes |
| deep_convert | Deep conversions | Yes |
| deep_convert_cost | Deep conversion cost | Yes |
| deep_convert_rate | Deep conversion rate | Yes |
| download | Download starts | Yes |
| game_addiction | Key actions | Yes |
| game_addiction_cost | Key action cost | Yes |
| game_addiction_rate | Key action rate | Yes |
| game_pay_cost | Payment cost | Yes |
| game_pay_count | Purchases | Yes |
| next_day_open | Next-day retention postbacks (not matched) | |
| next_day_open_cost | Next-day retention cost (not matched) | |
| next_day_open_rate | Next-day retention rate (not matched) | |
| pay_count | First purchases | Yes |
| play_100_feed_break | Plays to 99% progress | |
| play_25_feed_break | Plays to 25% progress | |
| play_50_feed_break | Plays to 50% progress | |
| play_75_feed_break | Plays to 75% progress | |
| play_duration_sum | Play duration, in ms | |
| total_play | Plays | |
| valid_play | Valid plays | |
| valid_play_cost | Valid play cost | |
| valid_play_rate | Valid play rate | |
| play_over_rate | Play completion rate | |
| redirect | Page redirects | |
| register | Registrations | |
| share | Shares | |
| show | Number of impressions | Yes |
| wifi_play | Wi-Fi plays | |
| wifi_play_rate | Wi-Fi play ratio |
2.4.3 Event ingestion rules
- The stat_datetime field in the data, that is, the date of the data, is set as the #event_time of the aggregated data. Currently, the data pulled from Ocean Engine is at hourly granularity, so stat_datetime is also accurate to the hour
- The event name is oceanengine_show_click_convert_data
- All other fields are stored
2.5 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
Go back to the Ocean Engine developer console, open the basic information page of the app you created earlier, and enter the URL you just copied as the callback URL
Then go back to the AE interface and click Go to authorization. This opens the Ocean Engine authorization page
The authorization page appears. Select All accounts of the current user, and make sure that Current login user owns the ad accounts you want to pull data from. Check that the login user ID in the red box is the login user ID you entered in the plan configuration. After confirming, click Agree to authorize to complete authorization.
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.
2.6 Standardized fields
The AE system standardizes some fields in the Ocean Engine all-in-one data report:
| Field name | Standardized field | Description |
|---|---|---|
| advertiser_id | te_ads_object.ad_account_id | Advertiser ID |
| campaign_name | te_ads_object.campaign_name | Ad group name |
| campaign_id | te_ads_object.campaign_id | Ad group ID |
| ad_name | te_ads_object.ad_group_name | Campaign name |
| ad_id | te_ads_object.ad_group_id | Campaign 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 |
| click | te_ads_object.clicks | Clicks |
| click_install | te_ads_object.installs | Click installs |
| cost | te_ads_object.cost | Total spend |