Schema Information for Amazon Sponsored Brands

In this article, we will look at the schema information of the supported APIs and tables for Amazon Sponsored Brands

Find the links to other articles related to Amazon Sponsored Brands Below:

Tables/APIs

The following is the list of tables or APIs associated with the Amazon Sponsored Brand connector:

Profile

Purpose: Retrieve all profiles associated with the Amazon Advertising account

Source API Documentation: Amazon Sponsored Brand Ads - Profile

Replication Type: Full Load

Replication Key: N/A

Store

Purpose: List store information for all registered stores under an advertiser

Source API Documentation: Amazon Sponsored Brand Ads - Store

Replication Type: Full Load

Replication Key: N/A

SponsoredBrands_Campaign

Purpose: Return a list of Sponsored Brands campaigns

Source API Documentation: Amazon Sponsored Brand Ads - Campaign

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
campaignId	STRING
name	STRING
budget	NUMERIC
budgetType	STRING
startDate	STRING
endDate	STRING
state	STRING
servingStatus	STRING
bidOptimization	BOOLEAN
bidMultiplier	NUMERIC
portfolioId	STRING
creative	RECORD
landingPage	RECORD
brandEntityId	STRING
bidAdjustments	RECORD
adFormat	STRING

SponsoredBrands_Keywords

Purpose: Gets an array of keywords.

Source API Documentation: Amazon Sponsored Brand Ads - Keywords

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
keywordId	STRING
adGroupId	STRING
campaignId	STRING
keywordText	STRING
matchType	STRING
state	STRING
bid	NUMERIC
nativeLanguageKeyword	STRING

SponsoredBrands_StoresAssets

Purpose: For sellers or vendors, gets an array of assets associated with the specified brand entity identifier

Source API Documentation: Amazon Sponsored Brand Ads - Stores

Replication Type: Full Load

Replication Key: N/A

Delete

StoreAssets retrieves data based on the profile type:

1. For Seller profiles, data is fetched using the brandEntityId.

2. For Vendor profiles, data is fetched directly.

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
assetId	STRING
mediaType	STRING
url	STRING
name	STRING
brandId	STRING
brandEntityId	STRING
brandRegistryName	STRING

SponsoredBrands_Targets

Purpose: Gets a list of product targets associated with the client identifier

Source API Documentation: Amazon Sponsored Brand Ads - Targets

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
targetId	STRING
adGroupId	STRING
campaignId	STRING
state	STRING
bid	NUMERIC
expressions	RECORD
resolvedExpressions	RECORD

SponsoredBrands_TargetingRecommendations

Purpose: Gets a list of recommended products for targeting. Recommendations are based on the ASINs that are passed in the request.

Source API Documentation: Amazon Sponsored Brand Ads - Targeting Recommendations

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
recommendedTargetAsin	STRING

SponsoredBrands_CampaignsReports

Purpose: Retrieves campaign performance report

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: Campaign

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignName	STRING
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER
applicableBudgetRuleId	STRING
applicableBudgetRuleName	STRING
campaignRuleBasedBudget	NUMERIC

SponsoredBrands_AdGroupsReport

Purpose: Retrieves ad-group performance report

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: None

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignName	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignStatus	STRING
adGroupId	STRING
adGroupName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER

SponsoredBrands_PlacementKeywordsReport

Purpose: Retrieves keyword performance report with 'placement' segmentation

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: Keyword Placement

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
campaignStatus	STRING
keywordId	STRING
keywordStatus	STRING
keywordBid	STRING
keywordText	STRING
matchType	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER
applicableBudgetRuleId	STRING
applicableBudgetRuleName	STRING
campaignBudget	NUMERIC
campaignRuleBasedBudget	NUMERIC
searchTermImpressionRank	INTEGER
searchTermImpressionShare	NUMERIC

Portfolio

Purpose: Retrieve a list of up to 100 portfolios

Source API Documentation: Amazon Sponsored Brand Ads - Portfolio

Replication Type: Full Load

Replication Key: N/A

SponsoredBrands_ProductMetadata

Purpose: The Amazon Product Selector API allows integrators to receive product metadata such as inventory status, price, eligibility status, and product details for SKUS or ASINs in their Product Catalog to launch, manage, or optimize Sponsored Brands or Sponsored Display advertising campaigns. The Product Selector API is available to Sellers, Vendors, and Authors

Source API Documentation: Amazon Sponsored Brand Ads - Product Metadata

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
eligibilityStatus	STRING
basisPrice	RECORD
createdDate	STRING
imageUrl	STRING
priceToPay	RECORD
asin	STRING
availability	STRING
sku	STRING
title	STRING
brand	STRING
variationList	STRING
ineligibilityReasons	STRING
ineligibilityCodes	STRING

SponsoredBrands_AdGroup

