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",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "SOURCE_NAMING",
  "config": {
    "custom_reports": [
      {
        "base_report_type": "CAMPAIGN",
        "group_by": [
          "string"
        ],
        "table": "my_custom_report"
      }
    ],
    "organizations": [
      "string"
    ],
    "show_records_with_no_metrics": true,
    "sync_mode": "SpecificOrganizations | AllOrganizations",
    "timeframe_months": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE",
    "timezone_mode": "UserTimezone | UTC",
    "schema": "schema_name"
  },
  "auth": {
    "client_id": "your_api_client_id",
    "key_id": "your_api_key_id",
    "team_id": "your_api_team_id"
  }
}

Config parameters

Name	Description
`custom_reports`	Allows users to define reports with custom groupBy dimensions.
`custom_reports[0].base_report_type`	The base report type. It determines the set of available dimensions for the `groupBy` field and the metrics that will be included in the custom report. Only one value is supported: `CAMPAIGN`.
`custom_reports[0].group_by`	The list of dimensions to group the data by. The available dimensions depend on the selected `baseReportType`.
`custom_reports[0].table`	The name of the custom report table. It must be unique within this connection and must comply with Fivetran's naming conventions.
`organizations`	Organizations
`show_records_with_no_metrics`	Turn the toggle on if you want the reports to also return records without metrics.
`sync_mode`	Sync Mode
`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.
`timezone_mode`	Determines whether to use UTC or the users timezone from the apple account
`schema` (required)	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_id and client_id parameters in the auth section.

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
`client_id`	Apple Search Ads REST API Client ID. Must be populated if `is_auth2_enabled` is set to `true`.
`key_id`	Apple Search Ads REST API Key ID. Must be populated if `is_auth2_enabled` is set to `true`.
`team_id`	Apple Search Ads REST API Team ID. Must be populated if `is_auth2_enabled` is set to `true`.

By using the Connect Card or the Fivetran dashboard.