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
|
<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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.locationLists.html">locationLists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="displayvideo_v1.advertisers.locationLists.assignedLocations.html">assignedLocations()</a></code>
</p>
<p class="firstline">Returns the assignedLocations Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new location list. Returns the newly created location list if successful.</p>
<p class="toc_element">
<code><a href="#get">get(advertiserId, locationListId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a location list.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists location lists based on a given advertiser id.</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(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a location list. Returns the updated location list if successful.</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="create">create(advertiserId, body=None, x__xgafv=None)</code>
<pre>Creates a new location list. Returns the newly created location list if successful.
Args:
advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
body: object, The request body.
The object takes the form of:
{ # A list of locations used for targeting.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
"displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
"locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
"locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
"name": "A String", # Output only. The resource name of the location list.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of locations used for targeting.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
"displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
"locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
"locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
"name": "A String", # Output only. The resource name of the location list.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(advertiserId, locationListId, x__xgafv=None)</code>
<pre>Gets a location list.
Args:
advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location list belongs. (required)
locationListId: string, Required. The ID of the location list to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of locations used for targeting.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
"displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
"locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
"locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
"name": "A String", # Output only. The resource name of the location list.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists location lists based on a given advertiser id.
Args:
advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location lists belong. (required)
filter: string, Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"locationLists": [ # The list of location lists. This list will be absent if empty.
{ # A list of locations used for targeting.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
"displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
"locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
"locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
"name": "A String", # Output only. The resource name of the location list.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLocationLists` method to retrieve the next page of results.
}</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(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a location list. Returns the updated location list if successful.
Args:
advertiserId: string, Required. The ID of the DV360 advertiser to which the location lists belongs. (required)
locationListId: string, Output only. The unique ID of the location list. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:
{ # A list of locations used for targeting.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
"displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
"locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
"locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
"name": "A String", # Output only. The resource name of the location list.
}
updateMask: string, Required. The mask to control which fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of locations used for targeting.
"advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to.
"displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.
"locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system.
"locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type.
"name": "A String", # Output only. The resource name of the location list.
}</pre>
</div>
</body></html>
|
