feat: [google-analytics-data] add the comparisons field to the `Met…

…adata` resource (#12978) BEGIN_COMMIT_OVERRIDE feat: add the `comparisons` field to the `Metadata` resource feat: add the `comparisons` field to the `RunReportRequest`, `RunPivotReportRequest` resources feat: add the `Comparison` type feat: add the `ComparisonMetadata` type docs: a comment for field `custom_definition` in message `DimensionMetadata` is changed END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. feat: add the `comparisons` field to the `RunReportRequest`, `RunPivotReportRequest` resources feat: add the `Comparison` type feat: add the `ComparisonMetadata` type docs: a comment for field `custom_definition` in message `DimensionMetadata` is changed PiperOrigin-RevId: 658850708 Source-Link: googleapis/googleapis@a1cc0b4 Source-Link: googleapis/googleapis-gen@8f3e7bc Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1kYXRhLy5Pd2xCb3QueWFtbCIsImgiOiI4ZjNlN2JjYzlmOGZmNmY4N2JkZDRhN2QxM2QyZWMyNWU4ZjYzMzNhIn0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: ohmayr <omairnaveed@ymail.com>
googleapis · Aug 8, 2024 · 2c4e4d1 · 2c4e4d1
1 parent f16067b
commit 2c4e4d1
Show file tree

Hide file tree

Showing 11 changed files with 136 additions and 9 deletions.
diff --git a/packages/google-analytics-data/google/analytics/data/__init__.py b/packages/google-analytics-data/google/analytics/data/__init__.py
@@ -56,6 +56,8 @@
     CohortReportSettings,
     CohortSpec,
     CohortsRange,
+    Comparison,
+    ComparisonMetadata,
     Compatibility,
     DateRange,
     Dimension,
@@ -120,6 +122,8 @@
     "CohortReportSettings",
     "CohortSpec",
     "CohortsRange",
+    "Comparison",
+    "ComparisonMetadata",
     "DateRange",
     "Dimension",
     "DimensionCompatibility",

diff --git a/packages/google-analytics-data/google/analytics/data/gapic_version.py b/packages/google-analytics-data/google/analytics/data/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.18.10"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-analytics-data/google/analytics/data_v1alpha/gapic_version.py b/packages/google-analytics-data/google/analytics/data_v1alpha/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.18.10"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-analytics-data/google/analytics/data_v1beta/__init__.py b/packages/google-analytics-data/google/analytics/data_v1beta/__init__.py
@@ -54,6 +54,8 @@
     CohortReportSettings,
     CohortSpec,
     CohortsRange,
+    Comparison,
+    ComparisonMetadata,
     Compatibility,
     DateRange,
     Dimension,
@@ -104,6 +106,8 @@
     "CohortReportSettings",
     "CohortSpec",
     "CohortsRange",
+    "Comparison",
+    "ComparisonMetadata",
     "Compatibility",
     "CreateAudienceExportRequest",
     "DateRange",

diff --git a/packages/google-analytics-data/google/analytics/data_v1beta/gapic_version.py b/packages/google-analytics-data/google/analytics/data_v1beta/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.18.10"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-analytics-data/google/analytics/data_v1beta/types/__init__.py b/packages/google-analytics-data/google/analytics/data_v1beta/types/__init__.py
@@ -45,6 +45,8 @@
     CohortReportSettings,
     CohortSpec,
     CohortsRange,
+    Comparison,
+    ComparisonMetadata,
     Compatibility,
     DateRange,
     Dimension,
@@ -107,6 +109,8 @@
     "CohortReportSettings",
     "CohortSpec",
     "CohortsRange",
+    "Comparison",
+    "ComparisonMetadata",
     "DateRange",
     "Dimension",
     "DimensionCompatibility",

diff --git a/packages/google-analytics-data/google/analytics/data_v1beta/types/analytics_data_api.py b/packages/google-analytics-data/google/analytics/data_v1beta/types/analytics_data_api.py
@@ -157,6 +157,8 @@ class Metadata(proto.Message):
             The dimension descriptions.
         metrics (MutableSequence[google.analytics.data_v1beta.types.MetricMetadata]):
             The metric descriptions.
+        comparisons (MutableSequence[google.analytics.data_v1beta.types.ComparisonMetadata]):
+            The comparison descriptions.
     """
 
     name: str = proto.Field(
@@ -173,6 +175,11 @@ class Metadata(proto.Message):
         number=2,
         message=data.MetricMetadata,
     )
+    comparisons: MutableSequence[data.ComparisonMetadata] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=4,
+        message=data.ComparisonMetadata,
+    )
 
 
 class RunReportRequest(proto.Message):
@@ -269,6 +276,11 @@ class RunReportRequest(proto.Message):
             Toggles whether to return the current state of this
             Analytics Property's quota. Quota is returned in
             `PropertyQuota <#PropertyQuota>`__.
+        comparisons (MutableSequence[google.analytics.data_v1beta.types.Comparison]):
+            Optional. The configuration of comparisons
+            requested and displayed. The request only
+            requires a comparisons field in order to receive
+            a comparison column in the response.
     """
 
     property: str = proto.Field(
@@ -335,6 +347,11 @@ class RunReportRequest(proto.Message):
         proto.BOOL,
         number=14,
     )
+    comparisons: MutableSequence[data.Comparison] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=15,
+        message=data.Comparison,
+    )
 
 
 class RunReportResponse(proto.Message):
