Reference

Endpoint Get Beta Report

Name

get_beta_report

Description

Generates and downloads an Amazon Ads report. [API reference]

Parameters

Parameter Required Options
Name: ReportName

Label: Report Name

 YES
Name: ReportType

Label: Report Type

 YES
Option Value
Campaigns spCampaigns
Targeting spTargeting
Search Term spSearchTerm
Advertised Product spAdvertisedProduct
Purchased Product spPurchasedProduct
Name: StartDatePurchasedProductReportTypeGroupByAsin

Label: 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) 		YES
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
Name: EndDatePurchasedProductReportTypeGroupByAsin

Label: 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) 		YES
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
Name: StartDatePurchasedProductReportTypeGroupByPurchasedAsin

Label: 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) 		YES
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
Name: EndDatePurchasedProductReportTypeGroupByPurchasedAsin

Label: 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) 		YES
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
Name: TimeUnit

Label: Time Unit
Option Value
Summary SUMMARY
Daily DAILY
Name: GroupByCampaignReportType

Label: Group By
Option Value
Campaign campaign
Ad Group adGroup
Campaign Placement campaignPlacement
Name: GroupByTargetingReportType

Label: Group By
Option Value
Targeting targeting
Name: GroupBySearchTermReportType

Label: Group By
Option Value
Search Term searchTerm
Name: GroupByAdvertisedProductReportType

Label: Group By
Option Value
Advertiser advertiser
Name: GroupByPurchasedProductReportType

Label: Group By
Option Value
ASIN asin
Purchased ASIN purchasedAsin
Name: GroupByCampaignMetrics

Label: 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
Name: GroupByAdGroupMetrics

Label: 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
Name: GroupByCampaignPlacementMetrics

Label: 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
Name: GroupByTargetingMetrics

Label: 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
Name: GroupBySearchTermMetrics

Label: 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
Name: GroupByAdvertiserMetrics

Label: 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

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing Amazon Ads Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Amazon Ads Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Amazon Ads
Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
Amazon Ads
Get Beta Report
Required Parameters
Report Name Fill-in the parameter...
Report Type Fill-in the parameter...
Report Start Date (yyyy-MM-dd) Maximum date range: 31 days Fill-in the parameter...
Report End Date (yyyy-MM-dd) Maximum date range: 31 days Fill-in the parameter...
Report Start Date (yyyy-MM-dd) Maximum date range: 731 days Fill-in the parameter...
Report End Date (yyyy-MM-dd) Maximum date range: 731 days Fill-in the parameter...
Optional Parameters
Time Unit SUMMARY
Group By campaign
Group By targeting
Group By searchTerm
Group By advertiser
Group By asin
Metrics clicks
Metrics clicks
Metrics clicks
Metrics clicks
Metrics clicks
Metrics clicks
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Amazon Ads
Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.
Amazon Ads
Get Beta Report
Required Parameters
Report Name Fill-in the parameter...
Report Type Fill-in the parameter...
Report Start Date (yyyy-MM-dd) Maximum date range: 31 days Fill-in the parameter...
Report End Date (yyyy-MM-dd) Maximum date range: 31 days Fill-in the parameter...
Report Start Date (yyyy-MM-dd) Maximum date range: 731 days Fill-in the parameter...
Report End Date (yyyy-MM-dd) Maximum date range: 731 days Fill-in the parameter...
Optional Parameters
Time Unit SUMMARY
Group By campaign
Group By targeting
Group By searchTerm
Group By advertiser
Group By asin
Metrics clicks
Metrics clicks
Metrics clicks
Metrics clicks
Metrics clicks
Metrics clicks
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get beta report 

SELECT * FROM get_beta_report
WITH
(
    "ReportName" = 'Test Name',
    "ReportType" = 'spCampaigns',
    "StartDatePurchasedProductReportTypeGroupByAsin" = 'today-30d',
    "EndDatePurchasedProductReportTypeGroupByAsin" = 'today',
    "StartDatePurchasedProductReportTypeGroupByPurchasedAsin" = 'today-365d',
    "EndDatePurchasedProductReportTypeGroupByPurchasedAsin" = 'today'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get beta report 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_beta_report
WITH
(
    "ReportName" = ''Test Name'',
    "ReportType" = ''spCampaigns'',
    "StartDatePurchasedProductReportTypeGroupByAsin" = ''today-30d'',
    "EndDatePurchasedProductReportTypeGroupByAsin" = ''today'',
    "StartDatePurchasedProductReportTypeGroupByPurchasedAsin" = ''today-365d'',
    "EndDatePurchasedProductReportTypeGroupByPurchasedAsin" = ''today''
)';

EXEC (@MyQuery) AT [LS_TO_AMAZON_ADS_IN_GATEWAY];