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

feat: add subject_to_thresholding field to ResponseMetadata type #302

Merged
merged 3 commits into from
Oct 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -210,15 +210,18 @@ async def run_report(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> analytics_data_api.RunReportResponse:
r"""Returns a customized report of your Google Analytics
event data. Reports contain statistics derived from data
collected by the Google Analytics tracking code. The
data returned from the API is as a table with columns
for the requested dimensions and metrics. Metrics are
individual measurements of user activity on your
property, such as active users or event count.
Dimensions break down metrics across some common
criteria, such as country or event name.
r"""Returns a customized report of your Google Analytics event data.
Reports contain statistics derived from data collected by the
Google Analytics tracking code. The data returned from the API
is as a table with columns for the requested dimensions and
metrics. Metrics are individual measurements of user activity on
your property, such as active users or event count. Dimensions
break down metrics across some common criteria, such as country
or event name.

For a guide to constructing requests & understanding responses,
see `Creating a
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.

.. code-block:: python

Expand Down Expand Up @@ -633,7 +636,7 @@ async def sample_get_metadata():
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.get_metadata,
default_timeout=None,
default_timeout=60.0,
client_info=DEFAULT_CLIENT_INFO,
)

Expand Down Expand Up @@ -662,10 +665,16 @@ async def run_realtime_report(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> analytics_data_api.RunRealtimeReportResponse:
r"""The Google Analytics Realtime API returns a
customized report of realtime event data for your
property. These reports show events and usage from the
last 30 minutes.
r"""Returns a customized report of realtime event data for your
property. Events appear in realtime reports seconds after they
have been sent to the Google Analytics. Realtime reports show
events and usage data for the periods of time ranging from the
present moment to 30 minutes ago (up to 60 minutes for Google
Analytics 360 properties).

For a guide to constructing realtime requests & understanding
responses, see `Creating a Realtime
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.

.. code-block:: python

Expand Down Expand Up @@ -809,7 +818,7 @@ async def sample_check_compatibility():
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.check_compatibility,
default_timeout=None,
default_timeout=60.0,
client_info=DEFAULT_CLIENT_INFO,
)

Expand Down
35 changes: 22 additions & 13 deletions google/analytics/data_v1beta/services/beta_analytics_data/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -433,15 +433,18 @@ def run_report(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> analytics_data_api.RunReportResponse:
r"""Returns a customized report of your Google Analytics
event data. Reports contain statistics derived from data
collected by the Google Analytics tracking code. The
data returned from the API is as a table with columns
for the requested dimensions and metrics. Metrics are
individual measurements of user activity on your
property, such as active users or event count.
Dimensions break down metrics across some common
criteria, such as country or event name.
r"""Returns a customized report of your Google Analytics event data.
Reports contain statistics derived from data collected by the
Google Analytics tracking code. The data returned from the API
is as a table with columns for the requested dimensions and
metrics. Metrics are individual measurements of user activity on
your property, such as active users or event count. Dimensions
break down metrics across some common criteria, such as country
or event name.

For a guide to constructing requests & understanding responses,
see `Creating a
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.

.. code-block:: python

Expand Down Expand Up @@ -889,10 +892,16 @@ def run_realtime_report(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> analytics_data_api.RunRealtimeReportResponse:
r"""The Google Analytics Realtime API returns a
customized report of realtime event data for your
property. These reports show events and usage from the
last 30 minutes.
r"""Returns a customized report of realtime event data for your
property. Events appear in realtime reports seconds after they
have been sent to the Google Analytics. Realtime reports show
events and usage data for the periods of time ranging from the
present moment to 30 minutes ago (up to 60 minutes for Google
Analytics 360 properties).

For a guide to constructing realtime requests & understanding
responses, see `Creating a Realtime
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.

.. code-block:: python

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ def _prep_wrapped_messages(self, client_info):
),
self.get_metadata: gapic_v1.method.wrap_method(
self.get_metadata,
default_timeout=None,
default_timeout=60.0,
client_info=client_info,
),
self.run_realtime_report: gapic_v1.method.wrap_method(
Expand All @@ -162,7 +162,7 @@ def _prep_wrapped_messages(self, client_info):
),
self.check_compatibility: gapic_v1.method.wrap_method(
self.check_compatibility,
default_timeout=None,
default_timeout=60.0,
client_info=client_info,
),
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -237,15 +237,18 @@ def run_report(
]:
r"""Return a callable for the run report method over gRPC.

Returns a customized report of your Google Analytics
event data. Reports contain statistics derived from data
collected by the Google Analytics tracking code. The
data returned from the API is as a table with columns
for the requested dimensions and metrics. Metrics are
individual measurements of user activity on your
property, such as active users or event count.
Dimensions break down metrics across some common
criteria, such as country or event name.
Returns a customized report of your Google Analytics event data.
Reports contain statistics derived from data collected by the
Google Analytics tracking code. The data returned from the API
is as a table with columns for the requested dimensions and
metrics. Metrics are individual measurements of user activity on
your property, such as active users or event count. Dimensions
break down metrics across some common criteria, such as country
or event name.

For a guide to constructing requests & understanding responses,
see `Creating a
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.

Returns:
Callable[[~.RunReportRequest],
Expand Down Expand Up @@ -404,10 +407,16 @@ def run_realtime_report(
]:
r"""Return a callable for the run realtime report method over gRPC.

