# Apple Search Ads ## Pipeline Concepts Before setting up the pipeline, learn about pipeline concepts [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) ## Step by Step Guide ### STEP-1: Configure Connection To learn about Connection, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Log into Sprinkle application * Navigate to Ingest -> 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 [docs](https://developer.apple.com/documentation/apple_search_ads/implementing_oauth_for_the_apple_search_ads_api) * *Client Secret*: To generate Client Secret, Refer to this [docs](https://developer.apple.com/documentation/apple_search_ads/implementing_oauth_for_the_apple_search_ads_api) * *Advance Settings:* Refer [here](#advanced-connection-settings) * Test Connection * Create ### STEP-2: Configure Pipeline To learn about Pipeline, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Navigate to Import -> Pipeline -> 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](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines). 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](https://developer.apple.com/documentation/apple_search_ads). 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\_\\_\ * *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](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/databases/features/destination-create-table-clause) 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
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