Bing Ads Migration Guide
Upgrading to 3.0.0
Version 3.0.0 expands the primary keys of all report streams so that they include every attribute (dimension) column the connector requests from Microsoft's reporting API. Without this fix, when the previous (narrower) primary keys were used for incremental append+dedup, destinations silently collapsed rows that differed only on a requested-but-not-in-PK attribute, causing significant data loss.
The affected streams are all aggregations (_hourly, _daily, _weekly, _monthly) of age_gender_audience_report, campaign_performance_report, ad_group_performance_report, keyword_performance_report, ad_group_impression_performance_report, audience_performance_report, goals_and_funnels_report, user_location_performance_report, account_performance_report, ad_performance_report, search_query_performance_report, product_search_query_performance_report, plus budget_summary_report.
Connector upgrade guide
Review the following information to prepare for and execute your upgrade.
Review the changelog
Before updating a connector, review the changelog to understand the changes and their potential impact on your existing connections. Find the changelog for any connector by navigating to the bottom of the documentation for that connector. Major version releases also include a migration guide.
Plan for major updates
Major updates may require you to adjust connection settings or even make changes to your data pipelines. Allocate enough time and resources for this. Use the migration guide to ensure your transition process goes smoothly.
Airbyte provides tooling that guarantees safe connector version bumps and enforces automated version bumps for minor and patch updates. You always need to manually update for major version bumps.
Self-managed plans: pin a specific version if you can't update
If you're unable to upgrade to the new version of a connector, you can pin that connector to a specific version.
-
In the navigation bar:
-
If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.
-
If you're on any other plan, click Workspace settings > Sources/Destinations.
-
-
Edit the entry for the connector you want to pin.
-
Set the Default Version to the version you want to use.
Self-managed plans: update the local connector image
If you self-manage Airbyte, you must manually update the connector image in your local registry before proceeding with the migration. Follow the steps below.
-
In the navigation bar:
-
If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.
-
If you're on any other plan, click Workspace settings > Sources/Destinations.
-
-
Find the connector you want to update in the list of connectors.
noteAirbyte lists two versions, the current in-use version and the latest version available.
-
Click Change to update your OSS version to the latest available version.
Update the connector version
Update each instance of the connector separately. If you have multiple instances of a connector, updating one doesn't affect the others.
-
In the navigation bar:
-
If you're on the Self-Managed Enterprise plan, click Organization settings > Sources/Destinations.
-
If you're on any other plan, click Workspace settings > Sources/Destinations.
-
-
Select the instance of the connector you wish to upgrade.
-
Select Upgrade.
-
Follow the prompt to confirm you are ready to upgrade to the new version.
Clear data from affected streams
After upgrading a connector with a breaking change, you must refresh affected schemas and clear your data.
-
In the nav bar, click Connections.
-
Find the connection affected by the upgrade.
-
Click the Schema tab.
-
Click Refresh source schema (looks like ). When Airbyte finishes, it shows you any detected schema changes.
-
Click OK.
-
Click Save changes
-
Clear the data for the streams affected by this upgrade.
Once the clear is complete, you can begin syncing your data again as usual.
Upgrading to 2.0.0
This version update affects all hourly reports (end in report_hourly) and the following streams:
- Accounts
- Campaigns
- Search Query Performance Report
- AppInstallAds
- AppInstallAdLabels
- Labels
- Campaign Labels
- Keyword Labels
- Ad Group Labels
- Keywords
- Budget Summary Report
All date and date-time fields will be converted to standard RFC3339. Stream state format will be updated as well.
For the changes to take effect, please refresh the source schema and reset affected streams after you have applied the upgrade.
| Stream field | Current Airbyte Type | New Airbyte Type |
|---|---|---|
| LinkedAgencies | string | object |
| BiddingScheme.MaxCpc.Amount | string | number |
| CostPerConversion | integer | number |
| Modified Time | string | timestamp with tz |
| Date | string | date |
| TimePeriod | string | timestamp with tz |
Detailed date-time field change examples:
| Affected streams | Field_name | Old type | New type (RFC3339) |
|---|---|---|---|
AppInstallAds, AppInstallAdLabels, Labels, Campaign Labels, Keyword Labels, Ad Group Labels, Keywords | Modified Time | 04/27/2023 18:00:14.970 | 2023-04-27T16:00:14.970+00:00 |
Budget Summary Report | Date | 6/10/2021 | 2021-06-10 |
* Report Hourly | TimePeriod | 2023-11-04|11 | 2023-11-04T11:00:00+00:00 |
Upgrading to 1.0.0
This version update only affects the geographic performance reports streams.
Version 1.0.0 prevents the data loss by removing the primary keys from the GeographicPerformanceReportMonthly, GeographicPerformanceReportWeekly, GeographicPerformanceReportDaily, GeographicPerformanceReportHourly streams.
Due to multiple records with the same primary key, users could experience data loss in the incremental append+dedup mode because of deduplication.
For the changes to take effect, please reset your data and refresh the stream schemas after you have applied the upgrade.