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
|
<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_v3_1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_1.targetableRemarketingLists.html">targetableRemarketingLists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
<p class="firstline">Gets one remarketing list by ID.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)</a></code></p>
<p class="firstline">Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(profileId, id)</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)
Returns:
An object of the form:
{ # Contains properties of a targetable 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 is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
"kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"description": "A String", # Targetable remarketing list description.
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
"name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
"listSource": "A String", # Product from which this targetable remarketing list was originated.
"active": True or False, # Whether this targetable remarketing list is active.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # Targetable remarketing list ID.
"accountId": "A String", # Account 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, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)</code>
<pre>Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
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 -
maxResults: integer, Maximum number of results to return.
active: boolean, Select only active or only inactive targetable remarketing lists.
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
Returns:
An object of the form:
{ # Targetable remarketing list response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#targetableRemarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
"targetableRemarketingLists": [ # Targetable remarketing list collection.
{ # Contains properties of a targetable 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 is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
"kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
"subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
"description": "A String", # Targetable remarketing list description.
"listSize": "A String", # Number of users currently in the list. This is a read-only field.
"lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
"name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
"advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
"listSource": "A String", # Product from which this targetable remarketing list was originated.
"active": True or False, # Whether this targetable remarketing list is active.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # Targetable remarketing list ID.
"accountId": "A String", # Account 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(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
