Sponsored Brands

Sponsored Brands Report can be used to request and retrieve performance reports generated from the appropriate interface. It can be used to further retrieve the report ID that was generated, and then download the actual report.

Read more about the Sponsored Brands here

Configuring the Credentials

Select the account credentials which has access to relevant Amazon Ads data from the dropdown menu & Click Next

Credentials not listed in dropdown ?

Click on + Add New for adding new credentials

Data Pipelines Details

Data Pipeline

Select Sponsored Brands from the dropdown

amazonads sponsored brands list
Data Pipeline configuration

Enter the configuration for this pipeline in the screen that shows up. Detailed description for each parameter is given below.

amazonads sponsored brands config
Profile

Select one or more profiles from the drop-down

All profiles which your credentials have access to should be available here. If they are not, please check the credentials selected / configured by you. While you can add multiple profiles, the table size may become too large and so it is advisable to add one account per pipeline and use Union queries in the data warehouse to join the data for consumption
amazonads sponsored brands purchased product config field1
Dimensions and Metrics

Select the dimensions and metrics you would like to fetch from the Amazon Ads platform. You can click on View Schema anytime to see the schema of the table being created.

Each of the selected dimension / metric will create one or more columns in the database table in the destination warehouse. For a complete list of all the available dimensions and metrics along with their explanation refer this here
amazonads sponsored brands config field1

Setting Parameters

Parameter Description Values

Record Type

Required

The type of entity for which the report should be generated. Refer to Supported Dimensions and Metrics for a complete list of supported dimensions and metrics.

{campaign, campaign placement, adGroups, keywords, keywords placement, search term}

No of Days

Required

Number of days for which you wish to get the data in each run.

Integer value (Recommended value 30)

Insert Mode

Required

Specifies the manner in which data will get updated in the data warehouse : UPSERT will insert only new records or records with changes, APPEND will insert all fetched data at the end, REPLACE will drop the existing table and recreate a fresh one on each run.Recommended to use "Upsert" option unless there is a specific requirement.

{Upsert, Append, Replace}

Default Value: UPSERT
amazonads sponsored brands config field2

Supported Dimensions and Metrics

Record Type Dimensions Supported Metrics Supported

Campaigns

{applicableBudgetRuleId, applicableBudgetRuleName, campaignBudget, campaignBudgetType, campaignId, campaignName, campaignRuleBasedBudget, campaignStatus, currency}

{attributedBrandedSearches14d attributedConversions14d, attributedConversions14dSameSKU, attributedDetailPageViewsClicks14d, attributedOrderRateNewToBrand14d, attributedOrdersNewToBrand14d, attributedOrdersNewToBrandPercentage14d, attributedSales14d, attributedSales14dSameSKU, attributedSalesNewToBrand14d, attributedSalesNewToBrandPercentage14d, attributedUnitsOrderedNewToBrand14d, attributedUnitsOrderedNewToBrandPercentage14d, clicks, cost, dpv14d, impressions, unitsSold14d, vctr, video5SecondViewRate, video5SecondViews, videoCompleteViews, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoUnmutes, viewableImpressions, vtr}

CampaignsPlacement

{applicableBudgetRuleId, applicableBudgetRuleName, campaignBudget, campaignBudgetType, campaignId, campaignName, campaignRuleBasedBudget, campaignStatus, currency}

{attributedBrandedSearches14d attributedConversions14d, attributedConversions14dSameSKU, attributedDetailPageViewsClicks14d, attributedOrderRateNewToBrand14d, attributedOrdersNewToBrand14d, attributedOrdersNewToBrandPercentage14d, attributedSales14d, attributedSales14dSameSKU, attributedSalesNewToBrand14d, attributedSalesNewToBrandPercentage14d, attributedUnitsOrderedNewToBrand14d, attributedUnitsOrderedNewToBrandPercentage14d, clicks, cost, dpv14d, impressions, unitsSold14d, vctr, video5SecondViewRate, video5SecondViews, videoCompleteViews, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoUnmutes, viewableImpressions, vtr}

AdGroups

{adGroupId, adGroupName, campaignBudget, campaignBudgetType, campaignId, campaignName, campaignStatus, currency}

{attributedBrandedSearches14d, attributedConversions14d, attributedConversions14dSameSKU, attributedDetailPageViewsClicks14d, attributedOrderRateNewToBrand14d, attributedOrdersNewToBrandPercentage14d, attributedSales14d, attributedSales14dSameSKU, attributedSalesNewToBrand14d, attributedSalesNewToBrandPercentage14d, attributedUnitsOrderedNewToBrand14d, attributedUnitsOrderedNewToBrandPercentage14d, clicks, cost, dpv14d, impressions, vctr, video5SecondViewRate, video5SecondViews, videoCompleteViews, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoUnmutes, viewableImpressions, vtr}