@@ -504,6 +521,12 @@ class RunPivotReportRequest(proto.Message):
             Toggles whether to return the current state of this
             Analytics Property's quota. Quota is returned in
             `PropertyQuota <#PropertyQuota>`__.
+        comparisons (MutableSequence[google.analytics.data_v1beta.types.Comparison]):
+            Optional. The configuration of comparisons
+            requested and displayed. The request requires
+            both a comparisons field and a comparisons
+            dimension to receive a comparison column in the
+            response.
     """
 
     property: str = proto.Field(
@@ -557,6 +580,11 @@ class RunPivotReportRequest(proto.Message):
         proto.BOOL,
         number=11,
     )
+    comparisons: MutableSequence[data.Comparison] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=12,
+        message=data.Comparison,
+    )
 
 
 class RunPivotReportResponse(proto.Message):

diff --git a/packages/google-analytics-data/google/analytics/data_v1beta/types/data.py b/packages/google-analytics-data/google/analytics/data_v1beta/types/data.py
@@ -31,6 +31,7 @@
         "Dimension",
         "DimensionExpression",
         "Metric",
+        "Comparison",
         "FilterExpression",
         "FilterExpressionList",
         "Filter",
@@ -54,6 +55,7 @@
         "QuotaStatus",
         "DimensionMetadata",
         "MetricMetadata",
+        "ComparisonMetadata",
         "DimensionCompatibility",
         "MetricCompatibility",
     },
@@ -471,6 +473,56 @@ class Metric(proto.Message):
     )
 
 
+class Comparison(proto.Message):
+    r"""Defines an individual comparison. Most requests will include
+    multiple comparisons so that the report compares between the
+    comparisons.
+
+    This message has `oneof`_ fields (mutually exclusive fields).
+    For each oneof, at most one member field can be set at the same time.
+    Setting any member of the oneof automatically clears all other
+    members.
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        name (str):
+            Each comparison produces separate rows in the
+            response. In the response, this comparison is
+            identified by this name. If name is unspecified,
+            we will use the saved comparisons display name.
+
+            This field is a member of `oneof`_ ``_name``.
+        dimension_filter (google.analytics.data_v1beta.types.FilterExpression):
+            A basic comparison.
+
+            This field is a member of `oneof`_ ``one_comparison``.
+        comparison (str):
+            A saved comparison identified by the
+            comparison's resource name. For example,
+            'comparisons/1234'.
+
+            This field is a member of `oneof`_ ``one_comparison``.
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+        optional=True,
+    )
+    dimension_filter: "FilterExpression" = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        oneof="one_comparison",
+        message="FilterExpression",
+    )
+    comparison: str = proto.Field(
+        proto.STRING,
+        number=3,
+        oneof="one_comparison",
+    )
+
+
 class FilterExpression(proto.Message):
     r"""To express dimension or metric filters. The fields in the
     same FilterExpression need to be either all dimensions or all
@@ -1751,8 +1803,14 @@ class DimensionMetadata(proto.Message):
             the deprecation period, the dimension will be available only
             by ``apiName``.
         custom_definition (bool):
-            True if the dimension is a custom dimension
-            for this property.
+            True if the dimension is custom to this
+            property. This includes user, event, & item
+            scoped custom dimensions; to learn more about
+            custom dimensions, see
+            https://support.google.com/analytics/answer/14240153.
+            This also include custom channel groups; to
+            learn more about custom channel groups, see
+            https://support.google.com/analytics/answer/13051316.
         category (str):
             The display name of the category that this
             dimension belongs to. Similar dimensions and
@@ -1889,6 +1947,35 @@ class BlockedReason(proto.Enum):
     )
 
 
+class ComparisonMetadata(proto.Message):
+    r"""The metadata for a single comparison.
+
+    Attributes:
+        api_name (str):
+            This comparison's resource name. Useable in
+            `Comparison <#Comparison>`__'s ``comparison`` field. For
+            example, 'comparisons/1234'.
+        ui_name (str):
+            This comparison's name within the Google
+            Analytics user interface.
+        description (str):
+            This comparison's description.
+    """
+
+    api_name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    ui_name: str = proto.Field(
+        proto.STRING,
+        number=2,
+    )
+    description: str = proto.Field(
+        proto.STRING,
+        number=3,
+    )
+
+
 class DimensionCompatibility(proto.Message):
     r"""The compatibility for a single dimension.
 

