fix: rename CROSS_CHANNEL_DATA_DRIVEN to PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN (#366)

gcf-owl-bot[bot] · web-flow · commit 9a644b5ca129 · 2023-07-27T05:44:13.000-04:00
* fix!: update the `ReportingAttributionModel` enum to rename `CROSS_CHANNEL_DATA_DRIVEN` to `PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN`, `CROSS_CHANNEL_LAST_CLICK` to `PAID_AND_ORGANIC_CHANNELS_LAST_CLICK`, `CROSS_CHANNEL_FIRST_CLICK` to `PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK`, `CROSS_CHANNEL_LINEAR` to `PAID_AND_ORGANIC_CHANNELS_LINEAR`, `CROSS_CHANNEL_POSITION_BASED` to `PAID_AND_ORGANIC_CHANNELS_POSITION_BASED` `CROSS_CHANNEL_TIME_DECAY` to `PAID_AND_ORGANIC_CHANNELS_TIME_DECAY`, `ADS_PREFERRED_LAST_CLICK` to `GOOGLE_PAID_CHANNELS_LAST_CLICK` fix!: update the `AdsWebConversionDataExportScope` enum to rename `CROSS_CHANNEL` to `PAID_AND_ORGANIC_CHANNELS`, `ADS_PREFERRED` to `GOOGLE_PAID_CHANNELS` PiperOrigin-RevId: 551280325 Source-Link: googleapis/googleapis@0d84384 Source-Link: https://github.com/googleapis/googleapis-gen/commit/da9de65834a4b6b7ec4586220500e8cefeb5efd3 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZGE5ZGU2NTgzNGE0YjZiN2VjNDU4NjIyMDUwMGU4Y2VmZWI1ZWZkMyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py
@@ -3918,8 +3918,9 @@ async def sample_update_measurement_protocol_secret():
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
             update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
-                The list of fields to be updated.
-                Omitted fields will not be updated.
+                Required. The list of fields to be
+                updated. Omitted fields will not be
+                updated.
 
                 This corresponds to the ``update_mask`` field
                 on the ``request`` instance; if ``request`` is provided, this
@@ -9137,8 +9138,8 @@ async def sample_update_attribution_settings():
                 attribution_settings = admin_v1alpha.AttributionSettings()
                 attribution_settings.acquisition_conversion_event_lookback_window = "ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS"
                 attribution_settings.other_conversion_event_lookback_window = "OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS"
-                attribution_settings.reporting_attribution_model = "ADS_PREFERRED_LAST_CLICK"
-                attribution_settings.ads_web_conversion_data_export_scope = "ADS_PREFERRED"
+                attribution_settings.reporting_attribution_model = "GOOGLE_PAID_CHANNELS_LAST_CLICK"
+                attribution_settings.ads_web_conversion_data_export_scope = "GOOGLE_PAID_CHANNELS"
 
                 request = admin_v1alpha.UpdateAttributionSettingsRequest(
                     attribution_settings=attribution_settings,
diff --git a/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/client.py
@@ -4515,8 +4515,9 @@ def sample_update_measurement_protocol_secret():
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
             update_mask (google.protobuf.field_mask_pb2.FieldMask):
-                The list of fields to be updated.
-                Omitted fields will not be updated.
+                Required. The list of fields to be
+                updated. Omitted fields will not be
+                updated.
 
                 This corresponds to the ``update_mask`` field
                 on the ``request`` instance; if ``request`` is provided, this
@@ -9821,8 +9822,8 @@ def sample_update_attribution_settings():
                 attribution_settings = admin_v1alpha.AttributionSettings()
                 attribution_settings.acquisition_conversion_event_lookback_window = "ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS"
                 attribution_settings.other_conversion_event_lookback_window = "OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS"
-                attribution_settings.reporting_attribution_model = "ADS_PREFERRED_LAST_CLICK"
-                attribution_settings.ads_web_conversion_data_export_scope = "ADS_PREFERRED"
+                attribution_settings.reporting_attribution_model = "GOOGLE_PAID_CHANNELS_LAST_CLICK"
+                attribution_settings.ads_web_conversion_data_export_scope = "GOOGLE_PAID_CHANNELS"
 
                 request = admin_v1alpha.UpdateAttributionSettingsRequest(
                     attribution_settings=attribution_settings,
diff --git a/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py b/google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py
@@ -14917,7 +14917,9 @@ class _UpdateMeasurementProtocolSecret(AnalyticsAdminServiceRestStub):
         def __hash__(self):
             return hash("UpdateMeasurementProtocolSecret")
 
-        __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {}
+        __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {
+            "updateMask": {},
+        }
 
         @classmethod
         def _get_unset_required_fields(cls, message_dict):
diff --git a/google/analytics/admin_v1alpha/types/analytics_admin.py b/google/analytics/admin_v1alpha/types/analytics_admin.py
@@ -1623,8 +1623,8 @@ class UpdateMeasurementProtocolSecretRequest(proto.Message):
             Required. The measurement protocol secret to
             update.
         update_mask (google.protobuf.field_mask_pb2.FieldMask):
-            The list of fields to be updated. Omitted
-            fields will not be updated.
+            Required. The list of fields to be updated.
+            Omitted fields will not be updated.
     """
 
     measurement_protocol_secret: resources.MeasurementProtocolSecret = proto.Field(
diff --git a/google/analytics/admin_v1alpha/types/resources.py b/google/analytics/admin_v1alpha/types/resources.py
@@ -2240,69 +2240,69 @@ class ReportingAttributionModel(proto.Enum):
         Values:
             REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED (0):
                 Reporting attribution model unspecified.
-            CROSS_CHANNEL_DATA_DRIVEN (1):
-                Data-driven attribution distributes credit
-                for the conversion based on data for each
-                conversion event. Each Data-driven model is
-                specific to each advertiser and each conversion
-                event.
-            CROSS_CHANNEL_LAST_CLICK (2):
-                Ignores direct traffic and attributes 100% of
-                the conversion value to the last channel that
-                the customer clicked through (or engaged view
-                through for YouTube) before converting.
-            CROSS_CHANNEL_FIRST_CLICK (3):
+            PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN (1):
+                Data-driven attribution distributes credit for the
+                conversion based on data for each conversion event. Each
+                Data-driven model is specific to each advertiser and each
+                conversion event. Previously CROSS_CHANNEL_DATA_DRIVEN
+            PAID_AND_ORGANIC_CHANNELS_LAST_CLICK (2):
+                Ignores direct traffic and attributes 100% of the conversion
+                value to the last channel that the customer clicked through
+                (or engaged view through for YouTube) before converting.
+                Previously CROSS_CHANNEL_LAST_CLICK
+            PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK (3):
                 Starting in June 2023, new properties can no longer use this
                 model. See `Analytics
-                Help <https://support.google.com/analytics/answer/9164320?hl=en#040623>`__
+                Help <https://support.google.com/analytics/answer/9164320#040623>`__
                 for more details. Starting in September 2023, we will sunset
                 this model for all properties.
 
                 Gives all credit for the conversion to the first channel
                 that a customer clicked (or engaged view through for
-                YouTube) before converting.
-            CROSS_CHANNEL_LINEAR (4):
+                YouTube) before converting. Previously
+                CROSS_CHANNEL_FIRST_CLICK
+            PAID_AND_ORGANIC_CHANNELS_LINEAR (4):
                 Starting in June 2023, new properties can no longer use this
                 model. See `Analytics
-                Help <https://support.google.com/analytics/answer/9164320?hl=en#040623>`__
+                Help <https://support.google.com/analytics/answer/9164320#040623>`__
                 for more details. Starting in September 2023, we will sunset
                 this model for all properties.
 
                 Distributes the credit for the conversion equally across all
                 the channels a customer clicked (or engaged view through for
-                YouTube) before converting.
-            CROSS_CHANNEL_POSITION_BASED (5):
+                YouTube) before converting. Previously CROSS_CHANNEL_LINEAR
+            PAID_AND_ORGANIC_CHANNELS_POSITION_BASED (5):
                 Starting in June 2023, new properties can no longer use this
                 model. See `Analytics
-                Help <https://support.google.com/analytics/answer/9164320?hl=en#040623>`__
+                Help <https://support.google.com/analytics/answer/9164320#040623>`__
                 for more details. Starting in September 2023, we will sunset
                 this model for all properties.
 
                 Attributes 40% credit to the first and last interaction, and
                 the remaining 20% credit is distributed evenly to the middle
-                interactions.
-            CROSS_CHANNEL_TIME_DECAY (6):
+                interactions. Previously CROSS_CHANNEL_POSITION_BASED
+            PAID_AND_ORGANIC_CHANNELS_TIME_DECAY (6):
                 Starting in June 2023, new properties can no longer use this
                 model. See `Analytics
-                Help <https://support.google.com/analytics/answer/9164320?hl=en#040623>`__
+                Help <https://support.google.com/analytics/answer/9164320#040623>`__
                 for more details. Starting in September 2023, we will sunset
                 this model for all properties.
 
                 Gives more credit to the touchpoints that happened closer in
-                time to the conversion.
-            ADS_PREFERRED_LAST_CLICK (7):
-                Attributes 100% of the conversion value to
-                the last Google Ads channel that the customer
-                clicked through before converting.
+                time to the conversion. Previously CROSS_CHANNEL_TIME_DECAY
+            GOOGLE_PAID_CHANNELS_LAST_CLICK (7):
+                Attributes 100% of the conversion value to the last Google
+                Paid channel that the customer clicked through before
+                converting. Previously ADS_PREFERRED_LAST_CLICK
         """
         REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED = 0
-        CROSS_CHANNEL_DATA_DRIVEN = 1
-        CROSS_CHANNEL_LAST_CLICK = 2
-        CROSS_CHANNEL_FIRST_CLICK = 3
-        CROSS_CHANNEL_LINEAR = 4
-        CROSS_CHANNEL_POSITION_BASED = 5
-        CROSS_CHANNEL_TIME_DECAY = 6
-        ADS_PREFERRED_LAST_CLICK = 7
+        PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN = 1
+        PAID_AND_ORGANIC_CHANNELS_LAST_CLICK = 2
+        PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK = 3
+        PAID_AND_ORGANIC_CHANNELS_LINEAR = 4
+        PAID_AND_ORGANIC_CHANNELS_POSITION_BASED = 5
+        PAID_AND_ORGANIC_CHANNELS_TIME_DECAY = 6
+        GOOGLE_PAID_CHANNELS_LAST_CLICK = 7
 
     class AdsWebConversionDataExportScope(proto.Enum):
         r"""The Conversion Export Scope for data exported to linked Ads
@@ -2315,17 +2315,21 @@ class AdsWebConversionDataExportScope(proto.Enum):
                 No data export scope selected yet.
                 Export scope can never be changed back to this
                 value.
-            CROSS_CHANNEL (2):
-                The Ads Web Conversion Data export scope is
-                Cross Channel.
-            ADS_PREFERRED (3):
-                The Ads Web Conversion Data export scope is
-                Ads Preferred.
+            PAID_AND_ORGANIC_CHANNELS (2):
+                Paid and organic channels are eligible to receive conversion
+                credit, but only credit assigned to Google Ads channels will
+                appear in your Ads accounts. To learn more, see `Paid and
+                Organic
+                channels <https://support.google.com/analytics/answer/10632359>`__.
+            GOOGLE_PAID_CHANNELS (3):
+                Only Google Ads paid channels are eligible to receive
+                conversion credit. To learn more, see `Google Paid
+                channels <https://support.google.com/analytics/answer/10632359>`__.
         """
         ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED = 0
         NOT_SELECTED_YET = 1
-        CROSS_CHANNEL = 2
-        ADS_PREFERRED = 3
+        PAID_AND_ORGANIC_CHANNELS = 2
+        GOOGLE_PAID_CHANNELS = 3
 
     name: str = proto.Field(
         proto.STRING,
diff --git a/samples/generated_samples/analyticsadmin_v1alpha_generated_analytics_admin_service_update_attribution_settings_async.py b/samples/generated_samples/analyticsadmin_v1alpha_generated_analytics_admin_service_update_attribution_settings_async.py
@@ -42,8 +42,8 @@ async def sample_update_attribution_settings():
     attribution_settings = admin_v1alpha.AttributionSettings()
     attribution_settings.acquisition_conversion_event_lookback_window = "ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS"
     attribution_settings.other_conversion_event_lookback_window = "OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS"
-    attribution_settings.reporting_attribution_model = "ADS_PREFERRED_LAST_CLICK"
-    attribution_settings.ads_web_conversion_data_export_scope = "ADS_PREFERRED"
+    attribution_settings.reporting_attribution_model = "GOOGLE_PAID_CHANNELS_LAST_CLICK"
+    attribution_settings.ads_web_conversion_data_export_scope = "GOOGLE_PAID_CHANNELS"
 
     request = admin_v1alpha.UpdateAttributionSettingsRequest(
         attribution_settings=attribution_settings,
diff --git a/samples/generated_samples/analyticsadmin_v1alpha_generated_analytics_admin_service_update_attribution_settings_sync.py b/samples/generated_samples/analyticsadmin_v1alpha_generated_analytics_admin_service_update_attribution_settings_sync.py
@@ -42,8 +42,8 @@ def sample_update_attribution_settings():
     attribution_settings = admin_v1alpha.AttributionSettings()
     attribution_settings.acquisition_conversion_event_lookback_window = "ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS"
     attribution_settings.other_conversion_event_lookback_window = "OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS"
-    attribution_settings.reporting_attribution_model = "ADS_PREFERRED_LAST_CLICK"
-    attribution_settings.ads_web_conversion_data_export_scope = "ADS_PREFERRED"
+    attribution_settings.reporting_attribution_model = "GOOGLE_PAID_CHANNELS_LAST_CLICK"
+    attribution_settings.ads_web_conversion_data_export_scope = "GOOGLE_PAID_CHANNELS"
 
     request = admin_v1alpha.UpdateAttributionSettingsRequest(
         attribution_settings=attribution_settings,
diff --git a/tests/unit/gapic/admin_v1alpha/test_analytics_admin_service.py b/tests/unit/gapic/admin_v1alpha/test_analytics_admin_service.py
