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.
Files changed (51) hide show
  1. google/analytics/admin/__init__.py +615 -0
  2. google/analytics/admin/gapic_version.py +16 -0
  3. google/analytics/admin/py.typed +2 -0
  4. google/analytics/admin_v1alpha/__init__.py +613 -0
  5. google/analytics/admin_v1alpha/gapic_metadata.json +2278 -0
  6. google/analytics/admin_v1alpha/gapic_version.py +16 -0
  7. google/analytics/admin_v1alpha/py.typed +2 -0
  8. google/analytics/admin_v1alpha/services/__init__.py +15 -0
  9. google/analytics/admin_v1alpha/services/analytics_admin_service/__init__.py +22 -0
  10. google/analytics/admin_v1alpha/services/analytics_admin_service/async_client.py +14122 -0
  11. google/analytics/admin_v1alpha/services/analytics_admin_service/client.py +14680 -0
  12. google/analytics/admin_v1alpha/services/analytics_admin_service/pagers.py +4337 -0
  13. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/__init__.py +41 -0
  14. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/base.py +2494 -0
  15. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc.py +4797 -0
  16. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/grpc_asyncio.py +5671 -0
  17. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest.py +31875 -0
  18. google/analytics/admin_v1alpha/services/analytics_admin_service/transports/rest_base.py +7944 -0
  19. google/analytics/admin_v1alpha/types/__init__.py +602 -0
  20. google/analytics/admin_v1alpha/types/access_report.py +705 -0
  21. google/analytics/admin_v1alpha/types/analytics_admin.py +4997 -0
  22. google/analytics/admin_v1alpha/types/audience.py +781 -0
  23. google/analytics/admin_v1alpha/types/channel_group.py +309 -0
  24. google/analytics/admin_v1alpha/types/event_create_and_edit.py +298 -0
  25. google/analytics/admin_v1alpha/types/expanded_data_set.py +282 -0
  26. google/analytics/admin_v1alpha/types/resources.py +3289 -0
  27. google/analytics/admin_v1alpha/types/subproperty_event_filter.py +292 -0
  28. google/analytics/admin_v1beta/__init__.py +255 -0
  29. google/analytics/admin_v1beta/gapic_metadata.json +838 -0
  30. google/analytics/admin_v1beta/gapic_version.py +16 -0
  31. google/analytics/admin_v1beta/py.typed +2 -0
  32. google/analytics/admin_v1beta/services/__init__.py +15 -0
  33. google/analytics/admin_v1beta/services/analytics_admin_service/__init__.py +22 -0
  34. google/analytics/admin_v1beta/services/analytics_admin_service/async_client.py +6707 -0
  35. google/analytics/admin_v1beta/services/analytics_admin_service/client.py +7164 -0
  36. google/analytics/admin_v1beta/services/analytics_admin_service/pagers.py +1927 -0
  37. google/analytics/admin_v1beta/services/analytics_admin_service/transports/__init__.py +41 -0
  38. google/analytics/admin_v1beta/services/analytics_admin_service/transports/base.py +965 -0
  39. google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc.py +1917 -0
  40. google/analytics/admin_v1beta/services/analytics_admin_service/transports/grpc_asyncio.py +2251 -0
  41. google/analytics/admin_v1beta/services/analytics_admin_service/transports/rest.py +11423 -0
  42. google/analytics/admin_v1beta/services/analytics_admin_service/transports/rest_base.py +2857 -0
  43. google/analytics/admin_v1beta/types/__init__.py +244 -0
  44. google/analytics/admin_v1beta/types/access_report.py +705 -0
  45. google/analytics/admin_v1beta/types/analytics_admin.py +2006 -0
  46. google/analytics/admin_v1beta/types/resources.py +1677 -0
  47. google_analytics_admin-0.23.6.dist-info/LICENSE +202 -0
  48. google_analytics_admin-0.23.6.dist-info/METADATA +228 -0
  49. google_analytics_admin-0.23.6.dist-info/RECORD +51 -0
  50. google_analytics_admin-0.23.6.dist-info/WHEEL +5 -0
  51. google_analytics_admin-0.23.6.dist-info/top_level.txt +1 -0