Purpose: Return a list of ad groups

Source API Documentation: Amazon Sponsored Brand Ads - Ad Group

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
countryName	STRING
accountName	STRING
accountId	STRING
profileId	STRING
campaignId	STRING
adGroupId	STRING
name	STRING

SponsoredBrands_Drafts

Purpose: Gets an array of all draft campaigns associated with the client identifier passed in the authorization header, filtered by specified criteria. Returns both product collection and video draft campaigns by default

Source API Documentation: Amazon Sponsored Brand Ads - Drafts

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
draftCampaignId	STRING
name	STRING
budget	NUMERIC
budgetType	STRING
startDate	STRING
endDate	STRING
bidOptimization	BOOLEAN
bidMultiplier	NUMERIC
portfolioId	STRING
creative	RECORD
landingPage	RECORD
tags	STRING
brandEntityId	STRING
bidAdjustments	RECORD
adFormat	STRING

SponsoredBrands_NegativeKeywords

Purpose: Return a list of negative ad group-level keywords

Source API Documentation: Amazon Sponsored Brand Ads - Negative Keywords

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
keywordId	STRING
adGroupId	STRING
campaignId	STRING
keywordText	STRING
matchType	STRING
state	STRING

SponsoredBrands_NegativeTargets

Purpose: Gets a list of product negative targets associated with the client identifier

Source API Documentation: Amazon Sponsored Brand Ads - Negative Targets

Replication: Full Replication

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
targetId	STRING
adGroupId	STRING
campaignId	STRING
state	STRING
bid	NUMERIC
expressions	RECORD
resolvedExpressions	RECORD

SponsoredBrands_BidRecommendations

Purpose: Get a list of bid recommendation objects for a specified list of keywords or products.

Source API Documentation: Amazon Sponsored Brand Ads - Bid Recommendations

Replication Type: Full Load

Replication Key: N/A

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
fetchDate	DATE
keywordsBidsRecommendationSuccessResults	RECORD
keywordsBidsRecommendationErrorResults	RECORD
targetsBidsRecommendationSuccessResults	RECORD
targetsBidsRecommendationErrorResults	RECORD

SponsoredBrands_PlacementCampaignsReport

Purpose: Retrieves campaigns performance report with 'placement' segmentation

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: Campaign Placement

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
placement	STRING
campaignId	STRING
campaignBudgetType	STRING
campaignStatus	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER
applicableBudgetRuleId	STRING
applicableBudgetRuleName	STRING
campaignRuleBasedBudget	NUMERIC

SponsoredBrands_KeywordsReport

Purpose: Retrieves keyword performance report

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: Keyword

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
campaignBudgetType	STRING
campaignStatus	STRING
keywordId	STRING
keywordStatus	STRING
keywordBid	STRING
keywordText	STRING
matchType	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER
applicableBudgetRuleId	STRING
applicableBudgetRuleName	STRING
campaignBudget	NUMERIC
campaignRuleBasedBudget	NUMERIC
searchTermImpressionRank	INTEGER
searchTermImpressionShare	NUMERIC

SponsoredBrands_SearchTermKeywordsReport

Purpose: Retrieves keyword performance report with 'query' segmentation.

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: Search term

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedConversions14d	INTEGER
attributedSales14d	NUMERIC
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
query	STRING
campaignId	STRING
campaignName	STRING
adGroupId	STRING
adGroupName	STRING
campaignBudgetType	STRING
campaignStatus	STRING
keywordId	STRING
keywordStatus	STRING
keywordBid	STRING
keywordText	STRING
matchType	STRING
campaignBudget	NUMERIC
searchTermImpressionRank	INTEGER
searchTermImpressionShare	NUMERIC

SponsoredBrands_TargetReport

Purpose: Retrieves performance reports for targets.

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: None

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignName	STRING
adGroupId	STRING
adGroupName	STRING
campaignBudgetType	STRING
campaignStatus	STRING
targetId	STRING
targetingExpression	STRING
targetingType	STRING
targetingText	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER
campaignBudget	NUMERIC

SponsoredBrands_SearchTermHeadlineSearchReport

Purpose: Used to identify the most important search terms for your business and then optimize your listings.

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: None

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignName	STRING
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
adGroupName	STRING
adGroupId	STRING
keywordText	STRING
keywordBid	NUMERIC
keywordStatus	STRING
targetId	STRING
targetingExpression	STRING
targetingText	STRING
targetingType	STRING
matchType	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER

SponsoredBrands_AdGroupsVideoReport

Purpose: Retrieves video performance report for AdGroups

ReportName in Seller Central: None

Source API Documentation: Amazon Sponsored Brand Ads - Reports

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
adGroupId	STRING
adGroupName	STRING
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
dpv14d	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoCompleteViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC

SponsoredBrands_PlacementCampaignsVideoReport

