Amazon Sponsored Brand Ads

Amazon Sponsored Brand Ads ETL connector for data replication

Snapshot

Features
Details
Release Status
Released
Source API Version
V2
Table Selection
Yes
Column Selection
Yes
Edit Integration
Yes
Replication Type Selection
No
Authentication Parameters
Seller Login Id and Password
Replication Type
Full Replication Key Based Incremental
Replication Key
Date
Suggested Replication Frequency
24 hours
Supports attribution
Yes

Tables/APIs Supported

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

Reports Mapping

The following table represents how Daton maps tables with respect to the reports you see in the Amazon Ad console interface.
Report in Ad console
Report in Daton
Search term
SponsoredBrands_SearchTermKeywordsReport SponsoredBrands_SearchTermKeywordsVideoReport
Keyword
SponsoredBrands_KeywordsReport SponsoredBrands_KeywordsVideoReport
Keyword Placement
SponsoredBrands_PlacementKeywordsReport SponsoredBrands_PlacementKeywordsVideoReport
Campaign
SponsoredBrands_CampaignsReport SponsoredBrands_CampaignsVideoReport
Campaign Placement
SponsoredBrands_PlacementCampaignsReport SponsoredBrands_PlacementCampaignsVideoReport
Search Term Impression Share
-
Category Benchmark
-
Attributed Purchases
SponsoredBrands_PurchasedProductReport
Gross And Invalid Traffic
-

Authentication Credentials

  1. 1.
    Sponsored Brand APIs work for 'Seller' type users. Agency users and Attribution accounts will not have access to APIs
  2. 2.
    User account used for authentication must have access to Campaign Manager and all Reports

Integrate Amazon Sponsored Brand Ads with Daton

  1. 1.
    Sign in to Daton.
  2. 2.
    Select Amazon Sponsored Brand from the Connectors page.
  3. 3.
    Provide all required configuration parameters - Integration Name, Replication Frequency, History, Region/Marketplace, and Attribution lookback. The integration name would be used while creating tables in the warehouse and cannot be changed later.
  4. 4.
    You will be redirected to the Amazon Advertising login page to authorize Daton to extract data periodically. Log in with your seller account.
  5. 5.
    After authentication, you can choose from the available Amazon Advertising Accounts/ProfileIds list.
  6. 6.
    After account selection, you'll be prompted to select the Tables/APIs for replication.
  7. 7.
    Then select the required fields for each table.
  8. 8.
    Submit the integration.

Workflow

  1. 1.
    Integrations would be in configuring state initially. They would be moved to the active state when selected tables are created in the warehouse.
  2. 2.
    Users would be able to edit/pause/re-activate/delete integration anytime.
  3. 3.
    Users can view job status and process logs from the integration details page by clicking on the integration name from the active list.

Known Issues

  1. 1.
    Amazon reconciles data and may update metrics for up to 30 days. If you want to use 7-day attribution metrics, select 8-day attribution offset in the configuration. Daton will repeat the report data for a given date depending on the attribution offset selected
  2. 2.
    Data would always be fetched for the previous day after 2 AM Seller time
  3. 3.
    There can be mismatches of <1% in metrics even with 30-day attribution selection in Daton

AmazonAds Data

TABLES

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
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
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_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 in order to launch, manage or optimize Sponsored Brand, Sponsored Brands or Sponsored Display advertising campaigns. The Product Selector API is available to Sellers, Vendors, and Authors
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
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
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
SponsoredBrands_NegativeKeywords
Purpose: Return a list of negative ad group-level 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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
SponsoredBrands_NegativeTargets
Purpose: Gets a list of product negative targets associated with the client identifier
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
SponsoredBrands_TargetingRecommendations
Purpose: Gets a list of recommended products for targeting. Recommendations are based on the ASINs that are passed in the request.
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
SponsoredBrands_BidRecommendations
Purpose: Get a list of bid recommendation objects for a specified list of keywords or products.
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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC

REPORTS

SponsoredBrands_CampaignsReports
Purpose: Retrieves campaigns 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
_daton_user_id
NUMERIC
_daton_batch_runtime
NUMERIC
_daton_batch_id
NUMERIC
SponsoredBrands_PlacementCampaignsReport
Purpose: Retrieves campaigns performance report with 'placement' segmentation