Amazon Ads Migration Guide
Upgrading to 7.0.0
-
The stream SponsoredDisplayReportStream is split into five:
- sponsored_display_campaigns_report_stream
- sponsored_display_adgroups_report_stream
- sponsored_display_productads_report_stream
- sponsored_display_targets_report_stream
- sponsored_display_asins_report_stream
-
The stream SponsoredProductsReportStream is split into seven:
- sponsored_products_campaigns_report_stream
- sponsored_products_adgroups_report_stream
- sponsored_products_keywords_report_stream
- sponsored_products_targets_report_stream
- sponsored_products_productads_report_stream
- sponsored_products_asins_keywords_report_stream
- sponsored_products_asins_targets_report_stream
-
Changes for all *-report streams:
- They have new primary keys (see the following table).
- metrics have been moved to the root of the schema.
- metrics have been reset to the proper field type (previously, they were all stored as strings).
Primary Key changes
| Stream Name | Old Primary Key | New Primary key |
|---|---|---|
| sponsored_brands_v3_report_stream | ["profileId", "recordType", "reportDate", "recordId"] | ["profileId", "reportDate", "purchasedAsin"] |
| SponsoredDisplayReportStream (deprecated) | ["profileId", "recordType", "reportDate", "recordId"] | |
| - sponsored_display_campaigns_report_stream | ["profileId", "reportDate", "campaignId"] | |
| - sponsored_display_adgroups_report_stream | ["profileId", "reportDate", "adGroupId"] | |
| - sponsored_display_productads_report_stream | ["profileId", "reportDate", "adId"] | |
| - sponsored_display_targets_report_stream | ["profileId", "reportDate", "targetingId"] | |
| - sponsored_display_asins_report_stream | ["profileId", "reportDate", "promotedAsin"] | |
| SponsoredProductsReportStream (deprecated) | ["profileId", "recordType", "reportDate", "recordId"] | |
| - sponsored_products_campaigns_report_stream | ["profileId", "reportDate", "campaignId"] | |
| - sponsored_products_adgroups_report_stream | ["profileId", "reportDate", "adGroupId"] | |
| - sponsored_products_keywords_report_stream | ["profileId", "reportDate", "keywordId"] | |
| - sponsored_products_targets_report_stream | ["profileId", "reportDate", "keywordId"] | |
| - sponsored_products_productads_report_stream | ["profileId", "reportDate", "adId"] | |
| - sponsored_products_asins_keywords_report_stream | ["profileId", "reportDate", "advertisedAsin"] | |
| - sponsored_products_asins_targets_report_stream | ["profileId", "reportDate", "advertisedAsin"] |
Upgrading to 6.0.0
The SponsoredDisplayReportStream stream now has an updated schema, thanks to a recent change in the Amazon Ads API. You can find more details in the Amazon Migration Guide (metrics).
Please note that SponsoredBrandsReportStream and SponsoredBrandsVideoReportStream will become unavailable as a result of the deprecation of API V2. We recommend switching to SponsoredBrandsV3ReportStream as a great alternative. see Amazon Migration Guide (metrics) for more info.
Streams SponsoredBrandsReportStream SponsoredBrandsVideoReportStream will become unavailable.
It is recommended to use SponsoredBrandsV3ReportStream as an alternative.
Refresh affected schemas and reset data
- Select Connections in the main navbar.
- Select the connection(s) affected by the update.
- Select the Replication tab.
- Select Refresh source schema.
- Select OK.
Any detected schema changes will be listed for your review.
- Select Save changes at the bottom of the page.
- Ensure the Reset affected streams option is checked.
Depending on destination type you may not be prompted to reset your data.
- Select Save connection.
This will reset the data in your destination and initiate a fresh sync.
For more information on resetting your data in Airbyte, see this page.
Upgrading to 5.0.0
The following streams have updated schemas due to a change with the Amazon Ads API:
SponsoredBrandsCampaignsSponsoredBrandsAdGroupsSponsoredProductsCampaignsSponsoredProductsAdGroupBidRecommendations
Schema Changes - Removed/Added Fields
| Stream Name | Removed Fields | Added Fields |
|---|---|---|
SponsoredBrandsCampaigns | serviceStatus, bidOptimization, bidMultiplier, adFormat, bidAdjustments, creative, landingPage, supplySource | ruleBasedBudget, bidding, productLocation, costType, smartDefault, extendedData |
SponsoredBrandsAdGroups | bid, keywordId, keywordText, nativeLanuageKeyword, matchType | extendedData |
SponsoredProductsCampaigns | campaignType, dailyBudget, ruleBasedBudget, premiumBidAdjustment, networks | dynamicBidding, budget, extendedData |
SponsoredProductsAdGroupBidRecommendations | suggestedBid | theme, bidRecommendationsForTargetingExpressions |
Refresh affected schemas and reset data
- Select Connections in the main navbar.
- Select the connection(s) affected by the update.
- Select the Replication tab.
- Select Refresh source schema.
- Select OK.
Any detected schema changes will be listed for your review.
- Select Save changes at the bottom of the page.
- Ensure the Reset affected streams option is checked.
Depending on destination type you may not be prompted to reset your data.
- Select Save connection.
This will reset the data in your destination and initiate a fresh sync.
For more information on resetting your data in Airbyte, see this page.
Upgrading to 4.0.0
Streams SponsoredBrandsAdGroups and SponsoredBrandsKeywords now have updated schemas.
Refresh affected schemas and reset data
- Select Connections in the main navbar.
- Select the connection(s) affected by the update.
- Select the Replication tab.
- Select Refresh source schema.
- Select OK.
Any detected schema changes will be listed for your review.
- Select Save changes at the bottom of the page.
- Ensure the Reset affected streams option is checked.
Depending on destination type you may not be prompted to reset your data.
- Select Save connection.
This will reset the data in your destination and initiate a fresh sync.
For more information on resetting your data in Airbyte, see this page.
Upgrading to 3.0.0
A major update of attribution report stream schemas. For a smooth migration, a data reset and a schema refresh are needed.