diff --git a/...lytics-data/samples/generated_samples/snippet_metadata_google.analytics.data.v1alpha.json b/...lytics-data/samples/generated_samples/snippet_metadata_google.analytics.data.v1alpha.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-analytics-data",
-    "version": "0.18.10"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/...alytics-data/samples/generated_samples/snippet_metadata_google.analytics.data.v1beta.json b/...alytics-data/samples/generated_samples/snippet_metadata_google.analytics.data.v1beta.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-analytics-data",
-    "version": "0.18.10"
+    "version": "0.1.0"
   },
   "snippets": [
     {

diff --git a/packages/google-analytics-data/scripts/fixup_data_v1beta_keywords.py b/packages/google-analytics-data/scripts/fixup_data_v1beta_keywords.py
@@ -47,9 +47,9 @@ class dataCallTransformer(cst.CSTTransformer):
         'get_metadata': ('name', ),
         'list_audience_exports': ('parent', 'page_size', 'page_token', ),
         'query_audience_export': ('name', 'offset', 'limit', ),
-        'run_pivot_report': ('property', 'dimensions', 'metrics', 'date_ranges', 'pivots', 'dimension_filter', 'metric_filter', 'currency_code', 'cohort_spec', 'keep_empty_rows', 'return_property_quota', ),
+        'run_pivot_report': ('property', 'dimensions', 'metrics', 'date_ranges', 'pivots', 'dimension_filter', 'metric_filter', 'currency_code', 'cohort_spec', 'keep_empty_rows', 'return_property_quota', 'comparisons', ),
         'run_realtime_report': ('property', 'dimensions', 'metrics', 'dimension_filter', 'metric_filter', 'limit', 'metric_aggregations', 'order_bys', 'return_property_quota', 'minute_ranges', ),
-        'run_report': ('property', 'dimensions', 'metrics', 'date_ranges', 'dimension_filter', 'metric_filter', 'offset', 'limit', 'metric_aggregations', 'order_bys', 'currency_code', 'cohort_spec', 'keep_empty_rows', 'return_property_quota', ),
+        'run_report': ('property', 'dimensions', 'metrics', 'date_ranges', 'dimension_filter', 'metric_filter', 'offset', 'limit', 'metric_aggregations', 'order_bys', 'currency_code', 'cohort_spec', 'keep_empty_rows', 'return_property_quota', 'comparisons', ),
     }
 
     def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: