Skip to content

Commit

Permalink
docs: Minor formatting (#375)
Browse files Browse the repository at this point in the history
* docs: Minor formatting
docs: Add clarifications

PiperOrigin-RevId: 553885123

Source-Link: googleapis/googleapis@9458a5a

Source-Link: googleapis/googleapis-gen@8b78760
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>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Aug 6, 2023
1 parent 041382e commit c175c6f
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,6 @@ class CheckCompatibilityRequest(proto.Message):
``runReport`` request.
Example: properties/1234
Set the Property ID to 0 for compatibility checking on
dimensions and metrics common to all properties. In this
special mode, this method will not return custom dimensions
and metrics.
dimensions (MutableSequence[google.analytics.data_v1beta.types.Dimension]):
The dimensions in this report. ``dimensions`` should be the
same value as in your ``runReport`` request.
Expand Down Expand Up @@ -193,9 +188,9 @@ class RunReportRequest(proto.Message):
both date ranges. In a cohort request, this ``dateRanges``
must be unspecified.
dimension_filter (google.analytics.data_v1beta.types.FilterExpression):
Dimension filters allow you to ask for only specific
dimension values in the report. To learn more, see
`Fundamentals of Dimension
Dimension filters let you ask for only specific dimension
values in the report. To learn more, see `Fundamentals of
Dimension
Filters <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters>`__
for examples. Metrics cannot be used in this filter.
metric_filter (google.analytics.data_v1beta.types.FilterExpression):
Expand All @@ -217,7 +212,7 @@ class RunReportRequest(proto.Message):
`Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
limit (int):
The number of rows to return. If unspecified, 10,000 rows
are returned. The API returns a maximum of 100,000 rows per
are returned. The API returns a maximum of 250,000 rows per
request, no matter how many you ask for. ``limit`` must be
positive.
Expand Down Expand Up @@ -246,10 +241,18 @@ class RunReportRequest(proto.Message):
there is a cohort group in the request the
'cohort' dimension must be present.
keep_empty_rows (bool):
If false or unspecified, each row with all
metrics equal to 0 will not be returned. If
true, these rows will be returned if they are
not separately removed by a filter.
If false or unspecified, each row with all metrics equal to
0 will not be returned. If true, these rows will be returned
if they are not separately removed by a filter.
Regardless of this ``keep_empty_rows`` setting, only data
recorded by the Google Analytics (GA4) property can be
displayed in a report.
For example if a property never logs a ``purchase`` event,
then a query for the ``eventName`` dimension and
``eventCount`` metric will not have a row eventName:
"purchase" and eventCount: 0.
return_property_quota (bool):
Toggles whether to return the current state of this
Analytics Property's quota. Quota is returned in
Expand Down Expand Up @@ -473,10 +476,18 @@ class RunPivotReportRequest(proto.Message):
there is a cohort group in the request the
'cohort' dimension must be present.
keep_empty_rows (bool):
If false or unspecified, each row with all
metrics equal to 0 will not be returned. If
true, these rows will be returned if they are
not separately removed by a filter.
If false or unspecified, each row with all metrics equal to
0 will not be returned. If true, these rows will be returned
if they are not separately removed by a filter.
Regardless of this ``keep_empty_rows`` setting, only data
recorded by the Google Analytics (GA4) property can be
displayed in a report.
For example if a property never logs a ``purchase`` event,
then a query for the ``eventName`` dimension and
``eventCount`` metric will not have a row eventName:
"purchase" and eventCount: 0.
return_property_quota (bool):
Toggles whether to return the current state of this
Analytics Property's quota. Quota is returned in
Expand Down Expand Up @@ -814,7 +825,7 @@ class RunRealtimeReportRequest(proto.Message):
Dimensions cannot be used in this filter.
limit (int):
The number of rows to return. If unspecified, 10,000 rows
are returned. The API returns a maximum of 100,000 rows per
are returned. The API returns a maximum of 250,000 rows per
request, no matter how many you ask for. ``limit`` must be
positive.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,8 @@ class Compatibility(proto.Enum):


class DateRange(proto.Message):
r"""A contiguous set of days: startDate, startDate + 1, ...,
endDate. Requests
are allowed up to 4 date ranges.
r"""A contiguous set of days: ``startDate``, ``startDate + 1``, ...,
``endDate``. Requests are allowed up to 4 date ranges.
Attributes:
start_date (str):
Expand Down Expand Up @@ -215,9 +214,9 @@ class DateRange(proto.Message):


class MinuteRange(proto.Message):
r"""A contiguous set of minutes: startMinutesAgo, startMinutesAgo
+ 1, ...,
endMinutesAgo. Requests are allowed up to 2 minute ranges.
r"""A contiguous set of minutes: ``startMinutesAgo``,
``startMinutesAgo + 1``, ..., ``endMinutesAgo``. Requests are
allowed up to 2 minute ranges.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Expand Down Expand Up @@ -945,7 +944,7 @@ class Pivot(proto.Message):
``limit`` of 10,000 is common for single pivot requests.
The product of the ``limit`` for each ``pivot`` in a
``RunPivotReportRequest`` must not exceed 100,000. For
``RunPivotReportRequest`` must not exceed 250,000. For
example, a two pivot request with ``limit: 1000`` in each
pivot will fail because the product is ``1,000,000``.
metric_aggregations (MutableSequence[google.analytics.data_v1beta.types.MetricAggregation]):
Expand Down Expand Up @@ -1196,9 +1195,23 @@ class ResponseMetaData(proto.Message):
Attributes:
data_loss_from_other_row (bool):
If true, indicates some buckets of dimension
combinations are rolled into "(other)" row. This
can happen for high cardinality reports.
If true, indicates some buckets of dimension combinations
are rolled into "(other)" row. This can happen for high
cardinality reports.
The metadata parameter dataLossFromOtherRow is populated
based on the aggregated data table used in the report. The
parameter will be accurately populated regardless of the
filters and limits in the report.
For example, the (other) row could be dropped from the
report because the request contains a filter on
sessionSource = google. This parameter will still be
populated if data loss from other row was present in the
input aggregate data used to generate this report.
To learn more, see `About the (other) row and data
sampling <https://support.google.com/analytics/answer/13208658#reports>`__.
schema_restriction_response (google.analytics.data_v1beta.types.ResponseMetaData.SchemaRestrictionResponse):
Describes the schema restrictions actively enforced in
creating this report. To learn more, see `Access and
Expand Down Expand Up @@ -1552,13 +1565,13 @@ class PropertyQuota(proto.Message):
Attributes:
tokens_per_day (google.analytics.data_v1beta.types.QuotaStatus):
Standard Analytics Properties can use up to
25,000 tokens per day; Analytics 360 Properties
can use 250,000 tokens per day. Most requests
200,000 tokens per day; Analytics 360 Properties
can use 2,000,000 tokens per day. Most requests
consume fewer than 10 tokens.
tokens_per_hour (google.analytics.data_v1beta.types.QuotaStatus):
Standard Analytics Properties can use up to
5,000 tokens per hour; Analytics 360 Properties
can use 50,000 tokens per hour. An API request
40,000 tokens per hour; Analytics 360 Properties
can use 400,000 tokens per hour. An API request
consumes a single number of tokens, and that
number is deducted from all of the hourly,
daily, and per project hourly quotas.
Expand All @@ -1580,15 +1593,15 @@ class PropertyQuota(proto.Message):
if the request contains potentially thresholded
dimensions.
tokens_per_project_per_hour (google.analytics.data_v1beta.types.QuotaStatus):
Analytics Properties can use up to 25% of
Analytics Properties can use up to 35% of
their tokens per project per hour. This amounts
to standard Analytics Properties can use up to
1,250 tokens per project per hour, and Analytics
360 Properties can use 12,500 tokens per project
per hour. An API request consumes a single
number of tokens, and that number is deducted
from all of the hourly, daily, and per project
hourly quotas.
14,000 tokens per project per hour, and
Analytics 360 Properties can use 140,000 tokens
per project per hour. An API request consumes a
single number of tokens, and that number is
deducted from all of the hourly, daily, and per
project hourly quotas.
"""

tokens_per_day: "QuotaStatus" = proto.Field(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-analytics-data",
"version": "0.17.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-analytics-data",
"version": "0.17.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down

0 comments on commit c175c6f

Please sign in to comment.