Moloco Log API
Note that data generated by third-party data integration counts toward the cluster's data consumption
Moloco Log API is deprecated and is shown as Log API (Deprecated) in the AE backend. We recommend using Moloco Report API instead.
Summary
Interface overview
| Interface | Type | Granularity | Attribution | Cost | Revenue | Impressions | Clicks | Conversions |
|---|---|---|---|---|---|---|---|---|
| Log API | API | User data | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Log API provides user-level raw data with very rich user information.
Integration process
- Log in to your Moloco account and get the Workplace ID
- Log in to the AE backend, go to the Third-party Integration module, add a Moloco Log API plan, and complete the related configuration
- Check whether the AE system receives the data successfully, and build reports
1. Get the authorization information
1.1 Get the Workplace ID
Before calling the API, you need to get the Workplace ID. Log in to your Moloco account and click the Settings button in the left sidebar to open the settings page. On the settings page, you can get the Workplace ID on the Information tab, as shown in the image below.
1.2 Provide the Moloco account and password
Calling the Moloco API requires a Token, and generating the Token requires your Moloco account and password. If you don't want to use your everyday account directly, you can also create a new Moloco account dedicated to API calls. See the image below for how to create a new account
1.3 Get the ad account ID
Finally, get the IDs of all the ad accounts you want to pull data from. You can get the ad account ID as shown in the image below. Because you can configure multiple ad accounts, we recommend getting the IDs of all the ad accounts you want to pull data from
1.4 Summary
You need to get the following information from the Moloco backend:
- Workplace ID
- The Moloco account name, that is, the Email
- The Moloco account password
- The IDs of all the ad accounts you want to pull data from
2. Plan configuration
After you get the Moloco authorization information, you can log in to the AE system backend and configure Moloco Log API in the Third-party Integration module. The image below shows the Moloco configuration page:
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 following in order:
- Workplace ID: the Workplace ID you got earlier
- Email: the Moloco account name
- Password: the password of the Moloco account
- Ad Account ID: the IDs of the ad accounts you want to pull data from. Separate multiple IDs with ","
2.2 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.3 Configuration
In the Configuration module, you can control the details of data pulling, such as the event name after ingestion and the dimensions of the pulled data.
The content of the configuration is a JSON, which you can customize as follows:
| Module | Name | Description |
|---|---|---|
| sink_event | event_mapping | Event name after ingestion. Customizable; different reports can have different names. The Key corresponds to source.report_types |
| source | report_types | Report types to pull |
| transfer | double_columns | Ingested metric fields. Do not modify |
Log API provides three types of detailed data:
- IMP: impression data, which includes impressions and impression cost
- CLICK: click data, which includes clicks as well as the user's earlier impressions and impression cost
- CONVERSION: conversion data, which includes conversion, attribution, cost, and revenue data obtained from the MMP, as well as the user's earlier impressions and clicks
- For the specific fields returned for the three types of detailed data and their meanings, see the Moloco official documentation
The detailed data of Log API identifies users by ADID (that is, GAID) and IDFA, and custom user identification fields can't be set. Therefore, the AE system doesn't currently support user identification fields or the ingestion of user properties. Log API data is written only to the event table, and the data belongs to one virtual user.
By default, we connect all three types of data. To make changes, enter the names of the reports you need in source.report_types
2.3.1 Common fields
- The following fields are common to all three types of detailed data:
| Ingested field name | Description |
|---|---|
| req_exchange | Ad exchange of the bid |
| req_timestamp | Bid request time |
| req_app_bundle | Bundle name |
| req_app_publisher_id | Publisher ID |
| req_device_ifa | Device ID, such as ADID or IDFA |
| req_device_os | Device platform, such as ios or android |
| req_device_osv | Device platform version |
| req_device_carrier | Device carrier |
| req_device_connectiontype | Device network status |
| req_device_hwv | Device hardware version |
| req_device_make | Device manufacturer |
| req_device_model | Device model |
| req_device_devicetype | Device Type |
| req_device_language | Device language |
| req_device_ip | Device IP address |
| req_device_lmt | Whether LAT is enabled |
| req_device_geo_country | Country or region code |
| req_device_geo_utcoffset | Time zone offset in minutes |
| req_device_geo_region | US region code |
| req_device_geo_metro | Google metro code |
| req_device_geo_city | City |
| req_device_geo_zip | ZIP code |
| req_imp_bidfloor | Bid floor price |
| req_imp_tagid | Ad placement or tag ID |
| req_imp_banner_w | Banner width |
| req_imp_banner_h | Banner height |
| req_imp_video_maxduration | Maximum video duration |
| req_imp_video_minduration | Minimum video duration |
| req_imp_video_w | Video width |
| req_imp_video_h | Video height |
| req_imp_video_skip | Whether the video can be skipped |
| req_imp_video_ext_is_rewarded | Whether it is a rewarded video |
| req_imp_native_ext_has_image | Whether banner ads are allowed |
| req_imp_native_ext_has_video | Whether video ads are allowed |
| req_imp_instl | Whether interstitial ads are allowed |
| bid_mtid | Unique Moloco bid ID |
| bid_advertiser_id | Advertiser ID |
| bid_advertiser_title | Advertiser name |
| bid_campaign_id | Campaign ID |
| bid_campaign_title | Campaign name |
| bid_adgroup_id | Ad group ID |
| bid_adgroup_title | Ad group name |
| bid_creativegroup_id | Creative group ID |
| bid_creativegroup_title | Creative group name |
| bid_creative_id | Asset ID |
| bid_creative_title | Creative name |
| bid_creative_type | Creative type |
| bid_creative_w | Creative width |
| bid_creative_h | Creative height |
| bid_creative_size_in_bytes | Creative size |
| bid_creative_video_duration | Video duration, or 0 if it isn't a video |
| bid_user_bucket | User traffic bucket |
| bid_adslot_type | Ad slot type |
| bid_adslot_w | Ad slot width |
| bid_adslot_h | Ad slot height |
2.3.2 IMP data (Impression)
The following fields are specific to IMP data:
| Ingested field name | Description |
|---|---|
| imp_timestamp | Impression time |
| imp_cost_moloco_micro | Original impression cost, in USD, multiplied by 1,000,000 |
| imp_cost_currency | Impression currency |
| imp_cost_fee_percent | Impression service fee, in USD, multiplied by 1,000,000 |
| imp_cost_total_micro | Total impression cost, in USD, multiplied by 1,000,000 |
| imp_ip | IP address |
- imp_timestamp, that is, the time when the impression occurred, is set as the #event_time of the record
- The default event name for IMP data is: moloco_log_imp
2.3.3 CLICK data
The following fields are specific to CLICK data:
| Ingested field name | Description |
|---|---|
| click_timestamp | Click time |
| click_type | Click type |
| click_ip | IP address |
- click_timestamp, that is, the time when the click occurred, is set as the #event_time of the record
- The event name for CLICK data is: moloco_log_click
2.3.4 CONVERSION data
The following fields are specific to CONVERSION data:
| Ingested field name | Description |
|---|---|
| conversion_mmp | Partner |
| conversion_event | Event callback name received from the partner |
| conversion_timestamp | Time when the data was received from the partner |
| conversion_attribution_timestamp | Conversion data time |
| conversion_attribution_is_view_through | Whether it is a view-through conversion |
| conversion_attribution_is_engaged_view_through | Whether it is an engaged view-through conversion |
| conversion_revenue_amount | Revenue sent back |
| conversion_revenue_currency | Currency of the revenue sent back |
| conversion_revenue_amount_usd | Revenue sent back in USD |
| conversion_postback | Raw callback data |
- conversion_attribution_timestamp, that is, the time when attribution occurred, is set as the #event_time of the record
- The event name for CONVERSION data is: moloco_log_conversion
2.4 Standardized fields
The following event properties are standardized:
| Original field | Standardized field | Description |
|---|---|---|
| bid_advertiser_id | te_ads_object.ad_account_id | Ad account ID |
| bid_campaign_title | te_ads_object.campaign_name | Campaign name |
| bid_campaign_id | te_ads_object.campaign_id | Campaign ID |
| bid_adgroup_title | te_ads_object.ad_group_name | Ad group name, or the Unit name for monetization ads |
| bid_adgroup_id | te_ads_object.ad_group_id | Ad group ID, or the Unit ID for monetization ads |
| bid_creativegroup_title | te_ads_object.ad_name | Ad name |
| bid_creativegroup_id | te_ads_object.ad_id | Ad ID |
| req_device_os | te_ads_object.platform | Platform, such as Android or iOS |
| req_device_geo_country | te_ads_object.country | Country or region code |
| USD (fixed value) | te_ads_object.currency | Currency of the cost or revenue |
| imp_cost_total_micro | te_ads_object.cost | User acquisition cost |
| conversion_revenue_amount_usd | te_ads_object.revenue | Monetization revenue |