/
analyticsadmin_v1alpha.accounts.html
555 lines (498 loc) 路 49.3 KB
/
analyticsadmin_v1alpha.accounts.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="analyticsadmin_v1alpha.accounts.userLinks.html">userLinks()</a></code>
</p>
<p class="firstline">Returns the userLinks Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Lookup for a single Account.</p>
<p class="toc_element">
<code><a href="#getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get data sharing settings on an account. Data sharing settings are singletons.</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an account.</p>
<p class="toc_element">
<code><a href="#provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Requests a ticket for creating an account.</p>
<p class="toc_element">
<code><a href="#searchChangeHistoryEvents">searchChangeHistoryEvents(account, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches through all changes to an account or its children given the specified set of filters.</p>
<p class="toc_element">
<code><a href="#searchChangeHistoryEvents_next">searchChangeHistoryEvents_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
Args:
name: string, Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Lookup for a single Account.
Args:
name: string, Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</code>
<pre>Get data sharing settings on an account. Data sharing settings are singletons.
Args:
name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing data sharing settings of a Google Analytics account.
"name": "A String", # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
"sharingWithGoogleAnySalesEnabled": True or False, # Allows any of Google sales to access the data in order to suggest configuration changes to improve results.
"sharingWithGoogleAssignedSalesEnabled": True or False, # Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.
"sharingWithGoogleProductsEnabled": True or False, # Allows Google to use the data to improve other Google products or services.
"sharingWithGoogleSupportEnabled": True or False, # Allows Google support to access the data in order to help troubleshoot issues.
"sharingWithOthersEnabled": True or False, # Allows Google to share the data anonymously in aggregate form with others.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
<pre>Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Args:
pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Request message for ListAccounts RPC.
"accounts": [ # Results that were accessible to the caller.
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an account.
Args:
name: string, Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
body: object, The request body.
The object takes the form of:
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
}
updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</code>
<pre>Requests a ticket for creating an account.
Args:
body: object, The request body.
The object takes the form of:
{ # Request message for ProvisionAccountTicket RPC.
"account": { # A resource message representing a Google Analytics account. # The account to create.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
"redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ProvisionAccountTicket RPC.
"accountTicketId": "A String", # The param to be passed in the ToS link.
}</pre>
</div>
<div class="method">
<code class="details" id="searchChangeHistoryEvents">searchChangeHistoryEvents(account, body=None, x__xgafv=None)</code>
<pre>Searches through all changes to an account or its children given the specified set of filters.
Args:
account: string, Required. The account resource for which to return change history resources. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for SearchChangeHistoryEvents RPC.
"action": [ # Optional. If set, only return changes that match one or more of these types of actions.
"A String",
],
"actorEmail": [ # Optional. If set, only return changes if they are made by a user in this list.
"A String",
],
"earliestChangeTime": "A String", # Optional. If set, only return changes made after this time (inclusive).
"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive).
"pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
"pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token.
"property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.
"resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SearchAccounts RPC.
"changeHistoryEvents": [ # Results that were accessible to the caller.
{ # A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.
"actorType": "A String", # The type of actor that made this change.
"changeTime": "A String", # Time when change was made.
"changes": [ # A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.
{ # A description of a change to a single Google Analytics resource.
"action": "A String", # The type of action that changed this resource.
"resource": "A String", # Resource name of the resource whose changes are described by this entry.
"resourceAfterChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.
"account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
"androidAppDataStream": { # A resource message representing a Google Analytics Android app stream. # A snapshot of an AndroidAppDataStream resource in change history.
"createTime": "A String", # Output only. Time when this stream was originally created.
"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
"firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"
"packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
},
"conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.
"createTime": "A String", # Output only. Time when this conversion event was created in the property.
"custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
"eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
"isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
"name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
},
"customDimension": { # A definition for a CustomDimension. # A snapshot of a CustomDimension resource in change history.
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
"name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
"scope": "A String", # Required. Immutable. The scope of this dimension.
},
"customMetric": { # A definition for a custom metric. # A snapshot of a CustomMetric resource in change history.
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
"displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
"measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
"name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
"parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
"scope": "A String", # Required. Immutable. The scope of this custom metric.
},
"firebaseLink": { # A link between an GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.
"createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
"name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
"project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
},
"googleAdsLink": { # A link between an GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.
"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
"createTime": "A String", # Output only. Time when this link was originally created.
"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
"customerId": "A String", # Immutable. Google Ads customer ID.
"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
"updateTime": "A String", # Output only. Time when this link was last updated.
},
"googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history.
"consent": "A String", # Output only. Terms of Service acceptance.
"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
"state": "A String", # Status of this setting.
},
"iosAppDataStream": { # A resource message representing a Google Analytics IOS app stream. # A snapshot of an IosAppDataStream resource in change history.
"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
"createTime": "A String", # Output only. Time when this stream was originally created.
"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
"firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"
"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
},
"measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.
"displayName": "A String", # Required. Human-readable display name for this secret.
"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
},
"property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history.
"createTime": "A String", # Output only. Time when the entity was originally created.
"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
},
"webDataStream": { # A resource message representing a Google Analytics web stream. # A snapshot of a WebDataStream resource in change history.
"createTime": "A String", # Output only. Time when this stream was originally created.
"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
},
},
"resourceBeforeChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from before the change was made. If this resource was created in this change, this field will be missing.
"account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
"androidAppDataStream": { # A resource message representing a Google Analytics Android app stream. # A snapshot of an AndroidAppDataStream resource in change history.
"createTime": "A String", # Output only. Time when this stream was originally created.
"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
"firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"
"packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
},
"conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.
"createTime": "A String", # Output only. Time when this conversion event was created in the property.
"custom": True or False, # Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
"eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
"isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
"name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
},
"customDimension": { # A definition for a CustomDimension. # A snapshot of a CustomDimension resource in change history.
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
"name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
"scope": "A String", # Required. Immutable. The scope of this dimension.
},
"customMetric": { # A definition for a custom metric. # A snapshot of a CustomMetric resource in change history.
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.
"displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
"measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.
"name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
"parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
"scope": "A String", # Required. Immutable. The scope of this custom metric.
},
"firebaseLink": { # A link between an GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.
"createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
"name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
"project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
},
"googleAdsLink": { # A link between an GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.
"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
"createTime": "A String", # Output only. Time when this link was originally created.
"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
"customerId": "A String", # Immutable. Google Ads customer ID.
"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
"updateTime": "A String", # Output only. Time when this link was last updated.
},
"googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history.
"consent": "A String", # Output only. Terms of Service acceptance.
"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
"state": "A String", # Status of this setting.
},
"iosAppDataStream": { # A resource message representing a Google Analytics IOS app stream. # A snapshot of an IosAppDataStream resource in change history.
"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
"createTime": "A String", # Output only. Time when this stream was originally created.
"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.
"firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"
"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
},
"measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.
"displayName": "A String", # Required. Human-readable display name for this secret.
"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
},
"property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history.
"createTime": "A String", # Output only. Time when the entity was originally created.
"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
},
"webDataStream": { # A resource message representing a Google Analytics web stream. # A snapshot of a WebDataStream resource in change history.
"createTime": "A String", # Output only. Time when this stream was originally created.
"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
},
},
},
],
"changesFiltered": True or False, # If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.
"id": "A String", # ID of this change history event. This ID is unique across Google Analytics.
"userActorEmail": "A String", # Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="searchChangeHistoryEvents_next">searchChangeHistoryEvents_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>