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
|
<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="dfareporting_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.remarketingLists.html">remarketingLists</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="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one remarketing list by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new remarketing list.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, advertiserId, active=None, floodlightActivityId=None, maxResults=None, name=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of remarketing lists, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing remarketing list. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing remarketing list.</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="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one remarketing list by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Remarketing list ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
<pre>Inserts a new remarketing list.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, advertiserId, active=None, floodlightActivityId=None, maxResults=None, name=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
<pre>Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
advertiserId: string, Required. Select only remarketing lists owned by this advertiser. (required)
active: boolean, Select only active or only inactive remarketing lists.
floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
maxResults: integer, Maximum number of results to return.
name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
pageToken: string, Value of the nextPageToken from the previous result page.
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Remarketing list response
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"remarketingLists": [ # Remarketing list collection.
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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(profileId, id, body=None, x__xgafv=None)</code>
<pre>Updates an existing remarketing list. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Required. RemarketingList ID. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
<pre>Updates an existing remarketing list.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
"accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"active": True or False, # Whether this remarketing list is active.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"description": "A String", # Remarketing list description.
"id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
"lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
"listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
"floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
"listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
{ # A group clause made up of list population terms representing constraints joined by ORs.
"terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
{ # Remarketing List Population Rule Term.
"contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
"negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
"type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
"value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
"variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
"variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
},
],
},
],
},
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"listSource": "A String", # Product from which this remarketing list was originated.
"name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
}</pre>
</div>
</body></html>
|
