Sprinkle Docs
  • What is Sprinkle?
  • Quick Start
  • Analysing your data
    • 🔭Analytics Overview
    • 💠Data Models
      • *️Variables
      • 🌲Hierarchies
      • 🤿Column Mask
    • 🎉Switch to New Reports & Dashboards
    • 🆕Reports
      • Overview
      • Build Using Tables
        • Create a new Report
        • Layout and options
        • Build and Format - Overview
        • Apply Row Limits
        • Identify Date Columns
        • Filter your data
        • Visualizations
          • Table
          • Pivot
          • Line Chart
          • Bar Chart
          • Column Chart
          • Area Chart
          • Combo Chart
          • Scatter & Bubble Plot
          • Pie Chart
          • Funnel Chart
          • Stat Card
          • Point Map
          • Heat Map
          • Radial gauge chart
        • Advanced Features
          • Custom Analysis
          • Variables
          • Table & Quick Calculations
          • Drill - Hierarchical & Date
          • Break Out
          • RLS in Table reports
          • Scheduled Exports
          • Embedding Table Reports
      • Build Using Models
        • Create a new report
        • Layout and options
        • Visualizations
        • Advanced Features
      • Build SQL Reports
        • Create a new Report
        • Layout and options
        • Writing a SQL Code on Editor
        • Visualizations
        • Variables in SQL Reports
    • 🆕Dashboards
      • 🌀Filters
      • 👆Click Behaviour
      • ⏰Data Alerts
      • 🗓️Date Drill
      • 📤Scheduled Exports
      • 🔗Embed link
      • 🖥️Dashboard layout
      • 📱Mobile Dashboards
  • Transforming your data
    • 🔰SQL Transform
    • 📓Python Notebooks
  • Integrating your data
    • ☁️Destination Warehouses
      • AWS Athena
        • Manage storage of Flow tables
      • AWS Redshift
      • Azure Synapse
      • Databricks
      • Google BigQuery
      • MySQL
      • Postgres
      • Snowflake
      • SQL Server
      • K8 Setup
        • AWS EKS
        • Google GKE
        • Azure AKS
    • ⚙️Warehouse & Storage Setup
  • Ingesting your data
    • ☄️Data Imports
      • Databases
        • Azure Cosmos DB
        • Azure Table Storage
        • Google BigQuery
        • Mongo DB
        • MySQL DB
        • Oracle DB
        • Postgres DB
        • SQL Server DB
        • Features
          • Ingestion Modes
          • Add Multiple Datasets
          • CDC Setup
            • CDC setup in Mysql
            • CDC setup in Postgres
            • CDC setup in Mongo
            • CDC setup in SQL Server
          • Destination Create Table Clause
          • SSH Tunnel Setup
      • Files
        • AWS S3
        • AWS S3 External
        • Azure Blob
        • FTP
        • Google Cloud Storage
        • Google Sheet
        • SFTP
      • Applications
        • Apple Search Ads
        • Appsflyer
        • Branch
        • Clevertap
        • Facebook Ads
        • Freshdesk
        • Freshsales
        • Google Ads
        • Google Ads V2
        • Google Analytics
        • Google Analytics 4
        • Google Analytics MCF
        • Google Search Console
        • Hubspot
        • Impact Ads
        • Intercom
        • Klaviyo
        • Leadsquared
        • LinkedIn Ads
        • Magento
        • Mailchimp
        • Marketo
        • Mixpanel
        • MoEngage
        • Rocketlane
        • Salesforce
        • SAP S4
        • Shopify
        • Snapchat Marketing
        • TikTok Ads
        • WooCommerce
        • Zendesk Chat
        • Zendesk Support
        • Zoho Analytics
        • Zoho Books
        • Zoho CRM
        • Zoho Desk
        • Zoho Invoice
        • Zoho Subscription
      • Events
        • Apache Kafka
        • AWS Kinesis
        • Azure EventHub
    • 📤File Uploads
    • 🤖API Pulls
    • 🕸️Webhooks
  • Collaborating on data
    • 📤Sharing
    • 💬Comments
    • ⚡Activity
    • 🏷️Labels
  • Managing Schedules and Data Refreshes
    • ⏱️Schedules
    • 🔔Notifications
  • User Management
    • 🔑Access Management
    • 🧑‍🤝‍🧑Groups
    • 📂Folders
    • 🔄Syncing users, groups and RLS
    • 📧Azure AD Integration
  • Data Security & Privacy
    • 🔐Security at Sprinkle
    • 📄GDPR
    • 📄Privacy Policy
  • Release Notes
    • 📢Release Notes
      • 🗒️Release Notes - v12.1 (New)
      • 🗒️Release Notes - v12.0
      • 🗒️Release Notes - v11.0
      • 🗒️Release Notes - v10.8
      • 🗒️Release Notes - v10.7
      • 🗒️Release Notes - v10.6
      • 🗒️Release Notes - v10.5
      • 🗒️Release Notes - v10.4
      • 🗒️Release Notes - v10.3
      • 🗒️Release Notes - v10.2
      • 🗒️Release Notes - v10.1
      • 🗒️Release Notes - v10.0
      • 🗒️Release Notes - v9.31
      • 🗒️Release Notes - v9.30
      • 🗒️Release Notes - v9.29
      • 🗒️Release Notes - v9.28
      • 🗒️Release Notes - v9.27
      • 🗒️Release Notes - v9.25
      • 🗒️Release Notes - v9.24
      • 🗒️Release Notes - v9.23
      • 🗒️Release Notes - v9.22
      • 🗒️Release Notes - v9.21
      • 🗒️Release Notes - v9.20
      • 🗒️Release Notes - v9.19
      • 🗒️Release Notes - v9.18
      • 🗒️Release Notes - v9.17
      • 🗒️Release Notes - v9.16
      • 🗒️Release Notes - v9.14
      • 🗒️Release Notes - v9.13
      • 🗒️Release Notes - v9.12
      • 🗒️Release Notes -v9.8
      • 🗒️Release Notes - v9.7
      • 🗒️Release Notes - v9.6
      • 🗒️Release Notes - v9.5
      • 🗒️Release Notes - v9.4
      • 🗒️Release Notes - v9.3
      • 🗒️Release Notes - v9.2
      • 🗒️Release Notes - v9.1
      • 🗒️Release Notes - v9.0 (Major)
      • 🗒️Release Notes - v7.23
      • 🗒️Release Notes - v7.21
      • 🗒️Release Notes - v7.20
      • 🗒️Release Notes - v7.15
      • 🗒️Release Notes - v7.14
      • 🗒️Release Notes - v7.13
