Apple Search Ads API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "apple_search_ads",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"sync_mode": "SpecificOrganizations | AllOrganizations",
"timezone_mode": "UserTimezone | UTC",
"timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
"organizations": [
"string"
],
"show_records_with_no_metrics": true,
"schema": "schema_name"
},
"auth": {
"key_id": "your_api_key_id",
"team_id": "your_api_team_id",
"client_id": "your_api_client_id"
}
}Config parameters
| Name | Description |
|---|---|
sync_mode | Sync Mode |
timezone_mode | Determines whether to use UTC or the users timezone from the apple account |
timeframe_months | Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created. NOTE: The more months of reporting data you sync, the longer your initial sync will take. |
organizations | Organizations |
show_records_with_no_metrics | Turn the toggle on if you want the reports to also return records without metrics. |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
key_id,team_idandclient_idparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "apple_search_ads", "group_id": "group_id", "auth": { "key_id": "your_api_key_id", "team_id": "your_api_team_id", "client_id": "your_api_client_id" } }Auth Parameters
Name Description key_idApple Search Ads REST API Key ID. Must be populated if is_auth2_enabledis set totrue.team_idApple Search Ads REST API Team ID. Must be populated if is_auth2_enabledis set totrue.client_idApple Search Ads REST API Client ID. Must be populated if is_auth2_enabledis set totrue.By using the Connect Card or the Fivetran dashboard.