Baidu Marketing data integration plan
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 |
|---|---|---|---|---|---|---|---|---|
| Data report (search promotion account report) | API | Aggregated metrics | ✅ | ✅ | ✅ | ✅ |
The AE system currently supports connecting the Data Report (search promotion account report) of Baidu Marketing data, which provides metrics such as spend, clicks, impressions, and conversions under the promotion account
Integration process
- Log in to the AE backend, go to the Third-party Integration module, add a Baidu Marketing data integration plan, complete the related configuration, and copy the authorization callback URL
- In the Baidu Marketing backend, get verified as a developer, create an app, and get the AppID and secretKey
- Go back to the AE backend, edit the Baidu Marketing data integration plan you created earlier to use the app's AppID and secretKey and the name of the promotion account whose data you want to pull (User Name), 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 the Baidu data platform, you need to 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 the Configure authorization information button in the Authorization Information section. In the authorization information pop-up, enter any values as temporary authorization information. You'll need to update them after you create the app on the Baidu data platform.
1.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull Baidu Marketing 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 | time_granularity | Time aggregation granularity of the data, that is, whether the pulled data is aggregated by day or by hour Valid values: DAY, HOUR |
| group_by | Grouping dimensions in the data; list type; customizable | |
| metrics | Metric fields of the corresponding API; list type; customizable |
- Grouping dimensions
The following are the grouping dimensions supported by the Baidu Marketing search promotion account report. To change them, enter the names of the grouping dimensions you need in source.group_by
| Dimension name | Ingested field name | Description | Remarks | Pulled by default |
|---|---|---|---|---|
| date | #event_time | Date | Date formats for different time units: DAY: 2021-03-31 HOUR: 2021-03-31 23:00 | Yes |
| userName | username | Account | Yes | |
| businessPointId | businesspointid | Promotion business ID | Yes | |
| businessPointName | businesspointname | Promotion business | Yes | |
| wBudget | wbudget | Budget | Yes | |
| budgetEfficiency | budgetefficiency | Budget utilization | Yes | |
| device | device | Promotion device | Enum values: 0: Computer 1: Mobile device | Yes |
| marketingTargetEnum | marketingtargetenum | Marketing objective | Enum values: 0: Website link 1: App promotion 2: Store promotion 3: Promotional campaign 4: E-commerce store promotion 5: Product catalog | Yes |
| targetingType | targetingtype | Buying type | Enum values: 0: Keyword 6: URL targeting | Yes |
| provinceName | provincename | Province | This dimension doesn't support hourly granularity | |
| provinceCityName | provincecityname | City | This dimension doesn't support hourly granularity |
- Metric fields
The following are the metric fields supported by the Baidu Marketing search promotion account report. To change them, enter the names of the metrics you need in source.metrics. In addition, Baidu Marketing supports a series of conversion metrics. Because there are many of them, they aren't listed here. For details, see the official documentation, and enter the names of the metrics you need to connect in source.metrics
| Name | Ingested field name | Description | Remarks | Pulled by default |
|---|---|---|---|---|
| impression | impression | Impressions | Yes | |
| click | click | Clicks | Yes | |
| cost | cost | Spend | Yes | |
| ctr | ctr | Click-through rate | Yes | |
| cpc | cpc | Average cost per click | Yes | |
| topPageViews | toppageviews | Top impressions | Yes | |
| topPClicks | toppclicks | Top clicks | Yes | |
| topPay | toppay | Top spend | Yes | |
| topPvWinA | toppvwina | Top impression win rate | "Top impression win rate" is mutually exclusive with "Promotion business", and this metric can't be requested together with provinceCityName or cityName. Top impression win rate = account top impressions / account searches that meet the delivery conditions | |
| topPvWinP | toppvwinp | Top impression win rate (exact) | "Top impression win rate (exact)" is mutually exclusive with "Promotion business", and this metric can't be requested together with provinceCityName or cityName. Top impression win rate (exact) = account top impressions triggered by exact match / account searches that meet the delivery conditions & exact-match trigger conditions | |
| topFirstPageViews | topfirstpageviews | Top first-position impressions | Yes | |
| topFirstPvWinA | topfirstpvwina | Top first-position win rate | "Top first-position win rate" is mutually exclusive with "Promotion business" | |
| topFirstPvWinP | topfirstpvwinp | Top first-position win rate (exact) | "Top first-position win rate (exact)" is mutually exclusive with "Promotion business" | |
| ocpcConversionsDetail4 | ocpcconversionsdetail4 | Activated Users | Number of users who completed activation (downloaded, installed, and opened the app for the first time) | Yes |
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 already saved when you click Save and authorize, so you don't need to save it separately. You have now temporarily completed the configuration in the AE backend. Next, complete the related configuration in the Baidu Marketing backend.
2. Register as a Baidu Marketing developer and get the authorization information
2.1 Register as a developer
To apply for developer permissions, first register as a developer
2.2 Create an app and get the AppID and secretKey
After your application for developer permissions is approved, create an app and enter the related information as prompted. For the callback URL, enter the callback URL you got from the AE system.
After completing the configuration, click Submit for Review. After the Baidu API team approves it, you can get the app's appId and secretKey fields. Developers can view them on the App Authorization tab
3. Go back to the AE backend and complete authorization
After completing the configuration in the Baidu Marketing data backend, go back to the AE backend, open the Baidu Marketing data integration plan you created earlier, and click the Configure authorization information button in the Authorization Information section:
Next, enter the appId and secretKey you got from the Baidu Marketing data backend in the corresponding fields, and enter the name of the Baidu Marketing promotion account whose data you want to pull in User Name. After editing, click the Save button:
Then click Save and authorize in the upper-right corner to open the authorization information pop-up again. Click Go to authorization to open the authorization page of the Baidu Marketing data platform. 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 pop-up
Log in to the Baidu Marketing data account from which you want to pull data, and complete authorization on the following page:
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 Baidu Marketing platform.
4. Data ingestion
4.1 Ingestion rules
- Because the search promotion account report is aggregated data, we use a fixed value as the user identifier. You can think of all the data as attached to one virtual user
- The date field in the data, that is, the aggregation time of the data, is used as the event's #event_time
- The event name is baidu_search_account_report
- All other fields are ingested
4.2 Standardized fields
The AE system standardizes the following fields:
| Original field | Standardized field | Description |
|---|---|---|
| impression | te_ads_object.impressions | Impressions |
| click | te_ads_object.clicks | Clicks |
| cost | te_ads_object.cost | Campaign cost |