Powered by GitBook
On this page
  • Datasource Concepts
  • Step by Step Guide
  • STEP-1: Configure Connection
  • STEP-2: Configure Datasource
  • STEP-3: Create Dataset
  • STEP-4: Run and schedule Ingestion
  • Advanced Connection Settings
  • Dataset Fields
  1. Ingesting your data
  2. Data Imports
  3. Applications

Apple Search Ads

Guide to integrate your Apple Search Ads with Sprinkle

PreviousApplicationsNextAppsflyer

Last updated 1 year ago

Datasource Concepts

Before setting up the datasource, learn about datasource concepts

Step by Step Guide

STEP-1: Configure Connection

To learn about Connection, refer

  • Log into Sprinkle application

  • Navigate to Datasources -> Connections Tab -> New Connection ->

  • Select Apple Search Ads

  • Provide all the mandatory details

    • Name: Name to identify this connection

    • Client Id: To generate Client ID, refer to this

    • Client Secret: To generate Client Secret, Refer to this

    • Advance Settings: Refer

  • Test Connection

  • Create

STEP-2: Configure Datasource

  • 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

  • Org (Required) : Select the Org Id from the drop-down

    • 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>

  • 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

User_ACL
  • orgName

  • orgId

  • currency

  • timeZone

  • paymentModel

  • roleNames_Admin

  • parentOrgId

  • displayName

Campaigns
  • adamId

  • adChannelType

  • billingEvent

  • budgetAmount

  • budgetOrders

  • countriesOrRegions

  • countryOrRegionServingStateReasons

  • dailyBudgetAmount

  • deleted

  • displayStatus

  • endTime

  • id

  • locInvoiceDetails

  • modificationTime

  • name

  • orgId

  • paymentModel

  • paymentModel

  • servingStatus

  • startTime

  • status

  • supplySources