The Google Analytics Realtime API returns a
customized report of realtime event data for your
property. These reports show events and usage from the
last 30 minutes.
Returns a customized report of realtime event data for your
property. Events appear in realtime reports seconds after they
have been sent to the Google Analytics. Realtime reports show
events and usage data for the periods of time ranging from the
present moment to 30 minutes ago (up to 60 minutes for Google
Analytics 360 properties).

For a guide to constructing realtime requests & understanding
responses, see `Creating a Realtime
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.

Returns:
Callable[[~.RunRealtimeReportRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -241,15 +241,18 @@ def run_report(
]:
r"""Return a callable for the run report method over gRPC.

Returns a customized report of your Google Analytics
event data. Reports contain statistics derived from data
collected by the Google Analytics tracking code. The
data returned from the API is as a table with columns
for the requested dimensions and metrics. Metrics are
individual measurements of user activity on your
property, such as active users or event count.
Dimensions break down metrics across some common
criteria, such as country or event name.
Returns a customized report of your Google Analytics event data.
Reports contain statistics derived from data collected by the
Google Analytics tracking code. The data returned from the API
is as a table with columns for the requested dimensions and
metrics. Metrics are individual measurements of user activity on
your property, such as active users or event count. Dimensions
break down metrics across some common criteria, such as country
or event name.

For a guide to constructing requests & understanding responses,
see `Creating a
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/basics>`__.

Returns:
Callable[[~.RunReportRequest],
Expand Down Expand Up @@ -410,10 +413,16 @@ def run_realtime_report(
]:
r"""Return a callable for the run realtime report method over gRPC.

The Google Analytics Realtime API returns a
customized report of realtime event data for your
property. These reports show events and usage from the
last 30 minutes.
Returns a customized report of realtime event data for your
property. Events appear in realtime reports seconds after they
have been sent to the Google Analytics. Realtime reports show
events and usage data for the periods of time ranging from the
present moment to 30 minutes ago (up to 60 minutes for Google
Analytics 360 properties).

For a guide to constructing realtime requests & understanding
responses, see `Creating a Realtime
Report <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics>`__.

Returns:
Callable[[~.RunRealtimeReportRequest],
Expand Down
16 changes: 7 additions & 9 deletions google/analytics/data_v1beta/types/analytics_data_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,10 @@ class RunReportRequest(proto.Message):
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):
The filter clause of metrics. Applied at post
aggregation phase, similar to SQL having-clause.
Dimensions cannot be used in this filter.
The filter clause of metrics. Applied after
aggregating the report's rows, similar to SQL
having-clause. Dimensions cannot be used in this
filter.
offset (int):
The row count of the start row. The first row is counted as
row 0.
Expand Down Expand Up @@ -798,15 +799,12 @@ class RunRealtimeReportRequest(proto.Message):
metrics (Sequence[google.analytics.data_v1beta.types.Metric]):
The metrics requested and displayed.
dimension_filter (google.analytics.data_v1beta.types.FilterExpression):
The filter clause of dimensions. Dimensions
must be requested to be used in this filter.
Metrics cannot be used in this filter.
The filter clause of dimensions. Metrics
cannot be used in this filter.
metric_filter (google.analytics.data_v1beta.types.FilterExpression):
The filter clause of metrics. Applied at post
aggregation phase, similar to SQL having-clause.
Metrics must be requested to be used in this
filter. Dimensions cannot be used in this
filter.
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
Expand Down
Loading