Apple Search Ads Field Reference
Sample
https://connectors.windsor.ai/apple_search_ads?api_key=[your API key]&date_preset=last_7d&fields=date,campaign,clicks,installs,spend,impressions&_renderer=csv
The Apple Search Ads connector lets you pull Apple Search ads data on a campaign level. If you specify the fields
date_from and date_to it will filter for a absolute date range (example: &date_from=2021-10-01&date_to=2021-10-10 instead of &date_preset=last_7d would return data from October 1st to October 10th 2021 instead of the last 7 days).Fields
| ID | Type | Name | Description |
|---|---|---|---|
| account_id | TEXT | Account ID | The Account ID |
| account_name | TEXT | Account Name | The Account Name |
| ad_group_display_status | TEXT | Ad Group Display Status | The state of the operation. |
| ad_group_id | TEXT | Ad Group Id | The unique identifier for the ad group the search term belongs to. |
| ad_group_name | TEXT | Ad Group Name | The name of the ad group, which is unique within the campaign. Responses don't include deleted ad groups. |
| ad_group_serving_state_reasons | TEXT | Ad Group Serving State Reasons | A list of reasons that displays when an ad group isn't running. |
| ad_group_serving_status | TEXT | Ad Group Serving Status | The status of whether the ad group is serving. |
| ad_group_status | TEXT | Ad Group Status | The status of the ad group. |
| app | TEXT | App | The App Name |
| automated_keywords_opt_in | BOOLEAN | Automated Keywords Opt In | The parameter for enabling and disabling Search Match. If true, the system automatically adds optimized keywords in addition to those you explicitly add to the ad group. |
| campaign | TEXT | Campaign | The Campaign Name |
| campaign_id | TEXT | Campaign ID | The Campaign ID |
| clicks | NUMERIC | Clicks | The Number of Clicks |
| conversion_rate | PERCENT | Conversion Rate | The Conversion Rate |
| countries_or_regions | TEXT | Country or Region | A group of countries and regions. |
| cpa | NUMERIC | Cost Per Acquisition | The Average Cost Per Acquisition |
| cpa_goal | NUMERIC | Cpa Goal | The cost-per-acquisition goal. |
| cpm | NUMERIC | Cost Per Thousand Impressions | The Average Cost Per Thousand Impressions |
| cpt | NUMERIC | Cost Per Tap | The Average Cost Per Tap |
| currency | TEXT | Currency | Campaign currency |
| date | DATE | Date | The Date |
| default_bid_amount | NUMERIC | Default Bid Amount | The default maximum cost per tap or impression bid for the ad group. |
| deleted | BOOLEAN | Deleted | An indicator of whether the search term is soft-deleted. |
| end_time | DATE | End Time | The scheduled end date and time for the ad group. |
| impressions | NUMERIC | Impressions | The Number of Impressions |
| installs | NUMERIC | Installs | The Number of installs |
| keyword | TEXT | Keyword | The targeting or negative keywords. |
| keyword_display_status | TEXT | Keyword Display Status | The state of the keyword display operation. |
| keyword_id | NUMERIC | Keyword Id | The unique identifier for a keyword that belongs to an ad group. |
| lat_off_installs | NUMERIC | Lat off installs | The Lat Off Installs |
| lat_on_installs | NUMERIC | Lat on installs | The Lat On Installs |
| match_type | TEXT | Match Type | An automated keyword and bidding strategy. See Ad Groups for Search Match use cases. |
| new_downloads | NUMERIC | New Downloads | The Number of New Downloads |
| number_of_installs | NUMERIC | Number of Installs | The Number of installs |
| org_id | NUMERIC | Org Id | The identifier of the organization that owns the campaign. Your orgId is the same as your account in the Apple Search Ads UI. |
| re_downloads | NUMERIC | Re Downloads | The Number of Re Downloads |
| search_term_source | TEXT | Search Term Source | The source of the keyword to use as a search term. |
| search_term_text | TEXT | Search Term Text | The search terms to use for app searches. |
| spend | NUMERIC | Spend | The Media Spend |
| start_time | DATE | Start Time | The scheduled start date and time for the ad group. |
| taps | NUMERIC | Taps | The Number of Taps |
| totalcost | NUMERIC | Total Cost | The Media Spend |
| ttr | PERCENT | Tap Through Rate | The Tap Through Rate |