Skip to content

Commit 0dab0e7

Browse files
gcf-owl-bot[bot]ohmayr
gcf-owl-bot[bot]
and
ohmayr
authored
feat: [google-analytics-data] add EmptyFilter type to the Data API v1beta (googleapis#13292)
BEGIN_COMMIT_OVERRIDE feat: add `EmptyFilter` type to the Data API v1beta feat: add the `empty_filter` field to the `Filter` type docs: update documentation for the`RunReport` method docs: remove all references to 'GA4' in documentation END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. feat: add the `empty_filter` field to the `Filter` type docs: update documentation for the`RunReport` method docs: remove all references to 'GA4' in documentation PiperOrigin-RevId: 698517184 Source-Link: googleapis/googleapis@3a6c7dc Source-Link: https://github.com/googleapis/googleapis-gen/commit/db3a50c62ddad1edcc91e3791636a4317f52dd06 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1kYXRhLy5Pd2xCb3QueWFtbCIsImgiOiJkYjNhNTBjNjJkZGFkMWVkY2M5MWUzNzkxNjM2YTQzMTdmNTJkZDA2In0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: ohmayr <[email protected]>
1 parent e3cdd49 commit 0dab0e7

File tree

11 files changed

+64
-47
lines changed

11 files changed

+64
-47
lines changed

‎packages/google-analytics-data/google/analytics/data/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.18.15" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-analytics-data/google/analytics/data_v1alpha/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.18.15" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-analytics-data/google/analytics/data_v1beta/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.18.15" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-analytics-data/google/analytics/data_v1beta/services/beta_analytics_data/async_client.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ async def batch_run_reports(
459459
metadata: Sequence[Tuple[str, str]] = (),
460460
) -> analytics_data_api.BatchRunReportsResponse:
461461
r"""Returns multiple reports in a batch. All reports must
462-
be for the same GA4 Property.
462+
be for the same Google Analytics property.
463463
464464
.. code-block:: python
465465
@@ -545,7 +545,7 @@ async def batch_run_pivot_reports(
545545
metadata: Sequence[Tuple[str, str]] = (),
546546
) -> analytics_data_api.BatchRunPivotReportsResponse:
547547
r"""Returns multiple pivot reports in a batch. All
548-
reports must be for the same GA4 Property.
548+
reports must be for the same Google Analytics property.
549549
550550
.. code-block:: python
551551
@@ -631,7 +631,7 @@ async def get_metadata(
631631
) -> analytics_data_api.Metadata:
632632
r"""Returns metadata for dimensions and metrics available in
633633
reporting methods. Used to explore the dimensions and metrics.
634-
In this method, a Google Analytics GA4 Property Identifier is
634+
In this method, a Google Analytics property identifier is
635635
specified in the request, and the metadata response includes
636636
Custom dimensions and metrics as well as Universal metadata.
637637
@@ -674,8 +674,8 @@ async def sample_get_metadata():
674674
name (:class:`str`):
675675
Required. The resource name of the metadata to retrieve.
676676
This name field is specified in the URL path and not URL
677-
parameters. Property is a numeric Google Analytics GA4
678-
Property identifier. To learn more, see `where to find
677+
parameters. Property is a numeric Google Analytics
678+
property identifier. To learn more, see `where to find
679679
your Property
680680
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
681681

‎packages/google-analytics-data/google/analytics/data_v1beta/services/beta_analytics_data/client.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -854,7 +854,7 @@ def batch_run_reports(
854854
metadata: Sequence[Tuple[str, str]] = (),
855855
) -> analytics_data_api.BatchRunReportsResponse:
856856
r"""Returns multiple reports in a batch. All reports must
857-
be for the same GA4 Property.
857+
be for the same Google Analytics property.
858858
859859
.. code-block:: python
860860
@@ -938,7 +938,7 @@ def batch_run_pivot_reports(
938938
metadata: Sequence[Tuple[str, str]] = (),
939939
) -> analytics_data_api.BatchRunPivotReportsResponse:
940940
r"""Returns multiple pivot reports in a batch. All
941-
reports must be for the same GA4 Property.
941+
reports must be for the same Google Analytics property.
942942
943943
.. code-block:: python
944944
@@ -1022,7 +1022,7 @@ def get_metadata(
10221022
) -> analytics_data_api.Metadata:
10231023
r"""Returns metadata for dimensions and metrics available in
10241024
reporting methods. Used to explore the dimensions and metrics.
1025-
In this method, a Google Analytics GA4 Property Identifier is
1025+
In this method, a Google Analytics property identifier is
10261026
specified in the request, and the metadata response includes
10271027
Custom dimensions and metrics as well as Universal metadata.
10281028
@@ -1065,8 +1065,8 @@ def sample_get_metadata():
10651065
name (str):
10661066
Required. The resource name of the metadata to retrieve.
10671067
This name field is specified in the URL path and not URL
1068-
parameters. Property is a numeric Google Analytics GA4
1069-
Property identifier. To learn more, see `where to find
1068+
parameters. Property is a numeric Google Analytics
1069+
property identifier. To learn more, see `where to find
10701070
your Property
10711071
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
10721072