Purpose: Retrieves video performance report for Campaigns with 'placement' segmentation

ReportName in Seller Central: Campaigns placement video

Source API Documentation: Amazon Sponsored Brand Ads - Reports

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignName	STRING
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
placement	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
dpv14d	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoCompleteViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC

SponsoredBrands_PlacementKeywordsVideoReport

Purpose: Retrieves video performance report for Keywords with 'placement' segmentation.

ReportName in Seller Central: None

Source API Documentation: Amazon Sponsored Brand Ads - Reports

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
placement	STRING
campaignId	STRING
campaignName	STRING
adGroupId	STRING
adGroupName	STRING
campaignBudgetType	STRING
campaignStatus	STRING
keywordId	STRING
keywordStatus	STRING
keywordBid	STRING
keywordText	STRING
matchType	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
dpv14d	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoCompleteViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC

SponsoredBrands_UnifiedAdGroupsReport

Purpose: Retrieves ad-group performance report

Source API Documentation: Amazon Sponsored Brand Ads - Reports

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	INTEGER
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
adGroupName	STRING
adGroupId	STRING
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
dpv14d	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
attributedBrandedSearches14d	INTEGER
currency	STRING
videoCompleteViews	INTEGER
_daton_user_id	NUMERIC
_daton_batch_runtime	NUMERIC
_daton_batch_id	NUMERIC

SponsoredBrands_UnifiedKeywordsReport

Purpose: Retrieves performance report for Keywords

Source API Documentation: Amazon Sponsored Brand Ads - Reports

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	INTEGER
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
keywordBid	STRING
keywordId	STRING
keywordStatus	STRING
keywordText	STRING
matchType	STRING
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
adGroupName	STRING
adGroupId	STRING
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
dpv14d	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
attributedBrandedSearches14d	INTEGER
currency	STRING
videoCompleteViews	INTEGER

SponsoredBrands_UnifiedPlacementCampaignsReport

Purpose: Retrieves campaign's performance report with 'placement' segmentation

Source API Documentation: Amazon Sponsored Brand Ads - Reports

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
placement	STRING
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
dpv14d	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
attributedBrandedSearches14d	INTEGER
currency	STRING
videoCompleteViews	INTEGER

SponsoredBrands_UnifiedPlacementKeywordsReport

Purpose: Retrieves keyword performance report with 'placement' segmentation

Source API Documentation: Amazon Sponsored Brand Ads - Reports

Note: The API reports don't return the data for match type "-" i.e. auto-targeting data

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
adGroupId	STRING
adGroupName	STRING
campaignId	INTEGER
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
keywordBid	STRING
keywordId	STRING
keywordStatus	STRING
keywordText	STRING
matchType	STRING
impressions	INTEGER
placement	STRING
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
dpv14d	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
attributedBrandedSearches14d	INTEGER
currency	STRING
videoCompleteViews	INTEGER

SponsoredBrands_HeadlineSearchReport

Purpose: Used to identify the most important search terms for your business and then optimize your listings.

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: None

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignName	STRING
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
adGroupName	STRING
adGroupId	STRING
keywordText	STRING
keywordBid	NUMERIC
keywordStatus	STRING
targetId	STRING
targetingExpression	STRING
targetingText	STRING
targetingType	STRING
matchType	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedOrderRateNewToBrand14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
unitsSold14d	INTEGER
dpv14d	INTEGER

SponsoredBrands_KeywordsVideoReport

Purpose: Retrieves video performance report for Keywords

Source API Documentation: Amazon Sponsored Brand Ads - Reports

ReportName in Seller Central: Keywords Video

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
keywordText	STRING
keywordBid	STRING
adGroupName	STRING
adGroupId	STRING
keywordStatus	STRING
query	STRING
keywordId	STRING
matchType	STRING
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC

SponsoredBrands_CampaignsVideoReport

Purpose: Retrieves video performance report for Campaigns.

ReportName in Seller Central: Campaigns Video

Source API Documentation: Amazon Sponsored Brand Ads - Reports

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
dpv14d	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoCompleteViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC

SponsoredBrands_SearchTermKeywordsVideoReport

Purpose: Retrieves video performance report for Keywords with 'query' segmentation

ReportName in Seller Central: Search term video

Source API Documentation: Amazon Sponsored Brand Ads - Reports

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
searchTermImpressionShare	INTEGER
searchTermImpressionRank	INTEGER
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedConversions14d	INTEGER
keywordText	STRING
keywordBid	STRING
adGroupName	STRING
adGroupId	STRING
keywordStatus	STRING
query	STRING
keywordId	STRING
matchType	STRING
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
videoCompleteViews	INTEGER

SponsoredBrands_TargetVideoReport

Purpose: Retrieves video performance report for Targets

ReportName in Seller Central: None

