Apple Search Ads
Guide to integrate your Apple Search Ads with Sprinkle
Datasource Concepts
Before setting up the datasource, learn about datasource concepts here
Step by Step Guide
STEP-1: Configure Connection
To learn about Connection, refer here
Log into Sprinkle application
Navigate to Datasources -> Connections Tab -> New Connection ->
Select Apple Search Ads
Test Connection
Create
STEP-2: Configure Datasource
To learn about datasource, refer here
Navigate to Datasources -> Datasources Tab -> Add ->
Select Apple Search Ads
Provide the name -> Create
Connection Tab:
From the drop-down, select the name of connection created in STEP-2
Update
STEP-3: Create Dataset
Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details
Org (Required) : Select the Org Id from the drop-down
Report Type (Required) : Select the API through which you want the result. Read more from apple search ads api docs. Select report type from any one of the following:
User_ACL
Campaigns
Budget_Orders
Ad_Groups
Campaigns: Select from the drop-down
Campaign_Negative_Keywords
Campaigns: Select from the drop-down
Geolocation
Device_Sizes
Campaign_Level_Report
Start Date: Start Date from which you want to fetch data. Give Start Date in Format yyyy-mm-dd
Window for Backfill: Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. Can take values 1, 7 and 28.
Ad_Group_Level_Report
Campaigns: Select from the drop-down
Start Date: Start Date from which you want to fetch data. Give Start Date in Format yyyy-mm-dd
Window for Backfill: Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. Can take values 1, 7 and 28.
Keyword_Level_Report
Campaigns: Select from the drop-down
Start Date: Start Date from which you want to fetch data. Give Start Date in Format yyyy-mm-dd
Window for Backfill: Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. Can take values 1, 7 and 28.
Search_Term_Level_Report
Campaigns: Select from the drop-down
Start Date: Start Date from which you want to fetch data. Give Start Date in Format yyyy-mm-dd
Window for Backfill: Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. Can take values 1, 7 and 28.
Creative_Set_Level_Report
Campaigns: Select from the drop-down
Start Date: Start Date from which you want to fetch data. Give Start Date in Format yyyy-mm-dd
Window for Backfill: Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. Can take values 1, 7 and 28.
Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.
Destination Schema (Required) : Data warehouse schema where the table will be ingested into
Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<datasourcename>_<tablename>
Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.
Create
STEP-4: Run and schedule Ingestion
In the Ingestion Jobs tab:
Trigger the Job, using Run button
To schedule, enable Auto-Run. Change the frequency if required
Advanced Connection Settings
API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds.
API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.
Retry Limit : Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking.
Retry Sleep Time (In milliseconds) : Given time, after which retry should happen in case an API call fails.
Incremental Batch Size (In days) : No. of days in one batch for which data is being downloaded during incremental ingestion.
Version : It gives information about the version of Apple Search Ads API being used.
Timezone : Enter the applicable timezone from the dropdown.
Dataset Fields
Last updated