Amazon Ads Connector

ZappySys Amazon Ads Connector provide read / write capability inside your app (see list below), using these drag and drop , high performance connector you can perform many Amazon Ads operations without any coding. You can use this connector to integrate Amazon Ads data inside apps like SSIS, SQL Server or popular ETL Platforms / BI Tools/ Reporting Apps / Programming languages (i.e. Informatica, Power BI, SSRS, Excel, C#, JAVA, Python)

Download for SSIS Download for Other Apps Documentation

Click on your App below to get started with Amazon Ads Integration

Choose your App / Scenario for which you like to integrate Amazon Ads

Actions supported by Amazon Ads Connector

Amazon Ads Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 test_connection
Endpoint to test connection.    [Read more...]
 get_profiles
Gets your Amazon Ads profiles    [Read more...]
 Get Report
Downloads an Amazon Ads report.    [Read more...]
Parameter Description
Record Type
Option Value
campaigns campaigns
adGroups adGroups
keywords keywords
productAds productAds
asins asins
State Filter
Option Value
enabled enabled
paused paused
archived archived
Campaign Type
Option Value
sponsoredProducts sponsoredProducts
headlineSearch headlineSearch
Segment
Option Value
query query
placement placement
Report Date (yyyyMMdd) The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
Metrics
Option Value
adGroupId adGroupId
adGroupName adGroupName
attributedConversions14d attributedConversions14d
attributedConversions14dSameSKU attributedConversions14dSameSKU
attributedConversions1d attributedConversions1d
attributedConversions1dSameSKU attributedConversions1dSameSKU
attributedConversions30d attributedConversions30d
attributedConversions30dSameSKU attributedConversions30dSameSKU
attributedConversions7d attributedConversions7d
attributedConversions7dSameSKU attributedConversions7dSameSKU
attributedKindleEditionNormalizedPagesRead14d attributedKindleEditionNormalizedPagesRead14d
attributedKindleEditionNormalizedPagesRoyalties14d attributedKindleEditionNormalizedPagesRoyalties14d
attributedSales14d attributedSales14d
attributedSales14dSameSKU attributedSales14dSameSKU
attributedSales1d attributedSales1d
attributedSales1dSameSKU attributedSales1dSameSKU
attributedSales30d attributedSales30d
attributedSales30dSameSKU attributedSales30dSameSKU
attributedSales7d attributedSales7d
attributedSales7dSameSKU attributedSales7dSameSKU
attributedUnitsOrdered14d attributedUnitsOrdered14d
attributedUnitsOrdered14dSameSKU attributedUnitsOrdered14dSameSKU
attributedUnitsOrdered1d attributedUnitsOrdered1d
attributedUnitsOrdered1dSameSKU attributedUnitsOrdered1dSameSKU
attributedUnitsOrdered30d attributedUnitsOrdered30d
attributedUnitsOrdered30dSameSKU attributedUnitsOrdered30dSameSKU
attributedUnitsOrdered7d attributedUnitsOrdered7d
attributedUnitsOrdered7dSameSKU attributedUnitsOrdered7dSameSKU
campaignBudget campaignBudget
campaignBudgetType campaignBudgetType
campaignId campaignId
campaignName campaignName
campaignStatus campaignStatus
clicks clicks
cost cost
currency currency
impressions impressions
keywordBid keywordBid
keywordId keywordId
keywordStatus keywordStatus
keywordText keywordText
matchType matchType
query query
 Get Beta Report
Generates and downloads an Amazon Ads report.    [Read more...]
Parameter Description
Report Name
Report Type
Option Value
Campaigns spCampaigns
Targeting spTargeting
Search Term spSearchTerm
Advertised Product spAdvertisedProduct
Purchased Product spPurchasedProduct
Time Unit
Option Value
Summary SUMMARY
Daily DAILY
Group By
Option Value
Campaign campaign
Ad Group adGroup
Campaign Placement campaignPlacement
Group By
Option Value
Targeting targeting
Group By
Option Value
Search Term searchTerm
Group By
Option Value
Advertiser advertiser
Group By
Option Value
ASIN asin
Purchased ASIN purchasedAsin
Report Start Date (yyyy-MM-dd) Maximum date range: 31 days The start date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
Report End Date (yyyy-MM-dd) Maximum date range: 31 days The end date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
Report Start Date (yyyy-MM-dd) Maximum date range: 731 days The start date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
Report End Date (yyyy-MM-dd) Maximum date range: 731 days The end date for the data to retrieve in YYYY-MM-DD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
Metrics
Option Value
impressions impressions
clicks clicks
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
date date
startDate startDate
endDate endDate
campaignBiddingStrategy campaignBiddingStrategy
costPerClick costPerClick
clickThroughRate clickThroughRate
spend spend
campaignName campaignName
campaignId campaignId
campaignStatus campaignStatus
campaignBudgetAmount campaignBudgetAmount
campaignBudgetType campaignBudgetType
campaignRuleBasedBudgetAmount campaignRuleBasedBudgetAmount
campaignApplicableBudgetRuleId campaignApplicableBudgetRuleId
campaignApplicableBudgetRuleName campaignApplicableBudgetRuleName
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
topOfSearchImpressionShare topOfSearchImpressionShare
Metrics
Option Value
impressions impressions
clicks clicks
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
date date
startDate startDate
endDate endDate
campaignBiddingStrategy campaignBiddingStrategy
costPerClick costPerClick
clickThroughRate clickThroughRate
spend spend
adGroupName adGroupName
adGroupId adGroupId
adStatus adStatus
Metrics
Option Value
impressions impressions
clicks clicks
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
date date
startDate startDate
endDate endDate
campaignBiddingStrategy campaignBiddingStrategy
costPerClick costPerClick
clickThroughRate clickThroughRate
spend spend
placementClassification placementClassification
Metrics
Option Value
impressions impressions
clicks clicks
costPerClick costPerClick
clickThroughRate clickThroughRate
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
salesOtherSku7d salesOtherSku7d
unitsSoldOtherSku7d unitsSoldOtherSku7d
acosClicks7d acosClicks7d
acosClicks14d acosClicks14d
roasClicks7d roasClicks7d
roasClicks14d roasClicks14d
keywordId keywordId
keyword keyword
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
date date
startDate startDate
endDate endDate
portfolioId portfolioId
campaignName campaignName
campaignId campaignId
campaignBudgetType campaignBudgetType
campaignBudgetAmount campaignBudgetAmount
campaignStatus campaignStatus
keywordBid keywordBid
adGroupName adGroupName
adGroupId adGroupId
keywordType keywordType
matchType matchType
targeting targeting
topOfSearchImpressionShare topOfSearchImpressionShare
adKeywordStatus adKeywordStatus
Metrics
Option Value
impressions impressions
clicks clicks
costPerClick costPerClick
clickThroughRate clickThroughRate
cost cost
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
salesOtherSku7d salesOtherSku7d
unitsSoldOtherSku7d unitsSoldOtherSku7d
acosClicks7d acosClicks7d
acosClicks14d acosClicks14d
roasClicks7d roasClicks7d
roasClicks14d roasClicks14d
keywordId keywordId
keyword keyword
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
date date
startDate startDate
endDate endDate
portfolioId portfolioId
searchTerm searchTerm
campaignName campaignName
campaignId campaignId
campaignBudgetType campaignBudgetType
campaignBudgetAmount campaignBudgetAmount
campaignStatus campaignStatus
keywordBid keywordBid
adGroupName adGroupName
adGroupId adGroupId
keywordType keywordType
matchType matchType
targeting targeting
adKeywordStatus adKeywordStatus
Metrics
Option Value
date date
startDate startDate
endDate endDate
campaignName campaignName
campaignId campaignId
adGroupName adGroupName
adGroupId adGroupId
adId adId
portfolioId portfolioId
impressions impressions
clicks clicks
costPerClick costPerClick
clickThroughRate clickThroughRate
cost cost
spend spend
campaignBudgetCurrencyCode campaignBudgetCurrencyCode
campaignBudgetAmount campaignBudgetAmount
campaignBudgetType campaignBudgetType
campaignStatus campaignStatus
advertisedAsin advertisedAsin
advertisedSku advertisedSku
purchases1d purchases1d
purchases7d purchases7d
purchases14d purchases14d
purchases30d purchases30d
purchasesSameSku1d purchasesSameSku1d
purchasesSameSku7d purchasesSameSku7d
purchasesSameSku14d purchasesSameSku14d
purchasesSameSku30d purchasesSameSku30d
unitsSoldClicks1d unitsSoldClicks1d
unitsSoldClicks7d unitsSoldClicks7d
unitsSoldClicks14d unitsSoldClicks14d
unitsSoldClicks30d unitsSoldClicks30d
sales1d sales1d
sales7d sales7d
sales14d sales14d
sales30d sales30d
attributedSalesSameSku1d attributedSalesSameSku1d
attributedSalesSameSku7d attributedSalesSameSku7d
attributedSalesSameSku14d attributedSalesSameSku14d
attributedSalesSameSku30d attributedSalesSameSku30d
salesOtherSku7d salesOtherSku7d
unitsSoldSameSku1d unitsSoldSameSku1d
unitsSoldSameSku7d unitsSoldSameSku7d
unitsSoldSameSku14d unitsSoldSameSku14d
unitsSoldSameSku30d unitsSoldSameSku30d
unitsSoldOtherSku7d unitsSoldOtherSku7d
kindleEditionNormalizedPagesRead14d kindleEditionNormalizedPagesRead14d
kindleEditionNormalizedPagesRoyalties14d kindleEditionNormalizedPagesRoyalties14d
acosClicks7d acosClicks7d
acosClicks14d acosClicks14d
roasClicks7d roasClicks7d
roasClicks14d roasClicks14d
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Amazon Ads Connector Examples (For ODBC PowerPack)

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

There are no examples

Download for SSIS Download for Other Apps