google-analytics-admin 0.23.6__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- google/analytics/admin/__init__.py +615 -0
- google/analytics/admin/gapic_version.py +16 -0
- google/analytics/admin/py.typed +2 -0
- google/analytics/admin_v1alpha/__init__.py +613 -0
- google/analytics/admin_v1alpha/gapic_metadata.json +2278 -0
- google/analytics/admin_v1alpha/gapic_version.py +16 -0
- google/analytics/admin_v1alpha/py.typed +2 -0
- google/analytics/admin_v1alpha/services/__init__.py +15 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/__init__.py +22 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py +14122 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/client.py +14680 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/pagers.py +4337 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/transports/__init__.py +41 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/transports/base.py +2494 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py +4797 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py +5671 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py +31875 -0
- google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest_base.py +7944 -0
- google/analytics/admin_v1alpha/types/__init__.py +602 -0
- google/analytics/admin_v1alpha/types/access_report.py +705 -0
- google/analytics/admin_v1alpha/types/analytics_admin.py +4997 -0
- google/analytics/admin_v1alpha/types/audience.py +781 -0
- google/analytics/admin_v1alpha/types/channel_group.py +309 -0
- google/analytics/admin_v1alpha/types/event_create_and_edit.py +298 -0
- google/analytics/admin_v1alpha/types/expanded_data_set.py +282 -0
- google/analytics/admin_v1alpha/types/resources.py +3289 -0
- google/analytics/admin_v1alpha/types/subproperty_event_filter.py +292 -0
- google/analytics/admin_v1beta/__init__.py +255 -0
- google/analytics/admin_v1beta/gapic_metadata.json +838 -0
- google/analytics/admin_v1beta/gapic_version.py +16 -0
- google/analytics/admin_v1beta/py.typed +2 -0
- google/analytics/admin_v1beta/services/__init__.py +15 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/__init__.py +22 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/async_client.py +6707 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/client.py +7164 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/pagers.py +1927 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/transports/__init__.py +41 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/transports/base.py +965 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc.py +1917 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc_asyncio.py +2251 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/transports/rest.py +11423 -0
- google/analytics/admin_v1beta/services/analytics_admin_service/transports/rest_base.py +2857 -0
- google/analytics/admin_v1beta/types/__init__.py +244 -0
- google/analytics/admin_v1beta/types/access_report.py +705 -0
- google/analytics/admin_v1beta/types/analytics_admin.py +2006 -0
- google/analytics/admin_v1beta/types/resources.py +1677 -0
- google_analytics_admin-0.23.6.dist-info/LICENSE +202 -0
- google_analytics_admin-0.23.6.dist-info/METADATA +228 -0
- google_analytics_admin-0.23.6.dist-info/RECORD +51 -0
- google_analytics_admin-0.23.6.dist-info/WHEEL +5 -0
- google_analytics_admin-0.23.6.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,2006 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
# Copyright 2024 Google LLC
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
# See the License for the specific language governing permissions and
|
|
14
|
+
# limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
from __future__ import annotations
|
|
17
|
+
|
|
18
|
+
from typing import MutableMapping, MutableSequence
|
|
19
|
+
|
|
20
|
+
from google.protobuf import field_mask_pb2 # type: ignore
|
|
21
|
+
from google.protobuf import timestamp_pb2 # type: ignore
|
|
22
|
+
import proto # type: ignore
|
|
23
|
+
|
|
24
|
+
from google.analytics.admin_v1beta.types import access_report, resources
|
|
25
|
+
|
|
26
|
+
__protobuf__ = proto.module(
|
|
27
|
+
package="google.analytics.admin.v1beta",
|
|
28
|
+
manifest={
|
|
29
|
+
"RunAccessReportRequest",
|
|
30
|
+
"RunAccessReportResponse",
|
|
31
|
+
"GetAccountRequest",
|
|
32
|
+
"ListAccountsRequest",
|
|
33
|
+
"ListAccountsResponse",
|
|
34
|
+
"DeleteAccountRequest",
|
|
35
|
+
"UpdateAccountRequest",
|
|
36
|
+
"ProvisionAccountTicketRequest",
|
|
37
|
+
"ProvisionAccountTicketResponse",
|
|
38
|
+
"GetPropertyRequest",
|
|
39
|
+
"ListPropertiesRequest",
|
|
40
|
+
"ListPropertiesResponse",
|
|
41
|
+
"UpdatePropertyRequest",
|
|
42
|
+
"CreatePropertyRequest",
|
|
43
|
+
"DeletePropertyRequest",
|
|
44
|
+
"CreateFirebaseLinkRequest",
|
|
45
|
+
"DeleteFirebaseLinkRequest",
|
|
46
|
+
"ListFirebaseLinksRequest",
|
|
47
|
+
"ListFirebaseLinksResponse",
|
|
48
|
+
"CreateGoogleAdsLinkRequest",
|
|
49
|
+
"UpdateGoogleAdsLinkRequest",
|
|
50
|
+
"DeleteGoogleAdsLinkRequest",
|
|
51
|
+
"ListGoogleAdsLinksRequest",
|
|
52
|
+
"ListGoogleAdsLinksResponse",
|
|
53
|
+
"GetDataSharingSettingsRequest",
|
|
54
|
+
"ListAccountSummariesRequest",
|
|
55
|
+
"ListAccountSummariesResponse",
|
|
56
|
+
"AcknowledgeUserDataCollectionRequest",
|
|
57
|
+
"AcknowledgeUserDataCollectionResponse",
|
|
58
|
+
"SearchChangeHistoryEventsRequest",
|
|
59
|
+
"SearchChangeHistoryEventsResponse",
|
|
60
|
+
"GetMeasurementProtocolSecretRequest",
|
|
61
|
+
"CreateMeasurementProtocolSecretRequest",
|
|
62
|
+
"DeleteMeasurementProtocolSecretRequest",
|
|
63
|
+
"UpdateMeasurementProtocolSecretRequest",
|
|
64
|
+
"ListMeasurementProtocolSecretsRequest",
|
|
65
|
+
"ListMeasurementProtocolSecretsResponse",
|
|
66
|
+
"CreateConversionEventRequest",
|
|
67
|
+
"UpdateConversionEventRequest",
|
|
68
|
+
"GetConversionEventRequest",
|
|
69
|
+
"DeleteConversionEventRequest",
|
|
70
|
+
"ListConversionEventsRequest",
|
|
71
|
+
"ListConversionEventsResponse",
|
|
72
|
+
"CreateKeyEventRequest",
|
|
73
|
+
"UpdateKeyEventRequest",
|
|
74
|
+
"GetKeyEventRequest",
|
|
75
|
+
"DeleteKeyEventRequest",
|
|
76
|
+
"ListKeyEventsRequest",
|
|
77
|
+
"ListKeyEventsResponse",
|
|
78
|
+
"CreateCustomDimensionRequest",
|
|
79
|
+
"UpdateCustomDimensionRequest",
|
|
80
|
+
"ListCustomDimensionsRequest",
|
|
81
|
+
"ListCustomDimensionsResponse",
|
|
82
|
+
"ArchiveCustomDimensionRequest",
|
|
83
|
+
"GetCustomDimensionRequest",
|
|
84
|
+
"CreateCustomMetricRequest",
|
|
85
|
+
"UpdateCustomMetricRequest",
|
|
86
|
+
"ListCustomMetricsRequest",
|
|
87
|
+
"ListCustomMetricsResponse",
|
|
88
|
+
"ArchiveCustomMetricRequest",
|
|
89
|
+
"GetCustomMetricRequest",
|
|
90
|
+
"GetDataRetentionSettingsRequest",
|
|
91
|
+
"UpdateDataRetentionSettingsRequest",
|
|
92
|
+
"CreateDataStreamRequest",
|
|
93
|
+
"DeleteDataStreamRequest",
|
|
94
|
+
"UpdateDataStreamRequest",
|
|
95
|
+
"ListDataStreamsRequest",
|
|
96
|
+
"ListDataStreamsResponse",
|
|
97
|
+
"GetDataStreamRequest",
|
|
98
|
+
},
|
|
99
|
+
)
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
class RunAccessReportRequest(proto.Message):
|
|
103
|
+
r"""The request for a Data Access Record Report.
|
|
104
|
+
|
|
105
|
+
Attributes:
|
|
106
|
+
entity (str):
|
|
107
|
+
The Data Access Report supports requesting at
|
|
108
|
+
the property level or account level. If
|
|
109
|
+
requested at the account level, Data Access
|
|
110
|
+
Reports include all access for all properties
|
|
111
|
+
under that account.
|
|
112
|
+
|
|
113
|
+
To request at the property level, entity should
|
|
114
|
+
be for example 'properties/123' if "123" is your
|
|
115
|
+
Google Analytics property ID. To request at the
|
|
116
|
+
account level, entity should be for example
|
|
117
|
+
'accounts/1234' if "1234" is your Google
|
|
118
|
+
Analytics Account ID.
|
|
119
|
+
dimensions (MutableSequence[google.analytics.admin_v1beta.types.AccessDimension]):
|
|
120
|
+
The dimensions requested and displayed in the
|
|
121
|
+
response. Requests are allowed up to 9
|
|
122
|
+
dimensions.
|
|
123
|
+
metrics (MutableSequence[google.analytics.admin_v1beta.types.AccessMetric]):
|
|
124
|
+
The metrics requested and displayed in the
|
|
125
|
+
response. Requests are allowed up to 10 metrics.
|
|
126
|
+
date_ranges (MutableSequence[google.analytics.admin_v1beta.types.AccessDateRange]):
|
|
127
|
+
Date ranges of access records to read. If
|
|
128
|
+
multiple date ranges are requested, each
|
|
129
|
+
response row will contain a zero based date
|
|
130
|
+
range index. If two date ranges overlap, the
|
|
131
|
+
access records for the overlapping days is
|
|
132
|
+
included in the response rows for both date
|
|
133
|
+
ranges. Requests are allowed up to 2 date
|
|
134
|
+
ranges.
|
|
135
|
+
dimension_filter (google.analytics.admin_v1beta.types.AccessFilterExpression):
|
|
136
|
+
Dimension filters let you restrict report response to
|
|
137
|
+
specific dimension values which match the filter. For
|
|
138
|
+
example, filtering on access records of a single user. To
|
|
139
|
+
learn more, see `Fundamentals of Dimension
|
|
140
|
+
Filters <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters>`__
|
|
141
|
+
for examples. Metrics cannot be used in this filter.
|
|
142
|
+
metric_filter (google.analytics.admin_v1beta.types.AccessFilterExpression):
|
|
143
|
+
Metric filters allow you to restrict report
|
|
144
|
+
response to specific metric values which match
|
|
145
|
+
the filter. Metric filters are applied after
|
|
146
|
+
aggregating the report's rows, similar to SQL
|
|
147
|
+
having-clause. Dimensions cannot be used in this
|
|
148
|
+
filter.
|
|
149
|
+
offset (int):
|
|
150
|
+
The row count of the start row. The first row is counted as
|
|
151
|
+
row 0. If offset is unspecified, it is treated as 0. If
|
|
152
|
+
offset is zero, then this method will return the first page
|
|
153
|
+
of results with ``limit`` entries.
|
|
154
|
+
|
|
155
|
+
To learn more about this pagination parameter, see
|
|
156
|
+
`Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
|
|
157
|
+
limit (int):
|
|
158
|
+
The number of rows to return. If unspecified, 10,000 rows
|
|
159
|
+
are returned. The API returns a maximum of 100,000 rows per
|
|
160
|
+
request, no matter how many you ask for. ``limit`` must be
|
|
161
|
+
positive.
|
|
162
|
+
|
|
163
|
+
The API may return fewer rows than the requested ``limit``,
|
|
164
|
+
if there aren't as many remaining rows as the ``limit``. For
|
|
165
|
+
instance, there are fewer than 300 possible values for the
|
|
166
|
+
dimension ``country``, so when reporting on only
|
|
167
|
+
``country``, you can't get more than 300 rows, even if you
|
|
168
|
+
set ``limit`` to a higher value.
|
|
169
|
+
|
|
170
|
+
To learn more about this pagination parameter, see
|
|
171
|
+
`Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
|
|
172
|
+
time_zone (str):
|
|
173
|
+
This request's time zone if specified. If unspecified, the
|
|
174
|
+
property's time zone is used. The request's time zone is
|
|
175
|
+
used to interpret the start & end dates of the report.
|
|
176
|
+
|
|
177
|
+
Formatted as strings from the IANA Time Zone database
|
|
178
|
+
(https://www.iana.org/time-zones); for example
|
|
179
|
+
"America/New_York" or "Asia/Tokyo".
|
|
180
|
+
order_bys (MutableSequence[google.analytics.admin_v1beta.types.AccessOrderBy]):
|
|
181
|
+
Specifies how rows are ordered in the
|
|
182
|
+
response.
|
|
183
|
+
return_entity_quota (bool):
|
|
184
|
+
Toggles whether to return the current state of this
|
|
185
|
+
Analytics Property's quota. Quota is returned in
|
|
186
|
+
`AccessQuota <#AccessQuota>`__. For account-level requests,
|
|
187
|
+
this field must be false.
|
|
188
|
+
include_all_users (bool):
|
|
189
|
+
Optional. Determines whether to include users
|
|
190
|
+
who have never made an API call in the response.
|
|
191
|
+
If true, all users with access to the specified
|
|
192
|
+
property or account are included in the
|
|
193
|
+
response, regardless of whether they have made
|
|
194
|
+
an API call or not. If false, only the users who
|
|
195
|
+
have made an API call will be included.
|
|
196
|
+
expand_groups (bool):
|
|
197
|
+
Optional. Decides whether to return the users within user
|
|
198
|
+
groups. This field works only when include_all_users is set
|
|
199
|
+
to true. If true, it will return all users with access to
|
|
200
|
+
the specified property or account. If false, only the users
|
|
201
|
+
with direct access will be returned.
|
|
202
|
+
"""
|
|
203
|
+
|
|
204
|
+
entity: str = proto.Field(
|
|
205
|
+
proto.STRING,
|
|
206
|
+
number=1,
|
|
207
|
+
)
|
|
208
|
+
dimensions: MutableSequence[access_report.AccessDimension] = proto.RepeatedField(
|
|
209
|
+
proto.MESSAGE,
|
|
210
|
+
number=2,
|
|
211
|
+
message=access_report.AccessDimension,
|
|
212
|
+
)
|
|
213
|
+
metrics: MutableSequence[access_report.AccessMetric] = proto.RepeatedField(
|
|
214
|
+
proto.MESSAGE,
|
|
215
|
+
number=3,
|
|
216
|
+
message=access_report.AccessMetric,
|
|
217
|
+
)
|
|
218
|
+
date_ranges: MutableSequence[access_report.AccessDateRange] = proto.RepeatedField(
|
|
219
|
+
proto.MESSAGE,
|
|
220
|
+
number=4,
|
|
221
|
+
message=access_report.AccessDateRange,
|
|
222
|
+
)
|
|
223
|
+
dimension_filter: access_report.AccessFilterExpression = proto.Field(
|
|
224
|
+
proto.MESSAGE,
|
|
225
|
+
number=5,
|
|
226
|
+
message=access_report.AccessFilterExpression,
|
|
227
|
+
)
|
|
228
|
+
metric_filter: access_report.AccessFilterExpression = proto.Field(
|
|
229
|
+
proto.MESSAGE,
|
|
230
|
+
number=6,
|
|
231
|
+
message=access_report.AccessFilterExpression,
|
|
232
|
+
)
|
|
233
|
+
offset: int = proto.Field(
|
|
234
|
+
proto.INT64,
|
|
235
|
+
number=7,
|
|
236
|
+
)
|
|
237
|
+
limit: int = proto.Field(
|
|
238
|
+
proto.INT64,
|
|
239
|
+
number=8,
|
|
240
|
+
)
|
|
241
|
+
time_zone: str = proto.Field(
|
|
242
|
+
proto.STRING,
|
|
243
|
+
number=9,
|
|
244
|
+
)
|
|
245
|
+
order_bys: MutableSequence[access_report.AccessOrderBy] = proto.RepeatedField(
|
|
246
|
+
proto.MESSAGE,
|
|
247
|
+
number=10,
|
|
248
|
+
message=access_report.AccessOrderBy,
|
|
249
|
+
)
|
|
250
|
+
return_entity_quota: bool = proto.Field(
|
|
251
|
+
proto.BOOL,
|
|
252
|
+
number=11,
|
|
253
|
+
)
|
|
254
|
+
include_all_users: bool = proto.Field(
|
|
255
|
+
proto.BOOL,
|
|
256
|
+
number=12,
|
|
257
|
+
)
|
|
258
|
+
expand_groups: bool = proto.Field(
|
|
259
|
+
proto.BOOL,
|
|
260
|
+
number=13,
|
|
261
|
+
)
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
class RunAccessReportResponse(proto.Message):
|
|
265
|
+
r"""The customized Data Access Record Report response.
|
|
266
|
+
|
|
267
|
+
Attributes:
|
|
268
|
+
dimension_headers (MutableSequence[google.analytics.admin_v1beta.types.AccessDimensionHeader]):
|
|
269
|
+
The header for a column in the report that
|
|
270
|
+
corresponds to a specific dimension. The number
|
|
271
|
+
of DimensionHeaders and ordering of
|
|
272
|
+
DimensionHeaders matches the dimensions present
|
|
273
|
+
in rows.
|
|
274
|
+
metric_headers (MutableSequence[google.analytics.admin_v1beta.types.AccessMetricHeader]):
|
|
275
|
+
The header for a column in the report that
|
|
276
|
+
corresponds to a specific metric. The number of
|
|
277
|
+
MetricHeaders and ordering of MetricHeaders
|
|
278
|
+
matches the metrics present in rows.
|
|
279
|
+
rows (MutableSequence[google.analytics.admin_v1beta.types.AccessRow]):
|
|
280
|
+
Rows of dimension value combinations and
|
|
281
|
+
metric values in the report.
|
|
282
|
+
row_count (int):
|
|
283
|
+
The total number of rows in the query result. ``rowCount``
|
|
284
|
+
is independent of the number of rows returned in the
|
|
285
|
+
response, the ``limit`` request parameter, and the
|
|
286
|
+
``offset`` request parameter. For example if a query returns
|
|
287
|
+
175 rows and includes ``limit`` of 50 in the API request,
|
|
288
|
+
the response will contain ``rowCount`` of 175 but only 50
|
|
289
|
+
rows.
|
|
290
|
+
|
|
291
|
+
To learn more about this pagination parameter, see
|
|
292
|
+
`Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
|
|
293
|
+
quota (google.analytics.admin_v1beta.types.AccessQuota):
|
|
294
|
+
The quota state for this Analytics property
|
|
295
|
+
including this request. This field doesn't work
|
|
296
|
+
with account-level requests.
|
|
297
|
+
"""
|
|
298
|
+
|
|
299
|
+
dimension_headers: MutableSequence[
|
|
300
|
+
access_report.AccessDimensionHeader
|
|
301
|
+
] = proto.RepeatedField(
|
|
302
|
+
proto.MESSAGE,
|
|
303
|
+
number=1,
|
|
304
|
+
message=access_report.AccessDimensionHeader,
|
|
305
|
+
)
|
|
306
|
+
metric_headers: MutableSequence[
|
|
307
|
+
access_report.AccessMetricHeader
|
|
308
|
+
] = proto.RepeatedField(
|
|
309
|
+
proto.MESSAGE,
|
|
310
|
+
number=2,
|
|
311
|
+
message=access_report.AccessMetricHeader,
|
|
312
|
+
)
|
|
313
|
+
rows: MutableSequence[access_report.AccessRow] = proto.RepeatedField(
|
|
314
|
+
proto.MESSAGE,
|
|
315
|
+
number=3,
|
|
316
|
+
message=access_report.AccessRow,
|
|
317
|
+
)
|
|
318
|
+
row_count: int = proto.Field(
|
|
319
|
+
proto.INT32,
|
|
320
|
+
number=4,
|
|
321
|
+
)
|
|
322
|
+
quota: access_report.AccessQuota = proto.Field(
|
|
323
|
+
proto.MESSAGE,
|
|
324
|
+
number=5,
|
|
325
|
+
message=access_report.AccessQuota,
|
|
326
|
+
)
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
class GetAccountRequest(proto.Message):
|
|
330
|
+
r"""Request message for GetAccount RPC.
|
|
331
|
+
|
|
332
|
+
Attributes:
|
|
333
|
+
name (str):
|
|
334
|
+
Required. The name of the account to lookup.
|
|
335
|
+
Format: accounts/{account}
|
|
336
|
+
Example: "accounts/100".
|
|
337
|
+
"""
|
|
338
|
+
|
|
339
|
+
name: str = proto.Field(
|
|
340
|
+
proto.STRING,
|
|
341
|
+
number=1,
|
|
342
|
+
)
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
class ListAccountsRequest(proto.Message):
|
|
346
|
+
r"""Request message for ListAccounts RPC.
|
|
347
|
+
|
|
348
|
+
Attributes:
|
|
349
|
+
page_size (int):
|
|
350
|
+
The maximum number of resources to return.
|
|
351
|
+
The service may return fewer than this value,
|
|
352
|
+
even if there are additional pages. If
|
|
353
|
+
unspecified, at most 50 resources will be
|
|
354
|
+
returned. The maximum value is 200; (higher
|
|
355
|
+
values will be coerced to the maximum)
|
|
356
|
+
page_token (str):
|
|
357
|
+
A page token, received from a previous ``ListAccounts``
|
|
358
|
+
call. Provide this to retrieve the subsequent page. When
|
|
359
|
+
paginating, all other parameters provided to
|
|
360
|
+
``ListAccounts`` must match the call that provided the page
|
|
361
|
+
token.
|
|
362
|
+
show_deleted (bool):
|
|
363
|
+
Whether to include soft-deleted (ie:
|
|
364
|
+
"trashed") Accounts in the results. Accounts can
|
|
365
|
+
be inspected to determine whether they are
|
|
366
|
+
deleted or not.
|
|
367
|
+
"""
|
|
368
|
+
|
|
369
|
+
page_size: int = proto.Field(
|
|
370
|
+
proto.INT32,
|
|
371
|
+
number=1,
|
|
372
|
+
)
|
|
373
|
+
page_token: str = proto.Field(
|
|
374
|
+
proto.STRING,
|
|
375
|
+
number=2,
|
|
376
|
+
)
|
|
377
|
+
show_deleted: bool = proto.Field(
|
|
378
|
+
proto.BOOL,
|
|
379
|
+
number=3,
|
|
380
|
+
)
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
class ListAccountsResponse(proto.Message):
|
|
384
|
+
r"""Request message for ListAccounts RPC.
|
|
385
|
+
|
|
386
|
+
Attributes:
|
|
387
|
+
accounts (MutableSequence[google.analytics.admin_v1beta.types.Account]):
|
|
388
|
+
Results that were accessible to the caller.
|
|
389
|
+
next_page_token (str):
|
|
390
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
391
|
+
next page. If this field is omitted, there are no subsequent
|
|
392
|
+
pages.
|
|
393
|
+
"""
|
|
394
|
+
|
|
395
|
+
@property
|
|
396
|
+
def raw_page(self):
|
|
397
|
+
return self
|
|
398
|
+
|
|
399
|
+
accounts: MutableSequence[resources.Account] = proto.RepeatedField(
|
|
400
|
+
proto.MESSAGE,
|
|
401
|
+
number=1,
|
|
402
|
+
message=resources.Account,
|
|
403
|
+
)
|
|
404
|
+
next_page_token: str = proto.Field(
|
|
405
|
+
proto.STRING,
|
|
406
|
+
number=2,
|
|
407
|
+
)
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
class DeleteAccountRequest(proto.Message):
|
|
411
|
+
r"""Request message for DeleteAccount RPC.
|
|
412
|
+
|
|
413
|
+
Attributes:
|
|
414
|
+
name (str):
|
|
415
|
+
Required. The name of the Account to
|
|
416
|
+
soft-delete. Format: accounts/{account}
|
|
417
|
+
Example: "accounts/100".
|
|
418
|
+
"""
|
|
419
|
+
|
|
420
|
+
name: str = proto.Field(
|
|
421
|
+
proto.STRING,
|
|
422
|
+
number=1,
|
|
423
|
+
)
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
class UpdateAccountRequest(proto.Message):
|
|
427
|
+
r"""Request message for UpdateAccount RPC.
|
|
428
|
+
|
|
429
|
+
Attributes:
|
|
430
|
+
account (google.analytics.admin_v1beta.types.Account):
|
|
431
|
+
Required. The account to update. The account's ``name``
|
|
432
|
+
field is used to identify the account.
|
|
433
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
434
|
+
Required. The list of fields to be updated. Field names must
|
|
435
|
+
be in snake case (for example, "field_to_update"). Omitted
|
|
436
|
+
fields will not be updated. To replace the entire entity,
|
|
437
|
+
use one path with the string "*" to match all fields.
|
|
438
|
+
"""
|
|
439
|
+
|
|
440
|
+
account: resources.Account = proto.Field(
|
|
441
|
+
proto.MESSAGE,
|
|
442
|
+
number=1,
|
|
443
|
+
message=resources.Account,
|
|
444
|
+
)
|
|
445
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
446
|
+
proto.MESSAGE,
|
|
447
|
+
number=2,
|
|
448
|
+
message=field_mask_pb2.FieldMask,
|
|
449
|
+
)
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
class ProvisionAccountTicketRequest(proto.Message):
|
|
453
|
+
r"""Request message for ProvisionAccountTicket RPC.
|
|
454
|
+
|
|
455
|
+
Attributes:
|
|
456
|
+
account (google.analytics.admin_v1beta.types.Account):
|
|
457
|
+
The account to create.
|
|
458
|
+
redirect_uri (str):
|
|
459
|
+
Redirect URI where the user will be sent
|
|
460
|
+
after accepting Terms of Service. Must be
|
|
461
|
+
configured in Cloud Console as a Redirect URI.
|
|
462
|
+
"""
|
|
463
|
+
|
|
464
|
+
account: resources.Account = proto.Field(
|
|
465
|
+
proto.MESSAGE,
|
|
466
|
+
number=1,
|
|
467
|
+
message=resources.Account,
|
|
468
|
+
)
|
|
469
|
+
redirect_uri: str = proto.Field(
|
|
470
|
+
proto.STRING,
|
|
471
|
+
number=2,
|
|
472
|
+
)
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
class ProvisionAccountTicketResponse(proto.Message):
|
|
476
|
+
r"""Response message for ProvisionAccountTicket RPC.
|
|
477
|
+
|
|
478
|
+
Attributes:
|
|
479
|
+
account_ticket_id (str):
|
|
480
|
+
The param to be passed in the ToS link.
|
|
481
|
+
"""
|
|
482
|
+
|
|
483
|
+
account_ticket_id: str = proto.Field(
|
|
484
|
+
proto.STRING,
|
|
485
|
+
number=1,
|
|
486
|
+
)
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
class GetPropertyRequest(proto.Message):
|
|
490
|
+
r"""Request message for GetProperty RPC.
|
|
491
|
+
|
|
492
|
+
Attributes:
|
|
493
|
+
name (str):
|
|
494
|
+
Required. The name of the property to lookup. Format:
|
|
495
|
+
properties/{property_id} Example: "properties/1000".
|
|
496
|
+
"""
|
|
497
|
+
|
|
498
|
+
name: str = proto.Field(
|
|
499
|
+
proto.STRING,
|
|
500
|
+
number=1,
|
|
501
|
+
)
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
class ListPropertiesRequest(proto.Message):
|
|
505
|
+
r"""Request message for ListProperties RPC.
|
|
506
|
+
|
|
507
|
+
Attributes:
|
|
508
|
+
filter (str):
|
|
509
|
+
Required. An expression for filtering the results of the
|
|
510
|
+
request. Fields eligible for filtering are:
|
|
511
|
+
``parent:``\ (The resource name of the parent
|
|
512
|
+
account/property) or ``ancestor:``\ (The resource name of
|
|
513
|
+
the parent account) or ``firebase_project:``\ (The id or
|
|
514
|
+
number of the linked firebase project). Some examples of
|
|
515
|
+
filters:
|
|
516
|
+
|
|
517
|
+
::
|
|
518
|
+
|
|
519
|
+
| Filter | Description |
|
|
520
|
+
|-----------------------------|-------------------------------------------|
|
|
521
|
+
| parent:accounts/123 | The account with account id: 123. |
|
|
522
|
+
| parent:properties/123 | The property with property id: 123. |
|
|
523
|
+
| ancestor:accounts/123 | The account with account id: 123. |
|
|
524
|
+
| firebase_project:project-id | The firebase project with id: project-id. |
|
|
525
|
+
| firebase_project:123 | The firebase project with number: 123. |
|
|
526
|
+
page_size (int):
|
|
527
|
+
The maximum number of resources to return.
|
|
528
|
+
The service may return fewer than this value,
|
|
529
|
+
even if there are additional pages. If
|
|
530
|
+
unspecified, at most 50 resources will be
|
|
531
|
+
returned. The maximum value is 200; (higher
|
|
532
|
+
values will be coerced to the maximum)
|
|
533
|
+
page_token (str):
|
|
534
|
+
A page token, received from a previous ``ListProperties``
|
|
535
|
+
call. Provide this to retrieve the subsequent page. When
|
|
536
|
+
paginating, all other parameters provided to
|
|
537
|
+
``ListProperties`` must match the call that provided the
|
|
538
|
+
page token.
|
|
539
|
+
show_deleted (bool):
|
|
540
|
+
Whether to include soft-deleted (ie:
|
|
541
|
+
"trashed") Properties in the results. Properties
|
|
542
|
+
can be inspected to determine whether they are
|
|
543
|
+
deleted or not.
|
|
544
|
+
"""
|
|
545
|
+
|
|
546
|
+
filter: str = proto.Field(
|
|
547
|
+
proto.STRING,
|
|
548
|
+
number=1,
|
|
549
|
+
)
|
|
550
|
+
page_size: int = proto.Field(
|
|
551
|
+
proto.INT32,
|
|
552
|
+
number=2,
|
|
553
|
+
)
|
|
554
|
+
page_token: str = proto.Field(
|
|
555
|
+
proto.STRING,
|
|
556
|
+
number=3,
|
|
557
|
+
)
|
|
558
|
+
show_deleted: bool = proto.Field(
|
|
559
|
+
proto.BOOL,
|
|
560
|
+
number=4,
|
|
561
|
+
)
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
class ListPropertiesResponse(proto.Message):
|
|
565
|
+
r"""Response message for ListProperties RPC.
|
|
566
|
+
|
|
567
|
+
Attributes:
|
|
568
|
+
properties (MutableSequence[google.analytics.admin_v1beta.types.Property]):
|
|
569
|
+
Results that matched the filter criteria and
|
|
570
|
+
were accessible to the caller.
|
|
571
|
+
next_page_token (str):
|
|
572
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
573
|
+
next page. If this field is omitted, there are no subsequent
|
|
574
|
+
pages.
|
|
575
|
+
"""
|
|
576
|
+
|
|
577
|
+
@property
|
|
578
|
+
def raw_page(self):
|
|
579
|
+
return self
|
|
580
|
+
|
|
581
|
+
properties: MutableSequence[resources.Property] = proto.RepeatedField(
|
|
582
|
+
proto.MESSAGE,
|
|
583
|
+
number=1,
|
|
584
|
+
message=resources.Property,
|
|
585
|
+
)
|
|
586
|
+
next_page_token: str = proto.Field(
|
|
587
|
+
proto.STRING,
|
|
588
|
+
number=2,
|
|
589
|
+
)
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
class UpdatePropertyRequest(proto.Message):
|
|
593
|
+
r"""Request message for UpdateProperty RPC.
|
|
594
|
+
|
|
595
|
+
Attributes:
|
|
596
|
+
property (google.analytics.admin_v1beta.types.Property):
|
|
597
|
+
Required. The property to update. The property's ``name``
|
|
598
|
+
field is used to identify the property to be updated.
|
|
599
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
600
|
+
Required. The list of fields to be updated. Field names must
|
|
601
|
+
be in snake case (e.g., "field_to_update"). Omitted fields
|
|
602
|
+
will not be updated. To replace the entire entity, use one
|
|
603
|
+
path with the string "*" to match all fields.
|
|
604
|
+
"""
|
|
605
|
+
|
|
606
|
+
property: resources.Property = proto.Field(
|
|
607
|
+
proto.MESSAGE,
|
|
608
|
+
number=1,
|
|
609
|
+
message=resources.Property,
|
|
610
|
+
)
|
|
611
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
612
|
+
proto.MESSAGE,
|
|
613
|
+
number=2,
|
|
614
|
+
message=field_mask_pb2.FieldMask,
|
|
615
|
+
)
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
class CreatePropertyRequest(proto.Message):
|
|
619
|
+
r"""Request message for CreateProperty RPC.
|
|
620
|
+
|
|
621
|
+
Attributes:
|
|
622
|
+
property (google.analytics.admin_v1beta.types.Property):
|
|
623
|
+
Required. The property to create.
|
|
624
|
+
Note: the supplied property must specify its
|
|
625
|
+
parent.
|
|
626
|
+
"""
|
|
627
|
+
|
|
628
|
+
property: resources.Property = proto.Field(
|
|
629
|
+
proto.MESSAGE,
|
|
630
|
+
number=1,
|
|
631
|
+
message=resources.Property,
|
|
632
|
+
)
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
class DeletePropertyRequest(proto.Message):
|
|
636
|
+
r"""Request message for DeleteProperty RPC.
|
|
637
|
+
|
|
638
|
+
Attributes:
|
|
639
|
+
name (str):
|
|
640
|
+
Required. The name of the Property to soft-delete. Format:
|
|
641
|
+
properties/{property_id} Example: "properties/1000".
|
|
642
|
+
"""
|
|
643
|
+
|
|
644
|
+
name: str = proto.Field(
|
|
645
|
+
proto.STRING,
|
|
646
|
+
number=1,
|
|
647
|
+
)
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
class CreateFirebaseLinkRequest(proto.Message):
|
|
651
|
+
r"""Request message for CreateFirebaseLink RPC
|
|
652
|
+
|
|
653
|
+
Attributes:
|
|
654
|
+
parent (str):
|
|
655
|
+
Required. Format: properties/{property_id}
|
|
656
|
+
|
|
657
|
+
Example: ``properties/1234``
|
|
658
|
+
firebase_link (google.analytics.admin_v1beta.types.FirebaseLink):
|
|
659
|
+
Required. The Firebase link to create.
|
|
660
|
+
"""
|
|
661
|
+
|
|
662
|
+
parent: str = proto.Field(
|
|
663
|
+
proto.STRING,
|
|
664
|
+
number=1,
|
|
665
|
+
)
|
|
666
|
+
firebase_link: resources.FirebaseLink = proto.Field(
|
|
667
|
+
proto.MESSAGE,
|
|
668
|
+
number=2,
|
|
669
|
+
message=resources.FirebaseLink,
|
|
670
|
+
)
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
class DeleteFirebaseLinkRequest(proto.Message):
|
|
674
|
+
r"""Request message for DeleteFirebaseLink RPC
|
|
675
|
+
|
|
676
|
+
Attributes:
|
|
677
|
+
name (str):
|
|
678
|
+
Required. Format:
|
|
679
|
+
properties/{property_id}/firebaseLinks/{firebase_link_id}
|
|
680
|
+
|
|
681
|
+
Example: ``properties/1234/firebaseLinks/5678``
|
|
682
|
+
"""
|
|
683
|
+
|
|
684
|
+
name: str = proto.Field(
|
|
685
|
+
proto.STRING,
|
|
686
|
+
number=1,
|
|
687
|
+
)
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
class ListFirebaseLinksRequest(proto.Message):
|
|
691
|
+
r"""Request message for ListFirebaseLinks RPC
|
|
692
|
+
|
|
693
|
+
Attributes:
|
|
694
|
+
parent (str):
|
|
695
|
+
Required. Format: properties/{property_id}
|
|
696
|
+
|
|
697
|
+
Example: ``properties/1234``
|
|
698
|
+
page_size (int):
|
|
699
|
+
The maximum number of resources to return.
|
|
700
|
+
The service may return fewer than this value,
|
|
701
|
+
even if there are additional pages. If
|
|
702
|
+
unspecified, at most 50 resources will be
|
|
703
|
+
returned. The maximum value is 200; (higher
|
|
704
|
+
values will be coerced to the maximum)
|
|
705
|
+
page_token (str):
|
|
706
|
+
A page token, received from a previous ``ListFirebaseLinks``
|
|
707
|
+
call. Provide this to retrieve the subsequent page. When
|
|
708
|
+
paginating, all other parameters provided to
|
|
709
|
+
``ListFirebaseLinks`` must match the call that provided the
|
|
710
|
+
page token.
|
|
711
|
+
"""
|
|
712
|
+
|
|
713
|
+
parent: str = proto.Field(
|
|
714
|
+
proto.STRING,
|
|
715
|
+
number=1,
|
|
716
|
+
)
|
|
717
|
+
page_size: int = proto.Field(
|
|
718
|
+
proto.INT32,
|
|
719
|
+
number=2,
|
|
720
|
+
)
|
|
721
|
+
page_token: str = proto.Field(
|
|
722
|
+
proto.STRING,
|
|
723
|
+
number=3,
|
|
724
|
+
)
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
class ListFirebaseLinksResponse(proto.Message):
|
|
728
|
+
r"""Response message for ListFirebaseLinks RPC
|
|
729
|
+
|
|
730
|
+
Attributes:
|
|
731
|
+
firebase_links (MutableSequence[google.analytics.admin_v1beta.types.FirebaseLink]):
|
|
732
|
+
List of FirebaseLinks. This will have at most
|
|
733
|
+
one value.
|
|
734
|
+
next_page_token (str):
|
|
735
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
736
|
+
next page. If this field is omitted, there are no subsequent
|
|
737
|
+
pages. Currently, Google Analytics supports only one
|
|
738
|
+
FirebaseLink per property, so this will never be populated.
|
|
739
|
+
"""
|
|
740
|
+
|
|
741
|
+
@property
|
|
742
|
+
def raw_page(self):
|
|
743
|
+
return self
|
|
744
|
+
|
|
745
|
+
firebase_links: MutableSequence[resources.FirebaseLink] = proto.RepeatedField(
|
|
746
|
+
proto.MESSAGE,
|
|
747
|
+
number=1,
|
|
748
|
+
message=resources.FirebaseLink,
|
|
749
|
+
)
|
|
750
|
+
next_page_token: str = proto.Field(
|
|
751
|
+
proto.STRING,
|
|
752
|
+
number=2,
|
|
753
|
+
)
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
class CreateGoogleAdsLinkRequest(proto.Message):
|
|
757
|
+
r"""Request message for CreateGoogleAdsLink RPC
|
|
758
|
+
|
|
759
|
+
Attributes:
|
|
760
|
+
parent (str):
|
|
761
|
+
Required. Example format: properties/1234
|
|
762
|
+
google_ads_link (google.analytics.admin_v1beta.types.GoogleAdsLink):
|
|
763
|
+
Required. The GoogleAdsLink to create.
|
|
764
|
+
"""
|
|
765
|
+
|
|
766
|
+
parent: str = proto.Field(
|
|
767
|
+
proto.STRING,
|
|
768
|
+
number=1,
|
|
769
|
+
)
|
|
770
|
+
google_ads_link: resources.GoogleAdsLink = proto.Field(
|
|
771
|
+
proto.MESSAGE,
|
|
772
|
+
number=2,
|
|
773
|
+
message=resources.GoogleAdsLink,
|
|
774
|
+
)
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
class UpdateGoogleAdsLinkRequest(proto.Message):
|
|
778
|
+
r"""Request message for UpdateGoogleAdsLink RPC
|
|
779
|
+
|
|
780
|
+
Attributes:
|
|
781
|
+
google_ads_link (google.analytics.admin_v1beta.types.GoogleAdsLink):
|
|
782
|
+
The GoogleAdsLink to update
|
|
783
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
784
|
+
Required. The list of fields to be updated. Field names must
|
|
785
|
+
be in snake case (e.g., "field_to_update"). Omitted fields
|
|
786
|
+
will not be updated. To replace the entire entity, use one
|
|
787
|
+
path with the string "*" to match all fields.
|
|
788
|
+
"""
|
|
789
|
+
|
|
790
|
+
google_ads_link: resources.GoogleAdsLink = proto.Field(
|
|
791
|
+
proto.MESSAGE,
|
|
792
|
+
number=1,
|
|
793
|
+
message=resources.GoogleAdsLink,
|
|
794
|
+
)
|
|
795
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
796
|
+
proto.MESSAGE,
|
|
797
|
+
number=2,
|
|
798
|
+
message=field_mask_pb2.FieldMask,
|
|
799
|
+
)
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
class DeleteGoogleAdsLinkRequest(proto.Message):
|
|
803
|
+
r"""Request message for DeleteGoogleAdsLink RPC.
|
|
804
|
+
|
|
805
|
+
Attributes:
|
|
806
|
+
name (str):
|
|
807
|
+
Required. Example format:
|
|
808
|
+
properties/1234/googleAdsLinks/5678
|
|
809
|
+
"""
|
|
810
|
+
|
|
811
|
+
name: str = proto.Field(
|
|
812
|
+
proto.STRING,
|
|
813
|
+
number=1,
|
|
814
|
+
)
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
class ListGoogleAdsLinksRequest(proto.Message):
|
|
818
|
+
r"""Request message for ListGoogleAdsLinks RPC.
|
|
819
|
+
|
|
820
|
+
Attributes:
|
|
821
|
+
parent (str):
|
|
822
|
+
Required. Example format: properties/1234
|
|
823
|
+
page_size (int):
|
|
824
|
+
The maximum number of resources to return.
|
|
825
|
+
If unspecified, at most 50 resources will be
|
|
826
|
+
returned. The maximum value is 200 (higher
|
|
827
|
+
values will be coerced to the maximum).
|
|
828
|
+
page_token (str):
|
|
829
|
+
A page token, received from a previous
|
|
830
|
+
``ListGoogleAdsLinks`` call. Provide this to retrieve the
|
|
831
|
+
subsequent page.
|
|
832
|
+
|
|
833
|
+
When paginating, all other parameters provided to
|
|
834
|
+
``ListGoogleAdsLinks`` must match the call that provided the
|
|
835
|
+
page token.
|
|
836
|
+
"""
|
|
837
|
+
|
|
838
|
+
parent: str = proto.Field(
|
|
839
|
+
proto.STRING,
|
|
840
|
+
number=1,
|
|
841
|
+
)
|
|
842
|
+
page_size: int = proto.Field(
|
|
843
|
+
proto.INT32,
|
|
844
|
+
number=2,
|
|
845
|
+
)
|
|
846
|
+
page_token: str = proto.Field(
|
|
847
|
+
proto.STRING,
|
|
848
|
+
number=3,
|
|
849
|
+
)
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
class ListGoogleAdsLinksResponse(proto.Message):
|
|
853
|
+
r"""Response message for ListGoogleAdsLinks RPC.
|
|
854
|
+
|
|
855
|
+
Attributes:
|
|
856
|
+
google_ads_links (MutableSequence[google.analytics.admin_v1beta.types.GoogleAdsLink]):
|
|
857
|
+
List of GoogleAdsLinks.
|
|
858
|
+
next_page_token (str):
|
|
859
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
860
|
+
next page. If this field is omitted, there are no subsequent
|
|
861
|
+
pages.
|
|
862
|
+
"""
|
|
863
|
+
|
|
864
|
+
@property
|
|
865
|
+
def raw_page(self):
|
|
866
|
+
return self
|
|
867
|
+
|
|
868
|
+
google_ads_links: MutableSequence[resources.GoogleAdsLink] = proto.RepeatedField(
|
|
869
|
+
proto.MESSAGE,
|
|
870
|
+
number=1,
|
|
871
|
+
message=resources.GoogleAdsLink,
|
|
872
|
+
)
|
|
873
|
+
next_page_token: str = proto.Field(
|
|
874
|
+
proto.STRING,
|
|
875
|
+
number=2,
|
|
876
|
+
)
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
class GetDataSharingSettingsRequest(proto.Message):
|
|
880
|
+
r"""Request message for GetDataSharingSettings RPC.
|
|
881
|
+
|
|
882
|
+
Attributes:
|
|
883
|
+
name (str):
|
|
884
|
+
Required. The name of the settings to lookup. Format:
|
|
885
|
+
accounts/{account}/dataSharingSettings
|
|
886
|
+
|
|
887
|
+
Example: ``accounts/1000/dataSharingSettings``
|
|
888
|
+
"""
|
|
889
|
+
|
|
890
|
+
name: str = proto.Field(
|
|
891
|
+
proto.STRING,
|
|
892
|
+
number=1,
|
|
893
|
+
)
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
class ListAccountSummariesRequest(proto.Message):
|
|
897
|
+
r"""Request message for ListAccountSummaries RPC.
|
|
898
|
+
|
|
899
|
+
Attributes:
|
|
900
|
+
page_size (int):
|
|
901
|
+
The maximum number of AccountSummary
|
|
902
|
+
resources to return. The service may return
|
|
903
|
+
fewer than this value, even if there are
|
|
904
|
+
additional pages. If unspecified, at most 50
|
|
905
|
+
resources will be returned. The maximum value is
|
|
906
|
+
200; (higher values will be coerced to the
|
|
907
|
+
maximum)
|
|
908
|
+
page_token (str):
|
|
909
|
+
A page token, received from a previous
|
|
910
|
+
``ListAccountSummaries`` call. Provide this to retrieve the
|
|
911
|
+
subsequent page. When paginating, all other parameters
|
|
912
|
+
provided to ``ListAccountSummaries`` must match the call
|
|
913
|
+
that provided the page token.
|
|
914
|
+
"""
|
|
915
|
+
|
|
916
|
+
page_size: int = proto.Field(
|
|
917
|
+
proto.INT32,
|
|
918
|
+
number=1,
|
|
919
|
+
)
|
|
920
|
+
page_token: str = proto.Field(
|
|
921
|
+
proto.STRING,
|
|
922
|
+
number=2,
|
|
923
|
+
)
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
class ListAccountSummariesResponse(proto.Message):
|
|
927
|
+
r"""Response message for ListAccountSummaries RPC.
|
|
928
|
+
|
|
929
|
+
Attributes:
|
|
930
|
+
account_summaries (MutableSequence[google.analytics.admin_v1beta.types.AccountSummary]):
|
|
931
|
+
Account summaries of all accounts the caller
|
|
932
|
+
has access to.
|
|
933
|
+
next_page_token (str):
|
|
934
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
935
|
+
next page. If this field is omitted, there are no subsequent
|
|
936
|
+
pages.
|
|
937
|
+
"""
|
|
938
|
+
|
|
939
|
+
@property
|
|
940
|
+
def raw_page(self):
|
|
941
|
+
return self
|
|
942
|
+
|
|
943
|
+
account_summaries: MutableSequence[resources.AccountSummary] = proto.RepeatedField(
|
|
944
|
+
proto.MESSAGE,
|
|
945
|
+
number=1,
|
|
946
|
+
message=resources.AccountSummary,
|
|
947
|
+
)
|
|
948
|
+
next_page_token: str = proto.Field(
|
|
949
|
+
proto.STRING,
|
|
950
|
+
number=2,
|
|
951
|
+
)
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
class AcknowledgeUserDataCollectionRequest(proto.Message):
|
|
955
|
+
r"""Request message for AcknowledgeUserDataCollection RPC.
|
|
956
|
+
|
|
957
|
+
Attributes:
|
|
958
|
+
property (str):
|
|
959
|
+
Required. The property for which to
|
|
960
|
+
acknowledge user data collection.
|
|
961
|
+
acknowledgement (str):
|
|
962
|
+
Required. An acknowledgement that the caller
|
|
963
|
+
of this method understands the terms of user
|
|
964
|
+
data collection.
|
|
965
|
+
|
|
966
|
+
This field must contain the exact value:
|
|
967
|
+
|
|
968
|
+
"I acknowledge that I have the necessary privacy
|
|
969
|
+
disclosures and rights from my end users for the
|
|
970
|
+
collection and processing of their data,
|
|
971
|
+
including the association of such data with the
|
|
972
|
+
visitation information Google Analytics collects
|
|
973
|
+
from my site and/or app property.".
|
|
974
|
+
"""
|
|
975
|
+
|
|
976
|
+
property: str = proto.Field(
|
|
977
|
+
proto.STRING,
|
|
978
|
+
number=1,
|
|
979
|
+
)
|
|
980
|
+
acknowledgement: str = proto.Field(
|
|
981
|
+
proto.STRING,
|
|
982
|
+
number=2,
|
|
983
|
+
)
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
class AcknowledgeUserDataCollectionResponse(proto.Message):
|
|
987
|
+
r"""Response message for AcknowledgeUserDataCollection RPC."""
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
class SearchChangeHistoryEventsRequest(proto.Message):
|
|
991
|
+
r"""Request message for SearchChangeHistoryEvents RPC.
|
|
992
|
+
|
|
993
|
+
Attributes:
|
|
994
|
+
account (str):
|
|
995
|
+
Required. The account resource for which to return change
|
|
996
|
+
history resources. Format: accounts/{account}
|
|
997
|
+
|
|
998
|
+
Example: ``accounts/100``
|
|
999
|
+
property (str):
|
|
1000
|
+
Optional. Resource name for a child property. If set, only
|
|
1001
|
+
return changes made to this property or its child resources.
|
|
1002
|
+
Format: properties/{propertyId}
|
|
1003
|
+
|
|
1004
|
+
Example: ``properties/100``
|
|
1005
|
+
resource_type (MutableSequence[google.analytics.admin_v1beta.types.ChangeHistoryResourceType]):
|
|
1006
|
+
Optional. If set, only return changes if they
|
|
1007
|
+
are for a resource that matches at least one of
|
|
1008
|
+
these types.
|
|
1009
|
+
action (MutableSequence[google.analytics.admin_v1beta.types.ActionType]):
|
|
1010
|
+
Optional. If set, only return changes that
|
|
1011
|
+
match one or more of these types of actions.
|
|
1012
|
+
actor_email (MutableSequence[str]):
|
|
1013
|
+
Optional. If set, only return changes if they
|
|
1014
|
+
are made by a user in this list.
|
|
1015
|
+
earliest_change_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1016
|
+
Optional. If set, only return changes made
|
|
1017
|
+
after this time (inclusive).
|
|
1018
|
+
latest_change_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1019
|
+
Optional. If set, only return changes made
|
|
1020
|
+
before this time (inclusive).
|
|
1021
|
+
page_size (int):
|
|
1022
|
+
Optional. The maximum number of ChangeHistoryEvent items to
|
|
1023
|
+
return. If unspecified, at most 50 items will be returned.
|
|
1024
|
+
The maximum value is 200 (higher values will be coerced to
|
|
1025
|
+
the maximum).
|
|
1026
|
+
|
|
1027
|
+
Note that the service may return a page with fewer items
|
|
1028
|
+
than this value specifies (potentially even zero), and that
|
|
1029
|
+
there still may be additional pages. If you want a
|
|
1030
|
+
particular number of items, you'll need to continue
|
|
1031
|
+
requesting additional pages using ``page_token`` until you
|
|
1032
|
+
get the needed number.
|
|
1033
|
+
page_token (str):
|
|
1034
|
+
Optional. A page token, received from a previous
|
|
1035
|
+
``SearchChangeHistoryEvents`` call. Provide this to retrieve
|
|
1036
|
+
the subsequent page. When paginating, all other parameters
|
|
1037
|
+
provided to ``SearchChangeHistoryEvents`` must match the
|
|
1038
|
+
call that provided the page token.
|
|
1039
|
+
"""
|
|
1040
|
+
|
|
1041
|
+
account: str = proto.Field(
|
|
1042
|
+
proto.STRING,
|
|
1043
|
+
number=1,
|
|
1044
|
+
)
|
|
1045
|
+
property: str = proto.Field(
|
|
1046
|
+
proto.STRING,
|
|
1047
|
+
number=2,
|
|
1048
|
+
)
|
|
1049
|
+
resource_type: MutableSequence[
|
|
1050
|
+
resources.ChangeHistoryResourceType
|
|
1051
|
+
] = proto.RepeatedField(
|
|
1052
|
+
proto.ENUM,
|
|
1053
|
+
number=3,
|
|
1054
|
+
enum=resources.ChangeHistoryResourceType,
|
|
1055
|
+
)
|
|
1056
|
+
action: MutableSequence[resources.ActionType] = proto.RepeatedField(
|
|
1057
|
+
proto.ENUM,
|
|
1058
|
+
number=4,
|
|
1059
|
+
enum=resources.ActionType,
|
|
1060
|
+
)
|
|
1061
|
+
actor_email: MutableSequence[str] = proto.RepeatedField(
|
|
1062
|
+
proto.STRING,
|
|
1063
|
+
number=5,
|
|
1064
|
+
)
|
|
1065
|
+
earliest_change_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1066
|
+
proto.MESSAGE,
|
|
1067
|
+
number=6,
|
|
1068
|
+
message=timestamp_pb2.Timestamp,
|
|
1069
|
+
)
|
|
1070
|
+
latest_change_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1071
|
+
proto.MESSAGE,
|
|
1072
|
+
number=7,
|
|
1073
|
+
message=timestamp_pb2.Timestamp,
|
|
1074
|
+
)
|
|
1075
|
+
page_size: int = proto.Field(
|
|
1076
|
+
proto.INT32,
|
|
1077
|
+
number=8,
|
|
1078
|
+
)
|
|
1079
|
+
page_token: str = proto.Field(
|
|
1080
|
+
proto.STRING,
|
|
1081
|
+
number=9,
|
|
1082
|
+
)
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
class SearchChangeHistoryEventsResponse(proto.Message):
|
|
1086
|
+
r"""Response message for SearchAccounts RPC.
|
|
1087
|
+
|
|
1088
|
+
Attributes:
|
|
1089
|
+
change_history_events (MutableSequence[google.analytics.admin_v1beta.types.ChangeHistoryEvent]):
|
|
1090
|
+
Results that were accessible to the caller.
|
|
1091
|
+
next_page_token (str):
|
|
1092
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
1093
|
+
next page. If this field is omitted, there are no subsequent
|
|
1094
|
+
pages.
|
|
1095
|
+
"""
|
|
1096
|
+
|
|
1097
|
+
@property
|
|
1098
|
+
def raw_page(self):
|
|
1099
|
+
return self
|
|
1100
|
+
|
|
1101
|
+
change_history_events: MutableSequence[
|
|
1102
|
+
resources.ChangeHistoryEvent
|
|
1103
|
+
] = proto.RepeatedField(
|
|
1104
|
+
proto.MESSAGE,
|
|
1105
|
+
number=1,
|
|
1106
|
+
message=resources.ChangeHistoryEvent,
|
|
1107
|
+
)
|
|
1108
|
+
next_page_token: str = proto.Field(
|
|
1109
|
+
proto.STRING,
|
|
1110
|
+
number=2,
|
|
1111
|
+
)
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
class GetMeasurementProtocolSecretRequest(proto.Message):
|
|
1115
|
+
r"""Request message for GetMeasurementProtocolSecret RPC.
|
|
1116
|
+
|
|
1117
|
+
Attributes:
|
|
1118
|
+
name (str):
|
|
1119
|
+
Required. The name of the measurement
|
|
1120
|
+
protocol secret to lookup. Format:
|
|
1121
|
+
|
|
1122
|
+
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
|
|
1123
|
+
"""
|
|
1124
|
+
|
|
1125
|
+
name: str = proto.Field(
|
|
1126
|
+
proto.STRING,
|
|
1127
|
+
number=1,
|
|
1128
|
+
)
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
class CreateMeasurementProtocolSecretRequest(proto.Message):
|
|
1132
|
+
r"""Request message for CreateMeasurementProtocolSecret RPC
|
|
1133
|
+
|
|
1134
|
+
Attributes:
|
|
1135
|
+
parent (str):
|
|
1136
|
+
Required. The parent resource where this
|
|
1137
|
+
secret will be created. Format:
|
|
1138
|
+
properties/{property}/dataStreams/{dataStream}
|
|
1139
|
+
measurement_protocol_secret (google.analytics.admin_v1beta.types.MeasurementProtocolSecret):
|
|
1140
|
+
Required. The measurement protocol secret to
|
|
1141
|
+
create.
|
|
1142
|
+
"""
|
|
1143
|
+
|
|
1144
|
+
parent: str = proto.Field(
|
|
1145
|
+
proto.STRING,
|
|
1146
|
+
number=1,
|
|
1147
|
+
)
|
|
1148
|
+
measurement_protocol_secret: resources.MeasurementProtocolSecret = proto.Field(
|
|
1149
|
+
proto.MESSAGE,
|
|
1150
|
+
number=2,
|
|
1151
|
+
message=resources.MeasurementProtocolSecret,
|
|
1152
|
+
)
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
class DeleteMeasurementProtocolSecretRequest(proto.Message):
|
|
1156
|
+
r"""Request message for DeleteMeasurementProtocolSecret RPC
|
|
1157
|
+
|
|
1158
|
+
Attributes:
|
|
1159
|
+
name (str):
|
|
1160
|
+
Required. The name of the
|
|
1161
|
+
MeasurementProtocolSecret to delete. Format:
|
|
1162
|
+
|
|
1163
|
+
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
|
|
1164
|
+
"""
|
|
1165
|
+
|
|
1166
|
+
name: str = proto.Field(
|
|
1167
|
+
proto.STRING,
|
|
1168
|
+
number=1,
|
|
1169
|
+
)
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
class UpdateMeasurementProtocolSecretRequest(proto.Message):
|
|
1173
|
+
r"""Request message for UpdateMeasurementProtocolSecret RPC
|
|
1174
|
+
|
|
1175
|
+
Attributes:
|
|
1176
|
+
measurement_protocol_secret (google.analytics.admin_v1beta.types.MeasurementProtocolSecret):
|
|
1177
|
+
Required. The measurement protocol secret to
|
|
1178
|
+
update.
|
|
1179
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1180
|
+
Required. The list of fields to be updated.
|
|
1181
|
+
Omitted fields will not be updated.
|
|
1182
|
+
"""
|
|
1183
|
+
|
|
1184
|
+
measurement_protocol_secret: resources.MeasurementProtocolSecret = proto.Field(
|
|
1185
|
+
proto.MESSAGE,
|
|
1186
|
+
number=1,
|
|
1187
|
+
message=resources.MeasurementProtocolSecret,
|
|
1188
|
+
)
|
|
1189
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1190
|
+
proto.MESSAGE,
|
|
1191
|
+
number=2,
|
|
1192
|
+
message=field_mask_pb2.FieldMask,
|
|
1193
|
+
)
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
class ListMeasurementProtocolSecretsRequest(proto.Message):
|
|
1197
|
+
r"""Request message for ListMeasurementProtocolSecret RPC
|
|
1198
|
+
|
|
1199
|
+
Attributes:
|
|
1200
|
+
parent (str):
|
|
1201
|
+
Required. The resource name of the parent
|
|
1202
|
+
stream. Format:
|
|
1203
|
+
|
|
1204
|
+
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
|
|
1205
|
+
page_size (int):
|
|
1206
|
+
The maximum number of resources to return.
|
|
1207
|
+
If unspecified, at most 10 resources will be
|
|
1208
|
+
returned. The maximum value is 10. Higher values
|
|
1209
|
+
will be coerced to the maximum.
|
|
1210
|
+
page_token (str):
|
|
1211
|
+
A page token, received from a previous
|
|
1212
|
+
``ListMeasurementProtocolSecrets`` call. Provide this to
|
|
1213
|
+
retrieve the subsequent page. When paginating, all other
|
|
1214
|
+
parameters provided to ``ListMeasurementProtocolSecrets``
|
|
1215
|
+
must match the call that provided the page token.
|
|
1216
|
+
"""
|
|
1217
|
+
|
|
1218
|
+
parent: str = proto.Field(
|
|
1219
|
+
proto.STRING,
|
|
1220
|
+
number=1,
|
|
1221
|
+
)
|
|
1222
|
+
page_size: int = proto.Field(
|
|
1223
|
+
proto.INT32,
|
|
1224
|
+
number=2,
|
|
1225
|
+
)
|
|
1226
|
+
page_token: str = proto.Field(
|
|
1227
|
+
proto.STRING,
|
|
1228
|
+
number=3,
|
|
1229
|
+
)
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
class ListMeasurementProtocolSecretsResponse(proto.Message):
|
|
1233
|
+
r"""Response message for ListMeasurementProtocolSecret RPC
|
|
1234
|
+
|
|
1235
|
+
Attributes:
|
|
1236
|
+
measurement_protocol_secrets (MutableSequence[google.analytics.admin_v1beta.types.MeasurementProtocolSecret]):
|
|
1237
|
+
A list of secrets for the parent stream
|
|
1238
|
+
specified in the request.
|
|
1239
|
+
next_page_token (str):
|
|
1240
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
1241
|
+
next page. If this field is omitted, there are no subsequent
|
|
1242
|
+
pages.
|
|
1243
|
+
"""
|
|
1244
|
+
|
|
1245
|
+
@property
|
|
1246
|
+
def raw_page(self):
|
|
1247
|
+
return self
|
|
1248
|
+
|
|
1249
|
+
measurement_protocol_secrets: MutableSequence[
|
|
1250
|
+
resources.MeasurementProtocolSecret
|
|
1251
|
+
] = proto.RepeatedField(
|
|
1252
|
+
proto.MESSAGE,
|
|
1253
|
+
number=1,
|
|
1254
|
+
message=resources.MeasurementProtocolSecret,
|
|
1255
|
+
)
|
|
1256
|
+
next_page_token: str = proto.Field(
|
|
1257
|
+
proto.STRING,
|
|
1258
|
+
number=2,
|
|
1259
|
+
)
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
class CreateConversionEventRequest(proto.Message):
|
|
1263
|
+
r"""Request message for CreateConversionEvent RPC
|
|
1264
|
+
|
|
1265
|
+
Attributes:
|
|
1266
|
+
conversion_event (google.analytics.admin_v1beta.types.ConversionEvent):
|
|
1267
|
+
Required. The conversion event to create.
|
|
1268
|
+
parent (str):
|
|
1269
|
+
Required. The resource name of the parent
|
|
1270
|
+
property where this conversion event will be
|
|
1271
|
+
created. Format: properties/123
|
|
1272
|
+
"""
|
|
1273
|
+
|
|
1274
|
+
conversion_event: resources.ConversionEvent = proto.Field(
|
|
1275
|
+
proto.MESSAGE,
|
|
1276
|
+
number=1,
|
|
1277
|
+
message=resources.ConversionEvent,
|
|
1278
|
+
)
|
|
1279
|
+
parent: str = proto.Field(
|
|
1280
|
+
proto.STRING,
|
|
1281
|
+
number=2,
|
|
1282
|
+
)
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
class UpdateConversionEventRequest(proto.Message):
|
|
1286
|
+
r"""Request message for UpdateConversionEvent RPC
|
|
1287
|
+
|
|
1288
|
+
Attributes:
|
|
1289
|
+
conversion_event (google.analytics.admin_v1beta.types.ConversionEvent):
|
|
1290
|
+
Required. The conversion event to update. The ``name`` field
|
|
1291
|
+
is used to identify the settings to be updated.
|
|
1292
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1293
|
+
Required. The list of fields to be updated. Field names must
|
|
1294
|
+
be in snake case (e.g., "field_to_update"). Omitted fields
|
|
1295
|
+
will not be updated. To replace the entire entity, use one
|
|
1296
|
+
path with the string "*" to match all fields.
|
|
1297
|
+
"""
|
|
1298
|
+
|
|
1299
|
+
conversion_event: resources.ConversionEvent = proto.Field(
|
|
1300
|
+
proto.MESSAGE,
|
|
1301
|
+
number=1,
|
|
1302
|
+
message=resources.ConversionEvent,
|
|
1303
|
+
)
|
|
1304
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1305
|
+
proto.MESSAGE,
|
|
1306
|
+
number=2,
|
|
1307
|
+
message=field_mask_pb2.FieldMask,
|
|
1308
|
+
)
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
class GetConversionEventRequest(proto.Message):
|
|
1312
|
+
r"""Request message for GetConversionEvent RPC
|
|
1313
|
+
|
|
1314
|
+
Attributes:
|
|
1315
|
+
name (str):
|
|
1316
|
+
Required. The resource name of the conversion event to
|
|
1317
|
+
retrieve. Format:
|
|
1318
|
+
properties/{property}/conversionEvents/{conversion_event}
|
|
1319
|
+
Example: "properties/123/conversionEvents/456".
|
|
1320
|
+
"""
|
|
1321
|
+
|
|
1322
|
+
name: str = proto.Field(
|
|
1323
|
+
proto.STRING,
|
|
1324
|
+
number=1,
|
|
1325
|
+
)
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
class DeleteConversionEventRequest(proto.Message):
|
|
1329
|
+
r"""Request message for DeleteConversionEvent RPC
|
|
1330
|
+
|
|
1331
|
+
Attributes:
|
|
1332
|
+
name (str):
|
|
1333
|
+
Required. The resource name of the conversion event to
|
|
1334
|
+
delete. Format:
|
|
1335
|
+
properties/{property}/conversionEvents/{conversion_event}
|
|
1336
|
+
Example: "properties/123/conversionEvents/456".
|
|
1337
|
+
"""
|
|
1338
|
+
|
|
1339
|
+
name: str = proto.Field(
|
|
1340
|
+
proto.STRING,
|
|
1341
|
+
number=1,
|
|
1342
|
+
)
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
class ListConversionEventsRequest(proto.Message):
|
|
1346
|
+
r"""Request message for ListConversionEvents RPC
|
|
1347
|
+
|
|
1348
|
+
Attributes:
|
|
1349
|
+
parent (str):
|
|
1350
|
+
Required. The resource name of the parent
|
|
1351
|
+
property. Example: 'properties/123'
|
|
1352
|
+
page_size (int):
|
|
1353
|
+
The maximum number of resources to return.
|
|
1354
|
+
If unspecified, at most 50 resources will be
|
|
1355
|
+
returned. The maximum value is 200; (higher
|
|
1356
|
+
values will be coerced to the maximum)
|
|
1357
|
+
page_token (str):
|
|
1358
|
+
A page token, received from a previous
|
|
1359
|
+
``ListConversionEvents`` call. Provide this to retrieve the
|
|
1360
|
+
subsequent page. When paginating, all other parameters
|
|
1361
|
+
provided to ``ListConversionEvents`` must match the call
|
|
1362
|
+
that provided the page token.
|
|
1363
|
+
"""
|
|
1364
|
+
|
|
1365
|
+
parent: str = proto.Field(
|
|
1366
|
+
proto.STRING,
|
|
1367
|
+
number=1,
|
|
1368
|
+
)
|
|
1369
|
+
page_size: int = proto.Field(
|
|
1370
|
+
proto.INT32,
|
|
1371
|
+
number=2,
|
|
1372
|
+
)
|
|
1373
|
+
page_token: str = proto.Field(
|
|
1374
|
+
proto.STRING,
|
|
1375
|
+
number=3,
|
|
1376
|
+
)
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
class ListConversionEventsResponse(proto.Message):
|
|
1380
|
+
r"""Response message for ListConversionEvents RPC.
|
|
1381
|
+
|
|
1382
|
+
Attributes:
|
|
1383
|
+
conversion_events (MutableSequence[google.analytics.admin_v1beta.types.ConversionEvent]):
|
|
1384
|
+
The requested conversion events
|
|
1385
|
+
next_page_token (str):
|
|
1386
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
1387
|
+
next page. If this field is omitted, there are no subsequent
|
|
1388
|
+
pages.
|
|
1389
|
+
"""
|
|
1390
|
+
|
|
1391
|
+
@property
|
|
1392
|
+
def raw_page(self):
|
|
1393
|
+
return self
|
|
1394
|
+
|
|
1395
|
+
conversion_events: MutableSequence[resources.ConversionEvent] = proto.RepeatedField(
|
|
1396
|
+
proto.MESSAGE,
|
|
1397
|
+
number=1,
|
|
1398
|
+
message=resources.ConversionEvent,
|
|
1399
|
+
)
|
|
1400
|
+
next_page_token: str = proto.Field(
|
|
1401
|
+
proto.STRING,
|
|
1402
|
+
number=2,
|
|
1403
|
+
)
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
class CreateKeyEventRequest(proto.Message):
|
|
1407
|
+
r"""Request message for CreateKeyEvent RPC
|
|
1408
|
+
|
|
1409
|
+
Attributes:
|
|
1410
|
+
key_event (google.analytics.admin_v1beta.types.KeyEvent):
|
|
1411
|
+
Required. The Key Event to create.
|
|
1412
|
+
parent (str):
|
|
1413
|
+
Required. The resource name of the parent
|
|
1414
|
+
property where this Key Event will be created.
|
|
1415
|
+
Format: properties/123
|
|
1416
|
+
"""
|
|
1417
|
+
|
|
1418
|
+
key_event: resources.KeyEvent = proto.Field(
|
|
1419
|
+
proto.MESSAGE,
|
|
1420
|
+
number=1,
|
|
1421
|
+
message=resources.KeyEvent,
|
|
1422
|
+
)
|
|
1423
|
+
parent: str = proto.Field(
|
|
1424
|
+
proto.STRING,
|
|
1425
|
+
number=2,
|
|
1426
|
+
)
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
class UpdateKeyEventRequest(proto.Message):
|
|
1430
|
+
r"""Request message for UpdateKeyEvent RPC
|
|
1431
|
+
|
|
1432
|
+
Attributes:
|
|
1433
|
+
key_event (google.analytics.admin_v1beta.types.KeyEvent):
|
|
1434
|
+
Required. The Key Event to update. The ``name`` field is
|
|
1435
|
+
used to identify the settings to be updated.
|
|
1436
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1437
|
+
Required. The list of fields to be updated. Field names must
|
|
1438
|
+
be in snake case (e.g., "field_to_update"). Omitted fields
|
|
1439
|
+
will not be updated. To replace the entire entity, use one
|
|
1440
|
+
path with the string "*" to match all fields.
|
|
1441
|
+
"""
|
|
1442
|
+
|
|
1443
|
+
key_event: resources.KeyEvent = proto.Field(
|
|
1444
|
+
proto.MESSAGE,
|
|
1445
|
+
number=1,
|
|
1446
|
+
message=resources.KeyEvent,
|
|
1447
|
+
)
|
|
1448
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1449
|
+
proto.MESSAGE,
|
|
1450
|
+
number=2,
|
|
1451
|
+
message=field_mask_pb2.FieldMask,
|
|
1452
|
+
)
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
class GetKeyEventRequest(proto.Message):
|
|
1456
|
+
r"""Request message for GetKeyEvent RPC
|
|
1457
|
+
|
|
1458
|
+
Attributes:
|
|
1459
|
+
name (str):
|
|
1460
|
+
Required. The resource name of the Key Event to retrieve.
|
|
1461
|
+
Format: properties/{property}/keyEvents/{key_event} Example:
|
|
1462
|
+
"properties/123/keyEvents/456".
|
|
1463
|
+
"""
|
|
1464
|
+
|
|
1465
|
+
name: str = proto.Field(
|
|
1466
|
+
proto.STRING,
|
|
1467
|
+
number=1,
|
|
1468
|
+
)
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
class DeleteKeyEventRequest(proto.Message):
|
|
1472
|
+
r"""Request message for DeleteKeyEvent RPC
|
|
1473
|
+
|
|
1474
|
+
Attributes:
|
|
1475
|
+
name (str):
|
|
1476
|
+
Required. The resource name of the Key Event to delete.
|
|
1477
|
+
Format: properties/{property}/keyEvents/{key_event} Example:
|
|
1478
|
+
"properties/123/keyEvents/456".
|
|
1479
|
+
"""
|
|
1480
|
+
|
|
1481
|
+
name: str = proto.Field(
|
|
1482
|
+
proto.STRING,
|
|
1483
|
+
number=1,
|
|
1484
|
+
)
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
class ListKeyEventsRequest(proto.Message):
|
|
1488
|
+
r"""Request message for ListKeyEvents RPC
|
|
1489
|
+
|
|
1490
|
+
Attributes:
|
|
1491
|
+
parent (str):
|
|
1492
|
+
Required. The resource name of the parent
|
|
1493
|
+
property. Example: 'properties/123'
|
|
1494
|
+
page_size (int):
|
|
1495
|
+
The maximum number of resources to return.
|
|
1496
|
+
If unspecified, at most 50 resources will be
|
|
1497
|
+
returned. The maximum value is 200; (higher
|
|
1498
|
+
values will be coerced to the maximum)
|
|
1499
|
+
page_token (str):
|
|
1500
|
+
A page token, received from a previous ``ListKeyEvents``
|
|
1501
|
+
call. Provide this to retrieve the subsequent page. When
|
|
1502
|
+
paginating, all other parameters provided to
|
|
1503
|
+
``ListKeyEvents`` must match the call that provided the page
|
|
1504
|
+
token.
|
|
1505
|
+
"""
|
|
1506
|
+
|
|
1507
|
+
parent: str = proto.Field(
|
|
1508
|
+
proto.STRING,
|
|
1509
|
+
number=1,
|
|
1510
|
+
)
|
|
1511
|
+
page_size: int = proto.Field(
|
|
1512
|
+
proto.INT32,
|
|
1513
|
+
number=2,
|
|
1514
|
+
)
|
|
1515
|
+
page_token: str = proto.Field(
|
|
1516
|
+
proto.STRING,
|
|
1517
|
+
number=3,
|
|
1518
|
+
)
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
class ListKeyEventsResponse(proto.Message):
|
|
1522
|
+
r"""Response message for ListKeyEvents RPC.
|
|
1523
|
+
|
|
1524
|
+
Attributes:
|
|
1525
|
+
key_events (MutableSequence[google.analytics.admin_v1beta.types.KeyEvent]):
|
|
1526
|
+
The requested Key Events
|
|
1527
|
+
next_page_token (str):
|
|
1528
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
1529
|
+
next page. If this field is omitted, there are no subsequent
|
|
1530
|
+
pages.
|
|
1531
|
+
"""
|
|
1532
|
+
|
|
1533
|
+
@property
|
|
1534
|
+
def raw_page(self):
|
|
1535
|
+
return self
|
|
1536
|
+
|
|
1537
|
+
key_events: MutableSequence[resources.KeyEvent] = proto.RepeatedField(
|
|
1538
|
+
proto.MESSAGE,
|
|
1539
|
+
number=1,
|
|
1540
|
+
message=resources.KeyEvent,
|
|
1541
|
+
)
|
|
1542
|
+
next_page_token: str = proto.Field(
|
|
1543
|
+
proto.STRING,
|
|
1544
|
+
number=2,
|
|
1545
|
+
)
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
class CreateCustomDimensionRequest(proto.Message):
|
|
1549
|
+
r"""Request message for CreateCustomDimension RPC.
|
|
1550
|
+
|
|
1551
|
+
Attributes:
|
|
1552
|
+
parent (str):
|
|
1553
|
+
Required. Example format: properties/1234
|
|
1554
|
+
custom_dimension (google.analytics.admin_v1beta.types.CustomDimension):
|
|
1555
|
+
Required. The CustomDimension to create.
|
|
1556
|
+
"""
|
|
1557
|
+
|
|
1558
|
+
parent: str = proto.Field(
|
|
1559
|
+
proto.STRING,
|
|
1560
|
+
number=1,
|
|
1561
|
+
)
|
|
1562
|
+
custom_dimension: resources.CustomDimension = proto.Field(
|
|
1563
|
+
proto.MESSAGE,
|
|
1564
|
+
number=2,
|
|
1565
|
+
message=resources.CustomDimension,
|
|
1566
|
+
)
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
class UpdateCustomDimensionRequest(proto.Message):
|
|
1570
|
+
r"""Request message for UpdateCustomDimension RPC.
|
|
1571
|
+
|
|
1572
|
+
Attributes:
|
|
1573
|
+
custom_dimension (google.analytics.admin_v1beta.types.CustomDimension):
|
|
1574
|
+
The CustomDimension to update
|
|
1575
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1576
|
+
Required. The list of fields to be updated. Omitted fields
|
|
1577
|
+
will not be updated. To replace the entire entity, use one
|
|
1578
|
+
path with the string "*" to match all fields.
|
|
1579
|
+
"""
|
|
1580
|
+
|
|
1581
|
+
custom_dimension: resources.CustomDimension = proto.Field(
|
|
1582
|
+
proto.MESSAGE,
|
|
1583
|
+
number=1,
|
|
1584
|
+
message=resources.CustomDimension,
|
|
1585
|
+
)
|
|
1586
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1587
|
+
proto.MESSAGE,
|
|
1588
|
+
number=2,
|
|
1589
|
+
message=field_mask_pb2.FieldMask,
|
|
1590
|
+
)
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
class ListCustomDimensionsRequest(proto.Message):
|
|
1594
|
+
r"""Request message for ListCustomDimensions RPC.
|
|
1595
|
+
|
|
1596
|
+
Attributes:
|
|
1597
|
+
parent (str):
|
|
1598
|
+
Required. Example format: properties/1234
|
|
1599
|
+
page_size (int):
|
|
1600
|
+
The maximum number of resources to return.
|
|
1601
|
+
If unspecified, at most 50 resources will be
|
|
1602
|
+
returned. The maximum value is 200 (higher
|
|
1603
|
+
values will be coerced to the maximum).
|
|
1604
|
+
page_token (str):
|
|
1605
|
+
A page token, received from a previous
|
|
1606
|
+
``ListCustomDimensions`` call. Provide this to retrieve the
|
|
1607
|
+
subsequent page.
|
|
1608
|
+
|
|
1609
|
+
When paginating, all other parameters provided to
|
|
1610
|
+
``ListCustomDimensions`` must match the call that provided
|
|
1611
|
+
the page token.
|
|
1612
|
+
"""
|
|
1613
|
+
|
|
1614
|
+
parent: str = proto.Field(
|
|
1615
|
+
proto.STRING,
|
|
1616
|
+
number=1,
|
|
1617
|
+
)
|
|
1618
|
+
page_size: int = proto.Field(
|
|
1619
|
+
proto.INT32,
|
|
1620
|
+
number=2,
|
|
1621
|
+
)
|
|
1622
|
+
page_token: str = proto.Field(
|
|
1623
|
+
proto.STRING,
|
|
1624
|
+
number=3,
|
|
1625
|
+
)
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
class ListCustomDimensionsResponse(proto.Message):
|
|
1629
|
+
r"""Response message for ListCustomDimensions RPC.
|
|
1630
|
+
|
|
1631
|
+
Attributes:
|
|
1632
|
+
custom_dimensions (MutableSequence[google.analytics.admin_v1beta.types.CustomDimension]):
|
|
1633
|
+
List of CustomDimensions.
|
|
1634
|
+
next_page_token (str):
|
|
1635
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
1636
|
+
next page. If this field is omitted, there are no subsequent
|
|
1637
|
+
pages.
|
|
1638
|
+
"""
|
|
1639
|
+
|
|
1640
|
+
@property
|
|
1641
|
+
def raw_page(self):
|
|
1642
|
+
return self
|
|
1643
|
+
|
|
1644
|
+
custom_dimensions: MutableSequence[resources.CustomDimension] = proto.RepeatedField(
|
|
1645
|
+
proto.MESSAGE,
|
|
1646
|
+
number=1,
|
|
1647
|
+
message=resources.CustomDimension,
|
|
1648
|
+
)
|
|
1649
|
+
next_page_token: str = proto.Field(
|
|
1650
|
+
proto.STRING,
|
|
1651
|
+
number=2,
|
|
1652
|
+
)
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
class ArchiveCustomDimensionRequest(proto.Message):
|
|
1656
|
+
r"""Request message for ArchiveCustomDimension RPC.
|
|
1657
|
+
|
|
1658
|
+
Attributes:
|
|
1659
|
+
name (str):
|
|
1660
|
+
Required. The name of the CustomDimension to
|
|
1661
|
+
archive. Example format:
|
|
1662
|
+
properties/1234/customDimensions/5678
|
|
1663
|
+
"""
|
|
1664
|
+
|
|
1665
|
+
name: str = proto.Field(
|
|
1666
|
+
proto.STRING,
|
|
1667
|
+
number=1,
|
|
1668
|
+
)
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
class GetCustomDimensionRequest(proto.Message):
|
|
1672
|
+
r"""Request message for GetCustomDimension RPC.
|
|
1673
|
+
|
|
1674
|
+
Attributes:
|
|
1675
|
+
name (str):
|
|
1676
|
+
Required. The name of the CustomDimension to
|
|
1677
|
+
get. Example format:
|
|
1678
|
+
properties/1234/customDimensions/5678
|
|
1679
|
+
"""
|
|
1680
|
+
|
|
1681
|
+
name: str = proto.Field(
|
|
1682
|
+
proto.STRING,
|
|
1683
|
+
number=1,
|
|
1684
|
+
)
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
class CreateCustomMetricRequest(proto.Message):
|
|
1688
|
+
r"""Request message for CreateCustomMetric RPC.
|
|
1689
|
+
|
|
1690
|
+
Attributes:
|
|
1691
|
+
parent (str):
|
|
1692
|
+
Required. Example format: properties/1234
|
|
1693
|
+
custom_metric (google.analytics.admin_v1beta.types.CustomMetric):
|
|
1694
|
+
Required. The CustomMetric to create.
|
|
1695
|
+
"""
|
|
1696
|
+
|
|
1697
|
+
parent: str = proto.Field(
|
|
1698
|
+
proto.STRING,
|
|
1699
|
+
number=1,
|
|
1700
|
+
)
|
|
1701
|
+
custom_metric: resources.CustomMetric = proto.Field(
|
|
1702
|
+
proto.MESSAGE,
|
|
1703
|
+
number=2,
|
|
1704
|
+
message=resources.CustomMetric,
|
|
1705
|
+
)
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
class UpdateCustomMetricRequest(proto.Message):
|
|
1709
|
+
r"""Request message for UpdateCustomMetric RPC.
|
|
1710
|
+
|
|
1711
|
+
Attributes:
|
|
1712
|
+
custom_metric (google.analytics.admin_v1beta.types.CustomMetric):
|
|
1713
|
+
The CustomMetric to update
|
|
1714
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1715
|
+
Required. The list of fields to be updated. Omitted fields
|
|
1716
|
+
will not be updated. To replace the entire entity, use one
|
|
1717
|
+
path with the string "*" to match all fields.
|
|
1718
|
+
"""
|
|
1719
|
+
|
|
1720
|
+
custom_metric: resources.CustomMetric = proto.Field(
|
|
1721
|
+
proto.MESSAGE,
|
|
1722
|
+
number=1,
|
|
1723
|
+
message=resources.CustomMetric,
|
|
1724
|
+
)
|
|
1725
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1726
|
+
proto.MESSAGE,
|
|
1727
|
+
number=2,
|
|
1728
|
+
message=field_mask_pb2.FieldMask,
|
|
1729
|
+
)
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
class ListCustomMetricsRequest(proto.Message):
|
|
1733
|
+
r"""Request message for ListCustomMetrics RPC.
|
|
1734
|
+
|
|
1735
|
+
Attributes:
|
|
1736
|
+
parent (str):
|
|
1737
|
+
Required. Example format: properties/1234
|
|
1738
|
+
page_size (int):
|
|
1739
|
+
The maximum number of resources to return.
|
|
1740
|
+
If unspecified, at most 50 resources will be
|
|
1741
|
+
returned. The maximum value is 200 (higher
|
|
1742
|
+
values will be coerced to the maximum).
|
|
1743
|
+
page_token (str):
|
|
1744
|
+
A page token, received from a previous ``ListCustomMetrics``
|
|
1745
|
+
call. Provide this to retrieve the subsequent page.
|
|
1746
|
+
|
|
1747
|
+
When paginating, all other parameters provided to
|
|
1748
|
+
``ListCustomMetrics`` must match the call that provided the
|
|
1749
|
+
page token.
|
|
1750
|
+
"""
|
|
1751
|
+
|
|
1752
|
+
parent: str = proto.Field(
|
|
1753
|
+
proto.STRING,
|
|
1754
|
+
number=1,
|
|
1755
|
+
)
|
|
1756
|
+
page_size: int = proto.Field(
|
|
1757
|
+
proto.INT32,
|
|
1758
|
+
number=2,
|
|
1759
|
+
)
|
|
1760
|
+
page_token: str = proto.Field(
|
|
1761
|
+
proto.STRING,
|
|
1762
|
+
number=3,
|
|
1763
|
+
)
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
class ListCustomMetricsResponse(proto.Message):
|
|
1767
|
+
r"""Response message for ListCustomMetrics RPC.
|
|
1768
|
+
|
|
1769
|
+
Attributes:
|
|
1770
|
+
custom_metrics (MutableSequence[google.analytics.admin_v1beta.types.CustomMetric]):
|
|
1771
|
+
List of CustomMetrics.
|
|
1772
|
+
next_page_token (str):
|
|
1773
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
1774
|
+
next page. If this field is omitted, there are no subsequent
|
|
1775
|
+
pages.
|
|
1776
|
+
"""
|
|
1777
|
+
|
|
1778
|
+
@property
|
|
1779
|
+
def raw_page(self):
|
|
1780
|
+
return self
|
|
1781
|
+
|
|
1782
|
+
custom_metrics: MutableSequence[resources.CustomMetric] = proto.RepeatedField(
|
|
1783
|
+
proto.MESSAGE,
|
|
1784
|
+
number=1,
|
|
1785
|
+
message=resources.CustomMetric,
|
|
1786
|
+
)
|
|
1787
|
+
next_page_token: str = proto.Field(
|
|
1788
|
+
proto.STRING,
|
|
1789
|
+
number=2,
|
|
1790
|
+
)
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
class ArchiveCustomMetricRequest(proto.Message):
|
|
1794
|
+
r"""Request message for ArchiveCustomMetric RPC.
|
|
1795
|
+
|
|
1796
|
+
Attributes:
|
|
1797
|
+
name (str):
|
|
1798
|
+
Required. The name of the CustomMetric to
|
|
1799
|
+
archive. Example format:
|
|
1800
|
+
properties/1234/customMetrics/5678
|
|
1801
|
+
"""
|
|
1802
|
+
|
|
1803
|
+
name: str = proto.Field(
|
|
1804
|
+
proto.STRING,
|
|
1805
|
+
number=1,
|
|
1806
|
+
)
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
class GetCustomMetricRequest(proto.Message):
|
|
1810
|
+
r"""Request message for GetCustomMetric RPC.
|
|
1811
|
+
|
|
1812
|
+
Attributes:
|
|
1813
|
+
name (str):
|
|
1814
|
+
Required. The name of the CustomMetric to
|
|
1815
|
+
get. Example format:
|
|
1816
|
+
properties/1234/customMetrics/5678
|
|
1817
|
+
"""
|
|
1818
|
+
|
|
1819
|
+
name: str = proto.Field(
|
|
1820
|
+
proto.STRING,
|
|
1821
|
+
number=1,
|
|
1822
|
+
)
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
class GetDataRetentionSettingsRequest(proto.Message):
|
|
1826
|
+
r"""Request message for GetDataRetentionSettings RPC.
|
|
1827
|
+
|
|
1828
|
+
Attributes:
|
|
1829
|
+
name (str):
|
|
1830
|
+
Required. The name of the settings to lookup.
|
|
1831
|
+
Format:
|
|
1832
|
+
|
|
1833
|
+
properties/{property}/dataRetentionSettings
|
|
1834
|
+
Example: "properties/1000/dataRetentionSettings".
|
|
1835
|
+
"""
|
|
1836
|
+
|
|
1837
|
+
name: str = proto.Field(
|
|
1838
|
+
proto.STRING,
|
|
1839
|
+
number=1,
|
|
1840
|
+
)
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
class UpdateDataRetentionSettingsRequest(proto.Message):
|
|
1844
|
+
r"""Request message for UpdateDataRetentionSettings RPC.
|
|
1845
|
+
|
|
1846
|
+
Attributes:
|
|
1847
|
+
data_retention_settings (google.analytics.admin_v1beta.types.DataRetentionSettings):
|
|
1848
|
+
Required. The settings to update. The ``name`` field is used
|
|
1849
|
+
to identify the settings to be updated.
|
|
1850
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1851
|
+
Required. The list of fields to be updated. Field names must
|
|
1852
|
+
be in snake case (e.g., "field_to_update"). Omitted fields
|
|
1853
|
+
will not be updated. To replace the entire entity, use one
|
|
1854
|
+
path with the string "*" to match all fields.
|
|
1855
|
+
"""
|
|
1856
|
+
|
|
1857
|
+
data_retention_settings: resources.DataRetentionSettings = proto.Field(
|
|
1858
|
+
proto.MESSAGE,
|
|
1859
|
+
number=1,
|
|
1860
|
+
message=resources.DataRetentionSettings,
|
|
1861
|
+
)
|
|
1862
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1863
|
+
proto.MESSAGE,
|
|
1864
|
+
number=2,
|
|
1865
|
+
message=field_mask_pb2.FieldMask,
|
|
1866
|
+
)
|
|
1867
|
+
|
|
1868
|
+
|
|
1869
|
+
class CreateDataStreamRequest(proto.Message):
|
|
1870
|
+
r"""Request message for CreateDataStream RPC.
|
|
1871
|
+
|
|
1872
|
+
Attributes:
|
|
1873
|
+
parent (str):
|
|
1874
|
+
Required. Example format: properties/1234
|
|
1875
|
+
data_stream (google.analytics.admin_v1beta.types.DataStream):
|
|
1876
|
+
Required. The DataStream to create.
|
|
1877
|
+
"""
|
|
1878
|
+
|
|
1879
|
+
parent: str = proto.Field(
|
|
1880
|
+
proto.STRING,
|
|
1881
|
+
number=1,
|
|
1882
|
+
)
|
|
1883
|
+
data_stream: resources.DataStream = proto.Field(
|
|
1884
|
+
proto.MESSAGE,
|
|
1885
|
+
number=2,
|
|
1886
|
+
message=resources.DataStream,
|
|
1887
|
+
)
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
class DeleteDataStreamRequest(proto.Message):
|
|
1891
|
+
r"""Request message for DeleteDataStream RPC.
|
|
1892
|
+
|
|
1893
|
+
Attributes:
|
|
1894
|
+
name (str):
|
|
1895
|
+
Required. The name of the DataStream to
|
|
1896
|
+
delete. Example format:
|
|
1897
|
+
properties/1234/dataStreams/5678
|
|
1898
|
+
"""
|
|
1899
|
+
|
|
1900
|
+
name: str = proto.Field(
|
|
1901
|
+
proto.STRING,
|
|
1902
|
+
number=1,
|
|
1903
|
+
)
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
class UpdateDataStreamRequest(proto.Message):
|
|
1907
|
+
r"""Request message for UpdateDataStream RPC.
|
|
1908
|
+
|
|
1909
|
+
Attributes:
|
|
1910
|
+
data_stream (google.analytics.admin_v1beta.types.DataStream):
|
|
1911
|
+
The DataStream to update
|
|
1912
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1913
|
+
Required. The list of fields to be updated. Omitted fields
|
|
1914
|
+
will not be updated. To replace the entire entity, use one
|
|
1915
|
+
path with the string "*" to match all fields.
|
|
1916
|
+
"""
|
|
1917
|
+
|
|
1918
|
+
data_stream: resources.DataStream = proto.Field(
|
|
1919
|
+
proto.MESSAGE,
|
|
1920
|
+
number=1,
|
|
1921
|
+
message=resources.DataStream,
|
|
1922
|
+
)
|
|
1923
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1924
|
+
proto.MESSAGE,
|
|
1925
|
+
number=2,
|
|
1926
|
+
message=field_mask_pb2.FieldMask,
|
|
1927
|
+
)
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
class ListDataStreamsRequest(proto.Message):
|
|
1931
|
+
r"""Request message for ListDataStreams RPC.
|
|
1932
|
+
|
|
1933
|
+
Attributes:
|
|
1934
|
+
parent (str):
|
|
1935
|
+
Required. Example format: properties/1234
|
|
1936
|
+
page_size (int):
|
|
1937
|
+
The maximum number of resources to return.
|
|
1938
|
+
If unspecified, at most 50 resources will be
|
|
1939
|
+
returned. The maximum value is 200 (higher
|
|
1940
|
+
values will be coerced to the maximum).
|
|
1941
|
+
page_token (str):
|
|
1942
|
+
A page token, received from a previous ``ListDataStreams``
|
|
1943
|
+
call. Provide this to retrieve the subsequent page.
|
|
1944
|
+
|
|
1945
|
+
When paginating, all other parameters provided to
|
|
1946
|
+
``ListDataStreams`` must match the call that provided the
|
|
1947
|
+
page token.
|
|
1948
|
+
"""
|
|
1949
|
+
|
|
1950
|
+
parent: str = proto.Field(
|
|
1951
|
+
proto.STRING,
|
|
1952
|
+
number=1,
|
|
1953
|
+
)
|
|
1954
|
+
page_size: int = proto.Field(
|
|
1955
|
+
proto.INT32,
|
|
1956
|
+
number=2,
|
|
1957
|
+
)
|
|
1958
|
+
page_token: str = proto.Field(
|
|
1959
|
+
proto.STRING,
|
|
1960
|
+
number=3,
|
|
1961
|
+
)
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
class ListDataStreamsResponse(proto.Message):
|
|
1965
|
+
r"""Response message for ListDataStreams RPC.
|
|
1966
|
+
|
|
1967
|
+
Attributes:
|
|
1968
|
+
data_streams (MutableSequence[google.analytics.admin_v1beta.types.DataStream]):
|
|
1969
|
+
List of DataStreams.
|
|
1970
|
+
next_page_token (str):
|
|
1971
|
+
A token, which can be sent as ``page_token`` to retrieve the
|
|
1972
|
+
next page. If this field is omitted, there are no subsequent
|
|
1973
|
+
pages.
|
|
1974
|
+
"""
|
|
1975
|
+
|
|
1976
|
+
@property
|
|
1977
|
+
def raw_page(self):
|
|
1978
|
+
return self
|
|
1979
|
+
|
|
1980
|
+
data_streams: MutableSequence[resources.DataStream] = proto.RepeatedField(
|
|
1981
|
+
proto.MESSAGE,
|
|
1982
|
+
number=1,
|
|
1983
|
+
message=resources.DataStream,
|
|
1984
|
+
)
|
|
1985
|
+
next_page_token: str = proto.Field(
|
|
1986
|
+
proto.STRING,
|
|
1987
|
+
number=2,
|
|
1988
|
+
)
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
class GetDataStreamRequest(proto.Message):
|
|
1992
|
+
r"""Request message for GetDataStream RPC.
|
|
1993
|
+
|
|
1994
|
+
Attributes:
|
|
1995
|
+
name (str):
|
|
1996
|
+
Required. The name of the DataStream to get.
|
|
1997
|
+
Example format: properties/1234/dataStreams/5678
|
|
1998
|
+
"""
|
|
1999
|
+
|
|
2000
|
+
name: str = proto.Field(
|
|
2001
|
+
proto.STRING,
|
|
2002
|
+
number=1,
|
|
2003
|
+
)
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
__all__ = tuple(sorted(__protobuf__.manifest))
|