Budget_Orders
  • id

  • name

  • startDate

  • endDate

  • budget_amount

  • budget_currency

  • orderNumber

  • clientName

  • primaryBuyerEmail

  • billingEmail

  • status

  • parentOrgId

  • supplySources

Ad_Groups
  • automatedKeywordsOptIn

  • campaignId

  • cpaGoal

  • defaultBidAmount

  • deleted

  • displayStatus

  • endTime

  • id

  • modificationTime

  • name

  • orgId

  • paymentModel

  • pricingModel

  • servingStateReasons

  • servingStatus

  • startTime

  • status

  • targetingDimensions

Campaign_Negative_Keywords
  • id

  • campaignId

  • adGroupId

  • text

  • status

  • matchType

  • modificationTime

  • deleted

Geolocation
  • id

  • entity

  • displayName

  • countryOrRegion

  • adminArea

  • locality

Device_Sizes
  • ipadPro

  • iphone6+

  • iphone_5_8

  • iphone5

  • iphone6

  • ipadPro_2018

  • ipad

  • iphone_6_5

  • ipad_10_5

Campaign_Level_Report
  • other

  • granularity_impressions

  • granularity_taps

  • installs

  • granularity_newDownloads

  • granularity_redownloads

  • granularity_latOnInstalls

  • granularity_latOffInstalls

  • granularity_ttr

  • granularity_avgCPA _amount

  • granularity_avg_CPA_currency

  • granularity_avgCPT amount

  • granularity avgCPT_ currency

  • granularity_ avgCPM amount

  • granularity_avgCPM_currency

  • granularity localSpend _amount

  • granularity_localcurrency

  • granularity_conversionRate

  • granularity_date

  • metadata_ adChannelType

  • metadata_billingEvent

  • metadata_ supplySources

  • metadata_campaignId

  • metadata_campaignName

  • metadata_deleted

  • metadata_campaignStatus

  • metadata_app_appName

  • metadata_app_ adamId

  • metadata_servingStatus

  • metadata_ servingStateReasons

  • metadata_countriesOrRegions

  • metadata_modificationTime

  • metadata_totalBudget_amount

  • metadata_totalBudget_currency

  • metadata_dailyBudget_amount

  • metadata_dailyBudget_currency

  • metadata_displayStatus

  • metadata_orgId

  • metadata_countryOrRegionServingStateReasons

  • metadata_countryOrRegion

  • metadata_deviceClass

Ad_Group_Level_Report
  • other

  • granularity_impressions

  • granularity_taps

  • granularity_installs

  • granularity_newDownloads

  • granularity_redownloads

  • granularity_latOnInstalls

  • granularity_latOffInstalls

  • granularity_ttr

  • granularity_avgCPA_amount

  • granularity_avgCPA_currency

  • granularity_avgCPT_amount

  • granularity_avgCPT_currency

  • granularity_avgCPM_amount

  • granularity_avgCPM_currency

  • granularity_localSpend_amount

  • granularity_localSpend_currency

  • granularity_conversionRate

  • granularity_date

  • metadata_adGroupId

  • metadata_adGroupName

  • metadata_startTime

  • metadata_endTime

  • metadata_cpaGoal

  • metadata_pricingModel

  • metadata_defaultBidAmount_amount

  • metadata_defaultBidAmount_currency

  • deleted

  • adGroupStatus

  • adGroupServingStatus

  • adGroupServingStateReasons

  • modificationTime

  • automatedKeywordsOptIn

  • adGroupDisplayStatus

  • campaignId

  • orgId

  • countryOrRegion

  • deviceClass

