8000 docs: Add documentation for enums (#331) · googleapis/python-analytics-data@1154bd3 · 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 1154bd3

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Add documentation for enums (#331)
* docs: Add documentation for enums fix: Add context manager return types chore: Update gapic-generator-python to v1.8.1 PiperOrigin-RevId: 503210727 Source-Link: googleapis/googleapis@a391fd1 Source-Link: https://github.com/googleapis/googleapis-gen/commit/0080f830dec37c3384157082bce279e37079ea58 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 589a5c5 commit 1154bd3

File tree

7 files changed

+315
-14
lines changed

7 files changed

+315
-14
lines changed

‎google/analytics/data_v1alpha/services/alpha_analytics_data/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ def sample_run_funnel_report():
514514
# Done; return the response.
515515
return response
516516

517-
def __enter__(self):
517+
def __enter__(self) -> "AlphaAnalyticsDataClient":
518518
return self
519519

520520
def __exit__(self, type, value, traceback):

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,18 @@ class RunFunnelReportRequest(proto.Message):
107107
class FunnelVisualizationType(proto.Enum):
108108
r"""Controls the dimensions present in the funnel visualization
109109
sub report response.
110+
111+
Values:
112+
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED (0):
113+
Unspecified type.
114+
STANDARD_FUNNEL (1):
115+
A standard (stepped) funnel. The funnel
116+
visualization sub report in the response will
117+
not contain date.
118+
TRENDED_FUNNEL (2):
119 8000 +
A trended (line chart) funnel. The funnel
120+
visualization sub report in the response will
121+
contain the date dimension.
110122
"""
111123
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED = 0
112124
STANDARD_FUNNEL = 1

‎google/analytics/data_v1alpha/types/data.py

Lines changed: 137 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,19 @@
9191
class UserCriteriaScoping(proto.Enum):
9292
r"""Scoping specifies which events are considered when evaluating
9393
if a user meets a criteria.
94+
95+
Values:
96+
USER_CRITERIA_SCOPING_UNSPECIFIED (0):
97+
Unspecified criteria scoping. Do not specify.
98+
USER_CRITERIA_WITHIN_SAME_EVENT (1):
99+
If the criteria is satisfied within one
100+
event, the user matches the criteria.
101+
USER_CRITERIA_WITHIN_SAME_SESSION (2):
102+
If the criteria is satisfied within one
103+
session, the user matches the criteria.
104+
USER_CRITERIA_ACROSS_ALL_SESSIONS (3):
105+
If the criteria is satisfied by any events
106+
for the user, the user matches the criteria.
94107
"""
95108
USER_CRITERIA_SCOPING_UNSPECIFIED = 0
96109
USER_CRITERIA_WITHIN_SAME_EVENT = 1
@@ -101,6 +114,17 @@ class UserCriteriaScoping(proto.Enum):
101114
class UserExclusionDuration(proto.Enum):
102115
r"""Enumerates options for how long an exclusion will last if a user
103116
matches the ``userExclusionCriteria``.
117+
118+
Values:
119+
USER_EXCLUSION_DURATION_UNSPECIFIED (0):
120+
Unspecified exclusion duration. Do not
121+
specify.
122+
USER_EXCLUSION_TEMPORARY (1):
123+
Temporarily exclude users from the segment during periods
124+
when the user meets the ``userExclusionCriteria`` condition.
125+
USER_EXCLUSION_PERMANENT (2):
126+
Permanently exclude users from the segment if the user ever
127+
meets the ``userExclusionCriteria`` condition.
104128
"""
105129
USER_EXCLUSION_DURATION_UNSPECIFIED = 0
106130
USER_EXCLUSION_TEMPORARY = 1
@@ -110,6 +134,16 @@ class UserExclusionDuration(proto.Enum):
110134
class SessionCriteriaScoping(proto.Enum):
111135
r"""Scoping specifies which events are considered when evaluating
112136
if a session meets a criteria.
137+
138+
Values:
139+
SESSION_CRITERIA_SCOPING_UNSPECIFIED (0):
140+
Unspecified criteria scoping. Do not specify.
141+
SESSION_CRITERIA_WITHIN_SAME_EVENT (1):
142+
If the criteria is satisfied within one
143+
event, the session matches the criteria.
144+
SESSION_CRITERIA_WITHIN_SAME_SESSION (2):
145+
If the criteria is satisfied within one
146+
session, the session matches the criteria.
113147
"""
114148
SESSION_CRITERIA_SCOPING_UNSPECIFIED = 0
115149
SESSION_CRITERIA_WITHIN_SAME_EVENT = 1
@@ -119,6 +153,18 @@ class SessionCriteriaScoping(proto.Enum):
119153
class SessionExclusionDuration(proto.Enum):
120154
r"""Enumerates options for how long an exclusion will last if a session
121155
matches the ``sessionExclusionCriteria``.
156+
157+
Values:
158+
SESSION_EXCLUSION_DURATION_UNSPECIFIED (0):
159+
Unspecified exclusion duration. Do not
160+
specify.
161+
SESSION_EXCLUSION_TEMPORARY (1):
162+
Temporarily exclude sessions from the segment during periods
163+
when the session meets the ``sessionExclusionCriteria``
164+
condition.
165+
SESSION_EXCLUSION_PERMANENT (2):
166+
Permanently exclude sessions from the segment if the session
167+
ever meets the ``sessionExclusionCriteria`` condition.
122168
"""
123169
SESSION_EXCLUSION_DURATION_UNSPECIFIED = 0
124170
SESSION_EXCLUSION_TEMPORARY = 1
@@ -128,6 +174,13 @@ class SessionExclusionDuration(proto.Enum):
128174
class EventCriteriaScoping(proto.Enum):
129175
r"""Scoping specifies which events are considered when evaluating
130176
if an event meets a criteria.
177+
178+
Values:
179+
EVENT_CRITERIA_SCOPING_UNSPECIFIED (0):
180+
Unspecified criteria scoping. Do not specify.
181+
EVENT_CRITERIA_WITHIN_SAME_EVENT (1):
182+
If the criteria is satisfied within one
183+
event, the event matches the criteria.
131184
"""
132185
EVENT_CRITERIA_SCOPING_UNSPECIFIED = 0
133186
EVENT_CRITERIA_WITHIN_SAME_EVENT = 1
@@ -136,13 +189,60 @@ class EventCriteriaScoping(proto.Enum):
136189
class EventExclusionDuration(proto.Enum):
137190
r"""Enumerates options for how long an exclusion will last if an event
138191
matches the ``eventExclusionCriteria``.
192+
193+
Values:
194+
EVENT_EXCLUSION_DURATION_UNSPECIFIED (0):
195+
Unspecified exclusion duration. Do not
196+
specify.
197+
EVENT_EXCLUSION_PERMANENT (1):
198+
Permanently exclude events from the segment if the event
199+
ever meets the ``eventExclusionCriteria`` condition.
139200
"""
140201
EVENT_EXCLUSION_DURATION_UNSPECIFIED = 0
141202
EVENT_EXCLUSION_PERMANENT = 1
142203

143204

144205
class MetricType(proto.Enum):
145-
r"""A metric's value type."""
206+
r"""A metric's value type.
207+
208+
Values:
209+
METRIC_TYPE_UNSPECIFIED (0):
210+
Unspecified type.
211+
TYPE_INTEGER (1):
212+
Integer type.
213+
TYPE_FLOAT (2):
214+
Floating point type.
215+
TYPE_SECONDS (4):
216+
A duration of seconds; a special floating
217+
point type.
218+
TYPE_MILLISECONDS (5):
219+
A duration in milliseconds; a special
220+
floating point type.
221+
TYPE_MINUTES (6):
222+
A duration in minutes; a special floating
223+
point type.
224+
TYPE_HOURS (7):
225+
A duration in hours; a special floating point
226+
type.
227+
TYPE_STANDARD (8):
228+
A custom metric of standard type; a special
229+
floating point type.
230+
TYPE_CURRENCY (9):
231+
An amount of money; a special floating point
232+
type.
233+
TYPE_FEET (10):
234+
A length in feet; a special floating point
235+
type.
236+
TYPE_MILES (11):
237+
A length in miles; a special floating point
238+
type.
239+
TYPE_METERS (12):
240+
A length in meters; a special floating point
241+
type.
242+
TYPE_KILOMETERS (13):
243+
A length in kilometers; a special floating
244+
point type.
245+
"""
146246
METRIC_TYPE_UNSPECIFIED = 0
147247
TYPE_INTEGER = 1
148248
TYPE_FLOAT = 2
@@ -482,7 +582,26 @@ class StringFilter(proto.Message):
482582
"""
483583

484584
class MatchType(proto.Enum):
485-
r"""The match type of a string filter"""
585+
r"""The match type of a string filter
586+
587+
Values:
588+
MATCH_TYPE_UNSPECIFIED (0):
589+
Unspecified
590+
EXACT (1):
591+
Exact match of the string value.
592+
BEGINS_WITH (2):
593+
Begins with the string value.
594+
ENDS_WITH (3):
595+
Ends with the string value.
596+
CONTAINS (4):
597+
Contains the string value.
598+
FULL_REGEXP (5):
599+
Full match for the regular expression with
600+
the string value.
601+
PARTIAL_REGEXP (6):
602+
Partial match for the regular expression with
603+
the string value.
604+
"""
486605
MATCH_TYPE_UNSPECIFIED = 0
487606
EXACT = 1
488607
BEGINS_WITH = 2
@@ -538,7 +657,22 @@ class NumericFilter(proto.Message):
538657
"""
539658

540659
class Operation(proto.Enum):
541-
r"""The operation applied to a numeric filter"""
660+
r"""The operation applied to a numeric filter
661+
662+
Values:
663+
OPERATION_UNSPECIFIED (0):
664+
Unspecified.
665+
EQUAL (1):
666+
Equal
667+
LESS_THAN (2):
668+
Less than
669+
LESS_THAN_OR_EQUAL (3):
670+
Less than or equal
671+
GREATER_THAN (4):
672+
Greater than
673+
GREATER_THAN_OR_EQUAL (5):
674+
Greater than or equal
675+
"""
542676
OPERATION_UNSPECIFIED = 0
543677
EQUAL = 1
544678
LESS_THAN = 2

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1086,7 +1086,7 @@ def sample_check_compatibility():
10861086
# Done; return the response.
10871087
return response
10881088

1089-
def __enter__(self):
1089+
def __enter__(self) -> "BetaAnalyticsDataClient":
10901090
return self
10911091

10921092
def __exit__(self, type, value, traceback):

0 commit comments

Comments
 (0)
0