8000 feat: add `subject_to_thresholding` field to `ResponseMetadata` type … · googleapis/python-analytics-data@779da22 · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Nov 9, 2024. It is now read-only.

Commit 779da22

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add subject_to_thresholding field to ResponseMetadata type (#302)
- [ ] Regenerate this pull request now. feat: add `tokens_per_project_per_hour` field to `PropertyQuota` type PiperOrigin-RevId: 479394249 Source-Link: https://togithub.com/googleapis/googleapis/commit/59b73bd6f7c00dc5af895414c444b08055849bdf Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/c2f211bcb3cc0b10cb71905185dd740bd26fc372 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYzJmMjExYmNiM2NjMGIxMGNiNzE5MDUxODVkZDc0MGJkMjZmYzM3MiJ9
1 parent 24dd4b2 commit 779da22

File tree

7 files changed

+157
-83
lines changed

7 files changed

+157
-83
lines changed

‎google/analytics/data_v1beta/services/beta_analytics_data/async_client.py

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -210,15 +210,18 @@ async def run_report(
210210
timeout: float = None,
211211
metadata: Sequence[Tuple[str, str]] = (),
212212
) -> analytics_data_api.RunReportResponse:
213-
r"""Returns a customized report of your Google Analytics
214-
event data. Reports contain statistics derived from data
215-
collected by the Google Analytics tracking code. The
216-
data returned from the API is as a table with columns
217-
for the requested dimensions and metrics. Metrics are
218-
individual measurements of user activity on your
219-
property, such as active users or event count.
220-
Dimensions break down metrics across some common
221-
criteria, such as country or event name.
213+
r"""Returns a customized report of your Google Analytics event data.
214+
Reports contain statistics derived from data collected by the
215+
Google Analytics tracking code. The data returned from the API
216+
is as a table with columns for the requested dimensions and
217+
metrics. Metrics are individual measurements of user activity on
218+
your property, such as active users or event count. Dimensions
219+
break down metrics across some common criteria, such as country
220+
or event name.
221+
222+
For a guide to constructing requests & understanding responses,
223+
see `Creating a
224+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.
222225
223226
.. code-block:: python
224227
@@ -633,7 +636,7 @@ async def sample_get_metadata():
633636
# and friendly error handling.
634637
rpc = gapic_v1.method_async.wrap_method(
635638
self._client._transport.get_metadata,
636-
default_timeout=None,
639+
default_timeout=60.0,
637640
client_info=DEFAULT_CLIENT_INFO,
638641
)
639642

@@ -662,10 +665,16 @@ async def run_realtime_report(
662665
timeout: float = None,
663666
metadata: Sequence[Tuple[str, str]] = (),
664667
) -> analytics_data_api.RunRealtimeReportResponse:
665-
r"""The Google Analytics Realtime API returns a
666-
customized report of realtime event data for your
667-
property. These reports show events and usage from the
668-
last 30 minutes.
668+
r"""Returns a customized report of realtime event data for your
669+
property. Events appear in realtime reports seconds after they
670+
have been sent to the Google Analytics. Realtime reports show
671+
events and usage data for the periods of time ranging from the
672+
present moment to 30 minutes ago (up to 60 minutes for Google
673+
Analytics 360 properties).
674+
675+
For a guide to constructing realtime requests & understanding
676+
responses, see `Creating a Realtime
677+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.
669678
670679
.. code-block:: python
671680
@@ -809,7 +818,7 @@ async def sample_check_compatibility():
809818
# and friendly error handling.
810819
rpc = gapic_v1.method_async.wrap_method(
811820
self._client._transport.check_compatibility,
812-
default_timeout=None,
821+
default_timeout=60.0,
813822
client_info=DEFAULT_CLIENT_INFO,
814823
)
815824

‎google/analytics/data_v1beta/services/beta_analytics_data/client.py

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -433,15 +433,18 @@ def run_report(
433433
timeout: float = None,
434434
metadata: Sequence[Tuple[str, str]] = (),
435435
) -> analytics_data_api.RunReportResponse:
436-
r"""Returns a customized report of your Google Analytics
437-
event data. Reports contain statistics derived from data
438-
collected by the Google Analytics tracking code. The
439-
data returned from the API is as a table with columns
440-
for the requested dimensions and metrics. Metrics are
441-
individual measurements of user activity on your
442-
property, such as active users or event count.
443-
Dimensions break down metrics across some common
444-
criteria, such as country or event name.
436+
r"""Returns a customized report of your Google Analytics event data.
437+
Reports contain statistics derived from data collected by the
438+
Google Analytics tracking code. The data returned from the API
439+
is as a table with columns for the requested dimensions and
440+
metrics. Metrics are individual measurements of user activity on
441+
your property, such as active users or event count. Dimensions
442+
break down metrics across some common criteria, such as country
443+
or event name.
444+
445+
For a guide to constructing requests & understanding responses,
446+
see `Creating a
447+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.
445448
446449
.. code-block:: python
447450
@@ -889,10 +892,16 @@ def run_realtime_report(
889892
timeout: float = None,
890893
metadata: Sequence[Tuple[str, str]] = (),
891894
) -> analytics_data_api.RunRealtimeReportResponse:
892-
r"""The Google Analytics Realtime API returns a
893-
customized report of realtime event data for your
894-
property. These reports show events and usage from the
895-
last 30 minutes.
895+
r"""Returns a customized report of realtime event data for your
896+
property. Events appear in realtime reports seconds after they
897+
have been sent to the Google Analytics. Realtime reports show
898+
events and usage data for the periods of time ranging from the
899+
present moment to 30 minutes ago (up to 60 minutes for Google
900+
Analytics 360 properties).
901+
902+
For a guide to constructing realtime requests & understanding
903+
responses, see `Creating a Realtime
904+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.
896905
897906
.. code-block:: python
898907

‎google/analytics/data_v1beta/services/beta_analytics_data/transports/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ def _prep_wrapped_messages(self, client_info):
152152
),
153153
self.get_metadata: gapic_v1.method.wrap_method(
154154
self.get_metadata,
155-
default_timeout=None,
155+
default_timeout=60.0,
156156
client_info=client_info,
157157
),
158158
self.run_realtime_report: gapic_v1.method.wrap_method(
@@ -162,7 +162,7 @@ def _prep_wrapped_messages(self, client_info):
162162
),
163163
self.check_compatibility: gapic_v1.method.wrap_method(
164164
self.check_compatibility,
165-
default_timeout=None,
165+
default_timeout=60.0,
166166
client_info=client_info,
167167
),
168168
}

