Skip to content

Commit

Permalink
Update GA4 breaking changes doc (#31000)
Browse files Browse the repository at this point in the history
  • Loading branch information
nataliekwong authored Oct 3, 2023
1 parent bb034bb commit 3fab2cf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ data:
releases:
breakingChanges:
2.0.0:
message: "Version 2.0.0 introduces changes to stream naming. This fixes a defect when the connector config has multiple properties and produces duplicated streams. In order to have the connector working, please re-set up the connector."
message: "Version 2.0.0 introduces changes to stream names for those syncing more than one Google Analytics 4 property. It allows streams from all properties to sync successfully. Please upgrade the connector to enable this additional functionality."
upgradeDeadline: "2023-10-16"
releaseStage: generally_available
suggestedStreams:
Expand Down
24 changes: 11 additions & 13 deletions docs/integrations/sources/google-analytics-data-api-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,24 @@

## Upgrading to 2.0.0

A major update of most streams to avoid having duplicate stream names. This is relevant for the connections having more than one property ID.
Resetting a connector is needed if you have more than one property ID in your config.
This version update only affects the schema of GA4 connections that sync <b>more than one property</b>.

Let's say you have three property IDs - `0001`, `0002`, `0003`. Two of them will be included in the stream names:
- "daily_active_users",
- "daily_active_users_property_0002",
- "daily_active_users_property_0003",
- "weekly_active_users",
- "weekly_active_users_property_0002"
- "weekly_active_users_property_0003"
...
Version 2.0.0 prevents the duplication of stream names by renaming some property streams with a new stream name that includes the property ID.

If the number of properties in your config does not exceed one, you will not see changes to your stream names, and the reset is not required:
<b>If you only are syncing from one property, no changes will occur when you upgrade to the new version. </b> The stream names will continue to appear as:
- "daily_active_users",
- "weekly_active_users"

Once you add the second property ID, new streams will have names with the new property ID included. Existing streams will not be affected:
If you are syncing more than one property, any property after the first will have the property ID appended to the stream name.

For example, if your property IDs are: `0001`, `0002`, `0003`, the streams related to properties `0002` and `0003` will have the property ID appended to the end of the stream name.
- "daily_active_users",
- "daily_active_users_property_0002",
- "daily_active_users_property_0003",
- "weekly_active_users",
- "weekly_active_users_property_0002"
- "weekly_active_users_property_0003"

If you are syncing more than one property ID, you will need to reset those streams to ensure syncing continues accurately.

If you add the second+ property after running the upgrade, the reset is not required.
In the future, if you add an additional property ID, all new streams will append the property ID to the stream name without affecting existing streams. A reset is not required if you add the consecutive property after upgrading to 2.0.0.

0 comments on commit 3fab2cf

Please sign in to comment.