Keyword_Level_Report
  • other

  • total_impressions

  • total_taps

  • total_installs

  • total_newDownloads

  • total_redownloads

  • total_latOnInstalls

  • total_latOffInstalls

  • total_ttr

  • total_avgCPA_amount

  • total_avgCPA_currency

  • total_avgCPT_amount

  • total_avgCPT_currency

  • total_avgCPM_amount

  • total_avgCPM_currency

  • total_localSpend_amount

  • total_localSpend_currency

  • total_conversionRate

  • metadata_keywordId

  • metadata_keyword

  • metadata_keywordStatus

  • metadata_matchType

  • metadata_bidAmount_amount

  • metadata_bidAmount_currency

  • deleted

  • keywordDisplayStatus

  • adGroupId

  • adGroupName

  • adGroupDeleted

  • modificationTime

  • insights_bidRecommendation_bidMin_amount

  • insights_bidRecommendation_bidMin_currency

  • insights_bidRecommendation_bidMax_amount

  • insights_bidRecommendation_bidMax_currency

  • grandTotals_other

  • grandTotals_total_impressions

  • grandTotals_total_taps

  • grandTotals_total_installs

  • grandTotals_total_newDownloads

  • grandTotals_total_redownloads

  • grandTotals_total_latOnInstalls

  • grandTotals_total_latOffInstalls

  • grandTotals_total_ttr

  • grandTotals_total_avgCPA_amount

  • grandTotals_total_avgCPA_currency

  • grandTotals_total_avgCPT_amount

  • grandTotals_total_avgCPT_currency

  • grandTotals_total_avgCPM_amount

  • grandTotals_total_avgCPM_currency

  • grandTotals_total_localSpend_amount

  • grandTotals_total_localSpend_currency

  • grandTotals_total_conversionRate

Search_Term_Level_Report
  • other

  • total_impressions

  • total_taps

  • total_installs

  • total_newDownloads

  • total_redownloads

  • total_latOnInstalls

  • total_latOffInstalls

  • total_ttr

  • total_avgCPA_amount

  • total_avgCPA_currency

  • total_avgCPT_amount

  • total_avgCPT_currency

  • total_avgCPM_amount

  • total_avgCPM_currency

  • total_localSpend_amount

  • total_localSpend_currency

  • total_conversionRate

  • metadata_keywordId

  • metadata_keyword

  • metadata_keywordStatus

  • metadata_matchType

  • metadata_bidAmount_amount

  • metadata_bidAmount_currency

  • deleted

  • keywordDisplayStatus

  • adGroupId

  • adGroupName

  • adGroupDeleted

  • searchTermText

  • countryOrRegion

  • searchTermSource

  • grandTotals_other

  • grandTotals_total_impressions

  • grandTotals_total_taps

  • grandTotals_total_installs

  • grandTotals_total_newDownloads

  • grandTotals_total_redownloads

  • grandTotals_total_latOnInstalls

  • grandTotals_total_latOffInstalls

  • grandTotals_total_ttr

  • grandTotals_total_avgCPA_amount

  • grandTotals_total_avgCPA_currency

  • grandTotals_total_avgCPT_amount

  • grandTotals_total_avgCPT_currency

  • grandTotals_total_avgCPM_amount

  • grandTotals_total_avgCPM_currency

  • grandTotals_total_localSpend_amount

  • grandTotals_total_localSpend_currency

  • grandTotals_total_conversionRate

Creative_Set_Level_Report
  • other

  • total_impressions

  • total_taps

  • total_installs

  • total_newDownloads

  • total_redownloads

  • total_latOnInstalls

  • total_latOffInstalls

  • total_ttr

  • total_avgCPA_amount

  • total_avgCPA_currency

  • total_avgCPT_amount

  • total_avgCPT_currency

  • total_avgCPM_amount

  • total_avgCPM_currency

  • total_localSpend_amount

  • total_localSpend_currency

  • total_conversionRate

  • metadata_creativeSetId

  • metadata_creativeSetName

  • metadata_displayStatus

  • metadata_creativeSetLanguageDisplayName

  • metadata_deleted

  • metadata_status

  • metadata_orgId

  • metadata_campaignId

  • metadata_adGroupId

  • metadata_adGroupCreativeSetId

  • metadata_creationTime

  • metadata_modificationTime

  • metadata_adFormat

To learn about datasource, refer

Datasets Tab: To learn about Dataset, refer . Add Dataset for each report/dataset that you want to integrate, providing following details

Report Type (Required) : Select the API through which you want the result. Read more from apple search ads api . Select report type from any one of the following:

Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. on how to use this field.

☄️
here
here
docs
Learn more
here
here
docs
docs
here