As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit Python 2 support on Google Cloud.
Source code for google.analytics.data_v1alpha.types.data
# -*- coding: utf-8 -*-
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from __future__ import annotations
from typing import MutableMapping, MutableSequence
from google.protobuf import duration_pb2 # type: ignore
import proto # type: ignore
__protobuf__ = proto.module(
package="google.analytics.data.v1alpha",
manifest={
"UserCriteriaScoping",
"UserExclusionDuration",
"SessionCriteriaScoping",
"SessionExclusionDuration",
"EventCriteriaScoping",
"EventExclusionDuration",
"MetricType",
"DateRange",
"Dimension",
"DimensionExpression",
"FilterExpression",
"FilterExpressionList",
"Filter",
"StringFilter",
"InListFilter",
"NumericFilter",
"BetweenFilter",
"NumericValue",
"DimensionHeader",
"MetricHeader",
"Row",
"DimensionValue",
"MetricValue",
"PropertyQuota",
"QuotaStatus",
"FunnelBreakdown",
"FunnelNextAction",
"Funnel",
"FunnelStep",
"FunnelSubReport",
"UserSegment",
"UserSegmentCriteria",
"UserSegmentConditionGroup",
"UserSegmentSequenceGroup",
"UserSequenceStep",
"UserSegmentExclusion",
"SessionSegment",
"SessionSegmentCriteria",
"SessionSegmentConditionGroup",
"SessionSegmentExclusion",
"EventSegment",
"EventSegmentCriteria",
"EventSegmentConditionGroup",
"EventSegmentExclusion",
"Segment",
"SegmentFilterExpression",
"SegmentFilterExpressionList",
"SegmentFilter",
"SegmentFilterScoping",
"SegmentEventFilter",
"SegmentParameterFilterExpression",
"SegmentParameterFilterExpressionList",
"SegmentParameterFilter",
"SegmentParameterFilterScoping",
"FunnelFilterExpression",
"FunnelFilterExpressionList",
"FunnelFieldFilter",
"FunnelEventFilter",
"FunnelParameterFilterExpression",
"FunnelParameterFilterExpressionList",
"FunnelParameterFilter",
"FunnelResponseMetadata",
"SamplingMetadata",
},
)
[docs]class UserCriteriaScoping(proto.Enum):
r"""Scoping specifies which events are considered when evaluating
if a user meets a criteria.
Values:
USER_CRITERIA_SCOPING_UNSPECIFIED (0):
Unspecified criteria scoping. Do not specify.
USER_CRITERIA_WITHIN_SAME_EVENT (1):
If the criteria is satisfied within one
event, the user matches the criteria.
USER_CRITERIA_WITHIN_SAME_SESSION (2):
If the criteria is satisfied within one
session, the user matches the criteria.
USER_CRITERIA_ACROSS_ALL_SESSIONS (3):
If the criteria is satisfied by any events
for the user, the user matches the criteria.
"""
USER_CRITERIA_SCOPING_UNSPECIFIED = 0
USER_CRITERIA_WITHIN_SAME_EVENT = 1
USER_CRITERIA_WITHIN_SAME_SESSION = 2
USER_CRITERIA_ACROSS_ALL_SESSIONS = 3
[docs]class UserExclusionDuration(proto.Enum):
r"""Enumerates options for how long an exclusion will last if a user
matches the ``userExclusionCriteria``.
Values:
USER_EXCLUSION_DURATION_UNSPECIFIED (0):
Unspecified exclusion duration. Do not
specify.
USER_EXCLUSION_TEMPORARY (1):
Temporarily exclude users from the segment during periods
when the user meets the ``userExclusionCriteria`` condition.
USER_EXCLUSION_PERMANENT (2):
Permanently exclude users from the segment if the user ever
meets the ``userExclusionCriteria`` condition.
"""
USER_EXCLUSION_DURATION_UNSPECIFIED = 0
USER_EXCLUSION_TEMPORARY = 1
USER_EXCLUSION_PERMANENT = 2
[docs]class SessionCriteriaScoping(proto.Enum):
r"""Scoping specifies which events are considered when evaluating
if a session meets a criteria.
Values:
SESSION_CRITERIA_SCOPING_UNSPECIFIED (0):
Unspecified criteria scoping. Do not specify.
SESSION_CRITERIA_WITHIN_SAME_EVENT (1):
If the criteria is satisfied within one
event, the session matches the criteria.
SESSION_CRITERIA_WITHIN_SAME_SESSION (2):
If the criteria is satisfied within one
session, the session matches the criteria.
"""
SESSION_CRITERIA_SCOPING_UNSPECIFIED = 0
SESSION_CRITERIA_WITHIN_SAME_EVENT = 1
SESSION_CRITERIA_WITHIN_SAME_SESSION = 2
[docs]class SessionExclusionDuration(proto.Enum):
r"""Enumerates options for how long an exclusion will last if a session
matches the ``sessionExclusionCriteria``.
Values:
SESSION_EXCLUSION_DURATION_UNSPECIFIED (0):
Unspecified exclusion duration. Do not
specify.
SESSION_EXCLUSION_TEMPORARY (1):
Temporarily exclude sessions from the segment during periods
when the session meets the ``sessionExclusionCriteria``
condition.
SESSION_EXCLUSION_PERMANENT (2):
Permanently exclude sessions from the segment if the session
ever meets the ``sessionExclusionCriteria`` condition.
"""
SESSION_EXCLUSION_DURATION_UNSPECIFIED = 0
SESSION_EXCLUSION_TEMPORARY = 1
SESSION_EXCLUSION_PERMANENT = 2
[docs]class EventCriteriaScoping(proto.Enum):
r"""Scoping specifies which events are considered when evaluating
if an event meets a criteria.
Values:
EVENT_CRITERIA_SCOPING_UNSPECIFIED (0):
Unspecified criteria scoping. Do not specify.
EVENT_CRITERIA_WITHIN_SAME_EVENT (1):
If the criteria is satisfied within one
event, the event matches the criteria.
"""
EVENT_CRITERIA_SCOPING_UNSPECIFIED = 0
EVENT_CRITERIA_WITHIN_SAME_EVENT = 1
[docs]class EventExclusionDuration(proto.Enum):
r"""Enumerates options for how long an exclusion will last if an event
matches the ``eventExclusionCriteria``.
Values:
EVENT_EXCLUSION_DURATION_UNSPECIFIED (0):
Unspecified exclusion duration. Do not
specify.
EVENT_EXCLUSION_PERMANENT (1):
Permanently exclude events from the segment if the event
ever meets the ``eventExclusionCriteria`` condition.
"""
EVENT_EXCLUSION_DURATION_UNSPECIFIED = 0
EVENT_EXCLUSION_PERMANENT = 1
[docs]class MetricType(proto.Enum):
r"""A metric's value type.
Values:
METRIC_TYPE_UNSPECIFIED (0):
Unspecified type.
TYPE_INTEGER (1):
Integer type.
TYPE_FLOAT (2):
Floating point type.
TYPE_SECONDS (4):
A duration of seconds; a special floating
point type.
TYPE_MILLISECONDS (5):
A duration in milliseconds; a special
floating point type.
TYPE_MINUTES (6):
A duration in minutes; a special floating
point type.
TYPE_HOURS (7):
A duration in hours; a special floating point
type.
TYPE_STANDARD (8):
A custom metric of standard type; a special
floating point type.
TYPE_CURRENCY (9):
An amount of money; a special floating point
type.
TYPE_FEET (10):
A length in feet; a special floating point
type.
TYPE_MILES (11):
A length in miles; a special floating point
type.
TYPE_METERS (12):
A length in meters; a special floating point
type.
TYPE_KILOMETERS (13):
A length in kilometers; a special floating
point type.
"""
METRIC_TYPE_UNSPECIFIED = 0
TYPE_INTEGER = 1
TYPE_FLOAT = 2
TYPE_SECONDS = 4
TYPE_MILLISECONDS = 5
TYPE_MINUTES = 6
TYPE_HOURS = 7
TYPE_STANDARD = 8
TYPE_CURRENCY = 9
TYPE_FEET = 10
TYPE_MILES = 11
TYPE_METERS = 12
TYPE_KILOMETERS = 13
[docs]class DateRange(proto.Message):
r"""A contiguous set of days: ``startDate``, ``startDate + 1``, ...,
``endDate``. Requests are allowed up to 4 date ranges.
Attributes:
start_date (str):
The inclusive start date for the query in the format
``YYYY-MM-DD``. Cannot be after ``end_date``. The format
``NdaysAgo``, ``yesterday``, or ``today`` is also accepted,
and in that case, the date is inferred based on the
property's reporting time zone.
end_date (str):
The inclusive end date for the query in the format
``YYYY-MM-DD``. Cannot be before ``start_date``. The format
``NdaysAgo``, ``yesterday``, or ``today`` is also accepted,
and in that case, the date is inferred based on the
property's reporting time zone.
name (str):
Assigns a name to this date range. The dimension
``dateRange`` is valued to this name in a report response.
If set, cannot begin with ``date_range_`` or ``RESERVED_``.
If not set, date ranges are named by their zero based index
in the request: ``date_range_0``, ``date_range_1``, etc.
"""
start_date: str = proto.Field(
proto.STRING,
number=1,
)
end_date: str = proto.Field(
proto.STRING,
number=2,
)
name: str = proto.Field(
proto.STRING,
number=3,
)
[docs]class Dimension(proto.Message):
r"""Dimensions are attributes of your data. For example, the
dimension city indicates the city from which an event
originates. Dimension values in report responses are strings;
for example, the city could be "Paris" or "New York".
Attributes:
name (str):
The name of the dimension. See the `API
Dimensions <https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions>`__
for the list of dimension names supported by core reporting
methods such as ``runReport`` and ``batchRunReports``. See
`Realtime
Dimensions <https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions>`__
for the list of dimension names supported by the
``runRealtimeReport`` method. See `Funnel
Dimensions <https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions>`__
for the list of dimension names supported by the
``runFunnelReport`` method.
If ``dimensionExpression`` is specified, ``name`` can be any
string that you would like within the allowed character set.
For example if a ``dimensionExpression`` concatenates
``country`` and ``city``, you could call that dimension
``countryAndCity``. Dimension names that you choose must
match the regular expression ``^[a-zA-Z0-9_]$``.
Dimensions are referenced by ``name`` in
``dimensionFilter``, ``orderBys``, ``dimensionExpression``,
and ``pivots``.
dimension_expression (google.analytics.data_v1alpha.types.DimensionExpression):
One dimension can be the result of an
expression of multiple dimensions. For example,
dimension "country, city": concatenate(country,
", ", city).
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
dimension_expression: "DimensionExpression" = proto.Field(
proto.MESSAGE,
number=2,
message="DimensionExpression",
)
[docs]class DimensionExpression(proto.Message):
r"""Used to express a dimension which is the result of a formula of
multiple dimensions. Example usages:
1) lower_case(dimension)
2) concatenate(dimension1, symbol, dimension2).
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
lower_case (google.analytics.data_v1alpha.types.DimensionExpression.CaseExpression):
Used to convert a dimension value to lower
case.
This field is a member of `oneof`_ ``one_expression``.
upper_case (google.analytics.data_v1alpha.types.DimensionExpression.CaseExpression):
Used to convert a dimension value to upper
case.
This field is a member of `oneof`_ ``one_expression``.
concatenate (google.analytics.data_v1alpha.types.DimensionExpression.ConcatenateExpression):
Used to combine dimension values to a single
dimension. For example, dimension "country,
city": concatenate(country, ", ", city).
This field is a member of `oneof`_ ``one_expression``.
"""
[docs] class CaseExpression(proto.Message):
r"""Used to convert a dimension value to a single case.
Attributes:
dimension_name (str):
Name of a dimension. The name must refer back
to a name in dimensions field of the request.
"""
dimension_name: str = proto.Field(
proto.STRING,
number=1,
)
[docs] class ConcatenateExpression(proto.Message):
r"""Used to combine dimension values to a single dimension.
Attributes:
dimension_names (MutableSequence[str]):
Names of dimensions. The names must refer
back to names in the dimensions field of the
request.
delimiter (str):
The delimiter placed between dimension names.
Delimiters are often single characters such as "|" or ","
but can be longer strings. If a dimension value contains the
delimiter, both will be present in response with no
distinction. For example if dimension 1 value = "US,FR",
dimension 2 value = "JP", and delimiter = ",", then the
response will contain "US,FR,JP".
"""
dimension_names: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=1,
)
delimiter: str = proto.Field(
proto.STRING,
number=2,
)
lower_case: CaseExpression = proto.Field(
proto.MESSAGE,
number=4,
oneof="one_expression",
message=CaseExpression,
)
upper_case: CaseExpression = proto.Field(
proto.MESSAGE,
number=5,
oneof="one_expression",
message=CaseExpression,
)
concatenate: ConcatenateExpression = proto.Field(
proto.MESSAGE,
number=6,
oneof="one_expression",
message=ConcatenateExpression,
)
[docs]class FilterExpression(proto.Message):
r"""To express dimension or metric filters. The fields in the
same FilterExpression need to be either all dimensions or all
metrics.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
and_group (google.analytics.data_v1alpha.types.FilterExpressionList):
The FilterExpressions in and_group have an AND relationship.
This field is a member of `oneof`_ ``expr``.
or_group (google.analytics.data_v1alpha.types.FilterExpressionList):
The FilterExpressions in or_group have an OR relationship.
This field is a member of `oneof`_ ``expr``.
not_expression (google.analytics.data_v1alpha.types.FilterExpression):
The FilterExpression is NOT of not_expression.
This field is a member of `oneof`_ ``expr``.
filter (google.analytics.data_v1alpha.types.Filter):
A primitive filter. In the same
FilterExpression, all of the filter's field
names need to be either all dimensions or all
metrics.
This field is a member of `oneof`_ ``expr``.
"""
and_group: "FilterExpressionList" = proto.Field(
proto.MESSAGE,
number=1,
oneof="expr",
message="FilterExpressionList",
)
or_group: "FilterExpressionList" = proto.Field(
proto.MESSAGE,
number=2,
oneof="expr",
message="FilterExpressionList",
)
not_expression: "FilterExpression" = proto.Field(
proto.MESSAGE,
number=3,
oneof="expr",
message="FilterExpression",
)
filter: "Filter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="expr",
message="Filter",
)
[docs]class FilterExpressionList(proto.Message):
r"""A list of filter expressions.
Attributes:
expressions (MutableSequence[google.analytics.data_v1alpha.types.FilterExpression]):
A list of filter expressions.
"""
expressions: MutableSequence["FilterExpression"] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="FilterExpression",
)
[docs]class Filter(proto.Message):
r"""An expression to filter dimension or metric values.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
field_name (str):
The dimension name or metric name. Must be a
name defined in dimensions or metrics.
string_filter (google.analytics.data_v1alpha.types.StringFilter):
Strings related filter.
This field is a member of `oneof`_ ``one_filter``.
in_list_filter (google.analytics.data_v1alpha.types.InListFilter):
A filter for in list values.
This field is a member of `oneof`_ ``one_filter``.
numeric_filter (google.analytics.data_v1alpha.types.NumericFilter):
A filter for numeric or date values.
This field is a member of `oneof`_ ``one_filter``.
between_filter (google.analytics.data_v1alpha.types.BetweenFilter):
A filter for between two values.
This field is a member of `oneof`_ ``one_filter``.
"""
field_name: str = proto.Field(
proto.STRING,
number=1,
)
string_filter: "StringFilter" = proto.Field(
proto.MESSAGE,
number=2,
oneof="one_filter",
message="StringFilter",
)
in_list_filter: "InListFilter" = proto.Field(
proto.MESSAGE,
number=3,
oneof="one_filter",
message="InListFilter",
)
numeric_filter: "NumericFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="one_filter",
message="NumericFilter",
)
between_filter: "BetweenFilter" = proto.Field(
proto.MESSAGE,
number=5,
oneof="one_filter",
message="BetweenFilter",
)
[docs]class StringFilter(proto.Message):
r"""The filter for string
Attributes:
match_type (google.analytics.data_v1alpha.types.StringFilter.MatchType):
The match type for this filter.
value (str):
The string value used for the matching.
case_sensitive (bool):
If true, the string value is case sensitive.
"""
[docs] class MatchType(proto.Enum):
r"""The match type of a string filter
Values:
MATCH_TYPE_UNSPECIFIED (0):
Unspecified
EXACT (1):
Exact match of the string value.
BEGINS_WITH (2):
Begins with the string value.
ENDS_WITH (3):
Ends with the string value.
CONTAINS (4):
Contains the string value.
FULL_REGEXP (5):
Full match for the regular expression with
the string value.
PARTIAL_REGEXP (6):
Partial match for the regular expression with
the string value.
"""
MATCH_TYPE_UNSPECIFIED = 0
EXACT = 1
BEGINS_WITH = 2
ENDS_WITH = 3
CONTAINS = 4
FULL_REGEXP = 5
PARTIAL_REGEXP = 6
match_type: MatchType = proto.Field(
proto.ENUM,
number=1,
enum=MatchType,
)
value: str = proto.Field(
proto.STRING,
number=2,
)
case_sensitive: bool = proto.Field(
proto.BOOL,
number=3,
)
[docs]class InListFilter(proto.Message):
r"""The result needs to be in a list of string values.
Attributes:
values (MutableSequence[str]):
The list of string values.
Must be non-empty.
case_sensitive (bool):
If true, the string value is case sensitive.
"""
values: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=1,
)
case_sensitive: bool = proto.Field(
proto.BOOL,
number=2,
)
[docs]class NumericFilter(proto.Message):
r"""Filters for numeric or date values.
Attributes:
operation (google.analytics.data_v1alpha.types.NumericFilter.Operation):
The operation type for this filter.
value (google.analytics.data_v1alpha.types.NumericValue):
A numeric value or a date value.
"""
[docs] class Operation(proto.Enum):
r"""The operation applied to a numeric filter
Values:
OPERATION_UNSPECIFIED (0):
Unspecified.
EQUAL (1):
Equal
LESS_THAN (2):
Less than
LESS_THAN_OR_EQUAL (3):
Less than or equal
GREATER_THAN (4):
Greater than
GREATER_THAN_OR_EQUAL (5):
Greater than or equal
"""
OPERATION_UNSPECIFIED = 0
EQUAL = 1
LESS_THAN = 2
LESS_THAN_OR_EQUAL = 3
GREATER_THAN = 4
GREATER_THAN_OR_EQUAL = 5
operation: Operation = proto.Field(
proto.ENUM,
number=1,
enum=Operation,
)
value: "NumericValue" = proto.Field(
proto.MESSAGE,
number=2,
message="NumericValue",
)
[docs]class BetweenFilter(proto.Message):
r"""To express that the result needs to be between two numbers
(inclusive).
Attributes:
from_value (google.analytics.data_v1alpha.types.NumericValue):
Begins with this number.
to_value (google.analytics.data_v1alpha.types.NumericValue):
Ends with this number.
"""
from_value: "NumericValue" = proto.Field(
proto.MESSAGE,
number=1,
message="NumericValue",
)
to_value: "NumericValue" = proto.Field(
proto.MESSAGE,
number=2,
message="NumericValue",
)
[docs]class NumericValue(proto.Message):
r"""To represent a number.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
int64_value (int):
Integer value
This field is a member of `oneof`_ ``one_value``.
double_value (float):
Double value
This field is a member of `oneof`_ ``one_value``.
"""
int64_value: int = proto.Field(
proto.INT64,
number=1,
oneof="one_value",
)
double_value: float = proto.Field(
proto.DOUBLE,
number=2,
oneof="one_value",
)
[docs]class DimensionHeader(proto.Message):
r"""Describes a dimension column in the report. Dimensions
requested in a report produce column entries within rows and
DimensionHeaders. However, dimensions used exclusively within
filters or expressions do not produce columns in a report;
correspondingly, those dimensions do not produce headers.
Attributes:
name (str):
The dimension's name.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
[docs]class MetricHeader(proto.Message):
r"""Describes a metric column in the report. Visible metrics
requested in a report produce column entries within rows and
MetricHeaders. However, metrics used exclusively within filters
or expressions do not produce columns in a report;
correspondingly, those metrics do not produce headers.
Attributes:
name (str):
The metric's name.
type_ (google.analytics.data_v1alpha.types.MetricType):
The metric's data type.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
type_: "MetricType" = proto.Field(
proto.ENUM,
number=2,
enum="MetricType",
)
[docs]class Row(proto.Message):
r"""Report data for each row. For example if RunReportRequest contains:
.. code:: none
"dimensions": [
{
"name": "eventName"
},
{
"name": "countryId"
}
],
"metrics": [
{
"name": "eventCount"
}
]
One row with 'in_app_purchase' as the eventName, 'JP' as the
countryId, and 15 as the eventCount, would be:
.. code:: none
"dimensionValues": [
{
"value": "in_app_purchase"
},
{
"value": "JP"
}
],
"metricValues": [
{
"value": "15"
}
]
Attributes:
dimension_values (MutableSequence[google.analytics.data_v1alpha.types.DimensionValue]):
List of requested dimension values. In a PivotReport,
dimension_values are only listed for dimensions included in
a pivot.
metric_values (MutableSequence[google.analytics.data_v1alpha.types.MetricValue]):
List of requested visible metric values.
"""
dimension_values: MutableSequence["DimensionValue"] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="DimensionValue",
)
metric_values: MutableSequence["MetricValue"] = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="MetricValue",
)
[docs]class DimensionValue(proto.Message):
r"""The value of a dimension.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
value (str):
Value as a string if the dimension type is a
string.
This field is a member of `oneof`_ ``one_value``.
"""
value: str = proto.Field(
proto.STRING,
number=1,
oneof="one_value",
)
[docs]class MetricValue(proto.Message):
r"""The value of a metric.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
value (str):
Measurement value. See MetricHeader for type.
This field is a member of `oneof`_ ``one_value``.
"""
value: str = proto.Field(
proto.STRING,
number=4,
oneof="one_value",
)
[docs]class PropertyQuota(proto.Message):
r"""Current state of all quotas for this Analytics Property. If
any quota for a property is exhausted, all requests to that
property will return Resource Exhausted errors.
Attributes:
tokens_per_day (google.analytics.data_v1alpha.types.QuotaStatus):
Standard Analytics Properties can use up to
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_v1alpha.types.QuotaStatus):
Standard Analytics Properties can use up to
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.
concurrent_requests (google.analytics.data_v1alpha.types.QuotaStatus):
Standard Analytics Properties can send up to
10 concurrent requests; Analytics 360 Properties
can use up to 50 concurrent requests.
server_errors_per_project_per_hour (google.analytics.data_v1alpha.types.QuotaStatus):
Standard Analytics Properties and cloud
project pairs can have up to 10 server errors
per hour; Analytics 360 Properties and cloud
project pairs can have up to 50 server errors
per hour.
potentially_thresholded_requests_per_hour (google.analytics.data_v1alpha.types.QuotaStatus):
Analytics Properties can send up to 120
requests with potentially thresholded dimensions
per hour. In a batch request, each report
request is individually counted for this quota
if the request contains potentially thresholded
dimensions.
tokens_per_project_per_hour (google.analytics.data_v1alpha.types.QuotaStatus):
Analytics Properties can use up to 35% of
their tokens per project per hour. This amounts
to standard Analytics Properties can use up to
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(
proto.MESSAGE,
number=1,
message="QuotaStatus",
)
tokens_per_hour: "QuotaStatus" = proto.Field(
proto.MESSAGE,
number=2,
message="QuotaStatus",
)
concurrent_requests: "QuotaStatus" = proto.Field(
proto.MESSAGE,
number=3,
message="QuotaStatus",
)
server_errors_per_project_per_hour: "QuotaStatus" = proto.Field(
proto.MESSAGE,
number=4,
message="QuotaStatus",
)
potentially_thresholded_requests_per_hour: "QuotaStatus" = proto.Field(
proto.MESSAGE,
number=5,
message="QuotaStatus",
)
tokens_per_project_per_hour: "QuotaStatus" = proto.Field(
proto.MESSAGE,
number=6,
message="QuotaStatus",
)
[docs]class QuotaStatus(proto.Message):
r"""Current state for a particular quota group.
Attributes:
consumed (int):
Quota consumed by this request.
remaining (int):
Quota remaining after this request.
"""
consumed: int = proto.Field(
proto.INT32,
number=1,
)
remaining: int = proto.Field(
proto.INT32,
number=2,
)
[docs]class FunnelBreakdown(proto.Message):
r"""Breakdowns add a dimension to the funnel table sub report
response.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
breakdown_dimension (google.analytics.data_v1alpha.types.Dimension):
The dimension column added to the funnel table sub report
response. The breakdown dimension breaks down each funnel
step. A valid ``breakdownDimension`` is required if
``funnelBreakdown`` is specified.
limit (int):
The maximum number of distinct values of the breakdown
dimension to return in the response. A ``limit`` of ``5`` is
used if limit is not specified. Limit must exceed zero and
cannot exceed 15.
This field is a member of `oneof`_ ``_limit``.
"""
breakdown_dimension: "Dimension" = proto.Field(
proto.MESSAGE,
number=1,
message="Dimension",
)
limit: int = proto.Field(
proto.INT64,
number=2,
optional=True,
)
[docs]class FunnelNextAction(proto.Message):
r"""Next actions state the value for a dimension after the user has
achieved a step but before the same user has achieved the next step.
For example if the ``nextActionDimension`` is ``eventName``, then
``nextActionDimension`` in the ``i``\ th funnel step row will return
first event after the event that qualified the user into the
``i``\ th funnel step but before the user achieved the ``i+1``\ th
funnel step.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
next_action_dimension (google.analytics.data_v1alpha.types.Dimension):
The dimension column added to the funnel visualization sub
report response. The next action dimension returns the next
dimension value of this dimension after the user has
attained the ``i``\ th funnel step.
``nextActionDimension`` currently only supports
``eventName`` and most Page / Screen dimensions like
``pageTitle`` and ``pagePath``. ``nextActionDimension``
cannot be a dimension expression.
limit (int):
The maximum number of distinct values of the breakdown
dimension to return in the response. A ``limit`` of ``5`` is
used if limit is not specified. Limit must exceed zero and
cannot exceed 5.
This field is a member of `oneof`_ ``_limit``.
"""
next_action_dimension: "Dimension" = proto.Field(
proto.MESSAGE,
number=1,
message="Dimension",
)
limit: int = proto.Field(
proto.INT64,
number=2,
optional=True,
)
[docs]class Funnel(proto.Message):
r"""Configures the funnel in a funnel report request. A funnel
reports on users as they pass through a sequence of steps.
Funnel exploration lets you visualize the steps your users take
to complete a task and quickly see how well they are succeeding
or failing at each step. For example, how do prospects become
shoppers and then become buyers? How do one time buyers become
repeat buyers? With this information, you can improve
inefficient or abandoned customer journeys.
Attributes:
is_open_funnel (bool):
In an open funnel, users can enter the funnel
in any step, and in a closed funnel, users must
enter the funnel in the first step. Optional. If
unspecified, a closed funnel is used.
steps (MutableSequence[google.analytics.data_v1alpha.types.FunnelStep]):
The sequential steps of this funnel.
"""
is_open_funnel: bool = proto.Field(
proto.BOOL,
number=1,
)
steps: MutableSequence["FunnelStep"] = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="FunnelStep",
)
[docs]class FunnelStep(proto.Message):
r"""Steps define the user journey you want to measure. Steps
contain one or more conditions that your users must meet to be
included in that step of the funnel journey.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
name (str):
The distinctive name for this step. If unspecified, steps
will be named by a 1 based indexed name (for example "0. ",
"1. ", etc.). This name defines string value returned by the
``funnelStepName`` dimension. For example, specifying
``name = Purchase`` in the request's third funnel step will
produce ``3. Purchase`` in the funnel report response.
is_directly_followed_by (bool):
If true, this step must directly follow the previous step.
If false, there can be events between the previous step and
this step. If unspecified, ``isDirectlyFollowedBy`` is
treated as false.
within_duration_from_prior_step (google.protobuf.duration_pb2.Duration):
If specified, this step must complete within this duration
of the completion of the prior step.
``withinDurationFromPriorStep`` is inclusive of the endpoint
at the microsecond granularity. For example a duration of 5
seconds can be completed at 4.9 or 5.0 seconds, but not 5
seconds and 1 microsecond.
``withinDurationFromPriorStep`` is optional, and if
unspecified, steps may be separated by any time duration.
This field is a member of `oneof`_ ``_within_duration_from_prior_step``.
filter_expression (google.analytics.data_v1alpha.types.FunnelFilterExpression):
The condition that your users must meet to be
included in this step of the funnel journey.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
is_directly_followed_by: bool = proto.Field(
proto.BOOL,
number=2,
)
within_duration_from_prior_step: duration_pb2.Duration = proto.Field(
proto.MESSAGE,
number=3,
optional=True,
message=duration_pb2.Duration,
)
filter_expression: "FunnelFilterExpression" = proto.Field(
proto.MESSAGE,
number=4,
message="FunnelFilterExpression",
)
[docs]class FunnelSubReport(proto.Message):
r"""Funnel sub reports contain the dimension and metric data
values. For example, 12 users reached the second step of the
funnel.
Attributes:
dimension_headers (MutableSequence[google.analytics.data_v1alpha.types.DimensionHeader]):
Describes dimension columns. Funnel reports
always include the funnel step dimension in sub
report responses. Additional dimensions like
breakdowns, dates, and next actions may be
present in the response if requested.
metric_headers (MutableSequence[google.analytics.data_v1alpha.types.MetricHeader]):
Describes metric columns. Funnel reports
always include active users in sub report
responses. The funnel table includes additional
metrics like completion rate, abandonments, and
abandonments rate.
rows (MutableSequence[google.analytics.data_v1alpha.types.Row]):
Rows of dimension value combinations and
metric values in the report.
metadata (google.analytics.data_v1alpha.types.FunnelResponseMetadata):
Metadata for the funnel report.
"""
dimension_headers: MutableSequence["DimensionHeader"] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="DimensionHeader",
)
metric_headers: MutableSequence["MetricHeader"] = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="MetricHeader",
)
rows: MutableSequence["Row"] = proto.RepeatedField(
proto.MESSAGE,
number=3,
message="Row",
)
metadata: "FunnelResponseMetadata" = proto.Field(
proto.MESSAGE,
number=4,
message="FunnelResponseMetadata",
)
[docs]class UserSegment(proto.Message):
r"""User segments are subsets of users who engaged with your site
or app. For example, users who have previously purchased; users
who added items to their shopping carts, but didn’t complete a
purchase.
Attributes:
user_inclusion_criteria (google.analytics.data_v1alpha.types.UserSegmentCriteria):
Defines which users are included in this
segment. Optional.
exclusion (google.analytics.data_v1alpha.types.UserSegmentExclusion):
Defines which users are excluded in this
segment. Optional.
"""
user_inclusion_criteria: "UserSegmentCriteria" = proto.Field(
proto.MESSAGE,
number=1,
message="UserSegmentCriteria",
)
exclusion: "UserSegmentExclusion" = proto.Field(
proto.MESSAGE,
number=2,
message="UserSegmentExclusion",
)
[docs]class UserSegmentCriteria(proto.Message):
r"""A user matches a criteria if the user's events meet the
conditions in the criteria.
Attributes:
and_condition_groups (MutableSequence[google.analytics.data_v1alpha.types.UserSegmentConditionGroup]):
A user matches this criteria if the user matches each of
these ``andConditionGroups`` and each of the
``andSequenceGroups``. ``andConditionGroups`` may be empty
if ``andSequenceGroups`` are specified.
and_sequence_groups (MutableSequence[google.analytics.data_v1alpha.types.UserSegmentSequenceGroup]):
A user matches this criteria if the user matches each of
these ``andSequenceGroups`` and each of the
``andConditionGroups``. ``andSequenceGroups`` may be empty
if ``andConditionGroups`` are specified.
"""
and_condition_groups: MutableSequence[
"UserSegmentConditionGroup"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="UserSegmentConditionGroup",
)
and_sequence_groups: MutableSequence[
"UserSegmentSequenceGroup"
] = proto.RepeatedField(
proto.MESSAGE,
number=2,
message="UserSegmentSequenceGroup",
)
[docs]class UserSegmentConditionGroup(proto.Message):
r"""Conditions tell Analytics what data to include in or exclude
from the segment.
Attributes:
condition_scoping (google.analytics.data_v1alpha.types.UserCriteriaScoping):
Data is included or excluded from the segment based on if it
matches the condition group. This scoping defines how many
events the ``segmentFilterExpression`` is evaluated on
before the condition group is determined to be matched or
not. For example if
``conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION``,
the expression is evaluated on all events in a session, and
then, the condition group is determined to be matched or not
for this user. For example if
``conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT``, the
expression is evaluated on a single event, and then, the
condition group is determined to be matched or not for this
user.
Optional. If unspecified,
``conditionScoping = ACROSS_ALL_SESSIONS`` is used.
segment_filter_expression (google.analytics.data_v1alpha.types.SegmentFilterExpression):
Data is included or excluded from the segment
based on if it matches this expression.
Expressions express criteria on dimension,
metrics, and/or parameters.
"""
condition_scoping: "UserCriteriaScoping" = proto.Field(
proto.ENUM,
number=1,
enum="UserCriteriaScoping",
)
segment_filter_expression: "SegmentFilterExpression" = proto.Field(
proto.MESSAGE,
number=2,
message="SegmentFilterExpression",
)
[docs]class UserSegmentSequenceGroup(proto.Message):
r"""Define conditions that must occur in a specific order for the
user to be a member of the segment.
Attributes:
sequence_scoping (google.analytics.data_v1alpha.types.UserCriteriaScoping):
All sequence steps must be satisfied in the scoping for the
user to match the sequence. For example if
``sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION``, all
sequence steps must complete within one session for the user
to match the sequence.
``sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT`` is not
supported.
Optional. If unspecified,
``conditionScoping = ACROSS_ALL_SESSIONS`` is used.
sequence_maximum_duration (google.protobuf.duration_pb2.Duration):
Defines the time period in which the whole sequence must
occur; for example, 30 Minutes. ``sequenceMaximumDuration``
is inclusive of the endpoint at the microsecond granularity.
For example a sequence with a maximum duration of 5 seconds
can be completed at 4.9 or 5.0 seconds, but not 5 seconds
and 1 microsecond.
``sequenceMaximumDuration`` is optional, and if unspecified,
sequences can be completed in any time duration.
user_sequence_steps (MutableSequence[google.analytics.data_v1alpha.types.UserSequenceStep]):
An ordered sequence of condition steps. A user's events must
complete each step in order for the user to match the
``UserSegmentSequenceGroup``.
"""
sequence_scoping: "UserCriteriaScoping" = proto.Field(
proto.ENUM,
number=1,
enum="UserCriteriaScoping",
)
sequence_maximum_duration: duration_pb2.Duration = proto.Field(
proto.MESSAGE,
number=2,
message=duration_pb2.Duration,
)
user_sequence_steps: MutableSequence["UserSequenceStep"] = proto.RepeatedField(
proto.MESSAGE,
number=3,
message="UserSequenceStep",
)
[docs]class UserSequenceStep(proto.Message):
r"""A condition that must occur in the specified step order for
this user to match the sequence.
Attributes:
is_directly_followed_by (bool):
If true, the event satisfying this step must be the very
next event after the event satifying the last step. If
false, this step indirectly follows the prior step; for
example, there may be events between the prior step and this
step. ``isDirectlyFollowedBy`` must be false for the first
step.
step_scoping (google.analytics.data_v1alpha.types.UserCriteriaScoping):
This sequence step must be satisfied in the scoping for the
user to match the sequence. For example if
``sequenceScoping = WITHIN_SAME_SESSION``, this sequence
steps must complete within one session for the user to match
the sequence. ``stepScoping = ACROSS_ALL_SESSIONS`` is only
allowed if the ``sequenceScoping = ACROSS_ALL_SESSIONS``.
Optional. If unspecified, ``stepScoping`` uses the same
``UserCriteriaScoping`` as the ``sequenceScoping``.
segment_filter_expression (google.analytics.data_v1alpha.types.SegmentFilterExpression):
A user matches this sequence step if their
events match this expression. Expressions
express criteria on dimension, metrics, and/or
parameters.
"""
is_directly_followed_by: bool = proto.Field(
proto.BOOL,
number=1,
)
step_scoping: "UserCriteriaScoping" = proto.Field(
proto.ENUM,
number=2,
enum="UserCriteriaScoping",
)
segment_filter_expression: "SegmentFilterExpression" = proto.Field(
proto.MESSAGE,
number=3,
message="SegmentFilterExpression",
)
[docs]class UserSegmentExclusion(proto.Message):
r"""Specifies which users are excluded in this segment.
Attributes:
user_exclusion_duration (google.analytics.data_v1alpha.types.UserExclusionDuration):
Specifies how long an exclusion will last if a user matches
the ``userExclusionCriteria``.
Optional. If unspecified, ``userExclusionDuration`` of
``USER_EXCLUSION_TEMPORARY`` is used.
user_exclusion_criteria (google.analytics.data_v1alpha.types.UserSegmentCriteria):
If a user meets this condition, the user is excluded from
membership in the segment for the ``userExclusionDuration``.
"""
user_exclusion_duration: "UserExclusionDuration" = proto.Field(
proto.ENUM,
number=1,
enum="UserExclusionDuration",
)
user_exclusion_criteria: "UserSegmentCriteria" = proto.Field(
proto.MESSAGE,
number=2,
message="UserSegmentCriteria",
)
[docs]class SessionSegment(proto.Message):
r"""Session segments are subsets of the sessions that occurred on
your site or app: for example, all the sessions that originated
from a particular advertising campaign.
Attributes:
session_inclusion_criteria (google.analytics.data_v1alpha.types.SessionSegmentCriteria):
Defines which sessions are included in this
segment. Optional.
exclusion (google.analytics.data_v1alpha.types.SessionSegmentExclusion):
Defines which sessions are excluded in this
segment. Optional.
"""
session_inclusion_criteria: "SessionSegmentCriteria" = proto.Field(
proto.MESSAGE,
number=1,
message="SessionSegmentCriteria",
)
exclusion: "SessionSegmentExclusion" = proto.Field(
proto.MESSAGE,
number=2,
message="SessionSegmentExclusion",
)
[docs]class SessionSegmentCriteria(proto.Message):
r"""A session matches a criteria if the session's events meet the
conditions in the criteria.
Attributes:
and_condition_groups (MutableSequence[google.analytics.data_v1alpha.types.SessionSegmentConditionGroup]):
A session matches this criteria if the session matches each
of these ``andConditionGroups``.
"""
and_condition_groups: MutableSequence[
"SessionSegmentConditionGroup"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="SessionSegmentConditionGroup",
)
[docs]class SessionSegmentConditionGroup(proto.Message):
r"""Conditions tell Analytics what data to include in or exclude
from the segment.
Attributes:
condition_scoping (google.analytics.data_v1alpha.types.SessionCriteriaScoping):
Data is included or excluded from the segment based on if it
matches the condition group. This scoping defines how many
events the ``segmentFilterExpression`` is evaluated on
before the condition group is determined to be matched or
not. For example if
``conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION``,
the expression is evaluated on all events in a session, and
then, the condition group is determined to be matched or not
for this session. For example if
``conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT``,
the expression is evaluated on a single event, and then, the
condition group is determined to be matched or not for this
session.
Optional. If unspecified, a ``conditionScoping`` of
``WITHIN_SAME_SESSION`` is used.
segment_filter_expression (google.analytics.data_v1alpha.types.SegmentFilterExpression):
Data is included or excluded from the segment
based on if it matches this expression.
Expressions express criteria on dimension,
metrics, and/or parameters.
"""
condition_scoping: "SessionCriteriaScoping" = proto.Field(
proto.ENUM,
number=1,
enum="SessionCriteriaScoping",
)
segment_filter_expression: "SegmentFilterExpression" = proto.Field(
proto.MESSAGE,
number=2,
message="SegmentFilterExpression",
)
[docs]class SessionSegmentExclusion(proto.Message):
r"""Specifies which sessions are excluded in this segment.
Attributes:
session_exclusion_duration (google.analytics.data_v1alpha.types.SessionExclusionDuration):
Specifies how long an exclusion will last if a session
matches the ``sessionExclusionCriteria``.
Optional. If unspecified, a ``sessionExclusionDuration`` of
``SESSION_EXCLUSION_TEMPORARY`` is used.
session_exclusion_criteria (google.analytics.data_v1alpha.types.SessionSegmentCriteria):
If a session meets this condition, the session is excluded
from membership in the segment for the
``sessionExclusionDuration``.
"""
session_exclusion_duration: "SessionExclusionDuration" = proto.Field(
proto.ENUM,
number=1,
enum="SessionExclusionDuration",
)
session_exclusion_criteria: "SessionSegmentCriteria" = proto.Field(
proto.MESSAGE,
number=2,
message="SessionSegmentCriteria",
)
[docs]class EventSegment(proto.Message):
r"""Event segments are subsets of events that were triggered on your
site or app. for example, all purchase events made in a particular
location; app_exception events that occurred on a specific operating
system.
Attributes:
event_inclusion_criteria (google.analytics.data_v1alpha.types.EventSegmentCriteria):
Defines which events are included in this
segment. Optional.
exclusion (google.analytics.data_v1alpha.types.EventSegmentExclusion):
Defines which events are excluded in this
segment. Optional.
"""
event_inclusion_criteria: "EventSegmentCriteria" = proto.Field(
proto.MESSAGE,
number=1,
message="EventSegmentCriteria",
)
exclusion: "EventSegmentExclusion" = proto.Field(
proto.MESSAGE,
number=2,
message="EventSegmentExclusion",
)
[docs]class EventSegmentCriteria(proto.Message):
r"""An event matches a criteria if the event meet the conditions
in the criteria.
Attributes:
and_condition_groups (MutableSequence[google.analytics.data_v1alpha.types.EventSegmentConditionGroup]):
An event matches this criteria if the event matches each of
these ``andConditionGroups``.
"""
and_condition_groups: MutableSequence[
"EventSegmentConditionGroup"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="EventSegmentConditionGroup",
)
[docs]class EventSegmentConditionGroup(proto.Message):
r"""Conditions tell Analytics what data to include in or exclude
from the segment.
Attributes:
condition_scoping (google.analytics.data_v1alpha.types.EventCriteriaScoping):
``conditionScoping`` should always be
``EVENT_CRITERIA_WITHIN_SAME_EVENT``.
Optional. If unspecified, a ``conditionScoping`` of
``EVENT_CRITERIA_WITHIN_SAME_EVENT`` is used.
segment_filter_expression (google.analytics.data_v1alpha.types.SegmentFilterExpression):
Data is included or excluded from the segment
based on if it matches this expression.
Expressions express criteria on dimension,
metrics, and/or parameters.
"""
condition_scoping: "EventCriteriaScoping" = proto.Field(
proto.ENUM,
number=1,
enum="EventCriteriaScoping",
)
segment_filter_expression: "SegmentFilterExpression" = proto.Field(
proto.MESSAGE,
number=2,
message="SegmentFilterExpression",
)
[docs]class EventSegmentExclusion(proto.Message):
r"""Specifies which events are excluded in this segment.
Attributes:
event_exclusion_duration (google.analytics.data_v1alpha.types.EventExclusionDuration):
``eventExclusionDuration`` should always be
``PERMANENTLY_EXCLUDE``.
Optional. If unspecified, an ``eventExclusionDuration`` of
``EVENT_EXCLUSION_PERMANENT`` is used.
event_exclusion_criteria (google.analytics.data_v1alpha.types.EventSegmentCriteria):
If an event meets this condition, the event is excluded from
membership in the segment for the
``eventExclusionDuration``.
"""
event_exclusion_duration: "EventExclusionDuration" = proto.Field(
proto.ENUM,
number=1,
enum="EventExclusionDuration",
)
event_exclusion_criteria: "EventSegmentCriteria" = proto.Field(
proto.MESSAGE,
number=2,
message="EventSegmentCriteria",
)
[docs]class Segment(proto.Message):
r"""A segment is a subset of your Analytics data. For example, of your
entire set of users, one segment might be users from a particular
country or city. Another segment might be users who purchase a
particular line of products or who visit a specific part of your
site or trigger certain events in your app.
To learn more, see `GA4 Segment
Builder <https://support.google.com/analytics/answer/9304353>`__.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
name (str):
The name for this segment. If unspecified, segments are
named "Segment". This name defines string value returned by
the ``segment`` dimension. The ``segment`` dimension
prefixes segment names by the 1-based index number of the
segment in the request (for example "1. Segment", "2.
Segment", etc.).
user_segment (google.analytics.data_v1alpha.types.UserSegment):
User segments are subsets of users who
engaged with your site or app.
This field is a member of `oneof`_ ``one_segment_scope``.
session_segment (google.analytics.data_v1alpha.types.SessionSegment):
Session segments are subsets of the sessions
that occurred on your site or app.
This field is a member of `oneof`_ ``one_segment_scope``.
event_segment (google.analytics.data_v1alpha.types.EventSegment):
Event segments are subsets of events that
were triggered on your site or app.
This field is a member of `oneof`_ ``one_segment_scope``.
"""
name: str = proto.Field(
proto.STRING,
number=1,
)
user_segment: "UserSegment" = proto.Field(
proto.MESSAGE,
number=2,
oneof="one_segment_scope",
message="UserSegment",
)
session_segment: "SessionSegment" = proto.Field(
proto.MESSAGE,
number=3,
oneof="one_segment_scope",
message="SessionSegment",
)
event_segment: "EventSegment" = proto.Field(
proto.MESSAGE,
number=4,
oneof="one_segment_scope",
message="EventSegment",
)
[docs]class SegmentFilterExpression(proto.Message):
r"""Expresses combinations of segment filters.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
and_group (google.analytics.data_v1alpha.types.SegmentFilterExpressionList):
The SegmentFilterExpression in ``andGroup`` have an AND
relationship.
This field is a member of `oneof`_ ``expr``.
or_group (google.analytics.data_v1alpha.types.SegmentFilterExpressionList):
The SegmentFilterExpression in ``orGroup`` have an OR
relationship.
This field is a member of `oneof`_ ``expr``.
not_expression (google.analytics.data_v1alpha.types.SegmentFilterExpression):
The SegmentFilterExpression is NOT of ``notExpression``.
This field is a member of `oneof`_ ``expr``.
segment_filter (google.analytics.data_v1alpha.types.SegmentFilter):
A primitive segment filter.
This field is a member of `oneof`_ ``expr``.
segment_event_filter (google.analytics.data_v1alpha.types.SegmentEventFilter):
Creates a filter that matches events of a
single event name. If a parameter filter
expression is specified, only the subset of
events that match both the single event name and
the parameter filter expressions match this
event filter.
This field is a member of `oneof`_ ``expr``.
"""
and_group: "SegmentFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=1,
oneof="expr",
message="SegmentFilterExpressionList",
)
or_group: "SegmentFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=2,
oneof="expr",
message="SegmentFilterExpressionList",
)
not_expression: "SegmentFilterExpression" = proto.Field(
proto.MESSAGE,
number=3,
oneof="expr",
message="SegmentFilterExpression",
)
segment_filter: "SegmentFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="expr",
message="SegmentFilter",
)
segment_event_filter: "SegmentEventFilter" = proto.Field(
proto.MESSAGE,
number=5,
oneof="expr",
message="SegmentEventFilter",
)
[docs]class SegmentFilterExpressionList(proto.Message):
r"""A list of segment filter expressions.
Attributes:
expressions (MutableSequence[google.analytics.data_v1alpha.types.SegmentFilterExpression]):
The list of segment filter expressions
"""
expressions: MutableSequence["SegmentFilterExpression"] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="SegmentFilterExpression",
)
[docs]class SegmentFilter(proto.Message):
r"""An expression to filter dimension or metric values.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
field_name (str):
The dimension name or metric name.
string_filter (google.analytics.data_v1alpha.types.StringFilter):
Strings related filter.
This field is a member of `oneof`_ ``one_filter``.
in_list_filter (google.analytics.data_v1alpha.types.InListFilter):
A filter for in list values.
This field is a member of `oneof`_ ``one_filter``.
numeric_filter (google.analytics.data_v1alpha.types.NumericFilter):
A filter for numeric or date values.
This field is a member of `oneof`_ ``one_filter``.
between_filter (google.analytics.data_v1alpha.types.BetweenFilter):
A filter for between two values.
This field is a member of `oneof`_ ``one_filter``.
filter_scoping (google.analytics.data_v1alpha.types.SegmentFilterScoping):
Specifies the scope for the filter.
"""
field_name: str = proto.Field(
proto.STRING,
number=1,
)
string_filter: "StringFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="one_filter",
message="StringFilter",
)
in_list_filter: "InListFilter" = proto.Field(
proto.MESSAGE,
number=5,
oneof="one_filter",
message="InListFilter",
)
numeric_filter: "NumericFilter" = proto.Field(
proto.MESSAGE,
number=6,
oneof="one_filter",
message="NumericFilter",
)
between_filter: "BetweenFilter" = proto.Field(
proto.MESSAGE,
number=7,
oneof="one_filter",
message="BetweenFilter",
)
filter_scoping: "SegmentFilterScoping" = proto.Field(
proto.MESSAGE,
number=8,
message="SegmentFilterScoping",
)
[docs]class SegmentFilterScoping(proto.Message):
r"""Scopings specify how the dimensions & metrics of multiple
events should be considered when evaluating a segment filter.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
at_any_point_in_time (bool):
If ``atAnyPointInTime`` is true, this filter evaluates to
true for all events if it evaluates to true for any event in
the date range of the request.
This ``atAnyPointInTime`` parameter does not extend the date
range of events in the report. If ``atAnyPointInTime`` is
true, only events within the report's date range are
considered when evaluating this filter.
This ``atAnyPointInTime`` is only able to be specified if
the criteria scoping is ``ACROSS_ALL_SESSIONS`` and is not
able to be specified in sequences.
If the criteria scoping is ``ACROSS_ALL_SESSIONS``,
``atAnyPointInTime`` = false is used if unspecified.
This field is a member of `oneof`_ ``_at_any_point_in_time``.
"""
at_any_point_in_time: bool = proto.Field(
proto.BOOL,
number=1,
optional=True,
)
[docs]class SegmentEventFilter(proto.Message):
r"""Creates a filter that matches events of a single event name.
If a parameter filter expression is specified, only the subset
of events that match both the single event name and the
parameter filter expressions match this event filter.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
event_name (str):
This filter matches events of this single
event name. Event name is required.
This field is a member of `oneof`_ ``_event_name``.
segment_parameter_filter_expression (google.analytics.data_v1alpha.types.SegmentParameterFilterExpression):
If specified, this filter matches events that
match both the single event name and the
parameter filter expressions.
Inside the parameter filter expression, only
parameter filters are available.
This field is a member of `oneof`_ ``_segment_parameter_filter_expression``.
"""
event_name: str = proto.Field(
proto.STRING,
number=1,
optional=True,
)
segment_parameter_filter_expression: "SegmentParameterFilterExpression" = (
proto.Field(
proto.MESSAGE,
number=2,
optional=True,
message="SegmentParameterFilterExpression",
)
)
[docs]class SegmentParameterFilterExpression(proto.Message):
r"""Expresses combinations of segment filter on parameters.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
and_group (google.analytics.data_v1alpha.types.SegmentParameterFilterExpressionList):
The SegmentParameterFilterExpression in ``andGroup`` have an
AND relationship.
This field is a member of `oneof`_ ``expr``.
or_group (google.analytics.data_v1alpha.types.SegmentParameterFilterExpressionList):
The SegmentParameterFilterExpression in ``orGroup`` have an
OR relationship.
This field is a member of `oneof`_ ``expr``.
not_expression (google.analytics.data_v1alpha.types.SegmentParameterFilterExpression):
The SegmentParameterFilterExpression is NOT of
``notExpression``.
This field is a member of `oneof`_ ``expr``.
segment_parameter_filter (google.analytics.data_v1alpha.types.SegmentParameterFilter):
A primitive segment parameter filter.
This field is a member of `oneof`_ ``expr``.
"""
and_group: "SegmentParameterFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=1,
oneof="expr",
message="SegmentParameterFilterExpressionList",
)
or_group: "SegmentParameterFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=2,
oneof="expr",
message="SegmentParameterFilterExpressionList",
)
not_expression: "SegmentParameterFilterExpression" = proto.Field(
proto.MESSAGE,
number=3,
oneof="expr",
message="SegmentParameterFilterExpression",
)
segment_parameter_filter: "SegmentParameterFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="expr",
message="SegmentParameterFilter",
)
[docs]class SegmentParameterFilterExpressionList(proto.Message):
r"""A list of segment parameter filter expressions.
Attributes:
expressions (MutableSequence[google.analytics.data_v1alpha.types.SegmentParameterFilterExpression]):
The list of segment parameter filter
expressions.
"""
expressions: MutableSequence[
"SegmentParameterFilterExpression"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="SegmentParameterFilterExpression",
)
[docs]class SegmentParameterFilter(proto.Message):
r"""An expression to filter parameter values in a segment.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
event_parameter_name (str):
This filter will be evaluated on the specified event
parameter. Event parameters are logged as parameters of the
event. Event parameters include fields like
"firebase_screen" & "currency".
Event parameters can only be used in segments & funnels and
can only be used in a descendent filter from an EventFilter.
In a descendent filter from an EventFilter either event or
item parameters should be used.
This field is a member of `oneof`_ ``one_parameter``.
item_parameter_name (str):
This filter will be evaluated on the specified item
parameter. Item parameters are logged as parameters in the
item array. Item parameters include fields like "item_name"
& "item_category".
Item parameters can only be used in segments & funnels and
can only be used in a descendent filter from an EventFilter.
In a descendent filter from an EventFilter either event or
item parameters should be used.
Item parameters are only available in ecommerce events. To
learn more about ecommerce events, see the [Measure
ecommerce]
(https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)
guide.
This field is a member of `oneof`_ ``one_parameter``.
string_filter (google.analytics.data_v1alpha.types.StringFilter):
Strings related filter.
This field is a member of `oneof`_ ``one_filter``.
in_list_filter (google.analytics.data_v1alpha.types.InListFilter):
A filter for in list values.
This field is a member of `oneof`_ ``one_filter``.
numeric_filter (google.analytics.data_v1alpha.types.NumericFilter):
A filter for numeric or date values.
This field is a member of `oneof`_ ``one_filter``.
between_filter (google.analytics.data_v1alpha.types.BetweenFilter):
A filter for between two values.
This field is a member of `oneof`_ ``one_filter``.
filter_scoping (google.analytics.data_v1alpha.types.SegmentParameterFilterScoping):
Specifies the scope for the filter.
"""
event_parameter_name: str = proto.Field(
proto.STRING,
number=1,
oneof="one_parameter",
)
item_parameter_name: str = proto.Field(
proto.STRING,
number=2,
oneof="one_parameter",
)
string_filter: "StringFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="one_filter",
message="StringFilter",
)
in_list_filter: "InListFilter" = proto.Field(
proto.MESSAGE,
number=5,
oneof="one_filter",
message="InListFilter",
)
numeric_filter: "NumericFilter" = proto.Field(
proto.MESSAGE,
number=6,
oneof="one_filter",
message="NumericFilter",
)
between_filter: "BetweenFilter" = proto.Field(
proto.MESSAGE,
number=7,
oneof="one_filter",
message="BetweenFilter",
)
filter_scoping: "SegmentParameterFilterScoping" = proto.Field(
proto.MESSAGE,
number=8,
message="SegmentParameterFilterScoping",
)
[docs]class SegmentParameterFilterScoping(proto.Message):
r"""Scopings specify how multiple events should be considered
when evaluating a segment parameter filter.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
in_any_n_day_period (int):
Accumulates the parameter over the specified period of days
before applying the filter. Only supported if criteria
scoping is ``ACROSS_ALL_SESSIONS`` or
``WITHIN_SAME_SESSION``. Only supported if the parameter is
``event_count``.
For example if ``inAnyNDayPeriod`` is 3, the event_name is
"purchase", the event parameter is "event_count", and the
Filter's criteria is greater than 5, this filter will
accumulate the event count of purchase events over every 3
consecutive day period in the report's date range; a user
will pass this Filter's criteria to be included in this
segment if their count of purchase events exceeds 5 in any 3
consecutive day period. For example, the periods 2021-11-01
to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to
2021-11-05, and etc. will be considered.
The date range is not extended for the purpose of having a
full N day window near the start of the date range. For
example if a report is for 2021-11-01 to 2021-11-10 and
``inAnyNDayPeriod`` = 3, the first two day period will be
effectively shortened because no event data outside the
report's date range will be read. For example, the first
four periods will effectively be: 2021-11-01 to 2021-11-01,
2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and
2021-11-02 to 2021-11-04.
``inAnyNDayPeriod`` is optional. If not specified, the
``segmentParameterFilter`` is applied to each event
individually.
This field is a member of `oneof`_ ``_in_any_n_day_period``.
"""
in_any_n_day_period: int = proto.Field(
proto.INT64,
number=1,
optional=True,
)
[docs]class FunnelFilterExpression(proto.Message):
r"""Expresses combinations of funnel filters.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
and_group (google.analytics.data_v1alpha.types.FunnelFilterExpressionList):
The FunnelFilterExpression in ``andGroup`` have an AND
relationship.
This field is a member of `oneof`_ ``expr``.
or_group (google.analytics.data_v1alpha.types.FunnelFilterExpressionList):
The FunnelFilterExpression in ``orGroup`` have an OR
relationship.
This field is a member of `oneof`_ ``expr``.
not_expression (google.analytics.data_v1alpha.types.FunnelFilterExpression):
The FunnelFilterExpression is NOT of ``notExpression``.
This field is a member of `oneof`_ ``expr``.
funnel_field_filter (google.analytics.data_v1alpha.types.FunnelFieldFilter):
A funnel filter for a dimension or metric.
This field is a member of `oneof`_ ``expr``.
funnel_event_filter (google.analytics.data_v1alpha.types.FunnelEventFilter):
Creates a filter that matches events of a
single event name. If a parameter filter
expression is specified, only the subset of
events that match both the single event name and
the parameter filter expressions match this
event filter.
This field is a member of `oneof`_ ``expr``.
"""
and_group: "FunnelFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=1,
oneof="expr",
message="FunnelFilterExpressionList",
)
or_group: "FunnelFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=2,
oneof="expr",
message="FunnelFilterExpressionList",
)
not_expression: "FunnelFilterExpression" = proto.Field(
proto.MESSAGE,
number=3,
oneof="expr",
message="FunnelFilterExpression",
)
funnel_field_filter: "FunnelFieldFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="expr",
message="FunnelFieldFilter",
)
funnel_event_filter: "FunnelEventFilter" = proto.Field(
proto.MESSAGE,
number=5,
oneof="expr",
message="FunnelEventFilter",
)
[docs]class FunnelFilterExpressionList(proto.Message):
r"""A list of funnel filter expressions.
Attributes:
expressions (MutableSequence[google.analytics.data_v1alpha.types.FunnelFilterExpression]):
The list of funnel filter expressions.
"""
expressions: MutableSequence["FunnelFilterExpression"] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="FunnelFilterExpression",
)
[docs]class FunnelFieldFilter(proto.Message):
r"""An expression to filter dimension or metric values.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
field_name (str):
The dimension name or metric name.
string_filter (google.analytics.data_v1alpha.types.StringFilter):
Strings related filter.
This field is a member of `oneof`_ ``one_filter``.
in_list_filter (google.analytics.data_v1alpha.types.InListFilter):
A filter for in list values.
This field is a member of `oneof`_ ``one_filter``.
numeric_filter (google.analytics.data_v1alpha.types.NumericFilter):
A filter for numeric or date values.
This field is a member of `oneof`_ ``one_filter``.
between_filter (google.analytics.data_v1alpha.types.BetweenFilter):
A filter for between two values.
This field is a member of `oneof`_ ``one_filter``.
"""
field_name: str = proto.Field(
proto.STRING,
number=1,
)
string_filter: "StringFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="one_filter",
message="StringFilter",
)
in_list_filter: "InListFilter" = proto.Field(
proto.MESSAGE,
number=5,
oneof="one_filter",
message="InListFilter",
)
numeric_filter: "NumericFilter" = proto.Field(
proto.MESSAGE,
number=6,
oneof="one_filter",
message="NumericFilter",
)
between_filter: "BetweenFilter" = proto.Field(
proto.MESSAGE,
number=7,
oneof="one_filter",
message="BetweenFilter",
)
[docs]class FunnelEventFilter(proto.Message):
r"""Creates a filter that matches events of a single event name.
If a parameter filter expression is specified, only the subset
of events that match both the single event name and the
parameter filter expressions match this event filter.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
event_name (str):
This filter matches events of this single
event name. Event name is required.
This field is a member of `oneof`_ ``_event_name``.
funnel_parameter_filter_expression (google.analytics.data_v1alpha.types.FunnelParameterFilterExpression):
If specified, this filter matches events that
match both the single event name and the
parameter filter expressions.
Inside the parameter filter expression, only
parameter filters are available.
This field is a member of `oneof`_ ``_funnel_parameter_filter_expression``.
"""
event_name: str = proto.Field(
proto.STRING,
number=1,
optional=True,
)
funnel_parameter_filter_expression: "FunnelParameterFilterExpression" = proto.Field(
proto.MESSAGE,
number=2,
optional=True,
message="FunnelParameterFilterExpression",
)
[docs]class FunnelParameterFilterExpression(proto.Message):
r"""Expresses combinations of funnel filters on parameters.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
and_group (google.analytics.data_v1alpha.types.FunnelParameterFilterExpressionList):
The FunnelParameterFilterExpression in ``andGroup`` have an
AND relationship.
This field is a member of `oneof`_ ``expr``.
or_group (google.analytics.data_v1alpha.types.FunnelParameterFilterExpressionList):
The FunnelParameterFilterExpression in ``orGroup`` have an
OR relationship.
This field is a member of `oneof`_ ``expr``.
not_expression (google.analytics.data_v1alpha.types.FunnelParameterFilterExpression):
The FunnelParameterFilterExpression is NOT of
``notExpression``.
This field is a member of `oneof`_ ``expr``.
funnel_parameter_filter (google.analytics.data_v1alpha.types.FunnelParameterFilter):
A primitive funnel parameter filter.
This field is a member of `oneof`_ ``expr``.
"""
and_group: "FunnelParameterFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=1,
oneof="expr",
message="FunnelParameterFilterExpressionList",
)
or_group: "FunnelParameterFilterExpressionList" = proto.Field(
proto.MESSAGE,
number=2,
oneof="expr",
message="FunnelParameterFilterExpressionList",
)
not_expression: "FunnelParameterFilterExpression" = proto.Field(
proto.MESSAGE,
number=3,
oneof="expr",
message="FunnelParameterFilterExpression",
)
funnel_parameter_filter: "FunnelParameterFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="expr",
message="FunnelParameterFilter",
)
[docs]class FunnelParameterFilterExpressionList(proto.Message):
r"""A list of funnel parameter filter expressions.
Attributes:
expressions (MutableSequence[google.analytics.data_v1alpha.types.FunnelParameterFilterExpression]):
The list of funnel parameter filter
expressions.
"""
expressions: MutableSequence[
"FunnelParameterFilterExpression"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="FunnelParameterFilterExpression",
)
[docs]class FunnelParameterFilter(proto.Message):
r"""An expression to filter parameter values in a funnel.
This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
event_parameter_name (str):
This filter will be evaluated on the specified event
parameter. Event parameters are logged as parameters of the
event. Event parameters include fields like
"firebase_screen" & "currency".
Event parameters can only be used in segments & funnels and
can only be used in a descendent filter from an EventFilter.
In a descendent filter from an EventFilter either event or
item parameters should be used.
This field is a member of `oneof`_ ``one_parameter``.
item_parameter_name (str):
This filter will be evaluated on the specified item
parameter. Item parameters are logged as parameters in the
item array. Item parameters include fields like "item_name"
& "item_category".
Item parameters can only be used in segments & funnels and
can only be used in a descendent filter from an EventFilter.
In a descendent filter from an EventFilter either event or
item parameters should be used.
Item parameters are only available in ecommerce events. To
learn more about ecommerce events, see the [Measure
ecommerce]
(https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)
guide.
This field is a member of `oneof`_ ``one_parameter``.
string_filter (google.analytics.data_v1alpha.types.StringFilter):
Strings related filter.
This field is a member of `oneof`_ ``one_filter``.
in_list_filter (google.analytics.data_v1alpha.types.InListFilter):
A filter for in list values.
This field is a member of `oneof`_ ``one_filter``.
numeric_filter (google.analytics.data_v1alpha.types.NumericFilter):
A filter for numeric or date values.
This field is a member of `oneof`_ ``one_filter``.
between_filter (google.analytics.data_v1alpha.types.BetweenFilter):
A filter for between two values.
This field is a member of `oneof`_ ``one_filter``.
"""
event_parameter_name: str = proto.Field(
proto.STRING,
number=1,
oneof="one_parameter",
)
item_parameter_name: str = proto.Field(
proto.STRING,
number=2,
oneof="one_parameter",
)
string_filter: "StringFilter" = proto.Field(
proto.MESSAGE,
number=4,
oneof="one_filter",
message="StringFilter",
)
in_list_filter: "InListFilter" = proto.Field(
proto.MESSAGE,
number=5,
oneof="one_filter",
message="InListFilter",
)
numeric_filter: "NumericFilter" = proto.Field(
proto.MESSAGE,
number=6,
oneof="one_filter",
message="NumericFilter",
)
between_filter: "BetweenFilter" = proto.Field(
proto.MESSAGE,
number=7,
oneof="one_filter",
message="BetweenFilter",
)
[docs]class FunnelResponseMetadata(proto.Message):
r"""The funnel report's response metadata carries additional
information about the funnel report.
Attributes:
sampling_metadatas (MutableSequence[google.analytics.data_v1alpha.types.SamplingMetadata]):
If funnel report results are
`sampled <https://support.google.com/analytics/answer/13331292>`__,
this describes what percentage of events were used in this
funnel report. One ``samplingMetadatas`` is populated for
each date range. Each ``samplingMetadatas`` corresponds to a
date range in order that date ranges were specified in the
request.
However if the results are not sampled, this field will not
be defined.
"""
sampling_metadatas: MutableSequence["SamplingMetadata"] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="SamplingMetadata",
)
[docs]class SamplingMetadata(proto.Message):
r"""If funnel report results are
`sampled <https://support.google.com/analytics/answer/13331292>`__,
this metadata describes what percentage of events were used in this
funnel report for a date range. Sampling is the practice of
analyzing a subset of all data in order to uncover the meaningful
information in the larger data set.
Attributes:
samples_read_count (int):
The total number of events read in this
sampled report for a date range. This is the
size of the subset this property's data that was
analyzed in this funnel report.
sampling_space_size (int):
The total number of events present in this property's data
that could have been analyzed in this funnel report for a
date range. Sampling uncovers the meaningful information
about the larger data set, and this is the size of the
larger data set.
To calculate the percentage of available data that was used
in this funnel report, compute
``samplesReadCount/samplingSpaceSize``.
"""
samples_read_count: int = proto.Field(
proto.INT64,
number=1,
)
sampling_space_size: int = proto.Field(
proto.INT64,
number=2,
)
__all__ = tuple(sorted(__protobuf__.manifest))