‎google/analytics/data_v1beta/services/beta_analytics_data/transports/grpc.py

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -237,15 +237,18 @@ def run_report(
237237
]:
238238
r"""Return a callable for the run report method over gRPC.
239239
240-
Returns a customized report of your Google Analytics
241-
event data. Reports contain statistics derived from data
242-
collected by the Google Analytics tracking code. The
243-
data returned from the API is as a table with columns
244-
for the requested dimensions and metrics. Metrics are
245-
individual measurements of user activity on your
246-
property, such as active users or event count.
247-
Dimensions break down metrics across some common
248-
criteria, such as country or event name.
240+
Returns a customized report of your Google Analytics event data.
241+
Reports contain statistics derived from data collected by the
242+
Google Analytics tracking code. The data returned from the API
243+
is as a table with columns for the requested dimensions and
244+
metrics. Metrics are individual measurements of user activity on
245+
your property, such as active users or event count. Dimensions
246+
break down metrics across some common criteria, such as country
247+
or event name.
248+
249+
For a guide to constructing requests & understanding responses,
250+
see `Creating a
251+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.
249252
250253
Returns:
251254
Callable[[~.RunReportRequest],
@@ -404,10 +407,16 @@ def run_realtime_report(
8000 404407
]:
405408
r"""Return a callable for the run realtime report method over gRPC.
406409
407-
The Google Analytics Realtime API returns a
408-
customized report of realtime event data for your
409-
property. These reports show events and usage from the
410-
last 30 minutes.
410+
Returns a customized report of realtime event data for your
411+
property. Events appear in realtime reports seconds after they
412+
have been sent to the Google Analytics. Realtime reports show
413+
events and usage data for the periods of time ranging from the
414+
present moment to 30 minutes ago (up to 60 minutes for Google
415+
Analytics 360 properties).
416+
417+
For a guide to constructing realtime requests & understanding
418+
responses, see `Creating a Realtime
419+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.
411420
412421
Returns:
413422
Callable[[~.RunRealtimeReportRequest],

‎google/analytics/data_v1beta/services/beta_analytics_data/transports/grpc_asyncio.py

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -241,15 +241,18 @@ def run_report(
241241
]:
242242
r"""Return a callable for the run report method over gRPC.
243243
244-
Returns a customized report of your Google Analytics
245-
event data. Reports contain statistics derived from data
246-
collected by the Google Analytics tracking code. The
247-
data returned from the API is as a table with columns
248-
for the requested dimensions and metrics. Metrics are
249-
individual measurements of user activity on your
250-
property, such as active users or event count.
251-
Dimensions break down metrics across some common
252-
criteria, such as country or event name.
244+
Returns a customized report of your Google Analytics event data.
245+
Reports contain statistics derived from data collected by the
246+
Google Analytics tracking code. The data returned from the API
247+
is as a table with columns for the requested dimensions and
248+
metrics. Metrics are individual measurements of user activity on
249+
your property, such as active users or event count. Dimensions
250+
break down metrics across some common criteria, such as country
251+
or event name.
252+
253+
For a guide to constructing requests & understanding responses,
254+
see `Creating a
255+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.
253256
254257
Returns:
255258
Callable[[~.RunReportRequest],
@@ -410,10 +413,16 @@ def run_realtime_report(
410413
]:
411414
r"""Return a callable for the run realtime report method over gRPC.
412415
413-
The Google Analytics Realtime API returns a
414-
customized report of realtime event data for your
415-
property. These reports show events and usage from the
416-
last 30 minutes.
416+
Returns a customized report of realtime event data for your
417+
property. Events appear in realtime reports seconds after they
418+
have been sent to the Google Analytics. Realtime reports show
419+
events and usage data for the periods of time ranging from the
420+
present moment to 30 minutes ago (up to 60 minutes for Google
421+
Analytics 360 properties).
422+
423+
For a guide to constructing realtime requests & understanding
424+
responses, see `Creating a Realtime
425+
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.
417426
418427
Returns:
419428
Callable[[~.RunRealtimeReportRequest],

‎google/analytics/data_v1beta/types/analytics_data_api.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,10 @@ class RunReportRequest(proto.Message):
192192
Filters <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters>`__
193193
for examples. Metrics cannot be used in this filter.
194194
metric_filter (google.analytics.data_v1beta.types.FilterExpression):
195-
The filter clause of metrics. Applied at post
196-
aggregation phase, similar to SQL having-clause.
197-
Dimensions cannot be used in this filter.
195+
The filter clause of metrics. Applied after
196+
aggregating the report's rows, similar to SQL
197+
having-clause. Dimensions cannot be used in this
198+
filter.
198199
offset (int):
199200
The row count of the start row. The first row is counted as
200201
row 0.
@@ -798,15 +799,12 @@ class RunRealtimeReportRequest(proto.Message):
798799
metrics (Sequence[google.analytics.data_v1beta.types.Metric]):
799800
The metrics requested and displayed.
800801
dimension_filter (google.analytics.data_v1beta.types.FilterExpression):
801-
The filter clause of dimensions. Dimensions
802-
must be requested to be used in this filter.
803-
Metrics cannot be used in this filter.
802+
The filter clause of dimensions. Metrics
803+
cannot be used in this filter.
804804
metric_filter (google.analytics.data_v1beta.types.FilterExpression):
805805
The filter clause of metrics. Applied at post
806806
aggregation phase, similar to SQL having-clause.
807-
Metrics must be requested to be used in this
808-
filter. Dimensions cannot be used in this
809-
filter.
807+
Dimensions cannot be used in this filter.
810808
limit (int):
811809
The number of rows to return. If unspecified, 10,000 rows
812810
are returned. The API returns a maximum of 100,000 rows per

0 commit comments

Comments
 (0)
0