Set up data connector
Learn how Singular pulls advertising cost data from Apple Search Ads (ASA) and displays it in your reports.
Important: ASA has two solutions advertisers can use: Advanced or Basic (see differences here). Campaigns run on ASA's Basic solution are not supported in their reporting API so Singular will not be able to report advertising costs for those campaigns.
Updated Feb 11, 2022: Added Keyword Match Type dimension.
Quick Details
| Data Connector Technology | API (Apple Search Ads API v. 4) |
| Data breakdown (segmentation) |
Data from Apple Search Ads is broken down by:
In addition, you can choose one of the following breakdowns:
If you're interested in the City and Region breakdown instead of the keyword breakdown, reach out to your Customer Success Manager or Singular support. |
| How far back we pull data | 30 days |
| Time zone | By default, Singular pulls data in the original time zone you have defined in the Apple dashboard. Contact us if you want your data to be pulled in UTC. |
| Is data available on the creative level? | Yes |
| Does Singular show your creative assets? | No (the Apple Search Ads API does not provide access to the creative assets) |
| Does Singular supports Custom Product Page ROI? |
Yes - Each Apple Search Ads Creative corresponds to one and only one Custom Product Page |
Data Mapping
Tips:
- Singular's Sub-Campaign corresponds to Apple's Ad Group.
- The Publisher field is not populated for this data connector since the publisher is Apple Search Ads.
- For descriptions of each field in Singular reporting, see the Singular Metrics and Dimensions Glossary
| Field in Singular UI | Field in Singular API | Field in Apple |
| Dimensions | ||
| Account ID | adn_account_id | orgID |
| App | app | appName |
| App Site ID | app_site_id | adamId |
| City |
city |
locality |
| Country | country_field | countryOrRegion OR countryCode |
| Creative Format |
creative_format |
adFormat |
| Creative ID | creative_id | adId |
| Creative Name | creative_name | adName |
| Date | date_field | date |
| Keyword | keyword | searchTermText OR keyword |
| Keyword ID | keyword_id | keywordId |
| Keyword Match Type | keyword_match_type | matchType |
| Network Campaign ID | adn_campaign_id | (campaign) id |
| Network Campaign Name | adn_campaign_name | (campaign) name |
| Network Creative ID | adn_creative_id | adId, |
| Network Creative Name | adn_creative_name | adName |
| Network Sub Campaign ID | adn_sub_campaign_id | (adGroup) id |
| Network Sub Campaign Name | adn_sub_campaign_name | (adGroup) name |
| OS | os | Always "iOS" (hardcoded) |
| Platform |
platform |
deviceClass |
| Public Id | site_public_id | adamId |
| Region |
region |
adminArea |
| Sub Ad Network |
adn_subadnetwork |
adChannelType |
| Timezone | adn_timezone | timeZone |
| Ad Type | ad_type | SupplySources |
| Product Page ID | product_page_id | productPageId |
| Product Page Name | product_page_name | productPageName |
| Metrics | ||
| Network Clicks | adn_clicks | taps |
| Network Impressions | adn_impressions | impressions |
| Network Installs | adn_installs | installs |
| Original Cost | adn_original_cost | amount |
| Original Currency | adn_original_currency | currency |
Singular also supports pulling campaign properties for this partner - please see more details here.