Amazon Ads Connector
Documentation
Version: 1
Documentation
Endpoint

Get Report

Name

get_report

Description

Downloads an Amazon Ads report. [API reference]

Parameters

Parameter Label Required Options Description
RecordType Record Type YES
Option Value
campaigns campaigns
adGroups adGroups
keywords keywords
productAds productAds
asins asins
ReportDate Report Date (yyyyMMdd) 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
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)
Metrics Metrics YES
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
StateFilter State Filter NO
Option Value
enabled enabled
paused paused
archived archived
CampaignType Campaign Type NO
Option Value
sponsoredProducts sponsoredProducts
headlineSearch headlineSearch
Segment Segment NO
Option Value
query query
placement placement

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw 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 Raw 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 component to read data or in API Destination component to read/write data:

Get Report using API Source

Amazon Ads
Get Report
SSIS API Source - Read from table or endpoint

Get Report using API Destination

Amazon Ads
Get Report
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get report 

SELECT * FROM get_report
WITH
(
    "RecordType" = 'keywords',
    "ReportDate" = 'today',
    "Metrics" = 'abcd-1234-metrics'
)

SQL Server

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

Get report 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_report
WITH
(
    "RecordType" = ''keywords'',
    "ReportDate" = ''today'',
    "Metrics" = ''abcd-1234-metrics''
)';

EXEC (@MyQuery) AT [LS_TO_AMAZON_ADS_IN_GATEWAY];