Skip to content
This repository was archived by the owner on Nov 9, 2024. It is now read-only.

Commit e1cecc7

Browse files
docs: Minor formatting (#375)
* docs: Minor formatting docs: Add clarifications PiperOrigin-RevId: 553885123 Source-Link: googleapis/googleapis@9458a5a Source-Link: https://github.com/googleapis/googleapis-gen/commit/8b7876034fcfb521dbd9297709e073b61cd89351 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOGI3ODc2MDM0ZmNmYjUyMWRiZDkyOTc3MDllMDczYjYxY2Q4OTM1MSJ9 * 🦉 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>
1 parent 64efaae commit e1cecc7

File tree

4 files changed

+65
-41
lines changed

4 files changed

+65
-41
lines changed

google/analytics/data_v1beta/types/analytics_data_api.py

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,6 @@ class CheckCompatibilityRequest(proto.Message):
5757
``runReport`` request.
5858
5959
Example: properties/1234
60-
61-
Set the Property ID to 0 for compatibility checking on
62-
dimensions and metrics common to all properties. In this
63-
special mode, this method will not return custom dimensions
64-
and metrics.
6560
dimensions (MutableSequence[google.analytics.data_v1beta.types.Dimension]):
6661
The dimensions in this report. ``dimensions`` should be the
6762
same value as in your ``runReport`` request.
@@ -193,9 +188,9 @@ class RunReportRequest(proto.Message):
193188
both date ranges. In a cohort request, this ``dateRanges``
194189
must be unspecified.
195190
dimension_filter (google.analytics.data_v1beta.types.FilterExpression):
196-
Dimension filters allow you to ask for only specific
197-
dimension values in the report. To learn more, see
198-
`Fundamentals of Dimension
191+
Dimension filters let you ask for only specific dimension
192+
values in the report. To learn more, see `Fundamentals of
193+
Dimension
199194
Filters <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters>`__
200195
for examples. Metrics cannot be used in this filter.
201196
metric_filter (google.analytics.data_v1beta.types.FilterExpression):
@@ -217,7 +212,7 @@ class RunReportRequest(proto.Message):
217212
`Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
218213
limit (int):
219214
The number of rows to return. If unspecified, 10,000 rows
220-
are returned. The API returns a maximum of 100,000 rows per
215+
are returned. The API returns a maximum of 250,000 rows per
221216
request, no matter how many you ask for. ``limit`` must be
222217
positive.
223218
@@ -246,10 +241,18 @@ class RunReportRequest(proto.Message):
246241
there is a cohort group in the request the
247242
'cohort' dimension must be present.
248243
keep_empty_rows (bool):
249-
If false or unspecified, each row with all
250-
metrics equal to 0 will not be returned. If
251-
true, these rows will be returned if they are
252-
not separately removed by a filter.
244+
If false or unspecified, each row with all metrics equal to
245+
0 will not be returned. If true, these rows will be returned
246+
if they are not separately removed by a filter.
247+
248+
Regardless of this ``keep_empty_rows`` setting, only data
249+
recorded by the Google Analytics (GA4) property can be
250+
displayed in a report.
251+
252+
For example if a property never logs a ``purchase`` event,
253+
then a query for the ``eventName`` dimension and
254+
``eventCount`` metric will not have a row eventName:
255+
"purchase" and eventCount: 0.
253256
return_property_quota (bool):
254257
Toggles whether to return the current state of this
255258
Analytics Property's quota. Quota is returned in
@@ -473,10 +476,18 @@ class RunPivotReportRequest(proto.Message):
473476
there is a cohort group in the request the
474477
'cohort' dimension must be present.
475478
keep_empty_rows (bool):
476-
If false or unspecified, each row with all
477-
metrics equal to 0 will not be returned. If
478-
true, these rows will be returned if they are
479-
not separately removed by a filter.
479+
If false or unspecified, each row with all metrics equal to
480+
0 will not be returned. If true, these rows will be returned
481+
if they are not separately removed by a filter.
482+
483+
Regardless of this ``keep_empty_rows`` setting, only data
484+
recorded by the Google Analytics (GA4) property can be
485+
displayed in a report.
486+
487+
For example if a property never logs a ``purchase`` event,
488+
then a query for the ``eventName`` dimension and
489+
``eventCount`` metric will not have a row eventName:
490+
"purchase" and eventCount: 0.
480491
return_property_quota (bool):
481492
Toggles whether to return the current state of this
482493
Analytics Property's quota. Quota is returned in
@@ -814,7 +825,7 @@ class RunRealtimeReportRequest(proto.Message):
814825
Dimensions cannot be used in this filter.
815826
limit (int):
816827
The number of rows to return. If unspecified, 10,000 rows
817-
are returned. The API returns a maximum of 100,000 rows per
828+
are returned. The API returns a maximum of 250,000 rows per
818829
request, no matter how many you ask for. ``limit`` must be
819830
positive.
820831

google/analytics/data_v1beta/types/data.py

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,8 @@ class Compatibility(proto.Enum):
175175

176176

177177
class DateRange(proto.Message):
178-
r"""A contiguous set of days: startDate, startDate + 1, ...,
179-
endDate. Requests
180-
are allowed up to 4 date ranges.
178+
r"""A contiguous set of days: ``startDate``, ``startDate + 1``, ...,
179+
``endDate``. Requests are allowed up to 4 date ranges.
181180
182181
Attributes:
183182
start_date (str):
@@ -215,9 +214,9 @@ class DateRange(proto.Message):
215214

216215

217216
class MinuteRange(proto.Message):
218-
r"""A contiguous set of minutes: startMinutesAgo, startMinutesAgo
219-
+ 1, ...,
220-
endMinutesAgo. Requests are allowed up to 2 minute ranges.
217+
r"""A contiguous set of minutes: ``startMinutesAgo``,
218+
``startMinutesAgo + 1``, ..., ``endMinutesAgo``. Requests are
219+
allowed up to 2 minute ranges.
221220
222221
223222
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
@@ -945,7 +944,7 @@ class Pivot(proto.Message):
945944
``limit`` of 10,000 is common for single pivot requests.
946945
947946
The product of the ``limit`` for each ``pivot`` in a
948-
``RunPivotReportRequest`` must not exceed 100,000. For
947+
``RunPivotReportRequest`` must not exceed 250,000. For
949948
example, a two pivot request with ``limit: 1000`` in each
950949
pivot will fail because the product is ``1,000,000``.
951950
metric_aggregations (MutableSequence[google.analytics.data_v1beta.types.MetricAggregation]):
@@ -1196,9 +1195,23 @@ class ResponseMetaData(proto.Message):
11961195
11971196
Attributes:
11981197
data_loss_from_other_row (bool):
1199-
If true, indicates some buckets of dimension
1200-
combinations are rolled into "(other)" row. This
1201-
can happen for high cardinality reports.
1198+
If true, indicates some buckets of dimension combinations
1199+
are rolled into "(other)" row. This can happen for high
1200+
cardinality reports.
1201+
1202+
The metadata parameter dataLossFromOtherRow is populated
1203+
based on the aggregated data table used in the report. The
1204+
parameter will be accurately populated regardless of the
1205+
filters and limits in the report.
1206+
1207+
For example, the (other) row could be dropped from the
1208+
report because the request contains a filter on
1209+
sessionSource = google. This parameter will still be
1210+
populated if data loss from other row was present in the
1211+
input aggregate data used to generate this report.
1212+
1213+
To learn more, see `About the (other) row and data
1214+
sampling <https://support.google.com/analytics/answer/13208658#reports>`__.
12021215
schema_restriction_response (google.analytics.data_v1beta.types.ResponseMetaData.SchemaRestrictionResponse):
12031216
Describes the schema restrictions actively enforced in
12041217
creating this report. To learn more, see `Access and
@@ -1552,13 +1565,13 @@ class PropertyQuota(proto.Message):
15521565
Attributes:
15531566
tokens_per_day (google.analytics.data_v1beta.types.QuotaStatus):
15541567
Standard Analytics Properties can use up to
1555-
25,000 tokens per day; Analytics 360 Properties
1556-
can use 250,000 tokens per day. Most requests
1568+
200,000 tokens per day; Analytics 360 Properties
1569+
can use 2,000,000 tokens per day. Most requests
15571570
consume fewer than 10 tokens.
15581571
tokens_per_hour (google.analytics.data_v1beta.types.QuotaStatus):
15591572
Standard Analytics Properties can use up to
1560-
5,000 tokens per hour; Analytics 360 Properties
1561-
can use 50,000 tokens per hour. An API request
1573+
40,000 tokens per hour; Analytics 360 Properties
1574+
can use 400,000 tokens per hour. An API request
15621575
consumes a single number of tokens, and that
15631576
number is deducted from all of the hourly,
15641577
daily, and per project hourly quotas.
@@ -1580,15 +1593,15 @@ class PropertyQuota(proto.Message):
15801593
if the request contains potentially thresholded
15811594
dimensions.
15821595
tokens_per_project_per_hour (google.analytics.data_v1beta.types.QuotaStatus):
1583-
Analytics Properties can use up to 25% of
1596+
Analytics Properties can use up to 35% of
15841597
their tokens per project per hour. This amounts
15851598
to standard Analytics Properties can use up to
1586-
1,250 tokens per project per hour, and Analytics
1587-
360 Properties can use 12,500 tokens per project
1588-
per hour. An API request consumes a single
1589-
number of tokens, and that number is deducted
1590-
from all of the hourly, daily, and per project
1591-
hourly quotas.
1599+
14,000 tokens per project per hour, and
1600+
Analytics 360 Properties can use 140,000 tokens
1601+
per project per hour. An API request consumes a
1602+
single number of tokens, and that number is
1603+
deducted from all of the hourly, daily, and per
1604+
project hourly quotas.
15921605
"""
15931606

15941607
tokens_per_day: "QuotaStatus" = proto.Field(

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.17.0"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

samples/generated_samples/snippet_metadata_google.analytics.data.v1beta.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.17.0"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

0 commit comments

Comments
 (0)