‎packages/google-analytics-data/google/analytics/data_v1beta/services/beta_analytics_data/transports/grpc.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ def batch_run_reports(
333333
r"""Return a callable for the batch run reports method over gRPC.
334334
335335
Returns multiple reports in a batch. All reports must
336-
be for the same GA4 Property.
336+
be for the same Google Analytics property.
337337
338338
Returns:
339339
Callable[[~.BatchRunReportsRequest],
@@ -363,7 +363,7 @@ def batch_run_pivot_reports(
363363
r"""Return a callable for the batch run pivot reports method over gRPC.
364364
365365
Returns multiple pivot reports in a batch. All
366-
reports must be for the same GA4 Property.
366+
reports must be for the same Google Analytics property.
367367
368368
Returns:
369369
Callable[[~.BatchRunPivotReportsRequest],
@@ -391,7 +391,7 @@ def get_metadata(
391391
392392
Returns metadata for dimensions and metrics available in
393393
reporting methods. Used to explore the dimensions and metrics.
394-
In this method, a Google Analytics GA4 Property Identifier is
394+
In this method, a Google Analytics property identifier is
395395
specified in the request, and the metadata response includes
396396
Custom dimensions and metrics as well as Universal metadata.
397397

‎packages/google-analytics-data/google/analytics/data_v1beta/services/beta_analytics_data/transports/grpc_asyncio.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ def batch_run_reports(
344344
r"""Return a callable for the batch run reports method over gRPC.
345345
346346
Returns multiple reports in a batch. All reports must
347-
be for the same GA4 Property.
347+
be for the same Google Analytics property.
348348
349349
Returns:
350350
Callable[[~.BatchRunReportsRequest],
@@ -374,7 +374,7 @@ def batch_run_pivot_reports(
374374
r"""Return a callable for the batch run pivot reports method over gRPC.
375375
376376
Returns multiple pivot reports in a batch. All
377-
reports must be for the same GA4 Property.
377+
reports must be for the same Google Analytics property.
378378
379379
Returns:
380380
Callable[[~.BatchRunPivotReportsRequest],
@@ -404,7 +404,7 @@ def get_metadata(
404404
405405
Returns metadata for dimensions and metrics available in
406406
reporting methods. Used to explore the dimensions and metrics.
407-
In this method, a Google Analytics GA4 Property Identifier is
407+
In this method, a Google Analytics property identifier is
408408
specified in the request, and the metadata response includes
409409
Custom dimensions and metrics as well as Universal metadata.
410410

‎packages/google-analytics-data/google/analytics/data_v1beta/types/analytics_data_api.py‎

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class CheckCompatibilityRequest(proto.Message):
6262
6363
Attributes:
6464
property (str):
65-
A Google Analytics GA4 property identifier whose events are
65+
A Google Analytics property identifier whose events are
6666
tracked. To learn more, see `where to find your Property
6767
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
6868
``property`` should be the same value as in your
@@ -187,7 +187,7 @@ class RunReportRequest(proto.Message):
187187
188188
Attributes:
189189
property (str):
190-
A Google Analytics GA4 property identifier whose events are
190+
A Google Analytics property identifier whose events are
191191
tracked. Specified in the URL path and not the body. To
192192
learn more, see `where to find your Property
193193
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
@@ -247,10 +247,14 @@ class RunReportRequest(proto.Message):
247247
metric_aggregations (MutableSequence[google.analytics.data_v1beta.types.MetricAggregation]):
248248
Aggregation of metrics. Aggregated metric values will be
249249
shown in rows where the dimension_values are set to
250-
"RESERVED_(MetricAggregation)".
250+
"RESERVED_(MetricAggregation)". Aggregates including both
251+
comparisons and multiple date ranges will be aggregated
252+
based on the date ranges.
251253
order_bys (MutableSequence[google.analytics.data_v1beta.types.OrderBy]):
252254
Specifies how rows are ordered in the
253-
response.
255+
response. Requests including both comparisons
256+
and multiple date ranges will have order bys
257+
applied on the comparisons.
254258
currency_code (str):
255259
A currency code in ISO4217 format, such as
256260
"AED", "USD", "JPY". If the field is empty, the
@@ -265,16 +269,16 @@ class RunReportRequest(proto.Message):
265269
if they are not separately removed by a filter.
266270
267271
Regardless of this ``keep_empty_rows`` setting, only data
268-
recorded by the Google Analytics (GA4) property can be
269-
displayed in a report.
272+
recorded by the Google Analytics property can be displayed
273+
in a report.
270274
271275
For example if a property never logs a ``purchase`` event,
272276
then a query for the ``eventName`` dimension and
273277
``eventCount`` metric will not have a row eventName:
274278
"purchase" and eventCount: 0.
275279
return_property_quota (bool):
276-
Toggles whether to return the current state of this
277-
Analytics Property's quota. Quota is returned in
280+
Toggles whether to return the current state of this Google
281+
Analytics property's quota. Quota is returned in
278282
`PropertyQuota <#PropertyQuota>`__.
279283
comparisons (MutableSequence[google.analytics.data_v1beta.types.Comparison]):
280284
Optional. The configuration of comparisons
@@ -390,7 +394,7 @@ class RunReportResponse(proto.Message):
390394
metadata (google.analytics.data_v1beta.types.ResponseMetaData):
391395
Metadata for the report.
392396
property_quota (google.analytics.data_v1beta.types.PropertyQuota):
393-
This Analytics Property's quota state
397+
This Google Analytics property's quota state
394398
including this request.
395399
kind (str):
396400
Identifies what kind of resource this message is. This
@@ -454,7 +458,7 @@ class RunPivotReportRequest(proto.Message):
454458
455459
Attributes:
456460
property (str):
457-
A Google Analytics GA4 property identifier whose events are
461+
A Google Analytics property identifier whose events are
458462
tracked. Specified in the URL path and not the body. To
459463
learn more, see `where to find your Property
460464
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
@@ -510,16 +514,16 @@ class RunPivotReportRequest(proto.Message):
510514
if they are not separately removed by a filter.
511515
512516
Regardless of this ``keep_empty_rows`` setting, only data
513-
recorded by the Google Analytics (GA4) property can be
514-
displayed in a report.
517+
recorded by the Google Analytics property can be displayed
518+
in a report.
515519
516520
For example if a property never logs a ``purchase`` event,
517521
then a query for the ``eventName`` dimension and
518522
``eventCount`` metric will not have a row eventName:
519523
"purchase" and eventCount: 0.
520524
return_property_quota (bool):
521-
Toggles whether to return the current state of this
522-
Analytics Property's quota. Quota is returned in
525+
Toggles whether to return the current state of this Google
526+
Analytics property's quota. Quota is returned in
523527
`PropertyQuota <#PropertyQuota>`__.
524528
comparisons (MutableSequence[google.analytics.data_v1beta.types.Comparison]):
525529
Optional. The configuration of comparisons
@@ -654,7 +658,7 @@ class RunPivotReportResponse(proto.Message):
654658
metadata (google.analytics.data_v1beta.types.ResponseMetaData):
655659
Metadata for the report.
656660
property_quota (google.analytics.data_v1beta.types.PropertyQuota):
657-
This Analytics Property's quota state
661+
This Google Analytics property's quota state
658662
including this request.
659663
kind (str):
660664
Identifies what kind of resource this message is. This
@@ -709,7 +713,7 @@ class BatchRunReportsRequest(proto.Message):
709713
710714
Attributes:
711715
property (str):
712-
A Google Analytics GA4 property identifier whose events are
716+
A Google Analytics property identifier whose events are
713717
tracked. Specified in the URL path and not the body. To
714718
learn more, see `where to find your Property
715719
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
@@ -765,7 +769,7 @@ class BatchRunPivotReportsRequest(proto.Message):
765769
766770
Attributes:
767771
property (str):
768-
A Google Analytics GA4 property identifier whose events are
772+
A Google Analytics property identifier whose events are
769773
tracked. Specified in the URL path and not the body. To
770774
learn more, see `where to find your Property
771775
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
@@ -823,9 +827,8 @@ class GetMetadataRequest(proto.Message):
823827
name (str):
824828
Required. The resource name of the metadata to retrieve.
825829
This name field is specified in the URL path and not URL
826-
parameters. Property is a numeric Google Analytics GA4
827-
Property identifier. To learn more, see `where to find your
828-
Property
830+
parameters. Property is a numeric Google Analytics property
831+
identifier. To learn more, see `where to find your Property
829832
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
830833
831834
Example: properties/1234/metadata
@@ -846,7 +849,7 @@ class RunRealtimeReportRequest(proto.Message):
846849
847850
Attributes:
848851
property (str):
849-
A Google Analytics GA4 property identifier whose events are
852+
A Google Analytics property identifier whose events are
850853
tracked. Specified in the URL path and not the body. To
851854
learn more, see `where to find your Property
852855
ID <https://developers.google.com/analytics/devguides/reporting/data/v1/property-id>`__.
@@ -883,8 +886,8 @@ class RunRealtimeReportRequest(proto.Message):
883886
Specifies how rows are ordered in the
884887
response.
885888
return_property_quota (bool):
886-
Toggles whether to return the current state of this
887-
Analytics Property's Realtime quota. Quota is returned in
889+
Toggles whether to return the current state of this Google
890+
Analytics property's Realtime quota. Quota is returned in
888891
`PropertyQuota <#PropertyQuota>`__.
889892
minute_ranges (MutableSequence[google.analytics.data_v1beta.types.MinuteRange]):
890893
The minute ranges of event data to read. If
@@ -977,8 +980,8 @@ class RunRealtimeReportResponse(proto.Message):
977980
API request, the response will contain ``rowCount`` of 175
978981
but only 50 rows.
979982
property_quota (google.analytics.data_v1beta.types.PropertyQuota):
980-
This Analytics Property's Realtime quota
981-
state including this request.
983+
This Google Analytics property's Realtime
984+
quota state including this request.
982985
kind (str):
983986
Identifies what kind of resource this message is. This
984987
``kind`` is always the fixed string

‎packages/google-analytics-data/google/analytics/data_v1beta/types/data.py‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ class MetricType(proto.Enum):
142142

143143
class RestrictedMetricType(proto.Enum):
144144
r"""Categories of data that you may be restricted from viewing on
145-
certain GA4 properties.
145+
certain Google Analytics properties.
146146
147147
Values:
148148
RESTRICTED_METRIC_TYPE_UNSPECIFIED (0):
@@ -632,6 +632,11 @@ class Filter(proto.Message):
632632
between_filter (google.analytics.data_v1beta.types.Filter.BetweenFilter):
633633
A filter for two values.
634634
635+
This field is a member of `oneof`_ ``one_filter``.
636+
empty_filter (google.analytics.data_v1beta.types.Filter.EmptyFilter):
637+
A filter for empty values such as "(not set)"
638+
and "" values.
639+
635640
This field is a member of `oneof`_ ``one_filter``.
636641
"""
637642

@@ -777,6 +782,9 @@ class BetweenFilter(proto.Message):
777782
message="NumericValue",
778783
)
779784

785+
class EmptyFilter(proto.Message):
786+
r"""Filter for empty values."""
787+
780788
field_name: str = proto.Field(
781789
proto.STRING,
782790
number=1,
@@ -805,6 +813,12 @@ class BetweenFilter(proto.Message):
805813
oneof="one_filter",
806814
message=BetweenFilter,
807815
)
816+
empty_filter: EmptyFilter = proto.Field(
817+
proto.MESSAGE,
818+
number=8,
819+
oneof="one_filter",
820+
message=EmptyFilter,
821+
)
808822

809823

810824
class OrderBy(proto.Message):

‎packages/google-analytics-data/samples/generated_samples/snippet_metadata_google.analytics.data.v1alpha.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"language": "PYTHON",
1010
"name": "google-analytics-data",
11-
"version": "0.18.15"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

0 commit comments

Comments
 (0)