TradPlus full report query API
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 |
|---|---|---|---|---|---|---|---|---|
| Full report query API | API | Aggregated metrics | ✅ | ✅ | ✅ |
The full report query API provides aggregated metric data for ad monetization, including metrics such as ad impressions, clicks, and revenue.
Integration process
- Log in to the TradPlus dashboard and get the Access Token and app ID
- Log in to the AE backend, go to the Third-party Integration module, and add a TradPlus full report query API integration plan
- Check whether the AE system receives the data successfully, and build reports
1. Get information from the TradPlus dashboard
Log in to the TradPlus dashboard first and get the Access Token and app ID
- To get the Access token, go to My Account - Report API key in the TradPlus dashboard and click Generate key
- You can find the app ID under App Management - Apps & Placements
2. Plan configuration
After you get the Access Token and app ID, 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 TradPlus full report query API. 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 during authorization in the pop-up
2.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull the TradPlus full report query API 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 Pull time zone
You can also set the time zone of the pulled data. The default is UTC+8
2.4 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.5 Configuration
In the Configuration module, you can control the detailed settings of data pulling, including 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 | Metrics in the data; list type. Different levels support different metrics, so fill this in carefully |
| group_by | Grouping dimensions in the data; list type. Different levels support different group_by values, so fill this in carefully |
- Grouping dimensions
The following table shows all grouping dimensions supported by the full report query API. Note that after you add some dimensions, you may not be able to query some metric fields. To adjust, add the grouping items to source.group_by:
| Grouping item | Field | Default | Remarks |
|---|---|---|---|
| date | date | Yes | Date, in the format YYYY-mm-dd |
| appId | app_id | Yes | App ID (TradPlus) |
| platform | Yes | OS platform of the app (1 Android, 2 iOS) | |
| package_name | Yes | Package name | |
| placementId | placement_id | Yes | Ad placement ID (TradPlus) |
| placement_name | Yes | Ad placement name (TradPlus) | |
| adFormat | ad_format | Yes | Ad placement type |
| ad_format_name | Yes | Ad placement type name | |
| area | area | Yes | Country/region code (ISO 3166-1 two-letter country/region code) |
| network | network | Yes | Ad network ID |
| network_name | Yes | Ad network name | |
| networkPlacementId | network_placement_id | Yes | Ad placement ID of the ad network |
| network_placement_name | Yes | Ad source name of the ad network (TradPlus) | |
| network_placement_info | Yes | Ad placement details of the ad network | |
| adSceneId | ad_scene_id | Ad scenario ID | |
| ad_scene_name | Ad scenario name | ||
| sdk | sdk | SDK version | |
| channel | channel | Channel | |
| appVersion | app_version | App version | |
| idfa | idfa | IDFA authorization | |
| bucketId | bucket_id | A/B test group |
- Metric fields
By default, we store some of the fields. To adjust them, enter the metric field names in source.metrics:
| Metric field | Ingested name | Default | Remarks |
|---|---|---|---|
| dau | dau | Yes | Daily active users counted by TradPlus (app level) |
| deu | deu | Yes | Daily users who watched ads, counted by TradPlus |
| arpu | arpu | Yes | Average revenue per user counted by TradPlus |
| newUsers | new_users | Yes | New users counted by TradPlus (app level) |
| newUserRate | new_user_rate | Yes | Percentage of new users counted by TradPlus (app level) |
| bidRequestApi | bid_request_api | Bid requests of the third-party ad network | |
| bidResponseApi | bid_response_api | Bid responses of the third-party ad network | |
| bidResponseRateApi | bid_response_rate_api | Bid response rate of the third-party ad network | |
| bidWinRateApi | bid_win_rate_api | Bid win rate of the third-party ad network | |
| requestApi | request_api | Yes | Requests of the third-party ad network |
| fillApi | fill_api | Yes | Fills of the third-party ad network |
| fillrateApi | fillrate_api | Yes | Fill rate of the third-party ad network |
| impressionApi | impression_api | Yes | Impressions of the third-party ad network |
| clickApi | click_api | Yes | Clicks of the third-party ad network |
| ctrApi | ctr_api | Yes | Click-through rate of the third-party ad network |
| ecpmApi | ecpm_api | Yes | ECPM of the third-party ad network |
| revenue | revenue | Yes | Revenue of the third-party ad network |
| appRequest | app_request | App requests counted by TradPlus | |
| enterAdScene | enter_ad_scene | Ad scenario entries counted by TradPlus | |
| enterAdSceneUsers | enter_ad_scene_users | Users entering ad scenarios, counted by TradPlus | |
| bidRequest | bid_request | Bid requests counted by TradPlus | |
| bidResponse | bid_response | Bid responses counted by TradPlus | |
| bidResponseRate | bid_response_rate | Bid response rate counted by TradPlus | |
| bidWinRate | bid_win_rate | Bid win rate counted by TradPlus | |
| request | request | Yes | Requests counted by TradPlus |
| fill | fill | Yes | Fills counted by TradPlus |
| fillrate | fillrate | Yes | Fill rate counted by TradPlus |
| impression | impression | Yes | Impressions counted by TradPlus |
| impressionRatio | impression_ratio | Yes | Impression share counted by TradPlus |
| click | click | Yes | Clicks counted by TradPlus |
| clickUsers | click_users | Yes | Users who clicked, counted by TradPlus |
| ctr | ctr | Yes | Click-through rate counted by TradPlus |
| estimateRevenue | estimate_revenue | Yes | Estimated revenue counted by TradPlus |
| eventRevenue | event_revenue | Yes | Event-tracked revenue counted by TradPlus |
2.6 Data ingestion rules
By default, we write the pulled data to the AE project as events:
- The date field in the data, that is, the date of the data, is used as the event's #event_time
- The event name is tradplus_allreport
- All other fields are ingested
2.7 Standardized fields
The AE system standardizes some fields in the TradPlus device-level data report
| Original field | Standardized field | Description |
|---|---|---|
| network_name | te_ads_object.media_source | Monetization channel |
| package_name | te_ads_object.app_id | App ID |
| platform | te_ads_object.platform | Platform, such as Android or iOS |
| package_name | te_ads_object.placement | Ad placement |
| area | te_ads_object.country | Country or region code |
| impression | te_ads_object.impressions | Impressions |
| click | te_ads_object.clicks | Clicks |
| revenue | te_ads_object.revenue | Monetization revenue |