@@ -0,0 +1,4997 @@
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_v1alpha.types import channel_group as gaa_channel_group
25
+ from google.analytics.admin_v1alpha.types import (
26
+ expanded_data_set as gaa_expanded_data_set,
27
+ )
28
+ from google.analytics.admin_v1alpha.types import (
29
+ subproperty_event_filter as gaa_subproperty_event_filter,
30
+ )
31
+ from google.analytics.admin_v1alpha.types import access_report
32
+ from google.analytics.admin_v1alpha.types import audience as gaa_audience
33
+ from google.analytics.admin_v1alpha.types import event_create_and_edit
34
+ from google.analytics.admin_v1alpha.types import resources
35
+
36
+ __protobuf__ = proto.module(
37
+ package="google.analytics.admin.v1alpha",
38
+ manifest={
39
+ "RunAccessReportRequest",
40
+ "RunAccessReportResponse",
41
+ "GetAccountRequest",
42
+ "ListAccountsRequest",
43
+ "ListAccountsResponse",
44
+ "DeleteAccountRequest",
45
+ "UpdateAccountRequest",
46
+ "ProvisionAccountTicketRequest",
47
+ "ProvisionAccountTicketResponse",
48
+ "GetPropertyRequest",
49
+ "ListPropertiesRequest",
50
+ "ListPropertiesResponse",
51
+ "UpdatePropertyRequest",
52
+ "CreatePropertyRequest",
53
+ "DeletePropertyRequest",
54
+ "CreateFirebaseLinkRequest",
55
+ "DeleteFirebaseLinkRequest",
56
+ "ListFirebaseLinksRequest",
57
+ "ListFirebaseLinksResponse",
58
+ "GetGlobalSiteTagRequest",
59
+ "CreateGoogleAdsLinkRequest",
60
+ "UpdateGoogleAdsLinkRequest",
61
+ "DeleteGoogleAdsLinkRequest",
62
+ "ListGoogleAdsLinksRequest",
63
+ "ListGoogleAdsLinksResponse",
64
+ "GetDataSharingSettingsRequest",
65
+ "ListAccountSummariesRequest",
66
+ "ListAccountSummariesResponse",
67
+ "AcknowledgeUserDataCollectionRequest",
68
+ "AcknowledgeUserDataCollectionResponse",
69
+ "SearchChangeHistoryEventsRequest",
70
+ "SearchChangeHistoryEventsResponse",
71
+ "GetMeasurementProtocolSecretRequest",
72
+ "CreateMeasurementProtocolSecretRequest",
73
+ "DeleteMeasurementProtocolSecretRequest",
74
+ "UpdateMeasurementProtocolSecretRequest",
75
+ "ListMeasurementProtocolSecretsRequest",
76
+ "ListMeasurementProtocolSecretsResponse",
77
+ "GetSKAdNetworkConversionValueSchemaRequest",
78
+ "CreateSKAdNetworkConversionValueSchemaRequest",
79
+ "DeleteSKAdNetworkConversionValueSchemaRequest",
80
+ "UpdateSKAdNetworkConversionValueSchemaRequest",
81
+ "ListSKAdNetworkConversionValueSchemasRequest",
82
+ "ListSKAdNetworkConversionValueSchemasResponse",
83
+ "GetGoogleSignalsSettingsRequest",
84
+ "UpdateGoogleSignalsSettingsRequest",
85
+ "CreateConversionEventRequest",
86
+ "UpdateConversionEventRequest",
87
+ "GetConversionEventRequest",
88
+ "DeleteConversionEventRequest",
89
+ "ListConversionEventsRequest",
90
+ "ListConversionEventsResponse",
91
+ "CreateKeyEventRequest",
92
+ "UpdateKeyEventRequest",
93
+ "GetKeyEventRequest",
94
+ "DeleteKeyEventRequest",
95
+ "ListKeyEventsRequest",
96
+ "ListKeyEventsResponse",
97
+ "GetDisplayVideo360AdvertiserLinkRequest",
98
+ "ListDisplayVideo360AdvertiserLinksRequest",
99
+ "ListDisplayVideo360AdvertiserLinksResponse",
100
+ "CreateDisplayVideo360AdvertiserLinkRequest",
101
+ "DeleteDisplayVideo360AdvertiserLinkRequest",
102
+ "UpdateDisplayVideo360AdvertiserLinkRequest",
103
+ "GetDisplayVideo360AdvertiserLinkProposalRequest",
104
+ "ListDisplayVideo360AdvertiserLinkProposalsRequest",
105
+ "ListDisplayVideo360AdvertiserLinkProposalsResponse",
106
+ "CreateDisplayVideo360AdvertiserLinkProposalRequest",
107
+ "DeleteDisplayVideo360AdvertiserLinkProposalRequest",
108
+ "ApproveDisplayVideo360AdvertiserLinkProposalRequest",
109
+ "ApproveDisplayVideo360AdvertiserLinkProposalResponse",
110
+ "CancelDisplayVideo360AdvertiserLinkProposalRequest",
111
+ "GetSearchAds360LinkRequest",
112
+ "ListSearchAds360LinksRequest",
113
+ "ListSearchAds360LinksResponse",
114
+ "CreateSearchAds360LinkRequest",
115
+ "DeleteSearchAds360LinkRequest",
116
+ "UpdateSearchAds360LinkRequest",
117
+ "CreateCustomDimensionRequest",
118
+ "UpdateCustomDimensionRequest",
119
+ "ListCustomDimensionsRequest",
120
+ "ListCustomDimensionsResponse",
121
+ "ArchiveCustomDimensionRequest",
122
+ "GetCustomDimensionRequest",
123
+ "CreateCustomMetricRequest",
124
+ "UpdateCustomMetricRequest",
125
+ "ListCustomMetricsRequest",
126
+ "ListCustomMetricsResponse",
127
+ "ArchiveCustomMetricRequest",
128
+ "GetCustomMetricRequest",
129
+ "CreateCalculatedMetricRequest",
130
+ "UpdateCalculatedMetricRequest",
131
+ "DeleteCalculatedMetricRequest",
132
+ "ListCalculatedMetricsRequest",
133
+ "ListCalculatedMetricsResponse",
134
+ "GetCalculatedMetricRequest",
135
+ "GetDataRetentionSettingsRequest",
136
+ "UpdateDataRetentionSettingsRequest",
137
+ "CreateDataStreamRequest",
138
+ "DeleteDataStreamRequest",
139
+ "UpdateDataStreamRequest",
140
+ "ListDataStreamsRequest",
141
+ "ListDataStreamsResponse",
142
+ "GetDataStreamRequest",
143
+ "GetAudienceRequest",
144
+ "ListAudiencesRequest",
145
+ "ListAudiencesResponse",
146
+ "CreateAudienceRequest",
147
+ "UpdateAudienceRequest",
148
+ "ArchiveAudienceRequest",
149
+ "GetAttributionSettingsRequest",
150
+ "UpdateAttributionSettingsRequest",
151
+ "GetAccessBindingRequest",
152
+ "BatchGetAccessBindingsRequest",
153
+ "BatchGetAccessBindingsResponse",
154
+ "ListAccessBindingsRequest",
155
+ "ListAccessBindingsResponse",
156
+ "CreateAccessBindingRequest",
157
+ "BatchCreateAccessBindingsRequest",
158
+ "BatchCreateAccessBindingsResponse",
159
+ "UpdateAccessBindingRequest",
160
+ "BatchUpdateAccessBindingsRequest",
161
+ "BatchUpdateAccessBindingsResponse",
162
+ "DeleteAccessBindingRequest",
163
+ "BatchDeleteAccessBindingsRequest",
164
+ "CreateExpandedDataSetRequest",
165
+ "UpdateExpandedDataSetRequest",
166
+ "DeleteExpandedDataSetRequest",
167
+ "GetExpandedDataSetRequest",
168
+ "ListExpandedDataSetsRequest",
169
+ "ListExpandedDataSetsResponse",
170
+ "CreateChannelGroupRequest",
171
+ "UpdateChannelGroupRequest",
172
+ "DeleteChannelGroupRequest",
173
+ "GetChannelGroupRequest",
174
+ "ListChannelGroupsRequest",
175
+ "ListChannelGroupsResponse",
176
+ "SetAutomatedGa4ConfigurationOptOutRequest",
177
+ "SetAutomatedGa4ConfigurationOptOutResponse",
178
+ "FetchAutomatedGa4ConfigurationOptOutRequest",
179
+ "FetchAutomatedGa4ConfigurationOptOutResponse",
180
+ "CreateBigQueryLinkRequest",
181
+ "GetBigQueryLinkRequest",
182
+ "ListBigQueryLinksRequest",
183
+ "ListBigQueryLinksResponse",
184
+ "UpdateBigQueryLinkRequest",
185
+ "DeleteBigQueryLinkRequest",
186
+ "GetEnhancedMeasurementSettingsRequest",
187
+ "UpdateEnhancedMeasurementSettingsRequest",
188
+ "GetDataRedactionSettingsRequest",
189
+ "UpdateDataRedactionSettingsRequest",
190
+ "CreateConnectedSiteTagRequest",
191
+ "CreateConnectedSiteTagResponse",
192
+ "DeleteConnectedSiteTagRequest",
193
+ "ListConnectedSiteTagsRequest",
194
+ "ListConnectedSiteTagsResponse",
195
+ "CreateAdSenseLinkRequest",
196
+ "GetAdSenseLinkRequest",
197
+ "DeleteAdSenseLinkRequest",
198
+ "ListAdSenseLinksRequest",
199
+ "ListAdSenseLinksResponse",
200
+ "FetchConnectedGa4PropertyRequest",
201
+ "FetchConnectedGa4PropertyResponse",
202
+ "CreateEventCreateRuleRequest",
203
+ "UpdateEventCreateRuleRequest",
204
+ "DeleteEventCreateRuleRequest",
205
+ "GetEventCreateRuleRequest",
206
+ "ListEventCreateRulesRequest",
207
+ "ListEventCreateRulesResponse",
208
+ "CreateEventEditRuleRequest",
209
+ "UpdateEventEditRuleRequest",
210
+ "DeleteEventEditRuleRequest",
211
+ "GetEventEditRuleRequest",
212
+ "ListEventEditRulesRequest",
213
+ "ListEventEditRulesResponse",
214
+ "ReorderEventEditRulesRequest",
215
+ "CreateRollupPropertyRequest",
216
+ "CreateRollupPropertyResponse",
217
+ "GetRollupPropertySourceLinkRequest",
218
+ "ListRollupPropertySourceLinksRequest",
219
+ "ListRollupPropertySourceLinksResponse",
220
+ "CreateRollupPropertySourceLinkRequest",
221
+ "DeleteRollupPropertySourceLinkRequest",
222
+ "ProvisionSubpropertyRequest",
223
+ "ProvisionSubpropertyResponse",
224
+ "CreateSubpropertyEventFilterRequest",
225
+ "GetSubpropertyEventFilterRequest",
226
+ "ListSubpropertyEventFiltersRequest",
227
+ "ListSubpropertyEventFiltersResponse",
228
+ "UpdateSubpropertyEventFilterRequest",
229
+ "DeleteSubpropertyEventFilterRequest",
230
+ },
231
+ )
232
+
233
+
234
+ class RunAccessReportRequest(proto.Message):
235
+ r"""The request for a Data Access Record Report.
236
+
237
+ Attributes:
238
+ entity (str):
239
+ The Data Access Report supports requesting at
240
+ the property level or account level. If
241
+ requested at the account level, Data Access
242
+ Reports include all access for all properties
243
+ under that account.
244
+
245
+ To request at the property level, entity should
246
+ be for example 'properties/123' if "123" is your
247
+ Google Analytics property ID. To request at the
248
+ account level, entity should be for example
249
+ 'accounts/1234' if "1234" is your Google
250
+ Analytics Account ID.
251
+ dimensions (MutableSequence[google.analytics.admin_v1alpha.types.AccessDimension]):
252
+ The dimensions requested and displayed in the
253
+ response. Requests are allowed up to 9
254
+ dimensions.
255
+ metrics (MutableSequence[google.analytics.admin_v1alpha.types.AccessMetric]):
256
+ The metrics requested and displayed in the
257
+ response. Requests are allowed up to 10 metrics.
258
+ date_ranges (MutableSequence[google.analytics.admin_v1alpha.types.AccessDateRange]):
259
+ Date ranges of access records to read. If
260
+ multiple date ranges are requested, each
261
+ response row will contain a zero based date
262
+ range index. If two date ranges overlap, the
263
+ access records for the overlapping days is
264
+ included in the response rows for both date
265
+ ranges. Requests are allowed up to 2 date
266
+ ranges.
267
+ dimension_filter (google.analytics.admin_v1alpha.types.AccessFilterExpression):
268
+ Dimension filters let you restrict report response to
269
+ specific dimension values which match the filter. For
270
+ example, filtering on access records of a single user. To
271
+ learn more, see `Fundamentals of Dimension
272
+ Filters <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters>`__
273
+ for examples. Metrics cannot be used in this filter.
274
+ metric_filter (google.analytics.admin_v1alpha.types.AccessFilterExpression):
275
+ Metric filters allow you to restrict report
276
+ response to specific metric values which match
277
+ the filter. Metric filters are applied after
278
+ aggregating the report's rows, similar to SQL
279
+ having-clause. Dimensions cannot be used in this
280
+ filter.
281
+ offset (int):
282
+ The row count of the start row. The first row is counted as
283
+ row 0. If offset is unspecified, it is treated as 0. If
284
+ offset is zero, then this method will return the first page
285
+ of results with ``limit`` entries.
286
+
287
+ To learn more about this pagination parameter, see
288
+ `Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
289
+ limit (int):
290
+ The number of rows to return. If unspecified, 10,000 rows
291
+ are returned. The API returns a maximum of 100,000 rows per
292
+ request, no matter how many you ask for. ``limit`` must be
293
+ positive.
294
+
295
+ The API may return fewer rows than the requested ``limit``,
296
+ if there aren't as many remaining rows as the ``limit``. For
297
+ instance, there are fewer than 300 possible values for the
298
+ dimension ``country``, so when reporting on only
299
+ ``country``, you can't get more than 300 rows, even if you
300
+ set ``limit`` to a higher value.
301
+
302
+ To learn more about this pagination parameter, see
303
+ `Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
304
+ time_zone (str):
305
+ This request's time zone if specified. If unspecified, the
306
+ property's time zone is used. The request's time zone is
307
+ used to interpret the start & end dates of the report.
308
+
309
+ Formatted as strings from the IANA Time Zone database
310
+ (https://www.iana.org/time-zones); for example
311
+ "America/New_York" or "Asia/Tokyo".
312
+ order_bys (MutableSequence[google.analytics.admin_v1alpha.types.AccessOrderBy]):
313
+ Specifies how rows are ordered in the
314
+ response.
315
+ return_entity_quota (bool):
316
+ Toggles whether to return the current state of this
317
+ Analytics Property's quota. Quota is returned in
318
+ `AccessQuota <#AccessQuota>`__. For account-level requests,
319
+ this field must be false.
320
+ include_all_users (bool):
321
+ Optional. Determines whether to include users
322
+ who have never made an API call in the response.
323
+ If true, all users with access to the specified
324
+ property or account are included in the
325
+ response, regardless of whether they have made
326
+ an API call or not. If false, only the users who
327
+ have made an API call will be included.
328
+ expand_groups (bool):
329
+ Optional. Decides whether to return the users within user
330
+ groups. This field works only when include_all_users is set
331
+ to true. If true, it will return all users with access to
332
+ the specified property or account. If false, only the users
333
+ with direct access will be returned.
334
+ """
335
+
336
+ entity: str = proto.Field(
337
+ proto.STRING,
338
+ number=1,
339
+ )
340
+ dimensions: MutableSequence[access_report.AccessDimension] = proto.RepeatedField(
341
+ proto.MESSAGE,
342
+ number=2,
343
+ message=access_report.AccessDimension,
344
+ )
345
+ metrics: MutableSequence[access_report.AccessMetric] = proto.RepeatedField(
346
+ proto.MESSAGE,
347
+ number=3,
348
+ message=access_report.AccessMetric,
349
+ )
350
+ date_ranges: MutableSequence[access_report.AccessDateRange] = proto.RepeatedField(
351
+ proto.MESSAGE,
352
+ number=4,
353
+ message=access_report.AccessDateRange,
354
+ )
355
+ dimension_filter: access_report.AccessFilterExpression = proto.Field(
356
+ proto.MESSAGE,
357
+ number=5,
358
+ message=access_report.AccessFilterExpression,
359
+ )
360
+ metric_filter: access_report.AccessFilterExpression = proto.Field(
361
+ proto.MESSAGE,
362
+ number=6,
363
+ message=access_report.AccessFilterExpression,
364
+ )
365
+ offset: int = proto.Field(
366
+ proto.INT64,
367
+ number=7,
368
+ )
369
+ limit: int = proto.Field(
370
+ proto.INT64,
371
+ number=8,
372
+ )
373
+ time_zone: str = proto.Field(
374
+ proto.STRING,
375
+ number=9,
376
+ )
377
+ order_bys: MutableSequence[access_report.AccessOrderBy] = proto.RepeatedField(
378
+ proto.MESSAGE,
379
+ number=10,
380
+ message=access_report.AccessOrderBy,
381
+ )
382
+ return_entity_quota: bool = proto.Field(
383
+ proto.BOOL,
384
+ number=11,
385
+ )
386
+ include_all_users: bool = proto.Field(
387
+ proto.BOOL,
388
+ number=12,
389
+ )
390
+ expand_groups: bool = proto.Field(
391
+ proto.BOOL,
392
+ number=13,
393
+ )
394
+
395
+
396
+ class RunAccessReportResponse(proto.Message):
397
+ r"""The customized Data Access Record Report response.
398
+
399
+ Attributes:
400
+ dimension_headers (MutableSequence[google.analytics.admin_v1alpha.types.AccessDimensionHeader]):
401
+ The header for a column in the report that
402
+ corresponds to a specific dimension. The number
403
+ of DimensionHeaders and ordering of
404
+ DimensionHeaders matches the dimensions present
405
+ in rows.
406
+ metric_headers (MutableSequence[google.analytics.admin_v1alpha.types.AccessMetricHeader]):
407
+ The header for a column in the report that
408
+ corresponds to a specific metric. The number of
409
+ MetricHeaders and ordering of MetricHeaders
410
+ matches the metrics present in rows.
411
+ rows (MutableSequence[google.analytics.admin_v1alpha.types.AccessRow]):
412
+ Rows of dimension value combinations and
413
+ metric values in the report.
414
+ row_count (int):
415
+ The total number of rows in the query result. ``rowCount``
416
+ is independent of the number of rows returned in the
417
+ response, the ``limit`` request parameter, and the
418
+ ``offset`` request parameter. For example if a query returns
419
+ 175 rows and includes ``limit`` of 50 in the API request,
420
+ the response will contain ``rowCount`` of 175 but only 50
421
+ rows.
422
+
423
+ To learn more about this pagination parameter, see
424
+ `Pagination <https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination>`__.
425
+ quota (google.analytics.admin_v1alpha.types.AccessQuota):
426
+ The quota state for this Analytics property
427
+ including this request. This field doesn't work
428
+ with account-level requests.
429
+ """
430
+
431
+ dimension_headers: MutableSequence[
432
+ access_report.AccessDimensionHeader
433
+ ] = proto.RepeatedField(
434
+ proto.MESSAGE,
435
+ number=1,
436
+ message=access_report.AccessDimensionHeader,
437
+ )
438
+ metric_headers: MutableSequence[
439
+ access_report.AccessMetricHeader
440
+ ] = proto.RepeatedField(
441
+ proto.MESSAGE,
442
+ number=2,
443
+ message=access_report.AccessMetricHeader,
444
+ )
445
+ rows: MutableSequence[access_report.AccessRow] = proto.RepeatedField(
446
+ proto.MESSAGE,
447
+ number=3,
448
+ message=access_report.AccessRow,
449
+ )
450
+ row_count: int = proto.Field(
451
+ proto.INT32,
452
+ number=4,
453
+ )
454
+ quota: access_report.AccessQuota = proto.Field(
455
+ proto.MESSAGE,
456
+ number=5,
457
+ message=access_report.AccessQuota,
458
+ )
459
+
460
+
461
+ class GetAccountRequest(proto.Message):
462
+ r"""Request message for GetAccount RPC.
463
+
464
+ Attributes:
465
+ name (str):
466
+ Required. The name of the account to lookup.
467
+ Format: accounts/{account}
468
+ Example: "accounts/100".
469
+ """
470
+
471
+ name: str = proto.Field(
472
+ proto.STRING,
473
+ number=1,
474
+ )
475
+
476
+
477
+ class ListAccountsRequest(proto.Message):
478
+ r"""Request message for ListAccounts RPC.
479
+
480
+ Attributes:
481
+ page_size (int):
482
+ The maximum number of resources to return.
483
+ The service may return fewer than this value,
484
+ even if there are additional pages. If
485
+ unspecified, at most 50 resources will be
486
+ returned. The maximum value is 200; (higher
487
+ values will be coerced to the maximum)
488
+ page_token (str):
489
+ A page token, received from a previous ``ListAccounts``
490
+ call. Provide this to retrieve the subsequent page. When
491
+ paginating, all other parameters provided to
492
+ ``ListAccounts`` must match the call that provided the page
493
+ token.
494
+ show_deleted (bool):
495
+ Whether to include soft-deleted (ie:
496
+ "trashed") Accounts in the results. Accounts can
497
+ be inspected to determine whether they are
498
+ deleted or not.
499
+ """
500
+
501
+ page_size: int = proto.Field(
502
+ proto.INT32,
503
+ number=1,
504
+ )
505
+ page_token: str = proto.Field(
506
+ proto.STRING,
507
+ number=2,
508
+ )
509
+ show_deleted: bool = proto.Field(
510
+ proto.BOOL,
511
+ number=3,
512
+ )
513
+
514
+
515
+ class ListAccountsResponse(proto.Message):
516
+ r"""Request message for ListAccounts RPC.
517
+
518
+ Attributes:
519
+ accounts (MutableSequence[google.analytics.admin_v1alpha.types.Account]):
520
+ Results that were accessible to the caller.
521
+ next_page_token (str):
522
+ A token, which can be sent as ``page_token`` to retrieve the
523
+ next page. If this field is omitted, there are no subsequent
524
+ pages.
525
+ """
526
+
527
+ @property
528
+ def raw_page(self):
529
+ return self
530
+
531
+ accounts: MutableSequence[resources.Account] = proto.RepeatedField(
532
+ proto.MESSAGE,
533
+ number=1,
534
+ message=resources.Account,
535
+ )
536
+ next_page_token: str = proto.Field(
537
+ proto.STRING,
538
+ number=2,
539
+ )
540
+
541
+
542
+ class DeleteAccountRequest(proto.Message):
543
+ r"""Request message for DeleteAccount RPC.
544
+
545
+ Attributes:
546
+ name (str):
547
+ Required. The name of the Account to
548
+ soft-delete. Format: accounts/{account}
549
+ Example: "accounts/100".
550
+ """
551
+
552
+ name: str = proto.Field(
553
+ proto.STRING,
554
+ number=1,
555
+ )
556
+
557
+
558
+ class UpdateAccountRequest(proto.Message):
559
+ r"""Request message for UpdateAccount RPC.
560
+
561
+ Attributes:
562
+ account (google.analytics.admin_v1alpha.types.Account):
563
+ Required. The account to update. The account's ``name``
564
+ field is used to identify the account.
565
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
566
+ Required. The list of fields to be updated. Field names must
567
+ be in snake case (for example, "field_to_update"). Omitted
568
+ fields will not be updated. To replace the entire entity,
569
+ use one path with the string "*" to match all fields.
570
+ """
571
+
572
+ account: resources.Account = proto.Field(
573
+ proto.MESSAGE,
574
+ number=1,
575
+ message=resources.Account,
576
+ )
577
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
578
+ proto.MESSAGE,
579
+ number=2,
580
+ message=field_mask_pb2.FieldMask,
581
+ )
582
+
583
+
584
+ class ProvisionAccountTicketRequest(proto.Message):
585
+ r"""Request message for ProvisionAccountTicket RPC.
586
+
587
+ Attributes:
588
+ account (google.analytics.admin_v1alpha.types.Account):
589
+ The account to create.
590
+ redirect_uri (str):
591
+ Redirect URI where the user will be sent
592
+ after accepting Terms of Service. Must be
593
+ configured in Cloud Console as a Redirect URI.
594
+ """
595
+
596
+ account: resources.Account = proto.Field(
597
+ proto.MESSAGE,
598
+ number=1,
599
+ message=resources.Account,
600
+ )
601
+ redirect_uri: str = proto.Field(
602
+ proto.STRING,
603
+ number=2,
604
+ )
605
+
606
+
607
+ class ProvisionAccountTicketResponse(proto.Message):
608
+ r"""Response message for ProvisionAccountTicket RPC.
609
+
610
+ Attributes:
611
+ account_ticket_id (str):
612
+ The param to be passed in the ToS link.
613
+ """
614
+
615
+ account_ticket_id: str = proto.Field(
616
+ proto.STRING,
617
+ number=1,
618
+ )
619
+
620
+
621
+ class GetPropertyRequest(proto.Message):
622
+ r"""Request message for GetProperty RPC.
623
+
624
+ Attributes:
625
+ name (str):
626
+ Required. The name of the property to lookup. Format:
627
+ properties/{property_id} Example: "properties/1000".
628
+ """
629
+
630
+ name: str = proto.Field(
631
+ proto.STRING,
632
+ number=1,
633
+ )
634
+
635
+
636
+ class ListPropertiesRequest(proto.Message):
637
+ r"""Request message for ListProperties RPC.
638
+
639
+ Attributes:
640
+ filter (str):
641
+ Required. An expression for filtering the results of the
642
+ request. Fields eligible for filtering are:
643
+ ``parent:``\ (The resource name of the parent
644
+ account/property) or ``ancestor:``\ (The resource name of
645
+ the parent account) or ``firebase_project:``\ (The id or
646
+ number of the linked firebase project). Some examples of
647
+ filters:
648
+
649
+ ::
650
+
651
+ | Filter | Description |
652
+ |-----------------------------|-------------------------------------------|
653
+ | parent:accounts/123 | The account with account id: 123. |
654
+ | parent:properties/123 | The property with property id: 123. |
655
+ | ancestor:accounts/123 | The account with account id: 123. |
656
+ | firebase_project:project-id | The firebase project with id: project-id. |
657
+ | firebase_project:123 | The firebase project with number: 123. |
658
+ page_size (int):
659
+ The maximum number of resources to return.
660
+ The service may return fewer than this value,
661
+ even if there are additional pages. If
662
+ unspecified, at most 50 resources will be
663
+ returned. The maximum value is 200; (higher
664
+ values will be coerced to the maximum)
665
+ page_token (str):
666
+ A page token, received from a previous ``ListProperties``
667
+ call. Provide this to retrieve the subsequent page. When
668
+ paginating, all other parameters provided to
669
+ ``ListProperties`` must match the call that provided the
670
+ page token.
671
+ show_deleted (bool):
672
+ Whether to include soft-deleted (ie:
673
+ "trashed") Properties in the results. Properties
674
+ can be inspected to determine whether they are
675
+ deleted or not.
676
+ """
677
+
678
+ filter: str = proto.Field(
679
+ proto.STRING,
680
+ number=1,
681
+ )
682
+ page_size: int = proto.Field(
683
+ proto.INT32,
684
+ number=2,
685
+ )
686
+ page_token: str = proto.Field(
687
+ proto.STRING,
688
+ number=3,
689
+ )
690
+ show_deleted: bool = proto.Field(
691
+ proto.BOOL,
692
+ number=4,
693
+ )
694
+
695
+
696
+ class ListPropertiesResponse(proto.Message):
697
+ r"""Response message for ListProperties RPC.
698
+
699
+ Attributes:
700
+ properties (MutableSequence[google.analytics.admin_v1alpha.types.Property]):
701
+ Results that matched the filter criteria and
702
+ were accessible to the caller.
703
+ next_page_token (str):
704
+ A token, which can be sent as ``page_token`` to retrieve the
705
+ next page. If this field is omitted, there are no subsequent
706
+ pages.
707
+ """
708
+
709
+ @property
710
+ def raw_page(self):
711
+ return self
712
+
713
+ properties: MutableSequence[resources.Property] = proto.RepeatedField(
714
+ proto.MESSAGE,
715
+ number=1,
716
+ message=resources.Property,
717
+ )
718
+ next_page_token: str = proto.Field(
719
+ proto.STRING,
720
+ number=2,
721
+ )
722
+
723
+
724
+ class UpdatePropertyRequest(proto.Message):
725
+ r"""Request message for UpdateProperty RPC.
726
+
727
+ Attributes:
728
+ property (google.analytics.admin_v1alpha.types.Property):
729
+ Required. The property to update. The property's ``name``
730
+ field is used to identify the property to be updated.
731
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
732
+ Required. The list of fields to be updated. Field names must
733
+ be in snake case (e.g., "field_to_update"). Omitted fields
734
+ will not be updated. To replace the entire entity, use one
735
+ path with the string "*" to match all fields.
736
+ """
737
+
738
+ property: resources.Property = proto.Field(
739
+ proto.MESSAGE,
740
+ number=1,
741
+ message=resources.Property,
742
+ )
743
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
744
+ proto.MESSAGE,
745
+ number=2,
746
+ message=field_mask_pb2.FieldMask,
747
+ )
748
+
749
+
750
+ class CreatePropertyRequest(proto.Message):
751
+ r"""Request message for CreateProperty RPC.
752
+
753
+ Attributes:
754
+ property (google.analytics.admin_v1alpha.types.Property):
755
+ Required. The property to create.
756
+ Note: the supplied property must specify its
757
+ parent.
758
+ """
759
+
760
+ property: resources.Property = proto.Field(
761
+ proto.MESSAGE,
762
+ number=1,
763
+ message=resources.Property,
764
+ )
765
+
766
+
767
+ class DeletePropertyRequest(proto.Message):
768
+ r"""Request message for DeleteProperty RPC.
769
+
770
+ Attributes:
771
+ name (str):
772
+ Required. The name of the Property to soft-delete. Format:
773
+ properties/{property_id} Example: "properties/1000".
774
+ """
775
+
776
+ name: str = proto.Field(
777
+ proto.STRING,
778
+ number=1,
779
+ )
780
+
781
+
782
+ class CreateFirebaseLinkRequest(proto.Message):
783
+ r"""Request message for CreateFirebaseLink RPC
784
+
785
+ Attributes:
786
+ parent (str):
787
+ Required. Format: properties/{property_id}
788
+
789
+ Example: ``properties/1234``
790
+ firebase_link (google.analytics.admin_v1alpha.types.FirebaseLink):
791
+ Required. The Firebase link to create.
792
+ """
793
+
794
+ parent: str = proto.Field(
795
+ proto.STRING,
796
+ number=1,
797
+ )
798
+ firebase_link: resources.FirebaseLink = proto.Field(
799
+ proto.MESSAGE,
800
+ number=2,
801
+ message=resources.FirebaseLink,
802
+ )
803
+
804
+
805
+ class DeleteFirebaseLinkRequest(proto.Message):
806
+ r"""Request message for DeleteFirebaseLink RPC
807
+
808
+ Attributes:
809
+ name (str):
810
+ Required. Format:
811
+ properties/{property_id}/firebaseLinks/{firebase_link_id}
812
+
813
+ Example: ``properties/1234/firebaseLinks/5678``
814
+ """
815
+
816
+ name: str = proto.Field(
817
+ proto.STRING,
818
+ number=1,
819
+ )
820
+
821
+
822
+ class ListFirebaseLinksRequest(proto.Message):
823
+ r"""Request message for ListFirebaseLinks RPC
824
+
825
+ Attributes:
826
+ parent (str):
827
+ Required. Format: properties/{property_id}
828
+
829
+ Example: ``properties/1234``
830
+ page_size (int):
831
+ The maximum number of resources to return.
832
+ The service may return fewer than this value,
833
+ even if there are additional pages. If
834
+ unspecified, at most 50 resources will be
835
+ returned. The maximum value is 200; (higher
836
+ values will be coerced to the maximum)
837
+ page_token (str):
838
+ A page token, received from a previous ``ListFirebaseLinks``
839
+ call. Provide this to retrieve the subsequent page. When
840
+ paginating, all other parameters provided to
841
+ ``ListFirebaseLinks`` must match the call that provided the
842
+ page token.
843
+ """
844
+
845
+ parent: str = proto.Field(
846
+ proto.STRING,
847
+ number=1,
848
+ )
849
+ page_size: int = proto.Field(
850
+ proto.INT32,
851
+ number=2,
852
+ )
853
+ page_token: str = proto.Field(
854
+ proto.STRING,
855
+ number=3,
856
+ )
857
+
858
+
859
+ class ListFirebaseLinksResponse(proto.Message):
860
+ r"""Response message for ListFirebaseLinks RPC
861
+
862
+ Attributes:
863
+ firebase_links (MutableSequence[google.analytics.admin_v1alpha.types.FirebaseLink]):
864
+ List of FirebaseLinks. This will have at most
865
+ one value.
866
+ next_page_token (str):
867
+ A token, which can be sent as ``page_token`` to retrieve the
868
+ next page. If this field is omitted, there are no subsequent
869
+ pages. Currently, Google Analytics supports only one
870
+ FirebaseLink per property, so this will never be populated.
871
+ """
872
+
873
+ @property
874
+ def raw_page(self):
875
+ return self
876
+
877
+ firebase_links: MutableSequence[resources.FirebaseLink] = proto.RepeatedField(
878
+ proto.MESSAGE,
879
+ number=1,
880
+ message=resources.FirebaseLink,
881
+ )
882
+ next_page_token: str = proto.Field(
883
+ proto.STRING,
884
+ number=2,
885
+ )
886
+
887
+
888
+ class GetGlobalSiteTagRequest(proto.Message):
889
+ r"""Request message for GetGlobalSiteTag RPC.
890
+
891
+ Attributes:
892
+ name (str):
893
+ Required. The name of the site tag to lookup. Note that site
894
+ tags are singletons and do not have unique IDs. Format:
895
+ properties/{property_id}/dataStreams/{stream_id}/globalSiteTag
896
+
897
+ Example: ``properties/123/dataStreams/456/globalSiteTag``
898
+ """
899
+
900
+ name: str = proto.Field(
901
+ proto.STRING,
902
+ number=1,
903
+ )
904
+
905
+
906
+ class CreateGoogleAdsLinkRequest(proto.Message):
907
+ r"""Request message for CreateGoogleAdsLink RPC
908
+
909
+ Attributes:
910
+ parent (str):
911
+ Required. Example format: properties/1234
912
+ google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink):
913
+ Required. The GoogleAdsLink to create.
914
+ """
915
+
916
+ parent: str = proto.Field(
917
+ proto.STRING,
918
+ number=1,
919
+ )
920
+ google_ads_link: resources.GoogleAdsLink = proto.Field(
921
+ proto.MESSAGE,
922
+ number=2,
923
+ message=resources.GoogleAdsLink,
924
+ )
925
+
926
+
927
+ class UpdateGoogleAdsLinkRequest(proto.Message):
928
+ r"""Request message for UpdateGoogleAdsLink RPC
929
+
930
+ Attributes:
931
+ google_ads_link (google.analytics.admin_v1alpha.types.GoogleAdsLink):
932
+ The GoogleAdsLink to update
933
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
934
+ Required. The list of fields to be updated. Field names must
935
+ be in snake case (e.g., "field_to_update"). Omitted fields
936
+ will not be updated. To replace the entire entity, use one
937
+ path with the string "*" to match all fields.
938
+ """
939
+
940
+ google_ads_link: resources.GoogleAdsLink = proto.Field(
941
+ proto.MESSAGE,
942
+ number=1,
943
+ message=resources.GoogleAdsLink,
944
+ )
945
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
946
+ proto.MESSAGE,
947
+ number=2,
948
+ message=field_mask_pb2.FieldMask,
949
+ )
950
+
951
+
952
+ class DeleteGoogleAdsLinkRequest(proto.Message):
953
+ r"""Request message for DeleteGoogleAdsLink RPC.
954
+
955
+ Attributes:
956
+ name (str):
957
+ Required. Example format:
958
+ properties/1234/googleAdsLinks/5678
959
+ """
960
+
961
+ name: str = proto.Field(
962
+ proto.STRING,
963
+ number=1,
964
+ )
965
+
966
+
967
+ class ListGoogleAdsLinksRequest(proto.Message):
968
+ r"""Request message for ListGoogleAdsLinks RPC.
969
+
970
+ Attributes:
971
+ parent (str):
972
+ Required. Example format: properties/1234
973
+ page_size (int):
974
+ The maximum number of resources to return.
975
+ If unspecified, at most 50 resources will be
976
+ returned. The maximum value is 200 (higher
977
+ values will be coerced to the maximum).
978
+ page_token (str):
979
+ A page token, received from a previous
980
+ ``ListGoogleAdsLinks`` call. Provide this to retrieve the
981
+ subsequent page.
982
+
983
+ When paginating, all other parameters provided to
984
+ ``ListGoogleAdsLinks`` must match the call that provided the
985
+ page token.
986
+ """
987
+
988
+ parent: str = proto.Field(
989
+ proto.STRING,
990
+ number=1,
991
+ )
992
+ page_size: int = proto.Field(
993
+ proto.INT32,
994
+ number=2,
995
+ )
996
+ page_token: str = proto.Field(
997
+ proto.STRING,
998
+ number=3,
999
+ )
1000
+
1001
+
1002
+ class ListGoogleAdsLinksResponse(proto.Message):
1003
+ r"""Response message for ListGoogleAdsLinks RPC.
1004
+
1005
+ Attributes:
1006
+ google_ads_links (MutableSequence[google.analytics.admin_v1alpha.types.GoogleAdsLink]):
1007
+ List of GoogleAdsLinks.
1008
+ next_page_token (str):
1009
+ A token, which can be sent as ``page_token`` to retrieve the
1010
+ next page. If this field is omitted, there are no subsequent
1011
+ pages.
1012
+ """
1013
+
1014
+ @property
1015
+ def raw_page(self):
1016
+ return self
1017
+
1018
+ google_ads_links: MutableSequence[resources.GoogleAdsLink] = proto.RepeatedField(
1019
+ proto.MESSAGE,
1020
+ number=1,
1021
+ message=resources.GoogleAdsLink,
1022
+ )
1023
+ next_page_token: str = proto.Field(
1024
+ proto.STRING,
1025
+ number=2,
1026
+ )
1027
+
1028
+
1029
+ class GetDataSharingSettingsRequest(proto.Message):
1030
+ r"""Request message for GetDataSharingSettings RPC.
1031
+
1032
+ Attributes:
1033
+ name (str):
1034
+ Required. The name of the settings to lookup. Format:
1035
+ accounts/{account}/dataSharingSettings
1036
+
1037
+ Example: ``accounts/1000/dataSharingSettings``
1038
+ """
1039
+
1040
+ name: str = proto.Field(
1041
+ proto.STRING,
1042
+ number=1,
1043
+ )
1044
+
1045
+
1046
+ class ListAccountSummariesRequest(proto.Message):
1047
+ r"""Request message for ListAccountSummaries RPC.
1048
+
1049
+ Attributes:
1050
+ page_size (int):
1051
+ The maximum number of AccountSummary
1052
+ resources to return. The service may return
1053
+ fewer than this value, even if there are
1054
+ additional pages. If unspecified, at most 50
1055
+ resources will be returned. The maximum value is
1056
+ 200; (higher values will be coerced to the
1057
+ maximum)
1058
+ page_token (str):
1059
+ A page token, received from a previous
1060
+ ``ListAccountSummaries`` call. Provide this to retrieve the
1061
+ subsequent page. When paginating, all other parameters
1062
+ provided to ``ListAccountSummaries`` must match the call
1063
+ that provided the page token.
1064
+ """
1065
+
1066
+ page_size: int = proto.Field(
1067
+ proto.INT32,
1068
+ number=1,
1069
+ )
1070
+ page_token: str = proto.Field(
1071
+ proto.STRING,
1072
+ number=2,
1073
+ )
1074
+
1075
+
1076
+ class ListAccountSummariesResponse(proto.Message):
1077
+ r"""Response message for ListAccountSummaries RPC.
1078
+
1079
+ Attributes:
1080
+ account_summaries (MutableSequence[google.analytics.admin_v1alpha.types.AccountSummary]):
1081
+ Account summaries of all accounts the caller
1082
+ has access to.
1083
+ next_page_token (str):
1084
+ A token, which can be sent as ``page_token`` to retrieve the
1085
+ next page. If this field is omitted, there are no subsequent
1086
+ pages.
1087
+ """
1088
+
1089
+ @property
1090
+ def raw_page(self):
1091
+ return self
1092
+
1093
+ account_summaries: MutableSequence[resources.AccountSummary] = proto.RepeatedField(
1094
+ proto.MESSAGE,
1095
+ number=1,
1096
+ message=resources.AccountSummary,
1097
+ )
1098
+ next_page_token: str = proto.Field(
1099
+ proto.STRING,
1100
+ number=2,
1101
+ )
1102
+
1103
+
1104
+ class AcknowledgeUserDataCollectionRequest(proto.Message):
1105
+ r"""Request message for AcknowledgeUserDataCollection RPC.
1106
+
1107
+ Attributes:
1108
+ property (str):
1109
+ Required. The property for which to
1110
+ acknowledge user data collection.
1111
+ acknowledgement (str):
1112
+ Required. An acknowledgement that the caller
1113
+ of this method understands the terms of user
1114
+ data collection.
1115
+
1116
+ This field must contain the exact value:
1117
+
1118
+ "I acknowledge that I have the necessary privacy
1119
+ disclosures and rights from my end users for the
1120
+ collection and processing of their data,
1121
+ including the association of such data with the
1122
+ visitation information Google Analytics collects
1123
+ from my site and/or app property.".
1124
+ """
1125
+
1126
+ property: str = proto.Field(
1127
+ proto.STRING,
1128
+ number=1,
1129
+ )
1130
+ acknowledgement: str = proto.Field(
1131
+ proto.STRING,
1132
+ number=2,
1133
+ )
1134
+
1135
+
1136
+ class AcknowledgeUserDataCollectionResponse(proto.Message):
1137
+ r"""Response message for AcknowledgeUserDataCollection RPC."""
1138
+
1139
+
1140
+ class SearchChangeHistoryEventsRequest(proto.Message):
1141
+ r"""Request message for SearchChangeHistoryEvents RPC.
1142
+
1143
+ Attributes:
1144
+ account (str):
1145
+ Required. The account resource for which to return change
1146
+ history resources. Format: accounts/{account}
1147
+
1148
+ Example: ``accounts/100``
1149
+ property (str):
1150
+ Optional. Resource name for a child property. If set, only
1151
+ return changes made to this property or its child resources.
1152
+ Format: properties/{propertyId}
1153
+
1154
+ Example: ``properties/100``
1155
+ resource_type (MutableSequence[google.analytics.admin_v1alpha.types.ChangeHistoryResourceType]):
1156
+ Optional. If set, only return changes if they
1157
+ are for a resource that matches at least one of
1158
+ these types.
1159
+ action (MutableSequence[google.analytics.admin_v1alpha.types.ActionType]):
1160
+ Optional. If set, only return changes that
1161
+ match one or more of these types of actions.
1162
+ actor_email (MutableSequence[str]):
1163
+ Optional. If set, only return changes if they
1164
+ are made by a user in this list.
1165
+ earliest_change_time (google.protobuf.timestamp_pb2.Timestamp):
1166
+ Optional. If set, only return changes made
1167
+ after this time (inclusive).
1168
+ latest_change_time (google.protobuf.timestamp_pb2.Timestamp):
1169
+ Optional. If set, only return changes made
1170
+ before this time (inclusive).
1171
+ page_size (int):
1172
+ Optional. The maximum number of ChangeHistoryEvent items to
1173
+ return. If unspecified, at most 50 items will be returned.
1174
+ The maximum value is 200 (higher values will be coerced to
1175
+ the maximum).
1176
+
1177
+ Note that the service may return a page with fewer items
1178
+ than this value specifies (potentially even zero), and that
1179
+ there still may be additional pages. If you want a
1180
+ particular number of items, you'll need to continue
1181
+ requesting additional pages using ``page_token`` until you
1182
+ get the needed number.
1183
+ page_token (str):
1184
+ Optional. A page token, received from a previous
1185
+ ``SearchChangeHistoryEvents`` call. Provide this to retrieve
1186
+ the subsequent page. When paginating, all other parameters
1187
+ provided to ``SearchChangeHistoryEvents`` must match the
1188
+ call that provided the page token.
1189
+ """
1190
+
1191
+ account: str = proto.Field(
1192
+ proto.STRING,
1193
+ number=1,
1194
+ )
1195
+ property: str = proto.Field(
1196
+ proto.STRING,
1197
+ number=2,
1198
+ )
1199
+ resource_type: MutableSequence[
1200
+ resources.ChangeHistoryResourceType
1201
+ ] = proto.RepeatedField(
1202
+ proto.ENUM,
1203
+ number=3,
1204
+ enum=resources.ChangeHistoryResourceType,
1205
+ )
1206
+ action: MutableSequence[resources.ActionType] = proto.RepeatedField(
1207
+ proto.ENUM,
1208
+ number=4,
1209
+ enum=resources.ActionType,
1210
+ )
1211
+ actor_email: MutableSequence[str] = proto.RepeatedField(
1212
+ proto.STRING,
1213
+ number=5,
1214
+ )
1215
+ earliest_change_time: timestamp_pb2.Timestamp = proto.Field(
1216
+ proto.MESSAGE,
1217
+ number=6,
1218
+ message=timestamp_pb2.Timestamp,
1219
+ )
1220
+ latest_change_time: timestamp_pb2.Timestamp = proto.Field(
1221
+ proto.MESSAGE,
1222
+ number=7,
1223
+ message=timestamp_pb2.Timestamp,
1224
+ )
1225
+ page_size: int = proto.Field(
1226
+ proto.INT32,
1227
+ number=8,
1228
+ )
1229
+ page_token: str = proto.Field(
1230
+ proto.STRING,
1231
+ number=9,
1232
+ )
1233
+
1234
+
1235
+ class SearchChangeHistoryEventsResponse(proto.Message):
1236
+ r"""Response message for SearchAccounts RPC.
1237
+
1238
+ Attributes:
1239
+ change_history_events (MutableSequence[google.analytics.admin_v1alpha.types.ChangeHistoryEvent]):
1240
+ Results that were accessible to the caller.
1241
+ next_page_token (str):
1242
+ A token, which can be sent as ``page_token`` to retrieve the
1243
+ next page. If this field is omitted, there are no subsequent
1244
+ pages.
1245
+ """
1246
+
1247
+ @property
1248
+ def raw_page(self):
1249
+ return self
1250
+
1251
+ change_history_events: MutableSequence[
1252
+ resources.ChangeHistoryEvent
1253
+ ] = proto.RepeatedField(
1254
+ proto.MESSAGE,
1255
+ number=1,
1256
+ message=resources.ChangeHistoryEvent,
1257
+ )
1258
+ next_page_token: str = proto.Field(
1259
+ proto.STRING,
1260
+ number=2,
1261
+ )
1262
+
1263
+
1264
+ class GetMeasurementProtocolSecretRequest(proto.Message):
1265
+ r"""Request message for GetMeasurementProtocolSecret RPC.
1266
+
1267
+ Attributes:
1268
+ name (str):
1269
+ Required. The name of the measurement
1270
+ protocol secret to lookup. Format:
1271
+
1272
+ properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
1273
+ """
1274
+
1275
+ name: str = proto.Field(
1276
+ proto.STRING,
1277
+ number=1,
1278
+ )
1279
+
1280
+
1281
+ class CreateMeasurementProtocolSecretRequest(proto.Message):
1282
+ r"""Request message for CreateMeasurementProtocolSecret RPC
1283
+
1284
+ Attributes:
1285
+ parent (str):
1286
+ Required. The parent resource where this
1287
+ secret will be created. Format:
1288
+ properties/{property}/dataStreams/{dataStream}
1289
+ measurement_protocol_secret (google.analytics.admin_v1alpha.types.MeasurementProtocolSecret):
1290
+ Required. The measurement protocol secret to
1291
+ create.
1292
+ """
1293
+
1294
+ parent: str = proto.Field(
1295
+ proto.STRING,
1296
+ number=1,
1297
+ )
1298
+ measurement_protocol_secret: resources.MeasurementProtocolSecret = proto.Field(
1299
+ proto.MESSAGE,
1300
+ number=2,
1301
+ message=resources.MeasurementProtocolSecret,
1302
+ )
1303
+
1304
+
1305
+ class DeleteMeasurementProtocolSecretRequest(proto.Message):
1306
+ r"""Request message for DeleteMeasurementProtocolSecret RPC
1307
+
1308
+ Attributes:
1309
+ name (str):
1310
+ Required. The name of the
1311
+ MeasurementProtocolSecret to delete. Format:
1312
+
1313
+ properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
1314
+ """
1315
+
1316
+ name: str = proto.Field(
1317
+ proto.STRING,
1318
+ number=1,
1319
+ )
1320
+
1321
+
1322
+ class UpdateMeasurementProtocolSecretRequest(proto.Message):
1323
+ r"""Request message for UpdateMeasurementProtocolSecret RPC
1324
+
1325
+ Attributes:
1326
+ measurement_protocol_secret (google.analytics.admin_v1alpha.types.MeasurementProtocolSecret):
1327
+ Required. The measurement protocol secret to
1328
+ update.
1329
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
1330
+ Required. The list of fields to be updated.
1331
+ Omitted fields will not be updated.
1332
+ """
1333
+
1334
+ measurement_protocol_secret: resources.MeasurementProtocolSecret = proto.Field(
1335
+ proto.MESSAGE,
1336
+ number=1,
1337
+ message=resources.MeasurementProtocolSecret,
1338
+ )
1339
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
1340
+ proto.MESSAGE,
1341
+ number=2,
1342
+ message=field_mask_pb2.FieldMask,
1343
+ )
1344
+
1345
+
1346
+ class ListMeasurementProtocolSecretsRequest(proto.Message):
1347
+ r"""Request message for ListMeasurementProtocolSecret RPC
1348
+
1349
+ Attributes:
1350
+ parent (str):
1351
+ Required. The resource name of the parent
1352
+ stream. Format:
1353
+
1354
+ properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
1355
+ page_size (int):
1356
+ The maximum number of resources to return.
1357
+ If unspecified, at most 10 resources will be
1358
+ returned. The maximum value is 10. Higher values
1359
+ will be coerced to the maximum.
1360
+ page_token (str):
1361
+ A page token, received from a previous
1362
+ ``ListMeasurementProtocolSecrets`` call. Provide this to
1363
+ retrieve the subsequent page. When paginating, all other
1364
+ parameters provided to ``ListMeasurementProtocolSecrets``
1365
+ must match the call that provided the page token.
1366
+ """
1367
+
1368
+ parent: str = proto.Field(
1369
+ proto.STRING,
1370
+ number=1,
1371
+ )
1372
+ page_size: int = proto.Field(
1373
+ proto.INT32,
1374
+ number=2,
1375
+ )
1376
+ page_token: str = proto.Field(
1377
+ proto.STRING,
1378
+ number=3,
1379
+ )
1380
+
1381
+
1382
+ class ListMeasurementProtocolSecretsResponse(proto.Message):
1383
+ r"""Response message for ListMeasurementProtocolSecret RPC
1384
+
1385
+ Attributes:
1386
+ measurement_protocol_secrets (MutableSequence[google.analytics.admin_v1alpha.types.MeasurementProtocolSecret]):
1387
+ A list of secrets for the parent stream
1388
+ specified in the request.
1389
+ next_page_token (str):
1390
+ A token, which can be sent as ``page_token`` to retrieve the
1391
+ next page. If this field is omitted, there are no subsequent
1392
+ pages.
1393
+ """
1394
+
1395
+ @property
1396
+ def raw_page(self):
1397
+ return self
1398
+
1399
+ measurement_protocol_secrets: MutableSequence[
1400
+ resources.MeasurementProtocolSecret
1401
+ ] = proto.RepeatedField(
1402
+ proto.MESSAGE,
1403
+ number=1,
1404
+ message=resources.MeasurementProtocolSecret,
1405
+ )
1406
+ next_page_token: str = proto.Field(
1407
+ proto.STRING,
1408
+ number=2,
1409
+ )
1410
+
1411
+
1412
+ class GetSKAdNetworkConversionValueSchemaRequest(proto.Message):
1413
+ r"""Request message for GetSKAdNetworkConversionValueSchema RPC.
1414
+
1415
+ Attributes:
1416
+ name (str):
1417
+ Required. The resource name of SKAdNetwork conversion value
1418
+ schema to look up. Format:
1419
+ properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}
1420
+ """
1421
+
1422
+ name: str = proto.Field(
1423
+ proto.STRING,
1424
+ number=1,
1425
+ )
1426
+
1427
+
1428
+ class CreateSKAdNetworkConversionValueSchemaRequest(proto.Message):
1429
+ r"""Request message for CreateSKAdNetworkConversionValueSchema
1430
+ RPC.
1431
+
1432
+ Attributes:
1433
+ parent (str):
1434
+ Required. The parent resource where this
1435
+ schema will be created. Format:
1436
+ properties/{property}/dataStreams/{dataStream}
1437
+ skadnetwork_conversion_value_schema (google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema):
1438
+ Required. SKAdNetwork conversion value schema
1439
+ to create.
1440
+ """
1441
+
1442
+ parent: str = proto.Field(
1443
+ proto.STRING,
1444
+ number=1,
1445
+ )
1446
+ skadnetwork_conversion_value_schema: resources.SKAdNetworkConversionValueSchema = (
1447
+ proto.Field(
1448
+ proto.MESSAGE,
1449
+ number=2,
1450
+ message=resources.SKAdNetworkConversionValueSchema,
1451
+ )
1452
+ )
1453
+
1454
+
1455
+ class DeleteSKAdNetworkConversionValueSchemaRequest(proto.Message):
1456
+ r"""Request message for DeleteSKAdNetworkConversionValueSchema
1457
+ RPC.
1458
+
1459
+ Attributes:
1460
+ name (str):
1461
+ Required. The name of the SKAdNetworkConversionValueSchema
1462
+ to delete. Format:
1463
+ properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}
1464
+ """
1465
+
1466
+ name: str = proto.Field(
1467
+ proto.STRING,
1468
+ number=1,
1469
+ )
1470
+
1471
+
1472
+ class UpdateSKAdNetworkConversionValueSchemaRequest(proto.Message):
1473
+ r"""Request message for UpdateSKAdNetworkConversionValueSchema
1474
+ RPC.
1475
+
1476
+ Attributes:
1477
+ skadnetwork_conversion_value_schema (google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema):
1478
+ Required. SKAdNetwork conversion value schema
1479
+ to update.
1480
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
1481
+ Required. The list of fields to be updated.
1482
+ Omitted fields will not be updated.
1483
+ """
1484
+
1485
+ skadnetwork_conversion_value_schema: resources.SKAdNetworkConversionValueSchema = (
1486
+ proto.Field(
1487
+ proto.MESSAGE,
1488
+ number=1,
1489
+ message=resources.SKAdNetworkConversionValueSchema,
1490
+ )
1491
+ )
1492
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
1493
+ proto.MESSAGE,
1494
+ number=2,
1495
+ message=field_mask_pb2.FieldMask,
1496
+ )
1497
+
1498
+
1499
+ class ListSKAdNetworkConversionValueSchemasRequest(proto.Message):
1500
+ r"""Request message for ListSKAdNetworkConversionValueSchemas RPC
1501
+
1502
+ Attributes:
1503
+ parent (str):
1504
+ Required. The DataStream resource to list schemas for.
1505
+ Format: properties/{property_id}/dataStreams/{dataStream}
1506
+ Example: properties/1234/dataStreams/5678
1507
+ page_size (int):
1508
+ The maximum number of resources to return.
1509
+ The service may return fewer than this value,
1510
+ even if there are additional pages. If
1511
+ unspecified, at most 50 resources will be
1512
+ returned. The maximum value is 200; (higher
1513
+ values will be coerced to the maximum)
1514
+ page_token (str):
1515
+ A page token, received from a previous
1516
+ ``ListSKAdNetworkConversionValueSchemas`` call. Provide this
1517
+ to retrieve the subsequent page. When paginating, all other
1518
+ parameters provided to
1519
+ ``ListSKAdNetworkConversionValueSchema`` must match the call
1520
+ that provided the page token.
1521
+ """
1522
+
1523
+ parent: str = proto.Field(
1524
+ proto.STRING,
1525
+ number=1,
1526
+ )
1527
+ page_size: int = proto.Field(
1528
+ proto.INT32,
1529
+ number=2,
1530
+ )
1531
+ page_token: str = proto.Field(
1532
+ proto.STRING,
1533
+ number=3,
1534
+ )
1535
+
1536
+
1537
+ class ListSKAdNetworkConversionValueSchemasResponse(proto.Message):
1538
+ r"""Response message for ListSKAdNetworkConversionValueSchemas
1539
+ RPC
1540
+
1541
+ Attributes:
1542
+ skadnetwork_conversion_value_schemas (MutableSequence[google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema]):
1543
+ List of SKAdNetworkConversionValueSchemas.
1544
+ This will have at most one value.
1545
+ next_page_token (str):
1546
+ A token, which can be sent as ``page_token`` to retrieve the
1547
+ next page. If this field is omitted, there are no subsequent
1548
+ pages. Currently, Google Analytics supports only one
1549
+ SKAdNetworkConversionValueSchema per dataStream, so this
1550
+ will never be populated.
1551
+ """
1552
+
1553
+ @property
1554
+ def raw_page(self):
1555
+ return self
1556
+
1557
+ skadnetwork_conversion_value_schemas: MutableSequence[
1558
+ resources.SKAdNetworkConversionValueSchema
1559
+ ] = proto.RepeatedField(
1560
+ proto.MESSAGE,
1561
+ number=1,
1562
+ message=resources.SKAdNetworkConversionValueSchema,
1563
+ )
1564
+ next_page_token: str = proto.Field(
1565
+ proto.STRING,
1566
+ number=2,
1567
+ )
1568
+
1569
+
1570
+ class GetGoogleSignalsSettingsRequest(proto.Message):
1571
+ r"""Request message for GetGoogleSignalsSettings RPC
1572
+
1573
+ Attributes:
1574
+ name (str):
1575
+ Required. The name of the google signals
1576
+ settings to retrieve. Format:
1577
+ properties/{property}/googleSignalsSettings
1578
+ """
1579
+
1580
+ name: str = proto.Field(
1581
+ proto.STRING,
1582
+ number=1,
1583
+ )
1584
+
1585
+
1586
+ class UpdateGoogleSignalsSettingsRequest(proto.Message):
1587
+ r"""Request message for UpdateGoogleSignalsSettings RPC
1588
+
1589
+ Attributes:
1590
+ google_signals_settings (google.analytics.admin_v1alpha.types.GoogleSignalsSettings):
1591
+ Required. The settings to update. The ``name`` field is used
1592
+ to identify the settings to be updated.
1593
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
1594
+ Required. The list of fields to be updated. Field names must
1595
+ be in snake case (e.g., "field_to_update"). Omitted fields
1596
+ will not be updated. To replace the entire entity, use one
1597
+ path with the string "*" to match all fields.
1598
+ """
1599
+
1600
+ google_signals_settings: resources.GoogleSignalsSettings = proto.Field(
1601
+ proto.MESSAGE,
1602
+ number=1,
1603
+ message=resources.GoogleSignalsSettings,
1604
+ )
1605
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
1606
+ proto.MESSAGE,
1607
+ number=2,
1608
+ message=field_mask_pb2.FieldMask,
1609
+ )
1610
+
1611
+
1612
+ class CreateConversionEventRequest(proto.Message):
1613
+ r"""Request message for CreateConversionEvent RPC
1614
+
1615
+ Attributes:
1616
+ conversion_event (google.analytics.admin_v1alpha.types.ConversionEvent):
1617
+ Required. The conversion event to create.
1618
+ parent (str):
1619
+ Required. The resource name of the parent
1620
+ property where this conversion event will be
1621
+ created. Format: properties/123
1622
+ """
1623
+
1624
+ conversion_event: resources.ConversionEvent = proto.Field(
1625
+ proto.MESSAGE,
1626
+ number=1,
1627
+ message=resources.ConversionEvent,
1628
+ )
1629
+ parent: str = proto.Field(
1630
+ proto.STRING,
1631
+ number=2,
1632
+ )
1633
+
1634
+
1635
+ class UpdateConversionEventRequest(proto.Message):
1636
+ r"""Request message for UpdateConversionEvent RPC
1637
+
1638
+ Attributes:
1639
+ conversion_event (google.analytics.admin_v1alpha.types.ConversionEvent):
1640
+ Required. The conversion event to update. The ``name`` field
1641
+ is used to identify the settings to be updated.
1642
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
1643
+ Required. The list of fields to be updated. Field names must
1644
+ be in snake case (e.g., "field_to_update"). Omitted fields
1645
+ will not be updated. To replace the entire entity, use one
1646
+ path with the string "*" to match all fields.
1647
+ """
1648
+
1649
+ conversion_event: resources.ConversionEvent = proto.Field(
1650
+ proto.MESSAGE,
1651
+ number=1,
1652
+ message=resources.ConversionEvent,
1653
+ )
1654
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
1655
+ proto.MESSAGE,
1656
+ number=2,
1657
+ message=field_mask_pb2.FieldMask,
1658
+ )
1659
+
1660
+
1661
+ class GetConversionEventRequest(proto.Message):
1662
+ r"""Request message for GetConversionEvent RPC
1663
+
1664
+ Attributes:
1665
+ name (str):
1666
+ Required. The resource name of the conversion event to
1667
+ retrieve. Format:
1668
+ properties/{property}/conversionEvents/{conversion_event}
1669
+ Example: "properties/123/conversionEvents/456".
1670
+ """
1671
+
1672
+ name: str = proto.Field(
1673
+ proto.STRING,
1674
+ number=1,
1675
+ )
1676
+
1677
+
1678
+ class DeleteConversionEventRequest(proto.Message):
1679
+ r"""Request message for DeleteConversionEvent RPC
1680
+
1681
+ Attributes:
1682
+ name (str):
1683
+ Required. The resource name of the conversion event to
1684
+ delete. Format:
1685
+ properties/{property}/conversionEvents/{conversion_event}
1686
+ Example: "properties/123/conversionEvents/456".
1687
+ """
1688
+
1689
+ name: str = proto.Field(
1690
+ proto.STRING,
1691
+ number=1,
1692
+ )
1693
+
1694
+
1695
+ class ListConversionEventsRequest(proto.Message):
1696
+ r"""Request message for ListConversionEvents RPC
1697
+
1698
+ Attributes:
1699
+ parent (str):
1700
+ Required. The resource name of the parent
1701
+ property. Example: 'properties/123'
1702
+ page_size (int):
1703
+ The maximum number of resources to return.
1704
+ If unspecified, at most 50 resources will be
1705
+ returned. The maximum value is 200; (higher
1706
+ values will be coerced to the maximum)
1707
+ page_token (str):
1708
+ A page token, received from a previous
1709
+ ``ListConversionEvents`` call. Provide this to retrieve the
1710
+ subsequent page. When paginating, all other parameters
1711
+ provided to ``ListConversionEvents`` must match the call
1712
+ that provided the page token.
1713
+ """
1714
+
1715
+ parent: str = proto.Field(
1716
+ proto.STRING,
1717
+ number=1,
1718
+ )
1719
+ page_size: int = proto.Field(
1720
+ proto.INT32,
1721
+ number=2,
1722
+ )
1723
+ page_token: str = proto.Field(
1724
+ proto.STRING,
1725
+ number=3,
1726
+ )
1727
+
1728
+
1729
+ class ListConversionEventsResponse(proto.Message):
1730
+ r"""Response message for ListConversionEvents RPC.
1731
+
1732
+ Attributes:
1733
+ conversion_events (MutableSequence[google.analytics.admin_v1alpha.types.ConversionEvent]):
1734
+ The requested conversion events
1735
+ next_page_token (str):
1736
+ A token, which can be sent as ``page_token`` to retrieve the
1737
+ next page. If this field is omitted, there are no subsequent
1738
+ pages.
1739
+ """
1740
+
1741
+ @property
1742
+ def raw_page(self):
1743
+ return self
1744
+
1745
+ conversion_events: MutableSequence[resources.ConversionEvent] = proto.RepeatedField(
1746
+ proto.MESSAGE,
1747
+ number=1,
1748
+ message=resources.ConversionEvent,
1749
+ )
1750
+ next_page_token: str = proto.Field(
1751
+ proto.STRING,
1752
+ number=2,
1753
+ )
1754
+
1755
+
1756
+ class CreateKeyEventRequest(proto.Message):
1757
+ r"""Request message for CreateKeyEvent RPC
1758
+
1759
+ Attributes:
1760
+ key_event (google.analytics.admin_v1alpha.types.KeyEvent):
1761
+ Required. The Key Event to create.
1762
+ parent (str):
1763
+ Required. The resource name of the parent
1764
+ property where this Key Event will be created.
1765
+ Format: properties/123
1766
+ """
1767
+
1768
+ key_event: resources.KeyEvent = proto.Field(
1769
+ proto.MESSAGE,
1770
+ number=1,
1771
+ message=resources.KeyEvent,
1772
+ )
1773
+ parent: str = proto.Field(
1774
+ proto.STRING,
1775
+ number=2,
1776
+ )
1777
+
1778
+
1779
+ class UpdateKeyEventRequest(proto.Message):
1780
+ r"""Request message for UpdateKeyEvent RPC
1781
+
1782
+ Attributes:
1783
+ key_event (google.analytics.admin_v1alpha.types.KeyEvent):
1784
+ Required. The Key Event to update. The ``name`` field is
1785
+ used to identify the settings to be updated.
1786
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
1787
+ Required. The list of fields to be updated. Field names must
1788
+ be in snake case (e.g., "field_to_update"). Omitted fields
1789
+ will not be updated. To replace the entire entity, use one
1790
+ path with the string "*" to match all fields.
1791
+ """
1792
+
1793
+ key_event: resources.KeyEvent = proto.Field(
1794
+ proto.MESSAGE,
1795
+ number=1,
1796
+ message=resources.KeyEvent,
1797
+ )
1798
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
1799
+ proto.MESSAGE,
1800
+ number=2,
1801
+ message=field_mask_pb2.FieldMask,
1802
+ )
1803
+
1804
+
1805
+ class GetKeyEventRequest(proto.Message):
1806
+ r"""Request message for GetKeyEvent RPC
1807
+
1808
+ Attributes:
1809
+ name (str):
1810
+ Required. The resource name of the Key Event to retrieve.
1811
+ Format: properties/{property}/keyEvents/{key_event} Example:
1812
+ "properties/123/keyEvents/456".
1813
+ """
1814
+
1815
+ name: str = proto.Field(
1816
+ proto.STRING,
1817
+ number=1,
1818
+ )
1819
+
1820
+
1821
+ class DeleteKeyEventRequest(proto.Message):
1822
+ r"""Request message for DeleteKeyEvent RPC
1823
+
1824
+ Attributes:
1825
+ name (str):
1826
+ Required. The resource name of the Key Event to delete.
1827
+ Format: properties/{property}/keyEvents/{key_event} Example:
1828
+ "properties/123/keyEvents/456".
1829
+ """
1830
+
1831
+ name: str = proto.Field(
1832
+ proto.STRING,
1833
+ number=1,
1834
+ )
1835
+
1836
+
1837
+ class ListKeyEventsRequest(proto.Message):
1838
+ r"""Request message for ListKeyEvents RPC
1839
+
1840
+ Attributes:
1841
+ parent (str):
1842
+ Required. The resource name of the parent
1843
+ property. Example: 'properties/123'
1844
+ page_size (int):
1845
+ The maximum number of resources to return.
1846
+ If unspecified, at most 50 resources will be
1847
+ returned. The maximum value is 200; (higher
1848
+ values will be coerced to the maximum)
1849
+ page_token (str):
1850
+ A page token, received from a previous ``ListKeyEvents``
1851
+ call. Provide this to retrieve the subsequent page. When
1852
+ paginating, all other parameters provided to
1853
+ ``ListKeyEvents`` must match the call that provided the page
1854
+ token.
1855
+ """
1856
+
1857
+ parent: str = proto.Field(
1858
+ proto.STRING,
1859
+ number=1,
1860
+ )
1861
+ page_size: int = proto.Field(
1862
+ proto.INT32,
1863
+ number=2,
1864
+ )
1865
+ page_token: str = proto.Field(
1866
+ proto.STRING,
1867
+ number=3,
1868
+ )
1869
+
1870
+
1871
+ class ListKeyEventsResponse(proto.Message):
1872
+ r"""Response message for ListKeyEvents RPC.
1873
+
1874
+ Attributes:
1875
+ key_events (MutableSequence[google.analytics.admin_v1alpha.types.KeyEvent]):
1876
+ The requested Key Events
1877
+ next_page_token (str):
1878
+ A token, which can be sent as ``page_token`` to retrieve the
1879
+ next page. If this field is omitted, there are no subsequent
1880
+ pages.
1881
+ """
1882
+
1883
+ @property
1884
+ def raw_page(self):
1885
+ return self
1886
+
1887
+ key_events: MutableSequence[resources.KeyEvent] = proto.RepeatedField(
1888
+ proto.MESSAGE,
1889
+ number=1,
1890
+ message=resources.KeyEvent,
1891
+ )
1892
+ next_page_token: str = proto.Field(
1893
+ proto.STRING,
1894
+ number=2,
1895
+ )
1896
+
1897
+
1898
+ class GetDisplayVideo360AdvertiserLinkRequest(proto.Message):
1899
+ r"""Request message for GetDisplayVideo360AdvertiserLink RPC.
1900
+
1901
+ Attributes:
1902
+ name (str):
1903
+ Required. The name of the
1904
+ DisplayVideo360AdvertiserLink to get. Example
1905
+ format:
1906
+ properties/1234/displayVideo360AdvertiserLink/5678
1907
+ """
1908
+
1909
+ name: str = proto.Field(
1910
+ proto.STRING,
1911
+ number=1,
1912
+ )
1913
+
1914
+
1915
+ class ListDisplayVideo360AdvertiserLinksRequest(proto.Message):
1916
+ r"""Request message for ListDisplayVideo360AdvertiserLinks RPC.
1917
+
1918
+ Attributes:
1919
+ parent (str):
1920
+ Required. Example format: properties/1234
1921
+ page_size (int):
1922
+ The maximum number of resources to return.
1923
+ If unspecified, at most 50 resources will be
1924
+ returned. The maximum value is 200 (higher
1925
+ values will be coerced to the maximum).
1926
+ page_token (str):
1927
+ A page token, received from a previous
1928
+ ``ListDisplayVideo360AdvertiserLinks`` call. Provide this to
1929
+ retrieve the subsequent page.
1930
+
1931
+ When paginating, all other parameters provided to
1932
+ ``ListDisplayVideo360AdvertiserLinks`` must match the call
1933
+ that provided the page token.
1934
+ """
1935
+
1936
+ parent: str = proto.Field(
1937
+ proto.STRING,
1938
+ number=1,
1939
+ )
1940
+ page_size: int = proto.Field(
1941
+ proto.INT32,
1942
+ number=2,
1943
+ )
1944
+ page_token: str = proto.Field(
1945
+ proto.STRING,
1946
+ number=3,
1947
+ )
1948
+
1949
+
1950
+ class ListDisplayVideo360AdvertiserLinksResponse(proto.Message):
1951
+ r"""Response message for ListDisplayVideo360AdvertiserLinks RPC.
1952
+
1953
+ Attributes:
1954
+ display_video_360_advertiser_links (MutableSequence[google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink]):
1955
+ List of DisplayVideo360AdvertiserLinks.
1956
+ next_page_token (str):
1957
+ A token, which can be sent as ``page_token`` to retrieve the
1958
+ next page. If this field is omitted, there are no subsequent
1959
+ pages.
1960
+ """
1961
+
1962
+ @property
1963
+ def raw_page(self):
1964
+ return self
1965
+
1966
+ display_video_360_advertiser_links: MutableSequence[
1967
+ resources.DisplayVideo360AdvertiserLink
1968
+ ] = proto.RepeatedField(
1969
+ proto.MESSAGE,
1970
+ number=1,
1971
+ message=resources.DisplayVideo360AdvertiserLink,
1972
+ )
1973
+ next_page_token: str = proto.Field(
1974
+ proto.STRING,
1975
+ number=2,
1976
+ )
1977
+
1978
+
1979
+ class CreateDisplayVideo360AdvertiserLinkRequest(proto.Message):
1980
+ r"""Request message for CreateDisplayVideo360AdvertiserLink RPC.
1981
+
1982
+ Attributes:
1983
+ parent (str):
1984
+ Required. Example format: properties/1234
1985
+ display_video_360_advertiser_link (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink):
1986
+ Required. The DisplayVideo360AdvertiserLink
1987
+ to create.
1988
+ """
1989
+
1990
+ parent: str = proto.Field(
1991
+ proto.STRING,
1992
+ number=1,
1993
+ )
1994
+ display_video_360_advertiser_link: resources.DisplayVideo360AdvertiserLink = (
1995
+ proto.Field(
1996
+ proto.MESSAGE,
1997
+ number=2,
1998
+ message=resources.DisplayVideo360AdvertiserLink,
1999
+ )
2000
+ )
2001
+
2002
+
2003
+ class DeleteDisplayVideo360AdvertiserLinkRequest(proto.Message):
2004
+ r"""Request message for DeleteDisplayVideo360AdvertiserLink RPC.
2005
+
2006
+ Attributes:
2007
+ name (str):
2008
+ Required. The name of the
2009
+ DisplayVideo360AdvertiserLink to delete. Example
2010
+ format:
2011
+ properties/1234/displayVideo360AdvertiserLinks/5678
2012
+ """
2013
+
2014
+ name: str = proto.Field(
2015
+ proto.STRING,
2016
+ number=1,
2017
+ )
2018
+
2019
+
2020
+ class UpdateDisplayVideo360AdvertiserLinkRequest(proto.Message):
2021
+ r"""Request message for UpdateDisplayVideo360AdvertiserLink RPC.
2022
+
2023
+ Attributes:
2024
+ display_video_360_advertiser_link (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink):
2025
+ The DisplayVideo360AdvertiserLink to update
2026
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
2027
+ Required. The list of fields to be updated. Omitted fields
2028
+ will not be updated. To replace the entire entity, use one
2029
+ path with the string "*" to match all fields.
2030
+ """
2031
+
2032
+ display_video_360_advertiser_link: resources.DisplayVideo360AdvertiserLink = (
2033
+ proto.Field(
2034
+ proto.MESSAGE,
2035
+ number=1,
2036
+ message=resources.DisplayVideo360AdvertiserLink,
2037
+ )
2038
+ )
2039
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
2040
+ proto.MESSAGE,
2041
+ number=2,
2042
+ message=field_mask_pb2.FieldMask,
2043
+ )
2044
+
2045
+
2046
+ class GetDisplayVideo360AdvertiserLinkProposalRequest(proto.Message):
2047
+ r"""Request message for GetDisplayVideo360AdvertiserLinkProposal
2048
+ RPC.
2049
+
2050
+ Attributes:
2051
+ name (str):
2052
+ Required. The name of the
2053
+ DisplayVideo360AdvertiserLinkProposal to get.
2054
+ Example format:
2055
+ properties/1234/displayVideo360AdvertiserLinkProposals/5678
2056
+ """
2057
+
2058
+ name: str = proto.Field(
2059
+ proto.STRING,
2060
+ number=1,
2061
+ )
2062
+
2063
+
2064
+ class ListDisplayVideo360AdvertiserLinkProposalsRequest(proto.Message):
2065
+ r"""Request message for
2066
+ ListDisplayVideo360AdvertiserLinkProposals RPC.
2067
+
2068
+ Attributes:
2069
+ parent (str):
2070
+ Required. Example format: properties/1234
2071
+ page_size (int):
2072
+ The maximum number of resources to return.
2073
+ If unspecified, at most 50 resources will be
2074
+ returned. The maximum value is 200 (higher
2075
+ values will be coerced to the maximum).
2076
+ page_token (str):
2077
+ A page token, received from a previous
2078
+ ``ListDisplayVideo360AdvertiserLinkProposals`` call. Provide
2079
+ this to retrieve the subsequent page.
2080
+
2081
+ When paginating, all other parameters provided to
2082
+ ``ListDisplayVideo360AdvertiserLinkProposals`` must match
2083
+ the call that provided the page token.
2084
+ """
2085
+
2086
+ parent: str = proto.Field(
2087
+ proto.STRING,
2088
+ number=1,
2089
+ )
2090
+ page_size: int = proto.Field(
2091
+ proto.INT32,
2092
+ number=2,
2093
+ )
2094
+ page_token: str = proto.Field(
2095
+ proto.STRING,
2096
+ number=3,
2097
+ )
2098
+
2099
+
2100
+ class ListDisplayVideo360AdvertiserLinkProposalsResponse(proto.Message):
2101
+ r"""Response message for
2102
+ ListDisplayVideo360AdvertiserLinkProposals RPC.
2103
+
2104
+ Attributes:
2105
+ display_video_360_advertiser_link_proposals (MutableSequence[google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal]):
2106
+ List of
2107
+ DisplayVideo360AdvertiserLinkProposals.
2108
+ next_page_token (str):
2109
+ A token, which can be sent as ``page_token`` to retrieve the
2110
+ next page. If this field is omitted, there are no subsequent
2111
+ pages.
2112
+ """
2113
+
2114
+ @property
2115
+ def raw_page(self):
2116
+ return self
2117
+
2118
+ display_video_360_advertiser_link_proposals: MutableSequence[
2119
+ resources.DisplayVideo360AdvertiserLinkProposal
2120
+ ] = proto.RepeatedField(
2121
+ proto.MESSAGE,
2122
+ number=1,
2123
+ message=resources.DisplayVideo360AdvertiserLinkProposal,
2124
+ )
2125
+ next_page_token: str = proto.Field(
2126
+ proto.STRING,
2127
+ number=2,
2128
+ )
2129
+
2130
+
2131
+ class CreateDisplayVideo360AdvertiserLinkProposalRequest(proto.Message):
2132
+ r"""Request message for
2133
+ CreateDisplayVideo360AdvertiserLinkProposal RPC.
2134
+
2135
+ Attributes:
2136
+ parent (str):
2137
+ Required. Example format: properties/1234
2138
+ display_video_360_advertiser_link_proposal (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal):
2139
+ Required. The
2140
+ DisplayVideo360AdvertiserLinkProposal to create.
2141
+ """
2142
+
2143
+ parent: str = proto.Field(
2144
+ proto.STRING,
2145
+ number=1,
2146
+ )
2147
+ display_video_360_advertiser_link_proposal: resources.DisplayVideo360AdvertiserLinkProposal = proto.Field(
2148
+ proto.MESSAGE,
2149
+ number=2,
2150
+ message=resources.DisplayVideo360AdvertiserLinkProposal,
2151
+ )
2152
+
2153
+
2154
+ class DeleteDisplayVideo360AdvertiserLinkProposalRequest(proto.Message):
2155
+ r"""Request message for
2156
+ DeleteDisplayVideo360AdvertiserLinkProposal RPC.
2157
+
2158
+ Attributes:
2159
+ name (str):
2160
+ Required. The name of the
2161
+ DisplayVideo360AdvertiserLinkProposal to delete.
2162
+ Example format:
2163
+ properties/1234/displayVideo360AdvertiserLinkProposals/5678
2164
+ """
2165
+
2166
+ name: str = proto.Field(
2167
+ proto.STRING,
2168
+ number=1,
2169
+ )
2170
+
2171
+
2172
+ class ApproveDisplayVideo360AdvertiserLinkProposalRequest(proto.Message):
2173
+ r"""Request message for
2174
+ ApproveDisplayVideo360AdvertiserLinkProposal RPC.
2175
+
2176
+ Attributes:
2177
+ name (str):
2178
+ Required. The name of the
2179
+ DisplayVideo360AdvertiserLinkProposal to
2180
+ approve. Example format:
2181
+ properties/1234/displayVideo360AdvertiserLinkProposals/5678
2182
+ """
2183
+
2184
+ name: str = proto.Field(
2185
+ proto.STRING,
2186
+ number=1,
2187
+ )
2188
+
2189
+
2190
+ class ApproveDisplayVideo360AdvertiserLinkProposalResponse(proto.Message):
2191
+ r"""Response message for
2192
+ ApproveDisplayVideo360AdvertiserLinkProposal RPC.
2193
+
2194
+ Attributes:
2195
+ display_video_360_advertiser_link (google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink):
2196
+ The DisplayVideo360AdvertiserLink created as
2197
+ a result of approving the proposal.
2198
+ """
2199
+
2200
+ display_video_360_advertiser_link: resources.DisplayVideo360AdvertiserLink = (
2201
+ proto.Field(
2202
+ proto.MESSAGE,
2203
+ number=1,
2204
+ message=resources.DisplayVideo360AdvertiserLink,
2205
+ )
2206
+ )
2207
+
2208
+
2209
+ class CancelDisplayVideo360AdvertiserLinkProposalRequest(proto.Message):
2210
+ r"""Request message for
2211
+ CancelDisplayVideo360AdvertiserLinkProposal RPC.
2212
+
2213
+ Attributes:
2214
+ name (str):
2215
+ Required. The name of the
2216
+ DisplayVideo360AdvertiserLinkProposal to cancel.
2217
+ Example format:
2218
+ properties/1234/displayVideo360AdvertiserLinkProposals/5678
2219
+ """
2220
+
2221
+ name: str = proto.Field(
2222
+ proto.STRING,
2223
+ number=1,
2224
+ )
2225
+
2226
+
2227
+ class GetSearchAds360LinkRequest(proto.Message):
2228
+ r"""Request message for GetSearchAds360Link RPC.
2229
+
2230
+ Attributes:
2231
+ name (str):
2232
+ Required. The name of the SearchAds360Link to
2233
+ get. Example format:
2234
+ properties/1234/SearchAds360Link/5678
2235
+ """
2236
+
2237
+ name: str = proto.Field(
2238
+ proto.STRING,
2239
+ number=1,
2240
+ )
2241
+
2242
+
2243
+ class ListSearchAds360LinksRequest(proto.Message):
2244
+ r"""Request message for ListSearchAds360Links RPC.
2245
+
2246
+ Attributes:
2247
+ parent (str):
2248
+ Required. Example format: properties/1234
2249
+ page_size (int):
2250
+ The maximum number of resources to return.
2251
+ If unspecified, at most 50 resources will be
2252
+ returned. The maximum value is 200 (higher
2253
+ values will be coerced to the maximum).
2254
+ page_token (str):
2255
+ A page token, received from a previous
2256
+ ``ListSearchAds360Links`` call. Provide this to retrieve the
2257
+ subsequent page.
2258
+
2259
+ When paginating, all other parameters provided to
2260
+ ``ListSearchAds360Links`` must match the call that provided
2261
+ the page token.
2262
+ """
2263
+
2264
+ parent: str = proto.Field(
2265
+ proto.STRING,
2266
+ number=1,
2267
+ )
2268
+ page_size: int = proto.Field(
2269
+ proto.INT32,
2270
+ number=2,
2271
+ )
2272
+ page_token: str = proto.Field(
2273
+ proto.STRING,
2274
+ number=3,
2275
+ )
2276
+
2277
+
2278
+ class ListSearchAds360LinksResponse(proto.Message):
2279
+ r"""Response message for ListSearchAds360Links RPC.
2280
+
2281
+ Attributes:
2282
+ search_ads_360_links (MutableSequence[google.analytics.admin_v1alpha.types.SearchAds360Link]):
2283
+ List of SearchAds360Links.
2284
+ next_page_token (str):
2285
+ A token, which can be sent as ``page_token`` to retrieve the
2286
+ next page. If this field is omitted, there are no subsequent
2287
+ pages.
2288
+ """
2289
+
2290
+ @property
2291
+ def raw_page(self):
2292
+ return self
2293
+
2294
+ search_ads_360_links: MutableSequence[
2295
+ resources.SearchAds360Link
2296
+ ] = proto.RepeatedField(
2297
+ proto.MESSAGE,
2298
+ number=1,
2299
+ message=resources.SearchAds360Link,
2300
+ )
2301
+ next_page_token: str = proto.Field(
2302
+ proto.STRING,
2303
+ number=2,
2304
+ )
2305
+
2306
+
2307
+ class CreateSearchAds360LinkRequest(proto.Message):
2308
+ r"""Request message for CreateSearchAds360Link RPC.
2309
+
2310
+ Attributes:
2311
+ parent (str):
2312
+ Required. Example format: properties/1234
2313
+ search_ads_360_link (google.analytics.admin_v1alpha.types.SearchAds360Link):
2314
+ Required. The SearchAds360Link to create.
2315
+ """
2316
+
2317
+ parent: str = proto.Field(
2318
+ proto.STRING,
2319
+ number=1,
2320
+ )
2321
+ search_ads_360_link: resources.SearchAds360Link = proto.Field(
2322
+ proto.MESSAGE,
2323
+ number=2,
2324
+ message=resources.SearchAds360Link,
2325
+ )
2326
+
2327
+
2328
+ class DeleteSearchAds360LinkRequest(proto.Message):
2329
+ r"""Request message for DeleteSearchAds360Link RPC.
2330
+
2331
+ Attributes:
2332
+ name (str):
2333
+ Required. The name of the SearchAds360Link to
2334
+ delete. Example format:
2335
+ properties/1234/SearchAds360Links/5678
2336
+ """
2337
+
2338
+ name: str = proto.Field(
2339
+ proto.STRING,
2340
+ number=1,
2341
+ )
2342
+
2343
+
2344
+ class UpdateSearchAds360LinkRequest(proto.Message):
2345
+ r"""Request message for UpdateSearchAds360Link RPC.
2346
+
2347
+ Attributes:
2348
+ search_ads_360_link (google.analytics.admin_v1alpha.types.SearchAds360Link):
2349
+ The SearchAds360Link to update
2350
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
2351
+ Required. The list of fields to be updated. Omitted fields
2352
+ will not be updated. To replace the entire entity, use one
2353
+ path with the string "*" to match all fields.
2354
+ """
2355
+
2356
+ search_ads_360_link: resources.SearchAds360Link = proto.Field(
2357
+ proto.MESSAGE,
2358
+ number=1,
2359
+ message=resources.SearchAds360Link,
2360
+ )
2361
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
2362
+ proto.MESSAGE,
2363
+ number=2,
2364
+ message=field_mask_pb2.FieldMask,
2365
+ )
2366
+
2367
+
2368
+ class CreateCustomDimensionRequest(proto.Message):
2369
+ r"""Request message for CreateCustomDimension RPC.
2370
+
2371
+ Attributes:
2372
+ parent (str):
2373
+ Required. Example format: properties/1234
2374
+ custom_dimension (google.analytics.admin_v1alpha.types.CustomDimension):
2375
+ Required. The CustomDimension to create.
2376
+ """
2377
+
2378
+ parent: str = proto.Field(
2379
+ proto.STRING,
2380
+ number=1,
2381
+ )
2382
+ custom_dimension: resources.CustomDimension = proto.Field(
2383
+ proto.MESSAGE,
2384
+ number=2,
2385
+ message=resources.CustomDimension,
2386
+ )
2387
+
2388
+
2389
+ class UpdateCustomDimensionRequest(proto.Message):
2390
+ r"""Request message for UpdateCustomDimension RPC.
2391
+
2392
+ Attributes:
2393
+ custom_dimension (google.analytics.admin_v1alpha.types.CustomDimension):
2394
+ The CustomDimension to update
2395
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
2396
+ Required. The list of fields to be updated. Omitted fields
2397
+ will not be updated. To replace the entire entity, use one
2398
+ path with the string "*" to match all fields.
2399
+ """
2400
+
2401
+ custom_dimension: resources.CustomDimension = proto.Field(
2402
+ proto.MESSAGE,
2403
+ number=1,
2404
+ message=resources.CustomDimension,
2405
+ )
2406
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
2407
+ proto.MESSAGE,
2408
+ number=2,
2409
+ message=field_mask_pb2.FieldMask,
2410
+ )
2411
+
2412
+
2413
+ class ListCustomDimensionsRequest(proto.Message):
2414
+ r"""Request message for ListCustomDimensions RPC.
2415
+
2416
+ Attributes:
2417
+ parent (str):
2418
+ Required. Example format: properties/1234
2419
+ page_size (int):
2420
+ The maximum number of resources to return.
2421
+ If unspecified, at most 50 resources will be
2422
+ returned. The maximum value is 200 (higher
2423
+ values will be coerced to the maximum).
2424
+ page_token (str):
2425
+ A page token, received from a previous
2426
+ ``ListCustomDimensions`` call. Provide this to retrieve the
2427
+ subsequent page.
2428
+
2429
+ When paginating, all other parameters provided to
2430
+ ``ListCustomDimensions`` must match the call that provided
2431
+ the page token.
2432
+ """
2433
+
2434
+ parent: str = proto.Field(
2435
+ proto.STRING,
2436
+ number=1,
2437
+ )
2438
+ page_size: int = proto.Field(
2439
+ proto.INT32,
2440
+ number=2,
2441
+ )
2442
+ page_token: str = proto.Field(
2443
+ proto.STRING,
2444
+ number=3,
2445
+ )
2446
+
2447
+
2448
+ class ListCustomDimensionsResponse(proto.Message):
2449
+ r"""Response message for ListCustomDimensions RPC.
2450
+
2451
+ Attributes:
2452
+ custom_dimensions (MutableSequence[google.analytics.admin_v1alpha.types.CustomDimension]):
2453
+ List of CustomDimensions.
2454
+ next_page_token (str):
2455
+ A token, which can be sent as ``page_token`` to retrieve the
2456
+ next page. If this field is omitted, there are no subsequent
2457
+ pages.
2458
+ """
2459
+
2460
+ @property
2461
+ def raw_page(self):
2462
+ return self
2463
+
2464
+ custom_dimensions: MutableSequence[resources.CustomDimension] = proto.RepeatedField(
2465
+ proto.MESSAGE,
2466
+ number=1,
2467
+ message=resources.CustomDimension,
2468
+ )
2469
+ next_page_token: str = proto.Field(
2470
+ proto.STRING,
2471
+ number=2,
2472
+ )
2473
+
2474
+
2475
+ class ArchiveCustomDimensionRequest(proto.Message):
2476
+ r"""Request message for ArchiveCustomDimension RPC.
2477
+
2478
+ Attributes:
2479
+ name (str):
2480
+ Required. The name of the CustomDimension to
2481
+ archive. Example format:
2482
+ properties/1234/customDimensions/5678
2483
+ """
2484
+
2485
+ name: str = proto.Field(
2486
+ proto.STRING,
2487
+ number=1,
2488
+ )
2489
+
2490
+
2491
+ class GetCustomDimensionRequest(proto.Message):
2492
+ r"""Request message for GetCustomDimension RPC.
2493
+
2494
+ Attributes:
2495
+ name (str):
2496
+ Required. The name of the CustomDimension to
2497
+ get. Example format:
2498
+ properties/1234/customDimensions/5678
2499
+ """
2500
+
2501
+ name: str = proto.Field(
2502
+ proto.STRING,
2503
+ number=1,
2504
+ )
2505
+
2506
+
2507
+ class CreateCustomMetricRequest(proto.Message):
2508
+ r"""Request message for CreateCustomMetric RPC.
2509
+
2510
+ Attributes:
2511
+ parent (str):
2512
+ Required. Example format: properties/1234
2513
+ custom_metric (google.analytics.admin_v1alpha.types.CustomMetric):
2514
+ Required. The CustomMetric to create.
2515
+ """
2516
+
2517
+ parent: str = proto.Field(
2518
+ proto.STRING,
2519
+ number=1,
2520
+ )
2521
+ custom_metric: resources.CustomMetric = proto.Field(
2522
+ proto.MESSAGE,
2523
+ number=2,
2524
+ message=resources.CustomMetric,
2525
+ )
2526
+
2527
+
2528
+ class UpdateCustomMetricRequest(proto.Message):
2529
+ r"""Request message for UpdateCustomMetric RPC.
2530
+
2531
+ Attributes:
2532
+ custom_metric (google.analytics.admin_v1alpha.types.CustomMetric):
2533
+ The CustomMetric to update
2534
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
2535
+ Required. The list of fields to be updated. Omitted fields
2536
+ will not be updated. To replace the entire entity, use one
2537
+ path with the string "*" to match all fields.
2538
+ """
2539
+
2540
+ custom_metric: resources.CustomMetric = proto.Field(
2541
+ proto.MESSAGE,
2542
+ number=1,
2543
+ message=resources.CustomMetric,
2544
+ )
2545
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
2546
+ proto.MESSAGE,
2547
+ number=2,
2548
+ message=field_mask_pb2.FieldMask,
2549
+ )
2550
+
2551
+
2552
+ class ListCustomMetricsRequest(proto.Message):
2553
+ r"""Request message for ListCustomMetrics RPC.
2554
+
2555
+ Attributes:
2556
+ parent (str):
2557
+ Required. Example format: properties/1234
2558
+ page_size (int):
2559
+ The maximum number of resources to return.
2560
+ If unspecified, at most 50 resources will be
2561
+ returned. The maximum value is 200 (higher
2562
+ values will be coerced to the maximum).
2563
+ page_token (str):
2564
+ A page token, received from a previous ``ListCustomMetrics``
2565
+ call. Provide this to retrieve the subsequent page.
2566
+
2567
+ When paginating, all other parameters provided to
2568
+ ``ListCustomMetrics`` must match the call that provided the
2569
+ page token.
2570
+ """
2571
+
2572
+ parent: str = proto.Field(
2573
+ proto.STRING,
2574
+ number=1,
2575
+ )
2576
+ page_size: int = proto.Field(
2577
+ proto.INT32,
2578
+ number=2,
2579
+ )
2580
+ page_token: str = proto.Field(
2581
+ proto.STRING,
2582
+ number=3,
2583
+ )
2584
+
2585
+
2586
+ class ListCustomMetricsResponse(proto.Message):
2587
+ r"""Response message for ListCustomMetrics RPC.
2588
+
2589
+ Attributes:
2590
+ custom_metrics (MutableSequence[google.analytics.admin_v1alpha.types.CustomMetric]):
2591
+ List of CustomMetrics.
2592
+ next_page_token (str):
2593
+ A token, which can be sent as ``page_token`` to retrieve the
2594
+ next page. If this field is omitted, there are no subsequent
2595
+ pages.
2596
+ """
2597
+
2598
+ @property
2599
+ def raw_page(self):
2600
+ return self
2601
+
2602
+ custom_metrics: MutableSequence[resources.CustomMetric] = proto.RepeatedField(
2603
+ proto.MESSAGE,
2604
+ number=1,
2605
+ message=resources.CustomMetric,
2606
+ )
2607
+ next_page_token: str = proto.Field(
2608
+ proto.STRING,
2609
+ number=2,
2610
+ )
2611
+
2612
+
2613
+ class ArchiveCustomMetricRequest(proto.Message):
2614
+ r"""Request message for ArchiveCustomMetric RPC.
2615
+
2616
+ Attributes:
2617
+ name (str):
2618
+ Required. The name of the CustomMetric to
2619
+ archive. Example format:
2620
+ properties/1234/customMetrics/5678
2621
+ """
2622
+
2623
+ name: str = proto.Field(
2624
+ proto.STRING,
2625
+ number=1,
2626
+ )
2627
+
2628
+
2629
+ class GetCustomMetricRequest(proto.Message):
2630
+ r"""Request message for GetCustomMetric RPC.
2631
+
2632
+ Attributes:
2633
+ name (str):
2634
+ Required. The name of the CustomMetric to
2635
+ get. Example format:
2636
+ properties/1234/customMetrics/5678
2637
+ """
2638
+
2639
+ name: str = proto.Field(
2640
+ proto.STRING,
2641
+ number=1,
2642
+ )
2643
+
2644
+
2645
+ class CreateCalculatedMetricRequest(proto.Message):
2646
+ r"""Request message for CreateCalculatedMetric RPC.
2647
+
2648
+ Attributes:
2649
+ parent (str):
2650
+ Required. Format: properties/{property_id} Example:
2651
+ properties/1234
2652
+ calculated_metric_id (str):
2653
+ Required. The ID to use for the calculated metric which will
2654
+ become the final component of the calculated metric's
2655
+ resource name.
2656
+
2657
+ This value should be 1-80 characters and valid characters
2658
+ are `[a-zA-Z0-9_]`, no spaces allowed. calculated_metric_id
2659
+ must be unique between all calculated metrics under a
2660
+ property. The calculated_metric_id is used when referencing
2661
+ this calculated metric from external APIs, for example,
2662
+ "calcMetric:{calculated_metric_id}".
2663
+ calculated_metric (google.analytics.admin_v1alpha.types.CalculatedMetric):
2664
+ Required. The CalculatedMetric to create.
2665
+ """
2666
+
2667
+ parent: str = proto.Field(
2668
+ proto.STRING,
2669
+ number=1,
2670
+ )
2671
+ calculated_metric_id: str = proto.Field(
2672
+ proto.STRING,
2673
+ number=2,
2674
+ )
2675
+ calculated_metric: resources.CalculatedMetric = proto.Field(
2676
+ proto.MESSAGE,
2677
+ number=3,
2678
+ message=resources.CalculatedMetric,
2679
+ )
2680
+
2681
+
2682
+ class UpdateCalculatedMetricRequest(proto.Message):
2683
+ r"""Request message for UpdateCalculatedMetric RPC.
2684
+
2685
+ Attributes:
2686
+ calculated_metric (google.analytics.admin_v1alpha.types.CalculatedMetric):
2687
+ Required. The CalculatedMetric to update
2688
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
2689
+ Required. The list of fields to be updated. Omitted fields
2690
+ will not be updated. To replace the entire entity, use one
2691
+ path with the string "*" to match all fields.
2692
+ """
2693
+
2694
+ calculated_metric: resources.CalculatedMetric = proto.Field(
2695
+ proto.MESSAGE,
2696
+ number=1,
2697
+ message=resources.CalculatedMetric,
2698
+ )
2699
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
2700
+ proto.MESSAGE,
2701
+ number=2,
2702
+ message=field_mask_pb2.FieldMask,
2703
+ )
2704
+
2705
+
2706
+ class DeleteCalculatedMetricRequest(proto.Message):
2707
+ r"""Request message for DeleteCalculatedMetric RPC.
2708
+
2709
+ Attributes:
2710
+ name (str):
2711
+ Required. The name of the CalculatedMetric to delete.
2712
+ Format:
2713
+ properties/{property_id}/calculatedMetrics/{calculated_metric_id}
2714
+ Example: properties/1234/calculatedMetrics/Metric01
2715
+ """
2716
+
2717
+ name: str = proto.Field(
2718
+ proto.STRING,
2719
+ number=1,
2720
+ )
2721
+
2722
+
2723
+ class ListCalculatedMetricsRequest(proto.Message):
2724
+ r"""Request message for ListCalculatedMetrics RPC.
2725
+
2726
+ Attributes:
2727
+ parent (str):
2728
+ Required. Example format: properties/1234
2729
+ page_size (int):
2730
+ Optional. The maximum number of resources to
2731
+ return. If unspecified, at most 50 resources
2732
+ will be returned. The maximum value is 200
2733
+ (higher values will be coerced to the maximum).
2734
+ page_token (str):
2735
+ Optional. A page token, received from a previous
2736
+ ``ListCalculatedMetrics`` call. Provide this to retrieve the
2737
+ subsequent page.
2738
+
2739
+ When paginating, all other parameters provided to
2740
+ ``ListCalculatedMetrics`` must match the call that provided
2741
+ the page token.
2742
+ """
2743
+
2744
+ parent: str = proto.Field(
2745
+ proto.STRING,
2746
+ number=1,
2747
+ )
2748
+ page_size: int = proto.Field(
2749
+ proto.INT32,
2750
+ number=2,
2751
+ )
2752
+ page_token: str = proto.Field(
2753
+ proto.STRING,
2754
+ number=3,
2755
+ )
2756
+
2757
+
2758
+ class ListCalculatedMetricsResponse(proto.Message):
2759
+ r"""Response message for ListCalculatedMetrics RPC.
2760
+
2761
+ Attributes:
2762
+ calculated_metrics (MutableSequence[google.analytics.admin_v1alpha.types.CalculatedMetric]):
2763
+ List of CalculatedMetrics.
2764
+ next_page_token (str):
2765
+ A token, which can be sent as ``page_token`` to retrieve the
2766
+ next page. If this field is omitted, there are no subsequent
2767
+ pages.
2768
+ """
2769
+
2770
+ @property
2771
+ def raw_page(self):
2772
+ return self
2773
+
2774
+ calculated_metrics: MutableSequence[
2775
+ resources.CalculatedMetric
2776
+ ] = proto.RepeatedField(
2777
+ proto.MESSAGE,
2778
+ number=1,
2779
+ message=resources.CalculatedMetric,
2780
+ )
2781
+ next_page_token: str = proto.Field(
2782
+ proto.STRING,
2783
+ number=2,
2784
+ )
2785
+
2786
+
2787
+ class GetCalculatedMetricRequest(proto.Message):
2788
+ r"""Request message for GetCalculatedMetric RPC.
2789
+
2790
+ Attributes:
2791
+ name (str):
2792
+ Required. The name of the CalculatedMetric to get. Format:
2793
+ properties/{property_id}/calculatedMetrics/{calculated_metric_id}
2794
+ Example: properties/1234/calculatedMetrics/Metric01
2795
+ """
2796
+
2797
+ name: str = proto.Field(
2798
+ proto.STRING,
2799
+ number=1,
2800
+ )
2801
+
2802
+
2803
+ class GetDataRetentionSettingsRequest(proto.Message):
2804
+ r"""Request message for GetDataRetentionSettings RPC.
2805
+
2806
+ Attributes:
2807
+ name (str):
2808
+ Required. The name of the settings to lookup.
2809
+ Format:
2810
+
2811
+ properties/{property}/dataRetentionSettings
2812
+ Example: "properties/1000/dataRetentionSettings".
2813
+ """
2814
+
2815
+ name: str = proto.Field(
2816
+ proto.STRING,
2817
+ number=1,
2818
+ )
2819
+
2820
+
2821
+ class UpdateDataRetentionSettingsRequest(proto.Message):
2822
+ r"""Request message for UpdateDataRetentionSettings RPC.
2823
+
2824
+ Attributes:
2825
+ data_retention_settings (google.analytics.admin_v1alpha.types.DataRetentionSettings):
2826
+ Required. The settings to update. The ``name`` field is used
2827
+ to identify the settings to be updated.
2828
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
2829
+ Required. The list of fields to be updated. Field names must
2830
+ be in snake case (e.g., "field_to_update"). Omitted fields
2831
+ will not be updated. To replace the entire entity, use one
2832
+ path with the string "*" to match all fields.
2833
+ """
2834
+
2835
+ data_retention_settings: resources.DataRetentionSettings = proto.Field(
2836
+ proto.MESSAGE,
2837
+ number=1,
2838
+ message=resources.DataRetentionSettings,
2839
+ )
2840
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
2841
+ proto.MESSAGE,
2842
+ number=2,
2843
+ message=field_mask_pb2.FieldMask,
2844
+ )
2845
+
2846
+
2847
+ class CreateDataStreamRequest(proto.Message):
2848
+ r"""Request message for CreateDataStream RPC.
2849
+
2850
+ Attributes:
2851
+ parent (str):
2852
+ Required. Example format: properties/1234
2853
+ data_stream (google.analytics.admin_v1alpha.types.DataStream):
2854
+ Required. The DataStream to create.
2855
+ """
2856
+
2857
+ parent: str = proto.Field(
2858
+ proto.STRING,
2859
+ number=1,
2860
+ )
2861
+ data_stream: resources.DataStream = proto.Field(
2862
+ proto.MESSAGE,
2863
+ number=2,
2864
+ message=resources.DataStream,
2865
+ )
2866
+
2867
+
2868
+ class DeleteDataStreamRequest(proto.Message):
2869
+ r"""Request message for DeleteDataStream RPC.
2870
+
2871
+ Attributes:
2872
+ name (str):
2873
+ Required. The name of the DataStream to
2874
+ delete. Example format:
2875
+ properties/1234/dataStreams/5678
2876
+ """
2877
+
2878
+ name: str = proto.Field(
2879
+ proto.STRING,
2880
+ number=1,
2881
+ )
2882
+
2883
+
2884
+ class UpdateDataStreamRequest(proto.Message):
2885
+ r"""Request message for UpdateDataStream RPC.
2886
+
2887
+ Attributes:
2888
+ data_stream (google.analytics.admin_v1alpha.types.DataStream):
2889
+ The DataStream to update
2890
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
2891
+ Required. The list of fields to be updated. Omitted fields
2892
+ will not be updated. To replace the entire entity, use one
2893
+ path with the string "*" to match all fields.
2894
+ """
2895
+
2896
+ data_stream: resources.DataStream = proto.Field(
2897
+ proto.MESSAGE,
2898
+ number=1,
2899
+ message=resources.DataStream,
2900
+ )
2901
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
2902
+ proto.MESSAGE,
2903
+ number=2,
2904
+ message=field_mask_pb2.FieldMask,
2905
+ )
2906
+
2907
+
2908
+ class ListDataStreamsRequest(proto.Message):
2909
+ r"""Request message for ListDataStreams RPC.
2910
+
2911
+ Attributes:
2912
+ parent (str):
2913
+ Required. Example format: properties/1234
2914
+ page_size (int):
2915
+ The maximum number of resources to return.
2916
+ If unspecified, at most 50 resources will be
2917
+ returned. The maximum value is 200 (higher
2918
+ values will be coerced to the maximum).
2919
+ page_token (str):
2920
+ A page token, received from a previous ``ListDataStreams``
2921
+ call. Provide this to retrieve the subsequent page.
2922
+
2923
+ When paginating, all other parameters provided to
2924
+ ``ListDataStreams`` must match the call that provided the
2925
+ page token.
2926
+ """
2927
+
2928
+ parent: str = proto.Field(
2929
+ proto.STRING,
2930
+ number=1,
2931
+ )
2932
+ page_size: int = proto.Field(
2933
+ proto.INT32,
2934
+ number=2,
2935
+ )
2936
+ page_token: str = proto.Field(
2937
+ proto.STRING,
2938
+ number=3,
2939
+ )
2940
+
2941
+
2942
+ class ListDataStreamsResponse(proto.Message):
2943
+ r"""Response message for ListDataStreams RPC.
2944
+
2945
+ Attributes:
2946
+ data_streams (MutableSequence[google.analytics.admin_v1alpha.types.DataStream]):
2947
+ List of DataStreams.
2948
+ next_page_token (str):
2949
+ A token, which can be sent as ``page_token`` to retrieve the
2950
+ next page. If this field is omitted, there are no subsequent
2951
+ pages.
2952
+ """
2953
+
2954
+ @property
2955
+ def raw_page(self):
2956
+ return self
2957
+
2958
+ data_streams: MutableSequence[resources.DataStream] = proto.RepeatedField(
2959
+ proto.MESSAGE,
2960
+ number=1,
2961
+ message=resources.DataStream,
2962
+ )
2963
+ next_page_token: str = proto.Field(
2964
+ proto.STRING,
2965
+ number=2,
2966
+ )
2967
+
2968
+
2969
+ class GetDataStreamRequest(proto.Message):
2970
+ r"""Request message for GetDataStream RPC.
2971
+
2972
+ Attributes:
2973
+ name (str):
2974
+ Required. The name of the DataStream to get.
2975
+ Example format: properties/1234/dataStreams/5678
2976
+ """
2977
+
2978
+ name: str = proto.Field(
2979
+ proto.STRING,
2980
+ number=1,
2981
+ )
2982
+
2983
+
2984
+ class GetAudienceRequest(proto.Message):
2985
+ r"""Request message for GetAudience RPC.
2986
+
2987
+ Attributes:
2988
+ name (str):
2989
+ Required. The name of the Audience to get.
2990
+ Example format: properties/1234/audiences/5678
2991
+ """
2992
+
2993
+ name: str = proto.Field(
2994
+ proto.STRING,
2995
+ number=1,
2996
+ )
2997
+
2998
+
2999
+ class ListAudiencesRequest(proto.Message):
3000
+ r"""Request message for ListAudiences RPC.
3001
+
3002
+ Attributes:
3003
+ parent (str):
3004
+ Required. Example format: properties/1234
3005
+ page_size (int):
3006
+ The maximum number of resources to return.
3007
+ If unspecified, at most 50 resources will be
3008
+ returned. The maximum value is 200 (higher
3009
+ values will be coerced to the maximum).
3010
+ page_token (str):
3011
+ A page token, received from a previous ``ListAudiences``
3012
+ call. Provide this to retrieve the subsequent page.
3013
+
3014
+ When paginating, all other parameters provided to
3015
+ ``ListAudiences`` must match the call that provided the page
3016
+ token.
3017
+ """
3018
+
3019
+ parent: str = proto.Field(
3020
+ proto.STRING,
3021
+ number=1,
3022
+ )
3023
+ page_size: int = proto.Field(
3024
+ proto.INT32,
3025
+ number=2,
3026
+ )
3027
+ page_token: str = proto.Field(
3028
+ proto.STRING,
3029
+ number=3,
3030
+ )
3031
+
3032
+
3033
+ class ListAudiencesResponse(proto.Message):
3034
+ r"""Response message for ListAudiences RPC.
3035
+
3036
+ Attributes:
3037
+ audiences (MutableSequence[google.analytics.admin_v1alpha.types.Audience]):
3038
+ List of Audiences.
3039
+ next_page_token (str):
3040
+ A token, which can be sent as ``page_token`` to retrieve the
3041
+ next page. If this field is omitted, there are no subsequent
3042
+ pages.
3043
+ """
3044
+
3045
+ @property
3046
+ def raw_page(self):
3047
+ return self
3048
+
3049
+ audiences: MutableSequence[gaa_audience.Audience] = proto.RepeatedField(
3050
+ proto.MESSAGE,
3051
+ number=1,
3052
+ message=gaa_audience.Audience,
3053
+ )
3054
+ next_page_token: str = proto.Field(
3055
+ proto.STRING,
3056
+ number=2,
3057
+ )
3058
+
3059
+
3060
+ class CreateAudienceRequest(proto.Message):
3061
+ r"""Request message for CreateAudience RPC.
3062
+
3063
+ Attributes:
3064
+ parent (str):
3065
+ Required. Example format: properties/1234
3066
+ audience (google.analytics.admin_v1alpha.types.Audience):
3067
+ Required. The audience to create.
3068
+ """
3069
+
3070
+ parent: str = proto.Field(
3071
+ proto.STRING,
3072
+ number=1,
3073
+ )
3074
+ audience: gaa_audience.Audience = proto.Field(
3075
+ proto.MESSAGE,
3076
+ number=2,
3077
+ message=gaa_audience.Audience,
3078
+ )
3079
+
3080
+
3081
+ class UpdateAudienceRequest(proto.Message):
3082
+ r"""Request message for UpdateAudience RPC.
3083
+
3084
+ Attributes:
3085
+ audience (google.analytics.admin_v1alpha.types.Audience):
3086
+ Required. The audience to update. The audience's ``name``
3087
+ field is used to identify the audience to be updated.
3088
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
3089
+ Required. The list of fields to be updated. Field names must
3090
+ be in snake case (e.g., "field_to_update"). Omitted fields
3091
+ will not be updated. To replace the entire entity, use one
3092
+ path with the string "*" to match all fields.
3093
+ """
3094
+
3095
+ audience: gaa_audience.Audience = proto.Field(
3096
+ proto.MESSAGE,
3097
+ number=1,
3098
+ message=gaa_audience.Audience,
3099
+ )
3100
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
3101
+ proto.MESSAGE,
3102
+ number=2,
3103
+ message=field_mask_pb2.FieldMask,
3104
+ )
3105
+
3106
+
3107
+ class ArchiveAudienceRequest(proto.Message):
3108
+ r"""Request message for ArchiveAudience RPC.
3109
+
3110
+ Attributes:
3111
+ name (str):
3112
+ Required. Example format:
3113
+ properties/1234/audiences/5678
3114
+ """
3115
+
3116
+ name: str = proto.Field(
3117
+ proto.STRING,
3118
+ number=1,
3119
+ )
3120
+
3121
+
3122
+ class GetAttributionSettingsRequest(proto.Message):
3123
+ r"""Request message for GetAttributionSettings RPC.
3124
+
3125
+ Attributes:
3126
+ name (str):
3127
+ Required. The name of the attribution
3128
+ settings to retrieve. Format:
3129
+ properties/{property}/attributionSettings
3130
+ """
3131
+
3132
+ name: str = proto.Field(
3133
+ proto.STRING,
3134
+ number=1,
3135
+ )
3136
+
3137
+
3138
+ class UpdateAttributionSettingsRequest(proto.Message):
3139
+ r"""Request message for UpdateAttributionSettings RPC
3140
+
3141
+ Attributes:
3142
+ attribution_settings (google.analytics.admin_v1alpha.types.AttributionSettings):
3143
+ Required. The attribution settings to update. The ``name``
3144
+ field is used to identify the settings to be updated.
3145
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
3146
+ Required. The list of fields to be updated. Field names must
3147
+ be in snake case (e.g., "field_to_update"). Omitted fields
3148
+ will not be updated. To replace the entire entity, use one
3149
+ path with the string "*" to match all fields.
3150
+ """
3151
+
3152
+ attribution_settings: resources.AttributionSettings = proto.Field(
3153
+ proto.MESSAGE,
3154
+ number=1,
3155
+ message=resources.AttributionSettings,
3156
+ )
3157
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
3158
+ proto.MESSAGE,
3159
+ number=2,
3160
+ message=field_mask_pb2.FieldMask,
3161
+ )
3162
+
3163
+
3164
+ class GetAccessBindingRequest(proto.Message):
3165
+ r"""Request message for GetAccessBinding RPC.
3166
+
3167
+ Attributes:
3168
+ name (str):
3169
+ Required. The name of the access binding to
3170
+ retrieve. Formats:
3171
+
3172
+ -
3173
+ accounts/{account}/accessBindings/{accessBinding}
3174
+ -
3175
+ properties/{property}/accessBindings/{accessBinding}
3176
+ """
3177
+
3178
+ name: str = proto.Field(
3179
+ proto.STRING,
3180
+ number=1,
3181
+ )
3182
+
3183
+
3184
+ class BatchGetAccessBindingsRequest(proto.Message):
3185
+ r"""Request message for BatchGetAccessBindings RPC.
3186
+
3187
+ Attributes:
3188
+ parent (str):
3189
+ Required. The account or property that owns
3190
+ the access bindings. The parent of all provided
3191
+ values for the 'names' field must match this
3192
+ field. Formats:
3193
+
3194
+ - accounts/{account}
3195
+ - properties/{property}
3196
+ names (MutableSequence[str]):
3197
+ Required. The names of the access bindings to
3198
+ retrieve. A maximum of 1000 access bindings can
3199
+ be retrieved in a batch. Formats:
3200
+
3201
+ -
3202
+ accounts/{account}/accessBindings/{accessBinding}
3203
+ -
3204
+ properties/{property}/accessBindings/{accessBinding}
3205
+ """
3206
+
3207
+ parent: str = proto.Field(
3208
+ proto.STRING,
3209
+ number=1,
3210
+ )
3211
+ names: MutableSequence[str] = proto.RepeatedField(
3212
+ proto.STRING,
3213
+ number=2,
3214
+ )
3215
+
3216
+
3217
+ class BatchGetAccessBindingsResponse(proto.Message):
3218
+ r"""Response message for BatchGetAccessBindings RPC.
3219
+
3220
+ Attributes:
3221
+ access_bindings (MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]):
3222
+ The requested access bindings.
3223
+ """
3224
+
3225
+ access_bindings: MutableSequence[resources.AccessBinding] = proto.RepeatedField(
3226
+ proto.MESSAGE,
3227
+ number=1,
3228
+ message=resources.AccessBinding,
3229
+ )
3230
+
3231
+
3232
+ class ListAccessBindingsRequest(proto.Message):
3233
+ r"""Request message for ListAccessBindings RPC.
3234
+
3235
+ Attributes:
3236
+ parent (str):
3237
+ Required. Formats:
3238
+
3239
+ - accounts/{account}
3240
+ - properties/{property}
3241
+ page_size (int):
3242
+ The maximum number of access bindings to
3243
+ return. The service may return fewer than this
3244
+ value. If unspecified, at most 200 access
3245
+ bindings will be returned. The maximum value is
3246
+ 500; values above 500 will be coerced to 500.
3247
+ page_token (str):
3248
+ A page token, received from a previous
3249
+ ``ListAccessBindings`` call. Provide this to retrieve the
3250
+ subsequent page. When paginating, all other parameters
3251
+ provided to ``ListAccessBindings`` must match the call that
3252
+ provided the page token.
3253
+ """
3254
+
3255
+ parent: str = proto.Field(
3256
+ proto.STRING,
3257
+ number=1,
3258
+ )
3259
+ page_size: int = proto.Field(
3260
+ proto.INT32,
3261
+ number=2,
3262
+ )
3263
+ page_token: str = proto.Field(
3264
+ proto.STRING,
3265
+ number=3,
3266
+ )
3267
+
3268
+
3269
+ class ListAccessBindingsResponse(proto.Message):
3270
+ r"""Response message for ListAccessBindings RPC.
3271
+
3272
+ Attributes:
3273
+ access_bindings (MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]):
3274
+ List of AccessBindings. These will be ordered
3275
+ stably, but in an arbitrary order.
3276
+ next_page_token (str):
3277
+ A token, which can be sent as ``page_token`` to retrieve the
3278
+ next page. If this field is omitted, there are no subsequent
3279
+ pages.
3280
+ """
3281
+
3282
+ @property
3283
+ def raw_page(self):
3284
+ return self
3285
+
3286
+ access_bindings: MutableSequence[resources.AccessBinding] = proto.RepeatedField(
3287
+ proto.MESSAGE,
3288
+ number=1,
3289
+ message=resources.AccessBinding,
3290
+ )
3291
+ next_page_token: str = proto.Field(
3292
+ proto.STRING,
3293
+ number=2,
3294
+ )
3295
+
3296
+
3297
+ class CreateAccessBindingRequest(proto.Message):
3298
+ r"""Request message for CreateAccessBinding RPC.
3299
+
3300
+ Attributes:
3301
+ parent (str):
3302
+ Required. Formats:
3303
+
3304
+ - accounts/{account}
3305
+ - properties/{property}
3306
+ access_binding (google.analytics.admin_v1alpha.types.AccessBinding):
3307
+ Required. The access binding to create.
3308
+ """
3309
+
3310
+ parent: str = proto.Field(
3311
+ proto.STRING,
3312
+ number=1,
3313
+ )
3314
+ access_binding: resources.AccessBinding = proto.Field(
3315
+ proto.MESSAGE,
3316
+ number=2,
3317
+ message=resources.AccessBinding,
3318
+ )
3319
+
3320
+
3321
+ class BatchCreateAccessBindingsRequest(proto.Message):
3322
+ r"""Request message for BatchCreateAccessBindings RPC.
3323
+
3324
+ Attributes:
3325
+ parent (str):
3326
+ Required. The account or property that owns
3327
+ the access bindings. The parent field in the
3328
+ CreateAccessBindingRequest messages must either
3329
+ be empty or match this field. Formats:
3330
+
3331
+ - accounts/{account}
3332
+ - properties/{property}
3333
+ requests (MutableSequence[google.analytics.admin_v1alpha.types.CreateAccessBindingRequest]):
3334
+ Required. The requests specifying the access
3335
+ bindings to create. A maximum of 1000 access
3336
+ bindings can be created in a batch.
3337
+ """
3338
+
3339
+ parent: str = proto.Field(
3340
+ proto.STRING,
3341
+ number=1,
3342
+ )
3343
+ requests: MutableSequence["CreateAccessBindingRequest"] = proto.RepeatedField(
3344
+ proto.MESSAGE,
3345
+ number=3,
3346
+ message="CreateAccessBindingRequest",
3347
+ )
3348
+
3349
+
3350
+ class BatchCreateAccessBindingsResponse(proto.Message):
3351
+ r"""Response message for BatchCreateAccessBindings RPC.
3352
+
3353
+ Attributes:
3354
+ access_bindings (MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]):
3355
+ The access bindings created.
3356
+ """
3357
+
3358
+ access_bindings: MutableSequence[resources.AccessBinding] = proto.RepeatedField(
3359
+ proto.MESSAGE,
3360
+ number=1,
3361
+ message=resources.AccessBinding,
3362
+ )
3363
+
3364
+
3365
+ class UpdateAccessBindingRequest(proto.Message):
3366
+ r"""Request message for UpdateAccessBinding RPC.
3367
+
3368
+ Attributes:
3369
+ access_binding (google.analytics.admin_v1alpha.types.AccessBinding):
3370
+ Required. The access binding to update.
3371
+ """
3372
+
3373
+ access_binding: resources.AccessBinding = proto.Field(
3374
+ proto.MESSAGE,
3375
+ number=1,
3376
+ message=resources.AccessBinding,
3377
+ )
3378
+
3379
+
3380
+ class BatchUpdateAccessBindingsRequest(proto.Message):
3381
+ r"""Request message for BatchUpdateAccessBindings RPC.
3382
+
3383
+ Attributes:
3384
+ parent (str):
3385
+ Required. The account or property that owns
3386
+ the access bindings. The parent of all provided
3387
+ AccessBinding in UpdateAccessBindingRequest
3388
+ messages must match this field.
3389
+ Formats:
3390
+
3391
+ - accounts/{account}
3392
+ - properties/{property}
3393
+ requests (MutableSequence[google.analytics.admin_v1alpha.types.UpdateAccessBindingRequest]):
3394
+ Required. The requests specifying the access
3395
+ bindings to update. A maximum of 1000 access
3396
+ bindings can be updated in a batch.
3397
+ """
3398
+
3399
+ parent: str = proto.Field(
3400
+ proto.STRING,
3401
+ number=1,
3402
+ )
3403
+ requests: MutableSequence["UpdateAccessBindingRequest"] = proto.RepeatedField(
3404
+ proto.MESSAGE,
3405
+ number=2,
3406
+ message="UpdateAccessBindingRequest",
3407
+ )
3408
+
3409
+
3410
+ class BatchUpdateAccessBindingsResponse(proto.Message):
3411
+ r"""Response message for BatchUpdateAccessBindings RPC.
3412
+
3413
+ Attributes:
3414
+ access_bindings (MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]):
3415
+ The access bindings updated.
3416
+ """
3417
+
3418
+ access_bindings: MutableSequence[resources.AccessBinding] = proto.RepeatedField(
3419
+ proto.MESSAGE,
3420
+ number=1,
3421
+ message=resources.AccessBinding,
3422
+ )
3423
+
3424
+
3425
+ class DeleteAccessBindingRequest(proto.Message):
3426
+ r"""Request message for DeleteAccessBinding RPC.
3427
+
3428
+ Attributes:
3429
+ name (str):
3430
+ Required. Formats:
3431
+
3432
+ -
3433
+ accounts/{account}/accessBindings/{accessBinding}
3434
+ -
3435
+ properties/{property}/accessBindings/{accessBinding}
3436
+ """
3437
+
3438
+ name: str = proto.Field(
3439
+ proto.STRING,
3440
+ number=1,
3441
+ )
3442
+
3443
+
3444
+ class BatchDeleteAccessBindingsRequest(proto.Message):
3445
+ r"""Request message for BatchDeleteAccessBindings RPC.
3446
+
3447
+ Attributes:
3448
+ parent (str):
3449
+ Required. The account or property that owns
3450
+ the access bindings. The parent of all provided
3451
+ values for the 'names' field in
3452
+ DeleteAccessBindingRequest messages must match
3453
+ this field. Formats:
3454
+
3455
+ - accounts/{account}
3456
+ - properties/{property}
3457
+ requests (MutableSequence[google.analytics.admin_v1alpha.types.DeleteAccessBindingRequest]):
3458
+ Required. The requests specifying the access
3459
+ bindings to delete. A maximum of 1000 access
3460
+ bindings can be deleted in a batch.
3461
+ """
3462
+
3463
+ parent: str = proto.Field(
3464
+ proto.STRING,
3465
+ number=1,
3466
+ )
3467
+ requests: MutableSequence["DeleteAccessBindingRequest"] = proto.RepeatedField(
3468
+ proto.MESSAGE,
3469
+ number=2,
3470
+ message="DeleteAccessBindingRequest",
3471
+ )
3472
+
3473
+
3474
+ class CreateExpandedDataSetRequest(proto.Message):
3475
+ r"""Request message for CreateExpandedDataSet RPC.
3476
+
3477
+ Attributes:
3478
+ parent (str):
3479
+ Required. Example format: properties/1234
3480
+ expanded_data_set (google.analytics.admin_v1alpha.types.ExpandedDataSet):
3481
+ Required. The ExpandedDataSet to create.
3482
+ """
3483
+
3484
+ parent: str = proto.Field(
3485
+ proto.STRING,
3486
+ number=1,
3487
+ )
3488
+ expanded_data_set: gaa_expanded_data_set.ExpandedDataSet = proto.Field(
3489
+ proto.MESSAGE,
3490
+ number=2,
3491
+ message=gaa_expanded_data_set.ExpandedDataSet,
3492
+ )
3493
+
3494
+
3495
+ class UpdateExpandedDataSetRequest(proto.Message):
3496
+ r"""Request message for UpdateExpandedDataSet RPC.
3497
+
3498
+ Attributes:
3499
+ expanded_data_set (google.analytics.admin_v1alpha.types.ExpandedDataSet):
3500
+ Required. The ExpandedDataSet to update. The resource's
3501
+ ``name`` field is used to identify the ExpandedDataSet to be
3502
+ updated.
3503
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
3504
+ Required. The list of fields to be updated. Field names must
3505
+ be in snake case (e.g., "field_to_update"). Omitted fields
3506
+ will not be updated. To replace the entire entity, use one
3507
+ path with the string "*" to match all fields.
3508
+ """
3509
+
3510
+ expanded_data_set: gaa_expanded_data_set.ExpandedDataSet = proto.Field(
3511
+ proto.MESSAGE,
3512
+ number=1,
3513
+ message=gaa_expanded_data_set.ExpandedDataSet,
3514
+ )
3515
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
3516
+ proto.MESSAGE,
3517
+ number=2,
3518
+ message=field_mask_pb2.FieldMask,
3519
+ )
3520
+
3521
+
3522
+ class DeleteExpandedDataSetRequest(proto.Message):
3523
+ r"""Request message for DeleteExpandedDataSet RPC.
3524
+
3525
+ Attributes:
3526
+ name (str):
3527
+ Required. Example format:
3528
+ properties/1234/expandedDataSets/5678
3529
+ """
3530
+
3531
+ name: str = proto.Field(
3532
+ proto.STRING,
3533
+ number=1,
3534
+ )
3535
+
3536
+
3537
+ class GetExpandedDataSetRequest(proto.Message):
3538
+ r"""Request message for GetExpandedDataSet RPC.
3539
+
3540
+ Attributes:
3541
+ name (str):
3542
+ Required. The name of the ExpandedDataSet to
3543
+ get. Example format:
3544
+ properties/1234/expandedDataSets/5678
3545
+ """
3546
+
3547
+ name: str = proto.Field(
3548
+ proto.STRING,
3549
+ number=1,
3550
+ )
3551
+
3552
+
3553
+ class ListExpandedDataSetsRequest(proto.Message):
3554
+ r"""Request message for ListExpandedDataSets RPC.
3555
+
3556
+ Attributes:
3557
+ parent (str):
3558
+ Required. Example format: properties/1234
3559
+ page_size (int):
3560
+ The maximum number of resources to return.
3561
+ If unspecified, at most 50 resources will be
3562
+ returned. The maximum value is 200 (higher
3563
+ values will be coerced to the maximum).
3564
+ page_token (str):
3565
+ A page token, received from a previous
3566
+ ``ListExpandedDataSets`` call. Provide this to retrieve the
3567
+ subsequent page.
3568
+
3569
+ When paginating, all other parameters provided to
3570
+ ``ListExpandedDataSet`` must match the call that provided
3571
+ the page token.
3572
+ """
3573
+
3574
+ parent: str = proto.Field(
3575
+ proto.STRING,
3576
+ number=1,
3577
+ )
3578
+ page_size: int = proto.Field(
3579
+ proto.INT32,
3580
+ number=2,
3581
+ )
3582
+ page_token: str = proto.Field(
3583
+ proto.STRING,
3584
+ number=3,
3585
+ )
3586
+
3587
+
3588
+ class ListExpandedDataSetsResponse(proto.Message):
3589
+ r"""Response message for ListExpandedDataSets RPC.
3590
+
3591
+ Attributes:
3592
+ expanded_data_sets (MutableSequence[google.analytics.admin_v1alpha.types.ExpandedDataSet]):
3593
+ List of ExpandedDataSet. These will be
3594
+ ordered stably, but in an arbitrary order.
3595
+ next_page_token (str):
3596
+ A token, which can be sent as ``page_token`` to retrieve the
3597
+ next page. If this field is omitted, there are no subsequent
3598
+ pages.
3599
+ """
3600
+
3601
+ @property
3602
+ def raw_page(self):
3603
+ return self
3604
+
3605
+ expanded_data_sets: MutableSequence[
3606
+ gaa_expanded_data_set.ExpandedDataSet
3607
+ ] = proto.RepeatedField(
3608
+ proto.MESSAGE,
3609
+ number=1,
3610
+ message=gaa_expanded_data_set.ExpandedDataSet,
3611
+ )
3612
+ next_page_token: str = proto.Field(
3613
+ proto.STRING,
3614
+ number=2,
3615
+ )
3616
+
3617
+
3618
+ class CreateChannelGroupRequest(proto.Message):
3619
+ r"""Request message for CreateChannelGroup RPC.
3620
+
3621
+ Attributes:
3622
+ parent (str):
3623
+ Required. The property for which to create a
3624
+ ChannelGroup. Example format: properties/1234
3625
+ channel_group (google.analytics.admin_v1alpha.types.ChannelGroup):
3626
+ Required. The ChannelGroup to create.
3627
+ """
3628
+
3629
+ parent: str = proto.Field(
3630
+ proto.STRING,
3631
+ number=1,
3632
+ )
3633
+ channel_group: gaa_channel_group.ChannelGroup = proto.Field(
3634
+ proto.MESSAGE,
3635
+ number=2,
3636
+ message=gaa_channel_group.ChannelGroup,
3637
+ )
3638
+
3639
+
3640
+ class UpdateChannelGroupRequest(proto.Message):
3641
+ r"""Request message for UpdateChannelGroup RPC.
3642
+
3643
+ Attributes:
3644
+ channel_group (google.analytics.admin_v1alpha.types.ChannelGroup):
3645
+ Required. The ChannelGroup to update. The resource's
3646
+ ``name`` field is used to identify the ChannelGroup to be
3647
+ updated.
3648
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
3649
+ Required. The list of fields to be updated. Field names must
3650
+ be in snake case (e.g., "field_to_update"). Omitted fields
3651
+ will not be updated. To replace the entire entity, use one
3652
+ path with the string "*" to match all fields.
3653
+ """
3654
+
3655
+ channel_group: gaa_channel_group.ChannelGroup = proto.Field(
3656
+ proto.MESSAGE,
3657
+ number=1,
3658
+ message=gaa_channel_group.ChannelGroup,
3659
+ )
3660
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
3661
+ proto.MESSAGE,
3662
+ number=2,
3663
+ message=field_mask_pb2.FieldMask,
3664
+ )
3665
+
3666
+
3667
+ class DeleteChannelGroupRequest(proto.Message):
3668
+ r"""Request message for DeleteChannelGroup RPC.
3669
+
3670
+ Attributes:
3671
+ name (str):
3672
+ Required. The ChannelGroup to delete.
3673
+ Example format:
3674
+ properties/1234/channelGroups/5678
3675
+ """
3676
+
3677
+ name: str = proto.Field(
3678
+ proto.STRING,
3679
+ number=1,
3680
+ )
3681
+
3682
+
3683
+ class GetChannelGroupRequest(proto.Message):
3684
+ r"""Request message for GetChannelGroup RPC.
3685
+
3686
+ Attributes:
3687
+ name (str):
3688
+ Required. The ChannelGroup to get.
3689
+ Example format:
3690
+ properties/1234/channelGroups/5678
3691
+ """
3692
+
3693
+ name: str = proto.Field(
3694
+ proto.STRING,
3695
+ number=1,
3696
+ )
3697
+
3698
+
3699
+ class ListChannelGroupsRequest(proto.Message):
3700
+ r"""Request message for ListChannelGroups RPC.
3701
+
3702
+ Attributes:
3703
+ parent (str):
3704
+ Required. The property for which to list
3705
+ ChannelGroups. Example format: properties/1234
3706
+ page_size (int):
3707
+ The maximum number of resources to return.
3708
+ If unspecified, at most 50 resources will be
3709
+ returned. The maximum value is 200 (higher
3710
+ values will be coerced to the maximum).
3711
+ page_token (str):
3712
+ A page token, received from a previous ``ListChannelGroups``
3713
+ call. Provide this to retrieve the subsequent page.
3714
+
3715
+ When paginating, all other parameters provided to
3716
+ ``ListChannelGroups`` must match the call that provided the
3717
+ page token.
3718
+ """
3719
+
3720
+ parent: str = proto.Field(
3721
+ proto.STRING,
3722
+ number=1,
3723
+ )
3724
+ page_size: int = proto.Field(
3725
+ proto.INT32,
3726
+ number=2,
3727
+ )
3728
+ page_token: str = proto.Field(
3729
+ proto.STRING,
3730
+ number=3,
3731
+ )
3732
+
3733
+
3734
+ class ListChannelGroupsResponse(proto.Message):
3735
+ r"""Response message for ListChannelGroups RPC.
3736
+
3737
+ Attributes:
3738
+ channel_groups (MutableSequence[google.analytics.admin_v1alpha.types.ChannelGroup]):
3739
+ List of ChannelGroup. These will be ordered
3740
+ stably, but in an arbitrary order.
3741
+ next_page_token (str):
3742
+ A token, which can be sent as ``page_token`` to retrieve the
3743
+ next page. If this field is omitted, there are no subsequent
3744
+ pages.
3745
+ """
3746
+
3747
+ @property
3748
+ def raw_page(self):
3749
+ return self
3750
+
3751
+ channel_groups: MutableSequence[
3752
+ gaa_channel_group.ChannelGroup
3753
+ ] = proto.RepeatedField(
3754
+ proto.MESSAGE,
3755
+ number=1,
3756
+ message=gaa_channel_group.ChannelGroup,
3757
+ )
3758
+ next_page_token: str = proto.Field(
3759
+ proto.STRING,
3760
+ number=2,
3761
+ )
3762
+
3763
+
3764
+ class SetAutomatedGa4ConfigurationOptOutRequest(proto.Message):
3765
+ r"""Request for setting the opt out status for the automated GA4
3766
+ setup process.
3767
+
3768
+ Attributes:
3769
+ property (str):
3770
+ Required. The UA property to set the opt out
3771
+ status. Note this request uses the internal
3772
+ property ID, not the tracking ID of the form
3773
+ UA-XXXXXX-YY. Format:
3774
+ properties/{internalWebPropertyId}
3775
+ Example: properties/1234
3776
+ opt_out (bool):
3777
+ The status to set.
3778
+ """
3779
+
3780
+ property: str = proto.Field(
3781
+ proto.STRING,
3782
+ number=1,
3783
+ )
3784
+ opt_out: bool = proto.Field(
3785
+ proto.BOOL,
3786
+ number=2,
3787
+ )
3788
+
3789
+
3790
+ class SetAutomatedGa4ConfigurationOptOutResponse(proto.Message):
3791
+ r"""Response message for setting the opt out status for the
3792
+ automated GA4 setup process.
3793
+
3794
+ """
3795
+
3796
+
3797
+ class FetchAutomatedGa4ConfigurationOptOutRequest(proto.Message):
3798
+ r"""Request for fetching the opt out status for the automated GA4
3799
+ setup process.
3800
+
3801
+ Attributes:
3802
+ property (str):
3803
+ Required. The UA property to get the opt out
3804
+ status. Note this request uses the internal
3805
+ property ID, not the tracking ID of the form
3806
+ UA-XXXXXX-YY. Format:
3807
+ properties/{internalWebPropertyId}
3808
+ Example: properties/1234
3809
+ """
3810
+
3811
+ property: str = proto.Field(
3812
+ proto.STRING,
3813
+ number=1,
3814
+ )
3815
+
3816
+
3817
+ class FetchAutomatedGa4ConfigurationOptOutResponse(proto.Message):
3818
+ r"""Response message for fetching the opt out status for the
3819
+ automated GA4 setup process.
3820
+
3821
+ Attributes:
3822
+ opt_out (bool):
3823
+ The opt out status for the UA property.
3824
+ """
3825
+
3826
+ opt_out: bool = proto.Field(
3827
+ proto.BOOL,
3828
+ number=1,
3829
+ )
3830
+
3831
+
3832
+ class CreateBigQueryLinkRequest(proto.Message):
3833
+ r"""Request message for CreateBigQueryLink RPC.
3834
+
3835
+ Attributes:
3836
+ parent (str):
3837
+ Required. Example format: properties/1234
3838
+ bigquery_link (google.analytics.admin_v1alpha.types.BigQueryLink):
3839
+ Required. The BigQueryLink to create.
3840
+ """
3841
+
3842
+ parent: str = proto.Field(
3843
+ proto.STRING,
3844
+ number=1,
3845
+ )
3846
+ bigquery_link: resources.BigQueryLink = proto.Field(
3847
+ proto.MESSAGE,
3848
+ number=2,
3849
+ message=resources.BigQueryLink,
3850
+ )
3851
+
3852
+
3853
+ class GetBigQueryLinkRequest(proto.Message):
3854
+ r"""Request message for GetBigQueryLink RPC.
3855
+
3856
+ Attributes:
3857
+ name (str):
3858
+ Required. The name of the BigQuery link to lookup. Format:
3859
+ properties/{property_id}/bigQueryLinks/{bigquery_link_id}
3860
+ Example: properties/123/bigQueryLinks/456
3861
+ """
3862
+
3863
+ name: str = proto.Field(
3864
+ proto.STRING,
3865
+ number=1,
3866
+ )
3867
+
3868
+
3869
+ class ListBigQueryLinksRequest(proto.Message):
3870
+ r"""Request message for ListBigQueryLinks RPC.
3871
+
3872
+ Attributes:
3873
+ parent (str):
3874
+ Required. The name of the property to list BigQuery links
3875
+ under. Format: properties/{property_id} Example:
3876
+ properties/1234
3877
+ page_size (int):
3878
+ The maximum number of resources to return.
3879
+ The service may return fewer than this value,
3880
+ even if there are additional pages. If
3881
+ unspecified, at most 50 resources will be
3882
+ returned. The maximum value is 200; (higher
3883
+ values will be coerced to the maximum)
3884
+ page_token (str):
3885
+ A page token, received from a previous ``ListBigQueryLinks``
3886
+ call. Provide this to retrieve the subsequent page. When
3887
+ paginating, all other parameters provided to
3888
+ ``ListBigQueryLinks`` must match the call that provided the
3889
+ page token.
3890
+ """
3891
+
3892
+ parent: str = proto.Field(
3893
+ proto.STRING,
3894
+ number=1,
3895
+ )
3896
+ page_size: int = proto.Field(
3897
+ proto.INT32,
3898
+ number=2,
3899
+ )
3900
+ page_token: str = proto.Field(
3901
+ proto.STRING,
3902
+ number=3,
3903
+ )
3904
+
3905
+
3906
+ class ListBigQueryLinksResponse(proto.Message):
3907
+ r"""Response message for ListBigQueryLinks RPC
3908
+
3909
+ Attributes:
3910
+ bigquery_links (MutableSequence[google.analytics.admin_v1alpha.types.BigQueryLink]):
3911
+ List of BigQueryLinks.
3912
+ next_page_token (str):
3913
+ A token, which can be sent as ``page_token`` to retrieve the
3914
+ next page. If this field is omitted, there are no subsequent
3915
+ pages.
3916
+ """
3917
+
3918
+ @property
3919
+ def raw_page(self):
3920
+ return self
3921
+
3922
+ bigquery_links: MutableSequence[resources.BigQueryLink] = proto.RepeatedField(
3923
+ proto.MESSAGE,
3924
+ number=1,
3925
+ message=resources.BigQueryLink,
3926
+ )
3927
+ next_page_token: str = proto.Field(
3928
+ proto.STRING,
3929
+ number=2,
3930
+ )
3931
+
3932
+
3933
+ class UpdateBigQueryLinkRequest(proto.Message):
3934
+ r"""Request message for UpdateBigQueryLink RPC.
3935
+
3936
+ Attributes:
3937
+ bigquery_link (google.analytics.admin_v1alpha.types.BigQueryLink):
3938
+ Required. The settings to update. The ``name`` field is used
3939
+ to identify the settings to be updated.
3940
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
3941
+ Required. The list of fields to be updated. Field names must
3942
+ be in snake case (e.g., "field_to_update"). Omitted fields
3943
+ will not be updated. To replace the entire entity, use one
3944
+ path with the string "*" to match all fields.
3945
+ """
3946
+
3947
+ bigquery_link: resources.BigQueryLink = proto.Field(
3948
+ proto.MESSAGE,
3949
+ number=1,
3950
+ message=resources.BigQueryLink,
3951
+ )
3952
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
3953
+ proto.MESSAGE,
3954
+ number=2,
3955
+ message=field_mask_pb2.FieldMask,
3956
+ )
3957
+
3958
+
3959
+ class DeleteBigQueryLinkRequest(proto.Message):
3960
+ r"""Request message for DeleteBigQueryLink RPC.
3961
+
3962
+ Attributes:
3963
+ name (str):
3964
+ Required. The BigQueryLink to delete.
3965
+ Example format:
3966
+ properties/1234/bigQueryLinks/5678
3967
+ """
3968
+
3969
+ name: str = proto.Field(
3970
+ proto.STRING,
3971
+ number=1,
3972
+ )
3973
+
3974
+
3975
+ class GetEnhancedMeasurementSettingsRequest(proto.Message):
3976
+ r"""Request message for GetEnhancedMeasurementSettings RPC.
3977
+
3978
+ Attributes:
3979
+ name (str):
3980
+ Required. The name of the settings to lookup. Format:
3981
+ properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings
3982
+ Example:
3983
+ "properties/1000/dataStreams/2000/enhancedMeasurementSettings".
3984
+ """
3985
+
3986
+ name: str = proto.Field(
3987
+ proto.STRING,
3988
+ number=1,
3989
+ )
3990
+
3991
+
3992
+ class UpdateEnhancedMeasurementSettingsRequest(proto.Message):
3993
+ r"""Request message for UpdateEnhancedMeasurementSettings RPC.
3994
+
3995
+ Attributes:
3996
+ enhanced_measurement_settings (google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings):
3997
+ Required. The settings to update. The ``name`` field is used
3998
+ to identify the settings to be updated.
3999
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
4000
+ Required. The list of fields to be updated. Field names must
4001
+ be in snake case (e.g., "field_to_update"). Omitted fields
4002
+ will not be updated. To replace the entire entity, use one
4003
+ path with the string "*" to match all fields.
4004
+ """
4005
+
4006
+ enhanced_measurement_settings: resources.EnhancedMeasurementSettings = proto.Field(
4007
+ proto.MESSAGE,
4008
+ number=1,
4009
+ message=resources.EnhancedMeasurementSettings,
4010
+ )
4011
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
4012
+ proto.MESSAGE,
4013
+ number=2,
4014
+ message=field_mask_pb2.FieldMask,
4015
+ )
4016
+
4017
+
4018
+ class GetDataRedactionSettingsRequest(proto.Message):
4019
+ r"""Request message for GetDataRedactionSettings RPC.
4020
+
4021
+ Attributes:
4022
+ name (str):
4023
+ Required. The name of the settings to lookup. Format:
4024
+ properties/{property}/dataStreams/{data_stream}/dataRedactionSettings
4025
+ Example:
4026
+ "properties/1000/dataStreams/2000/dataRedactionSettings".
4027
+ """
4028
+
4029
+ name: str = proto.Field(
4030
+ proto.STRING,
4031
+ number=1,
4032
+ )
4033
+
4034
+
4035
+ class UpdateDataRedactionSettingsRequest(proto.Message):
4036
+ r"""Request message for UpdateDataRedactionSettings RPC.
4037
+
4038
+ Attributes:
4039
+ data_redaction_settings (google.analytics.admin_v1alpha.types.DataRedactionSettings):
4040
+ Required. The settings to update. The ``name`` field is used
4041
+ to identify the settings to be updated.
4042
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
4043
+ Required. The list of fields to be updated. Field names must
4044
+ be in snake case (e.g., "field_to_update"). Omitted fields
4045
+ will not be updated. To replace the entire entity, use one
4046
+ path with the string "*" to match all fields.
4047
+ """
4048
+
4049
+ data_redaction_settings: resources.DataRedactionSettings = proto.Field(
4050
+ proto.MESSAGE,
4051
+ number=1,
4052
+ message=resources.DataRedactionSettings,
4053
+ )
4054
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
4055
+ proto.MESSAGE,
4056
+ number=2,
4057
+ message=field_mask_pb2.FieldMask,
4058
+ )
4059
+
4060
+
4061
+ class CreateConnectedSiteTagRequest(proto.Message):
4062
+ r"""Request message for CreateConnectedSiteTag RPC.
4063
+
4064
+ Attributes:
4065
+ property (str):
4066
+ The Universal Analytics property to create
4067
+ connected site tags for. This API does not
4068
+ support GA4 properties. Format:
4069
+ properties/{universalAnalyticsPropertyId}
4070
+ Example: properties/1234
4071
+ connected_site_tag (google.analytics.admin_v1alpha.types.ConnectedSiteTag):
4072
+ Required. The tag to add to the Universal
4073
+ Analytics property
4074
+ """
4075
+
4076
+ property: str = proto.Field(
4077
+ proto.STRING,
4078
+ number=1,
4079
+ )
4080
+ connected_site_tag: resources.ConnectedSiteTag = proto.Field(
4081
+ proto.MESSAGE,
4082
+ number=2,
4083
+ message=resources.ConnectedSiteTag,
4084
+ )
4085
+
4086
+
4087
+ class CreateConnectedSiteTagResponse(proto.Message):
4088
+ r"""Response message for CreateConnectedSiteTag RPC."""
4089
+
4090
+
4091
+ class DeleteConnectedSiteTagRequest(proto.Message):
4092
+ r"""Request message for DeleteConnectedSiteTag RPC.
4093
+
4094
+ Attributes:
4095
+ property (str):
4096
+ The Universal Analytics property to delete
4097
+ connected site tags for. This API does not
4098
+ support GA4 properties. Format:
4099
+ properties/{universalAnalyticsPropertyId}
4100
+ Example: properties/1234
4101
+ tag_id (str):
4102
+ Tag ID to forward events to. Also known as
4103
+ the Measurement ID, or the "G-ID" (For example:
4104
+ G-12345).
4105
+ """
4106
+
4107
+ property: str = proto.Field(
4108
+ proto.STRING,
4109
+ number=1,
4110
+ )
4111
+ tag_id: str = proto.Field(
4112
+ proto.STRING,
4113
+ number=2,
4114
+ )
4115
+
4116
+
4117
+ class ListConnectedSiteTagsRequest(proto.Message):
4118
+ r"""Request message for ListConnectedSiteTags RPC.
4119
+
4120
+ Attributes:
4121
+ property (str):
4122
+ The Universal Analytics property to fetch connected site
4123
+ tags for. This does not work on GA4 properties. A maximum of
4124
+ 20 connected site tags will be returned. Example Format:
4125
+ ``properties/1234``
4126
+ """
4127
+
4128
+ property: str = proto.Field(
4129
+ proto.STRING,
4130
+ number=1,
4131
+ )
4132
+
4133
+
4134
+ class ListConnectedSiteTagsResponse(proto.Message):
4135
+ r"""Response message for ListConnectedSiteTags RPC.
4136
+
4137
+ Attributes:
4138
+ connected_site_tags (MutableSequence[google.analytics.admin_v1alpha.types.ConnectedSiteTag]):
4139
+ The site tags for the Universal Analytics
4140
+ property. A maximum of 20 connected site tags
4141
+ will be returned.
4142
+ """
4143
+
4144
+ connected_site_tags: MutableSequence[
4145
+ resources.ConnectedSiteTag
4146
+ ] = proto.RepeatedField(
4147
+ proto.MESSAGE,
4148
+ number=1,
4149
+ message=resources.ConnectedSiteTag,
4150
+ )
4151
+
4152
+
4153
+ class CreateAdSenseLinkRequest(proto.Message):
4154
+ r"""Request message to be passed to CreateAdSenseLink method.
4155
+
4156
+ Attributes:
4157
+ parent (str):
4158
+ Required. The property for which to create an
4159
+ AdSense Link. Format: properties/{propertyId}
4160
+ Example: properties/1234
4161
+ adsense_link (google.analytics.admin_v1alpha.types.AdSenseLink):
4162
+ Required. The AdSense Link to create
4163
+ """
4164
+
4165
+ parent: str = proto.Field(
4166
+ proto.STRING,
4167
+ number=1,
4168
+ )
4169
+ adsense_link: resources.AdSenseLink = proto.Field(
4170
+ proto.MESSAGE,
4171
+ number=2,
4172
+ message=resources.AdSenseLink,
4173
+ )
4174
+
4175
+
4176
+ class GetAdSenseLinkRequest(proto.Message):
4177
+ r"""Request message to be passed to GetAdSenseLink method.
4178
+
4179
+ Attributes:
4180
+ name (str):
4181
+ Required. Unique identifier for the AdSense
4182
+ Link requested. Format:
4183
+ properties/{propertyId}/adSenseLinks/{linkId}
4184
+ Example: properties/1234/adSenseLinks/5678
4185
+ """
4186
+
4187
+ name: str = proto.Field(
4188
+ proto.STRING,
4189
+ number=1,
4190
+ )
4191
+
4192
+
4193
+ class DeleteAdSenseLinkRequest(proto.Message):
4194
+ r"""Request message to be passed to DeleteAdSenseLink method.
4195
+
4196
+ Attributes:
4197
+ name (str):
4198
+ Required. Unique identifier for the AdSense
4199
+ Link to be deleted. Format:
4200
+ properties/{propertyId}/adSenseLinks/{linkId}
4201
+ Example: properties/1234/adSenseLinks/5678
4202
+ """
4203
+
4204
+ name: str = proto.Field(
4205
+ proto.STRING,
4206
+ number=1,
4207
+ )
4208
+
4209
+
4210
+ class ListAdSenseLinksRequest(proto.Message):
4211
+ r"""Request message to be passed to ListAdSenseLinks method.
4212
+
4213
+ Attributes:
4214
+ parent (str):
4215
+ Required. Resource name of the parent
4216
+ property. Format: properties/{propertyId}
4217
+ Example: properties/1234
4218
+ page_size (int):
4219
+ The maximum number of resources to return.
4220
+ If unspecified, at most 50 resources will be
4221
+ returned. The maximum value is 200 (higher
4222
+ values will be coerced to the maximum).
4223
+ page_token (str):
4224
+ A page token received from a previous ``ListAdSenseLinks``
4225
+ call. Provide this to retrieve the subsequent page.
4226
+
4227
+ When paginating, all other parameters provided to
4228
+ ``ListAdSenseLinks`` must match the call that provided the
4229
+ page token.
4230
+ """
4231
+
4232
+ parent: str = proto.Field(
4233
+ proto.STRING,
4234
+ number=1,
4235
+ )
4236
+ page_size: int = proto.Field(
4237
+ proto.INT32,
4238
+ number=2,
4239
+ )
4240
+ page_token: str = proto.Field(
4241
+ proto.STRING,
4242
+ number=3,
4243
+ )
4244
+
4245
+
4246
+ class ListAdSenseLinksResponse(proto.Message):
4247
+ r"""Response message for ListAdSenseLinks method.
4248
+
4249
+ Attributes:
4250
+ adsense_links (MutableSequence[google.analytics.admin_v1alpha.types.AdSenseLink]):
4251
+ List of AdSenseLinks.
4252
+ next_page_token (str):
4253
+ A token, which can be sent as ``page_token`` to retrieve the
4254
+ next page. If this field is omitted, there are no subsequent
4255
+ pages.
4256
+ """
4257
+
4258
+ @property
4259
+ def raw_page(self):
4260
+ return self
4261
+
4262
+ adsense_links: MutableSequence[resources.AdSenseLink] = proto.RepeatedField(
4263
+ proto.MESSAGE,
4264
+ number=1,
4265
+ message=resources.AdSenseLink,
4266
+ )
4267
+ next_page_token: str = proto.Field(
4268
+ proto.STRING,
4269
+ number=2,
4270
+ )
4271
+
4272
+
4273
+ class FetchConnectedGa4PropertyRequest(proto.Message):
4274
+ r"""Request for looking up GA4 property connected to a UA
4275
+ property.
4276
+
4277
+ Attributes:
4278
+ property (str):
4279
+ Required. The UA property for which to look up the connected
4280
+ GA4 property. Note this request uses the internal property
4281
+ ID, not the tracking ID of the form UA-XXXXXX-YY. Format:
4282
+ properties/{internal_web_property_id} Example:
4283
+ properties/1234
4284
+ """
4285
+
4286
+ property: str = proto.Field(
4287
+ proto.STRING,
4288
+ number=1,
4289
+ )
4290
+
4291
+
4292
+ class FetchConnectedGa4PropertyResponse(proto.Message):
4293
+ r"""Response for looking up GA4 property connected to a UA
4294
+ property.
4295
+
4296
+ Attributes:
4297
+ property (str):
4298
+ The GA4 property connected to the UA property. An empty
4299
+ string is returned when there is no connected GA4 property.
4300
+ Format: properties/{property_id} Example: properties/1234
4301
+ """
4302
+
4303
+ property: str = proto.Field(
4304
+ proto.STRING,
4305
+ number=1,
4306
+ )
4307
+
4308
+
4309
+ class CreateEventCreateRuleRequest(proto.Message):
4310
+ r"""Request message for CreateEventCreateRule RPC.
4311
+
4312
+ Attributes:
4313
+ parent (str):
4314
+ Required. Example format:
4315
+ properties/123/dataStreams/456
4316
+ event_create_rule (google.analytics.admin_v1alpha.types.EventCreateRule):
4317
+ Required. The EventCreateRule to create.
4318
+ """
4319
+
4320
+ parent: str = proto.Field(
4321
+ proto.STRING,
4322
+ number=1,
4323
+ )
4324
+ event_create_rule: event_create_and_edit.EventCreateRule = proto.Field(
4325
+ proto.MESSAGE,
4326
+ number=2,
4327
+ message=event_create_and_edit.EventCreateRule,
4328
+ )
4329
+
4330
+
4331
+ class UpdateEventCreateRuleRequest(proto.Message):
4332
+ r"""Request message for UpdateEventCreateRule RPC.
4333
+
4334
+ Attributes:
4335
+ event_create_rule (google.analytics.admin_v1alpha.types.EventCreateRule):
4336
+ Required. The EventCreateRule to update. The resource's
4337
+ ``name`` field is used to identify the EventCreateRule to be
4338
+ updated.
4339
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
4340
+ Required. The list of fields to be updated. Field names must
4341
+ be in snake case (e.g., "field_to_update"). Omitted fields
4342
+ will not be updated. To replace the entire entity, use one
4343
+ path with the string "*" to match all fields.
4344
+ """
4345
+
4346
+ event_create_rule: event_create_and_edit.EventCreateRule = proto.Field(
4347
+ proto.MESSAGE,
4348
+ number=1,
4349
+ message=event_create_and_edit.EventCreateRule,
4350
+ )
4351
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
4352
+ proto.MESSAGE,
4353
+ number=2,
4354
+ message=field_mask_pb2.FieldMask,
4355
+ )
4356
+
4357
+
4358
+ class DeleteEventCreateRuleRequest(proto.Message):
4359
+ r"""Request message for DeleteEventCreateRule RPC.
4360
+
4361
+ Attributes:
4362
+ name (str):
4363
+ Required. Example format:
4364
+
4365
+ properties/123/dataStreams/456/eventCreateRules/789
4366
+ """
4367
+
4368
+ name: str = proto.Field(
4369
+ proto.STRING,
4370
+ number=1,
4371
+ )
4372
+
4373
+
4374
+ class GetEventCreateRuleRequest(proto.Message):
4375
+ r"""Request message for GetEventCreateRule RPC.
4376
+
4377
+ Attributes:
4378
+ name (str):
4379
+ Required. The name of the EventCreateRule to
4380
+ get. Example format:
4381
+ properties/123/dataStreams/456/eventCreateRules/789
4382
+ """
4383
+
4384
+ name: str = proto.Field(
4385
+ proto.STRING,
4386
+ number=1,
4387
+ )
4388
+
4389
+
4390
+ class ListEventCreateRulesRequest(proto.Message):
4391
+ r"""Request message for ListEventCreateRules RPC.
4392
+
4393
+ Attributes:
4394
+ parent (str):
4395
+ Required. Example format:
4396
+ properties/123/dataStreams/456
4397
+ page_size (int):
4398
+ The maximum number of resources to return.
4399
+ If unspecified, at most 50 resources will be
4400
+ returned. The maximum value is 200 (higher
4401
+ values will be coerced to the maximum).
4402
+ page_token (str):
4403
+ A page token, received from a previous
4404
+ ``ListEventCreateRules`` call. Provide this to retrieve the
4405
+ subsequent page.
4406
+
4407
+ When paginating, all other parameters provided to
4408
+ ``ListEventCreateRules`` must match the call that provided
4409
+ the page token.
4410
+ """
4411
+
4412
+ parent: str = proto.Field(
4413
+ proto.STRING,
4414
+ number=1,
4415
+ )
4416
+ page_size: int = proto.Field(
4417
+ proto.INT32,
4418
+ number=2,
4419
+ )
4420
+ page_token: str = proto.Field(
4421
+ proto.STRING,
4422
+ number=3,
4423
+ )
4424
+
4425
+
4426
+ class ListEventCreateRulesResponse(proto.Message):
4427
+ r"""Response message for ListEventCreateRules RPC.
4428
+
4429
+ Attributes:
4430
+ event_create_rules (MutableSequence[google.analytics.admin_v1alpha.types.EventCreateRule]):
4431
+ List of EventCreateRules. These will be
4432
+ ordered stably, but in an arbitrary order.
4433
+ next_page_token (str):
4434
+ A token, which can be sent as ``page_token`` to retrieve the
4435
+ next page. If this field is omitted, there are no subsequent
4436
+ pages.
4437
+ """
4438
+
4439
+ @property
4440
+ def raw_page(self):
4441
+ return self
4442
+
4443
+ event_create_rules: MutableSequence[
4444
+ event_create_and_edit.EventCreateRule
4445
+ ] = proto.RepeatedField(
4446
+ proto.MESSAGE,
4447
+ number=1,
4448
+ message=event_create_and_edit.EventCreateRule,
4449
+ )
4450
+ next_page_token: str = proto.Field(
4451
+ proto.STRING,
4452
+ number=2,
4453
+ )
4454
+
4455
+
4456
+ class CreateEventEditRuleRequest(proto.Message):
4457
+ r"""Request message for CreateEventEditRule RPC.
4458
+
4459
+ Attributes:
4460
+ parent (str):
4461
+ Required. Example format:
4462
+ properties/123/dataStreams/456
4463
+ event_edit_rule (google.analytics.admin_v1alpha.types.EventEditRule):
4464
+ Required. The EventEditRule to create.
4465
+ """
4466
+
4467
+ parent: str = proto.Field(
4468
+ proto.STRING,
4469
+ number=1,
4470
+ )
4471
+ event_edit_rule: event_create_and_edit.EventEditRule = proto.Field(
4472
+ proto.MESSAGE,
4473
+ number=2,
4474
+ message=event_create_and_edit.EventEditRule,
4475
+ )
4476
+
4477
+
4478
+ class UpdateEventEditRuleRequest(proto.Message):
4479
+ r"""Request message for UpdateEventEditRule RPC.
4480
+
4481
+ Attributes:
4482
+ event_edit_rule (google.analytics.admin_v1alpha.types.EventEditRule):
4483
+ Required. The EventEditRule to update. The resource's
4484
+ ``name`` field is used to identify the EventEditRule to be
4485
+ updated.
4486
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
4487
+ Required. The list of fields to be updated. Field names must
4488
+ be in snake case (e.g., "field_to_update"). Omitted fields
4489
+ will not be updated. To replace the entire entity, use one
4490
+ path with the string "*" to match all fields.
4491
+ """
4492
+
4493
+ event_edit_rule: event_create_and_edit.EventEditRule = proto.Field(
4494
+ proto.MESSAGE,
4495
+ number=1,
4496
+ message=event_create_and_edit.EventEditRule,
4497
+ )
4498
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
4499
+ proto.MESSAGE,
4500
+ number=2,
4501
+ message=field_mask_pb2.FieldMask,
4502
+ )
4503
+
4504
+
4505
+ class DeleteEventEditRuleRequest(proto.Message):
4506
+ r"""Request message for DeleteEventEditRule RPC.
4507
+
4508
+ Attributes:
4509
+ name (str):
4510
+ Required. Example format:
4511
+ properties/123/dataStreams/456/eventEditRules/789
4512
+ """
4513
+
4514
+ name: str = proto.Field(
4515
+ proto.STRING,
4516
+ number=1,
4517
+ )
4518
+
4519
+
4520
+ class GetEventEditRuleRequest(proto.Message):
4521
+ r"""Request message for GetEventEditRule RPC.
4522
+
4523
+ Attributes:
4524
+ name (str):
4525
+ Required. The name of the EventEditRule to
4526
+ get. Example format:
4527
+ properties/123/dataStreams/456/eventEditRules/789
4528
+ """
4529
+
4530
+ name: str = proto.Field(
4531
+ proto.STRING,
4532
+ number=1,
4533
+ )
4534
+
4535
+
4536
+ class ListEventEditRulesRequest(proto.Message):
4537
+ r"""Request message for ListEventEditRules RPC.
4538
+
4539
+ Attributes:
4540
+ parent (str):
4541
+ Required. Example format:
4542
+ properties/123/dataStreams/456
4543
+ page_size (int):
4544
+ Optional. The maximum number of resources to
4545
+ return. If unspecified, at most 50 resources
4546
+ will be returned. The maximum value is 200
4547
+ (higher values will be coerced to the maximum).
4548
+ page_token (str):
4549
+ Optional. A page token, received from a previous
4550
+ ``ListEventEditRules`` call. Provide this to retrieve the
4551
+ subsequent page.
4552
+
4553
+ When paginating, all other parameters provided to
4554
+ ``ListEventEditRules`` must match the call that provided the
4555
+ page token.
4556
+ """
4557
+
4558
+ parent: str = proto.Field(
4559
+ proto.STRING,
4560
+ number=1,
4561
+ )
4562
+ page_size: int = proto.Field(
4563
+ proto.INT32,
4564
+ number=2,
4565
+ )
4566
+ page_token: str = proto.Field(
4567
+ proto.STRING,
4568
+ number=3,
4569
+ )
4570
+
4571
+
4572
+ class ListEventEditRulesResponse(proto.Message):
4573
+ r"""Response message for ListEventEditRules RPC.
4574
+
4575
+ Attributes:
4576
+ event_edit_rules (MutableSequence[google.analytics.admin_v1alpha.types.EventEditRule]):
4577
+ List of EventEditRules. These will be ordered
4578
+ stably, but in an arbitrary order.
4579
+ next_page_token (str):
4580
+ A token, which can be sent as ``page_token`` to retrieve the
4581
+ next page. If this field is omitted, there are no subsequent
4582
+ pages.
4583
+ """
4584
+
4585
+ @property
4586
+ def raw_page(self):
4587
+ return self
4588
+
4589
+ event_edit_rules: MutableSequence[
4590
+ event_create_and_edit.EventEditRule
4591
+ ] = proto.RepeatedField(
4592
+ proto.MESSAGE,
4593
+ number=1,
4594
+ message=event_create_and_edit.EventEditRule,
4595
+ )
4596
+ next_page_token: str = proto.Field(
4597
+ proto.STRING,
4598
+ number=2,
4599
+ )
4600
+
4601
+
4602
+ class ReorderEventEditRulesRequest(proto.Message):
4603
+ r"""Request message for ReorderEventEditRules RPC.
4604
+
4605
+ Attributes:
4606
+ parent (str):
4607
+ Required. Example format:
4608
+ properties/123/dataStreams/456
4609
+ event_edit_rules (MutableSequence[str]):
4610
+ Required. EventEditRule resource names for
4611
+ the specified data stream, in the needed
4612
+ processing order. All EventEditRules for the
4613
+ stream must be present in the list.
4614
+ """
4615
+
4616
+ parent: str = proto.Field(
4617
+ proto.STRING,
4618
+ number=1,
4619
+ )
4620
+ event_edit_rules: MutableSequence[str] = proto.RepeatedField(
4621
+ proto.STRING,
4622
+ number=2,
4623
+ )
4624
+
4625
+
4626
+ class CreateRollupPropertyRequest(proto.Message):
4627
+ r"""Request message for CreateRollupProperty RPC.
4628
+
4629
+ Attributes:
4630
+ rollup_property (google.analytics.admin_v1alpha.types.Property):
4631
+ Required. The roll-up property to create.
4632
+ source_properties (MutableSequence[str]):
4633
+ Optional. The resource names of properties
4634
+ that will be sources to the created roll-up
4635
+ property.
4636
+ """
4637
+
4638
+ rollup_property: resources.Property = proto.Field(
4639
+ proto.MESSAGE,
4640
+ number=1,
4641
+ message=resources.Property,
4642
+ )
4643
+ source_properties: MutableSequence[str] = proto.RepeatedField(
4644
+ proto.STRING,
4645
+ number=2,
4646
+ )
4647
+
4648
+
4649
+ class CreateRollupPropertyResponse(proto.Message):
4650
+ r"""Response message for CreateRollupProperty RPC.
4651
+
4652
+ Attributes:
4653
+ rollup_property (google.analytics.admin_v1alpha.types.Property):
4654
+ The created roll-up property.
4655
+ rollup_property_source_links (MutableSequence[google.analytics.admin_v1alpha.types.RollupPropertySourceLink]):
4656
+ The created roll-up property source links.
4657
+ """
4658
+
4659
+ rollup_property: resources.Property = proto.Field(
4660
+ proto.MESSAGE,
4661
+ number=1,
4662
+ message=resources.Property,
4663
+ )
4664
+ rollup_property_source_links: MutableSequence[
4665
+ resources.RollupPropertySourceLink
4666
+ ] = proto.RepeatedField(
4667
+ proto.MESSAGE,
4668
+ number=2,
4669
+ message=resources.RollupPropertySourceLink,
4670
+ )
4671
+
4672
+
4673
+ class GetRollupPropertySourceLinkRequest(proto.Message):
4674
+ r"""Request message for GetRollupPropertySourceLink RPC.
4675
+
4676
+ Attributes:
4677
+ name (str):
4678
+ Required. The name of the roll-up property source link to
4679
+ lookup. Format:
4680
+ properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id}
4681
+ Example: properties/123/rollupPropertySourceLinks/456
4682
+ """
4683
+
4684
+ name: str = proto.Field(
4685
+ proto.STRING,
4686
+ number=1,
4687
+ )
4688
+
4689
+
4690
+ class ListRollupPropertySourceLinksRequest(proto.Message):
4691
+ r"""Request message for ListRollupPropertySourceLinks RPC.
4692
+
4693
+ Attributes:
4694
+ parent (str):
4695
+ Required. The name of the roll-up property to list roll-up
4696
+ property source links under. Format:
4697
+ properties/{property_id} Example: properties/1234
4698
+ page_size (int):
4699
+ Optional. The maximum number of resources to
4700
+ return. The service may return fewer than this
4701
+ value, even if there are additional pages. If
4702
+ unspecified, at most 50 resources will be
4703
+ returned. The maximum value is 200; (higher
4704
+ values will be coerced to the maximum)
4705
+ page_token (str):
4706
+ Optional. A page token, received from a previous
4707
+ ``ListRollupPropertySourceLinks`` call. Provide this to
4708
+ retrieve the subsequent page. When paginating, all other
4709
+ parameters provided to ``ListRollupPropertySourceLinks``
4710
+ must match the call that provided the page token.
4711
+ """
4712
+
4713
+ parent: str = proto.Field(
4714
+ proto.STRING,
4715
+ number=1,
4716
+ )
4717
+ page_size: int = proto.Field(
4718
+ proto.INT32,
4719
+ number=2,
4720
+ )
4721
+ page_token: str = proto.Field(
4722
+ proto.STRING,
4723
+ number=3,
4724
+ )
4725
+
4726
+
4727
+ class ListRollupPropertySourceLinksResponse(proto.Message):
4728
+ r"""Response message for ListRollupPropertySourceLinks RPC.
4729
+
4730
+ Attributes:
4731
+ rollup_property_source_links (MutableSequence[google.analytics.admin_v1alpha.types.RollupPropertySourceLink]):
4732
+ List of RollupPropertySourceLinks.
4733
+ next_page_token (str):
4734
+ A token, which can be sent as ``page_token`` to retrieve the
4735
+ next page. If this field is omitted, there are no subsequent
4736
+ pages.
4737
+ """
4738
+
4739
+ @property
4740
+ def raw_page(self):
4741
+ return self
4742
+
4743
+ rollup_property_source_links: MutableSequence[
4744
+ resources.RollupPropertySourceLink
4745
+ ] = proto.RepeatedField(
4746
+ proto.MESSAGE,
4747
+ number=1,
4748
+ message=resources.RollupPropertySourceLink,
4749
+ )
4750
+ next_page_token: str = proto.Field(
4751
+ proto.STRING,
4752
+ number=2,
4753
+ )
4754
+
4755
+
4756
+ class CreateRollupPropertySourceLinkRequest(proto.Message):
4757
+ r"""Request message for CreateRollupPropertySourceLink RPC.
4758
+
4759
+ Attributes:
4760
+ parent (str):
4761
+ Required. Format: properties/{property_id} Example:
4762
+ properties/1234
4763
+ rollup_property_source_link (google.analytics.admin_v1alpha.types.RollupPropertySourceLink):
4764
+ Required. The roll-up property source link to
4765
+ create.
4766
+ """
4767
+
4768
+ parent: str = proto.Field(
4769
+ proto.STRING,
4770
+ number=1,
4771
+ )
4772
+ rollup_property_source_link: resources.RollupPropertySourceLink = proto.Field(
4773
+ proto.MESSAGE,
4774
+ number=2,
4775
+ message=resources.RollupPropertySourceLink,
4776
+ )
4777
+
4778
+
4779
+ class DeleteRollupPropertySourceLinkRequest(proto.Message):
4780
+ r"""Request message for DeleteRollupPropertySourceLink RPC.
4781
+
4782
+ Attributes:
4783
+ name (str):
4784
+ Required. Format:
4785
+ properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id}
4786
+ Example: properties/1234/rollupPropertySourceLinks/5678
4787
+ """
4788
+
4789
+ name: str = proto.Field(
4790
+ proto.STRING,
4791
+ number=1,
4792
+ )
4793
+
4794
+
4795
+ class ProvisionSubpropertyRequest(proto.Message):
4796
+ r"""Request message for CreateSubproperty RPC.
4797
+
4798
+ Attributes:
4799
+ subproperty (google.analytics.admin_v1alpha.types.Property):
4800
+ Required. The subproperty to create.
4801
+ subproperty_event_filter (google.analytics.admin_v1alpha.types.SubpropertyEventFilter):
4802
+ Optional. The subproperty event filter to
4803
+ create on an ordinary property.
4804
+ """
4805
+
4806
+ subproperty: resources.Property = proto.Field(
4807
+ proto.MESSAGE,
4808
+ number=2,
4809
+ message=resources.Property,
4810
+ )
4811
+ subproperty_event_filter: gaa_subproperty_event_filter.SubpropertyEventFilter = (
4812
+ proto.Field(
4813
+ proto.MESSAGE,
4814
+ number=3,
4815
+ message=gaa_subproperty_event_filter.SubpropertyEventFilter,
4816
+ )
4817
+ )
4818
+
4819
+
4820
+ class ProvisionSubpropertyResponse(proto.Message):
4821
+ r"""Response message for ProvisionSubproperty RPC.
4822
+
4823
+ Attributes:
4824
+ subproperty (google.analytics.admin_v1alpha.types.Property):
4825
+ The created subproperty.
4826
+ subproperty_event_filter (google.analytics.admin_v1alpha.types.SubpropertyEventFilter):
4827
+ The created subproperty event filter.
4828
+ """
4829
+
4830
+ subproperty: resources.Property = proto.Field(
4831
+ proto.MESSAGE,
4832
+ number=1,
4833
+ message=resources.Property,
4834
+ )
4835
+ subproperty_event_filter: gaa_subproperty_event_filter.SubpropertyEventFilter = (
4836
+ proto.Field(
4837
+ proto.MESSAGE,
4838
+ number=2,
4839
+ message=gaa_subproperty_event_filter.SubpropertyEventFilter,
4840
+ )
4841
+ )
4842
+
4843
+
4844
+ class CreateSubpropertyEventFilterRequest(proto.Message):
4845
+ r"""Request message for CreateSubpropertyEventFilter RPC.
4846
+
4847
+ Attributes:
4848
+ parent (str):
4849
+ Required. The ordinary property for which to create a
4850
+ subproperty event filter. Format: properties/property_id
4851
+ Example: properties/123
4852
+ subproperty_event_filter (google.analytics.admin_v1alpha.types.SubpropertyEventFilter):
4853
+ Required. The subproperty event filter to
4854
+ create.
4855
+ """
4856
+
4857
+ parent: str = proto.Field(
4858
+ proto.STRING,
4859
+ number=1,
4860
+ )
4861
+ subproperty_event_filter: gaa_subproperty_event_filter.SubpropertyEventFilter = (
4862
+ proto.Field(
4863
+ proto.MESSAGE,
4864
+ number=2,
4865
+ message=gaa_subproperty_event_filter.SubpropertyEventFilter,
4866
+ )
4867
+ )
4868
+
4869
+
4870
+ class GetSubpropertyEventFilterRequest(proto.Message):
4871
+ r"""Request message for GetSubpropertyEventFilter RPC.
4872
+
4873
+ Attributes:
4874
+ name (str):
4875
+ Required. Resource name of the subproperty event filter to
4876
+ lookup. Format:
4877
+ properties/property_id/subpropertyEventFilters/subproperty_event_filter
4878
+ Example: properties/123/subpropertyEventFilters/456
4879
+ """
4880
+
4881
+ name: str = proto.Field(
4882
+ proto.STRING,
4883
+ number=1,
4884
+ )
4885
+
4886
+
4887
+ class ListSubpropertyEventFiltersRequest(proto.Message):
4888
+ r"""Request message for ListSubpropertyEventFilters RPC.
4889
+
4890
+ Attributes:
4891
+ parent (str):
4892
+ Required. Resource name of the ordinary property. Format:
4893
+ properties/property_id Example: properties/123
4894
+ page_size (int):
4895
+ Optional. The maximum number of resources to
4896
+ return. The service may return fewer than this
4897
+ value, even if there are additional pages. If
4898
+ unspecified, at most 50 resources will be
4899
+ returned. The maximum value is 200; (higher
4900
+ values will be coerced to the maximum)
4901
+ page_token (str):
4902
+ Optional. A page token, received from a previous
4903
+ ``ListSubpropertyEventFilters`` call. Provide this to
4904
+ retrieve the subsequent page. When paginating, all other
4905
+ parameters provided to ``ListSubpropertyEventFilters`` must
4906
+ match the call that provided the page token.
4907
+ """
4908
+
4909
+ parent: str = proto.Field(
4910
+ proto.STRING,
4911
+ number=1,
4912
+ )
4913
+ page_size: int = proto.Field(
4914
+ proto.INT32,
4915
+ number=2,
4916
+ )
4917
+ page_token: str = proto.Field(
4918
+ proto.STRING,
4919
+ number=3,
4920
+ )
4921
+
4922
+
4923
+ class ListSubpropertyEventFiltersResponse(proto.Message):
4924
+ r"""Response message for ListSubpropertyEventFilter RPC.
4925
+
4926
+ Attributes:
4927
+ subproperty_event_filters (MutableSequence[google.analytics.admin_v1alpha.types.SubpropertyEventFilter]):
4928
+ List of subproperty event filters.
4929
+ next_page_token (str):
4930
+ A token, which can be sent as ``page_token`` to retrieve the
4931
+ next page. If this field is omitted, there are no subsequent
4932
+ pages.
4933
+ """
4934
+
4935
+ @property
4936
+ def raw_page(self):
4937
+ return self
4938
+
4939
+ subproperty_event_filters: MutableSequence[
4940
+ gaa_subproperty_event_filter.SubpropertyEventFilter
4941
+ ] = proto.RepeatedField(
4942
+ proto.MESSAGE,
4943
+ number=1,
4944
+ message=gaa_subproperty_event_filter.SubpropertyEventFilter,
4945
+ )
4946
+ next_page_token: str = proto.Field(
4947
+ proto.STRING,
4948
+ number=2,
4949
+ )
4950
+
4951
+
4952
+ class UpdateSubpropertyEventFilterRequest(proto.Message):
4953
+ r"""Request message for UpdateSubpropertyEventFilter RPC.
4954
+
4955
+ Attributes:
4956
+ subproperty_event_filter (google.analytics.admin_v1alpha.types.SubpropertyEventFilter):
4957
+ Required. The subproperty event filter to
4958
+ update.
4959
+ update_mask (google.protobuf.field_mask_pb2.FieldMask):
4960
+ Required. The list of fields to update. Field names must be
4961
+ in snake case (for example, "field_to_update"). Omitted
4962
+ fields will not be updated. To replace the entire entity,
4963
+ use one path with the string "*" to match all fields.
4964
+ """
4965
+
4966
+ subproperty_event_filter: gaa_subproperty_event_filter.SubpropertyEventFilter = (
4967
+ proto.Field(
4968
+ proto.MESSAGE,
4969
+ number=1,
4970
+ message=gaa_subproperty_event_filter.SubpropertyEventFilter,
4971
+ )
4972
+ )
4973
+ update_mask: field_mask_pb2.FieldMask = proto.Field(
4974
+ proto.MESSAGE,
4975
+ number=2,
4976
+ message=field_mask_pb2.FieldMask,
4977
+ )
4978
+
4979
+
4980
+ class DeleteSubpropertyEventFilterRequest(proto.Message):
4981
+ r"""Request message for DeleteSubpropertyEventFilter RPC.
4982
+
4983
+ Attributes:
4984
+ name (str):
4985
+ Required. Resource name of the subproperty event filter to
4986
+ delete. Format:
4987
+ properties/property_id/subpropertyEventFilters/subproperty_event_filter
4988
+ Example: properties/123/subpropertyEventFilters/456
4989
+ """
4990
+
4991
+ name: str = proto.Field(
4992
+ proto.STRING,
4993
+ number=1,
4994
+ )
4995
+
4996
+
4997
+ __all__ = tuple(sorted(__protobuf__.manifest))