Search Term

{adGroupId, adGroupName, campaignBudget, campaignBudgetType, campaignId, campaignName, campaignStatus, keywordBid, keywordId, keywordText, matchType}

{attributedConversions14d, attributedSales14d, clicks, cost, impressions, searchTermImpressionRank, searchTermImpressionShare, vctr, video5SecondViewRate, video5SecondViews, videoCompleteViews, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoUnmutes, viewableImpressions, vtr}

Keywords

{adGroupId, adGroupName, campaignBudget, campaignBudgetType, campaignId, campaignName, campaignRuleBasedBudget, campaignStatus, currency, keywordBid, keywordId, keywordStatus, keywordText, matchType}

{attributedBrandedSearches14d, attributedConversions14d, attributedConversions14dSameSKU, attributedDetailPageViewsClicks14d, attributedOrderRateNewToBrand14d, attributedOrdersNewToBrand14d, attributedOrdersNewToBrandPercentage14d, attributedSales14d, attributedSales14dSameSKU, attributedSalesNewToBrand14d, attributedSalesNewToBrandPercentage14d, attributedUnitsOrderedNewToBrand14d, attributedUnitsOrderedNewToBrandPercentage14d, clicks, cost, dpv14d, impressions, searchTermImpressionRank, searchTermImpressionShare, unitsSold14d, vctr, video5SecondViewRate, video5SecondViews, videoCompleteViews, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoUnmutes, viewableImpressions}

Ads

{adGroupId, adGroupName, adId, applicableBudgetRuleId, applicableBudgetRuleName, campaignBudget, campaignBudgetType, campaignId, campaignName, campaignRuleBasedBudget, campaignStatus, currency}

{attributedBrandedSearches14d, attributedConversions14d, attributedConversions14dSameSKU, attributedDetailPageViewsClicks14d, attributedOrderRateNewToBrand14d, attributedOrdersNewToBrand14d, attributedOrdersNewToBrandPercentage14d, attributedSales14d, attributedSales14dSameSKU, attributedSalesNewToBrand14d, attributedSalesNewToBrandPercentage14d, attributedUnitsOrderedNewToBrand14d, attributedUnitsOrderedNewToBrandPercentage14d, clicks, cost, dpv14d, impressions, unitsSold14d, vctr, video5SecondViewRate, video5SecondViews, videoCompleteViews, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoUnmutes, viewableImpressions, vtr}

Targets

{adGroupId, campaignBudget, campaignBudgetType, campaignId, campaignName, campaignStatus, currency, targetId, targetingExpression, targetingText, targetingType}

{attributedBrandedSearches14d, attributedConversions14d, attributedConversions14dSameSKU, attributedDetailPageViewsClicks14d, attributedOrderRateNewToBrand14d, attributedOrdersNewToBrand14d attributedOrdersNewToBrandPercentage14d, attributedSales14d, attributedSales14dSameSKU, attributedSalesNewToBrand14d, attributedSalesNewToBrandPercentage14d, attributedUnitsOrderedNewToBrand14d, attributedUnitsOrderedNewToBrandPercentage14d, clicks, cost, dpv14d, impressions, unitsSold14d, vctr, video5SecondViewRate, video5SecondViews, videoCompleteViews, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoUnmutes, viewableImpressions, vtr}

Datapipeline Scheduling

Scheduling specifies the frequency with which data will get updated in the data warehouse. You can choose between Manual Run, Normal Scheduling or Advance Scheduling.

Manual Run

If scheduling is not required, you can use the toggle to run the pipeline manually.

Normal Scheduling

Use the dropdown to select an interval-based hourly, monthly, weekly, or daily frequency.

Advance Scheduling

Set schedules fine-grained at the level of Months, Days, Hours, and Minutes.

Detailed explanation on scheduling of pipelines can be found here

Dataset & Name

Dataset Name

Key in the Dataset Name(also serves as the table name in your data warehouse).Keep in mind, that the name should be unique across the account and the data source. Special characters (except underscore _) and blank spaces are not allowed. It is best to follow a consistent naming scheme for future search to locate the tables.

Dataset Description

Enter a short description (optional) describing the dataset being fetched by this particular pipeline.

Notifications

Choose the events for which you’d like to be notified: whether "ERROR ONLY" or "ERROR AND SUCCESS".

Once you have finished click on Finish to save it. Read more about naming and saving your pipelines including the option to save them as templates here

Still have Questions?

We’ll be happy to help you with any questions you might have! Send us an email at info@datachannel.co.

Subscribe to our Newsletter for latest updates at DataChannel.