Source API Documentation: Amazon Sponsored Brand Ads - Reports

Replication Type: Key Based Replication

Replication Key: Date

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignName	STRING
adGroupId	STRING
adGroupName	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignStatus	STRING
targetId	STRING
targetingExpression	STRING
targetingType	STRING
targetingText	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedDetailPageViewsClicks14d	INTEGER
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
dpv14d	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoCompleteViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
attributedBrandedSearches14d	INTEGER

SponsoredBrands_UnifiedTargetReport

Purpose: Retrieves performance report for targets.

Source API Documentation: Amazon Sponsored Brand Ads - Reports

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
targetId	INTEGER
targetingExpression	STRING
targetingText	STRING
targetingType	STRING
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
adGroupName	STRING
adGroupId	STRING
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
dpv14d	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
attributedBrandedSearches14d	INTEGER
currency	STRING
videoCompleteViews	INTEGER

SponsoredBrands_UnifiedCampaignsReport

Purpose: Retrieves campaigns performance report.

Source API Documentation: Amazon Sponsored Brand Ads - Reports

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
currency	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedSales14dSameSKU	NUMERIC
attributedConversions14d	INTEGER
attributedConversions14dSameSKU	INTEGER
attributedDetailPageViewsClicks14d	INTEGER
attributedOrderRateNewToBrand14d	NUMERIC
attributedOrdersNewToBrand14d	INTEGER
attributedOrdersNewToBrandPercentage14d	NUMERIC
attributedSalesNewToBrand14d	NUMERIC
attributedSalesNewToBrandPercentage14d	NUMERIC
attributedUnitsOrderedNewToBrand14d	INTEGER
attributedUnitsOrderedNewToBrandPercentage14d	NUMERIC
dpv14d	INTEGER
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoCompleteViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC

SponsoredBrands_UnifiedSearchTermKeywordsReport

Purpose: Retrieves keyword performance report with 'query' segmentation.

Source API Documentation: Amazon Sponsored Brand Ads - Reports

FIELDS

Field Name	Data Type
RequestTime	TIMESTAMP
profileId	STRING
countryName	STRING
accountName	STRING
accountId	STRING
reportDate	DATE
campaignId	STRING
campaignStatus	STRING
campaignBudget	NUMERIC
campaignBudgetType	STRING
campaignName	STRING
impressions	INTEGER
clicks	INTEGER
cost	NUMERIC
attributedSales14d	NUMERIC
attributedConversions14d	INTEGER
keywordText	STRING
keywordBid	STRING
adGroupName	STRING
adGroupId	STRING
keywordStatus	STRING
query	STRING
keywordId	STRING
matchType	STRING
vctr	NUMERIC
video5SecondViewRate	NUMERIC
video5SecondViews	INTEGER
videoFirstQuartileViews	INTEGER
videoMidpointViews	INTEGER
videoThirdQuartileViews	INTEGER
videoUnmutes	INTEGER
viewableImpressions	INTEGER
vtr	NUMERIC
videoCompleteViews	INTEGER

Table of Contents

Tables/APIs Profile Store SponsoredBrands_Campaign SponsoredBrands_Keywords SponsoredBrands_StoresAssets SponsoredBrands_Targets SponsoredBrands_TargetingRecommendations SponsoredBrands_CampaignsReports SponsoredBrands_AdGroupsReport SponsoredBrands_PlacementKeywordsReport Portfolio SponsoredBrands_ProductMetadata SponsoredBrands_AdGroup SponsoredBrands_Drafts SponsoredBrands_NegativeKeywords SponsoredBrands_NegativeTargets SponsoredBrands_BidRecommendations SponsoredBrands_PlacementCampaignsReport SponsoredBrands_KeywordsReport SponsoredBrands_SearchTermKeywordsReport SponsoredBrands_TargetReport SponsoredBrands_SearchTermHeadlineSearchReport SponsoredBrands_AdGroupsVideoReport SponsoredBrands_PlacementCampaignsVideoReport SponsoredBrands_PlacementKeywordsVideoReport SponsoredBrands_UnifiedAdGroupsReport SponsoredBrands_UnifiedKeywordsReport SponsoredBrands_UnifiedPlacementCampaignsReport SponsoredBrands_UnifiedPlacementKeywordsReport SponsoredBrands_HeadlineSearchReport SponsoredBrands_KeywordsVideoReport SponsoredBrands_CampaignsVideoReport SponsoredBrands_SearchTermKeywordsVideoReport SponsoredBrands_TargetVideoReport SponsoredBrands_UnifiedTargetReport SponsoredBrands_UnifiedCampaignsReport SponsoredBrands_UnifiedSearchTermKeywordsReport

Contact Us

Schema Information for Amazon Sponsored Brands

Contact Us

Saras Pulse

Saras Daton

Saras IQ