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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
|
<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="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.remarketingAudience.html">remarketingAudience</a></h1>
<h2>Instance Methods</h2>
<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(accountId, webPropertyId, remarketingAudienceId)</a></code></p>
<p class="firstline">Delete a remarketing audience.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId, remarketingAudienceId)</a></code></p>
<p class="firstline">Gets a remarketing audience to which the user has access.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
<p class="firstline">Creates a new remarketing audience.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None, type=None)</a></code></p>
<p class="firstline">Lists remarketing audiences to which the user has access.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, webPropertyId, remarketingAudienceId, body=None)</a></code></p>
<p class="firstline">Updates an existing remarketing audience. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, webPropertyId, remarketingAudienceId, body=None)</a></code></p>
<p class="firstline">Updates an existing remarketing audience.</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(accountId, webPropertyId, remarketingAudienceId)</code>
<pre>Delete a remarketing audience.
Args:
accountId: string, Account ID to which the remarketing audience belongs. (required)
webPropertyId: string, Web property ID to which the remarketing audience belongs. (required)
remarketingAudienceId: string, The ID of the remarketing audience to delete. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, webPropertyId, remarketingAudienceId)</code>
<pre>Gets a remarketing audience to which the user has access.
Args:
accountId: string, The account ID of the remarketing audience to retrieve. (required)
webPropertyId: string, The web property ID of the remarketing audience to retrieve. (required)
remarketingAudienceId: string, The ID of the remarketing audience to retrieve. (required)
Returns:
An object of the form:
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
<pre>Creates a new remarketing audience.
Args:
accountId: string, The account ID for which to create the remarketing audience. (required)
webPropertyId: string, Web property ID for which to create the remarketing audience. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
}
Returns:
An object of the form:
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None, type=None)</code>
<pre>Lists remarketing audiences to which the user has access.
Args:
accountId: string, The account ID of the remarketing audiences to retrieve. (required)
webPropertyId: string, The web property ID of the remarketing audiences to retrieve. (required)
max_results: integer, The maximum number of remarketing audiences to include in this response.
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
type: string, A parameter
Returns:
An object of the form:
{ # A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.
"items": [ # A list of remarketing audiences.
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"kind": "analytics#remarketingAudiences", # Collection type.
"nextLink": "A String", # Link to next page for this remarketing audience collection.
"previousLink": "A String", # Link to previous page for this view (profile) collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
"username": "A String", # Email ID of the authenticated user
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, webPropertyId, remarketingAudienceId, body=None)</code>
<pre>Updates an existing remarketing audience. This method supports patch semantics.
Args:
accountId: string, The account ID of the remarketing audience to update. (required)
webPropertyId: string, The web property ID of the remarketing audience to update. (required)
remarketingAudienceId: string, The ID of the remarketing audience to update. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
}
Returns:
An object of the form:
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, webPropertyId, remarketingAudienceId, body=None)</code>
<pre>Updates an existing remarketing audience.
Args:
accountId: string, The account ID of the remarketing audience to update. (required)
webPropertyId: string, The web property ID of the remarketing audience to update. (required)
remarketingAudienceId: string, The ID of the remarketing audience to update. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
}
Returns:
An object of the form:
{ # JSON template for an Analytics remarketing audience.
"accountId": "A String", # Account ID to which this remarketing audience belongs.
"audienceDefinition": { # The simple audience definition that will cause a user to be added to an audience.
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"audienceType": "A String", # The type of audience, either SIMPLE or STATE_BASED.
"created": "A String", # Time this remarketing audience was created.
"description": "A String", # The description of this remarketing audience.
"id": "A String", # Remarketing Audience ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this remarketing audience belongs.
"kind": "analytics#remarketingAudience", # Collection type.
"linkedAdAccounts": [ # The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.
{ # JSON template for an Analytics Remarketing Audience Foreign Link.
"accountId": "A String", # Account ID to which this linked foreign account belongs.
"eligibleForSearch": True or False, # Boolean indicating whether this is eligible for search.
"id": "A String", # Entity ad account link ID.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this linked foreign account belongs.
"kind": "analytics#linkedForeignAccount", # Resource type for linked foreign account.
"linkedAccountId": "A String", # The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.
"remarketingAudienceId": "A String", # Remarketing audience ID to which this linked foreign account belongs.
"status": "A String", # The status of this foreign account link.
"type": "A String", # The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.
},
],
"linkedViews": [ # The views (profiles) that this remarketing audience is linked to.
"A String",
],
"name": "A String", # The name of this remarketing audience.
"stateBasedAudienceDefinition": { # A state based audience definition that will cause a user to be added or removed from an audience.
"excludeConditions": { # Defines the conditions to exclude users from the audience.
"exclusionDuration": "A String", # Whether to make the exclusion TEMPORARY or PERMANENT.
"segment": "A String", # The segment condition that will cause a user to be removed from an audience.
},
"includeConditions": { # JSON template for an Analytics Remarketing Include Conditions. # Defines the conditions to include users to the audience.
"daysToLookBack": 42, # The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
"isSmartList": True or False, # Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577
"kind": "analytics#includeConditions", # Resource type for include conditions.
"membershipDurationDays": 42, # Number of days (in the range 1 to 540) a user remains in the audience.
"segment": "A String", # The segment condition that will cause a user to be added to an audience.
},
},
"updated": "A String", # Time this remarketing audience was last modified.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.
}</pre>
</div>
</body></html>
|
