Meta Ads Integration

Applicable to SA3.0.4 and above.

This feature is controlled by a separate license. Please contact your account manager if you require it.

If your app is running ad campaigns overseas to acquire new users, and you want to retrieve aggregated ad data (such as impressions, clicks, and cost) from overseas advertising platforms into the Sensors Data platform, you can use this feature.

Overview

It supports integration with Meta Ads, enabling the retrieval of ad-level data such as impressions, clicks, and cost via its OpenAPI. The retrieved data is then stored in Sensors Data as events, allowing for analysis within the analytics model. It can also be correlated with downstream user behavior data for further analysis.

Feature Entry

Channel Tracking > Third-Party Data Integration > Advertising > Meta Ads

Instructions

Meta Ads Data Explanation

It supports retrieving ad data via the Meta Ads Ads Insights API, this is an Ad-level template. For API details, please refer to: Meta Ads API

The built-in template covers commonly used advertising metrics and dimensions.

• Ad Group Ad Template: Ad data at the Ad level. The original content can be found in the official documentation . The metrics and dimensions obtainable through this template are as follows:

metrics

metrics.all_conversions metrics.all_conversions_value metrics.active_view_impressions metrics.active_view_cpm metrics.active_view_ctr metrics.impressions metrics.clicks metrics.conversions metrics.cost_micros metrics.cost_per_all_conversions metrics.cost_per_conversion metrics.average_cost metrics.average_cpc metrics.average_cpe metrics.average_cpm metrics.average_cpv metrics.ctr metrics.value_per_all_conversions metrics.value_per_all_conversions_by_conversion_date metrics.value_per_conversion metrics.value_per_conversions_by_conversion_date

group by

customer.id customer.status customer.time_zone customer.currency_code campaign.id campaign.name campaign.status campaign.app_campaign_setting.app_id campaign.advertising_channel_type campaign.advertising_channel_sub_type ad_group.id ad_group.name ad_group.status ad_group.type ad_group_ad.ad.id ad_group_ad.ad.name ad_group_ad.ad.type ad_group_ad.status segments.date segments.ad_network_type segments.slot

Preparation Before Integration

You need to complete authorization and authentication with Meta Ads before you can retrieve ad data through the Meta Ads API. For details, please refer to the official documentation: Meta Ads API Official Documentation

Step	Content	Description
Step 1	Create an application	Log in to the Meta for Developers backend and create an application. Enter the application name. Select the use case that uses the Marketing API to measure ad performance data. In the app settings - advanced options, find the authorized ad account and enter the ad account ID you want to use for subsequent data retrieving here.
Step 2	Add the application as a Business Asset	Log in to the Meta Business Suite, navigate to Ads Manager, then click All Tools and find Business Settings. Add the application you created in step one in Account - Applications Navigate to User > System user. If a system user already exists, select the existing system user under Assign People, click "Assign Assets", and add the application and ad accounts as assets for that system user. If there are no system users, create one as Step 3.
Step 3	Create a System User	Navigate to Users > System Users, create a new system user, and select Admin as the role. Click 'Assign Assets' and add the ad accounts to be used for data retrieving, as well as the application created in Step 1, as assets.
Step 4	Generate Access Token	Generate System Access Token Select application Set to never expire Select permissions, and check ads_management, ads_read, and business_management.
Step 5	Use Access Token	In the integrating with Meta Ads, enter the access token generated in step 4 in the Access Token field.

Configure Meta Ads Integration

The configuration mainly includes the following three parts:

1. Basic Information

2. Authorization Configuration

• • The fields in this section are primarily used for authentication with Meta Ads and to specify the scope of ad accounts to be retrieved. Please refer to the "Preparation Before Integration" section in the previous paragraph to obtain the relevant fields from the Meta Ads platform.
  • A maximum of 100 Meta Ads accounts are supported per integration plan. If you have more than 100 Meta Ads accounts, multiple integration plans can be created.
  • Before saving the solution, you need to complete the 'connection test' to ensure that the Access Token entered here has the necessary permissions to access the Customer ID Lists.
  • A connection test is required when modifying the Access Token and Customer ID. If the test fails, an error code will be displayed.

3. Data Retrieval Configuration

Data Retrieval

Data retrieval is supported, you can select a time period of up to 180 days to retrieve ad data.

Data Storage Instructions

The retrieved Google Ads data will be uniformly stored as events. The original fields will be standardized and stored as attributes prefixed with "sensors_ad".

Note:This data will be counted against your event quota.

These events will use a fixed value as their user identifier, effectively representing a virtual user.

Event name: meta_ads_ad_insight

The following lists some common raw data and their corresponding event properties:

Original field	Event properties
account_id	sensors_ad_customer_id
account_name	sensors_ad_customer_name
account_timezone	sensors_ad_customer_timezone
account_currency	sensors_ad_customer_currency
media _source	sensors_ad_media_source​
campaign_id	sensors_ad_campaign_id
campaign_name	sensors_ad_campaign_name
adset_id	sensors_ad_ad_group_id
adset_name	sensors_ad_ad_group_name
ad_id	sensors_ad_ad_id
ad_name	sensors_ad_ad_name
country	sensors_ad_country
impressions	sensors_ad_metrics_impressions
clicks	sensors_ad_metrics_clicks
spend	sensors_ad_metrics_cost
reach	sensors_ad_metrics_reach

How to Analyze

You can select the corresponding event in Event Analysis to analyze metrics such as Meta Ads impressions, clicks, and cost.

Permissions

By default, administrators can configure Google Ads integration plans. They can also assign permissions for configuring and viewing plans to standard users.