1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="displayvideo_v1.advertisers.locationLists.assignedLocations.html">assignedLocations()</a></code> 79</p> 80<p class="firstline">Returns the assignedLocations Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new location list. Returns the newly created location list if successful.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(advertiserId, locationListId, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets a location list.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Lists location lists based on a given advertiser id.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<p class="toc_element"> 98 <code><a href="#patch">patch(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Updates a location list. Returns the updated location list if successful.</p> 100<h3>Method Details</h3> 101<div class="method"> 102 <code class="details" id="close">close()</code> 103 <pre>Close httplib2 connections.</pre> 104</div> 105 106<div class="method"> 107 <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code> 108 <pre>Creates a new location list. Returns the newly created location list if successful. 109 110Args: 111 advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required) 112 body: object, The request body. 113 The object takes the form of: 114 115{ # A list of locations used for targeting. 116 "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. 117 "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. 118 "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. 119 "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. 120 "name": "A String", # Output only. The resource name of the location list. 121} 122 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { # A list of locations used for targeting. 132 "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. 133 "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. 134 "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. 135 "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. 136 "name": "A String", # Output only. The resource name of the location list. 137}</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="get">get(advertiserId, locationListId, x__xgafv=None)</code> 142 <pre>Gets a location list. 143 144Args: 145 advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location list belongs. (required) 146 locationListId: string, Required. The ID of the location list to fetch. (required) 147 x__xgafv: string, V1 error format. 148 Allowed values 149 1 - v1 error format 150 2 - v2 error format 151 152Returns: 153 An object of the form: 154 155 { # A list of locations used for targeting. 156 "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. 157 "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. 158 "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. 159 "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. 160 "name": "A String", # Output only. The resource name of the location list. 161}</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 166 <pre>Lists location lists based on a given advertiser id. 167 168Args: 169 advertiserId: string, Required. The ID of the DV360 advertiser to which the fetched location lists belong. (required) 170 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}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` 171 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`. 172 pageSize: integer, Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. 173 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. 174 x__xgafv: string, V1 error format. 175 Allowed values 176 1 - v1 error format 177 2 - v2 error format 178 179Returns: 180 An object of the form: 181 182 { 183 "locationLists": [ # The list of location lists. This list will be absent if empty. 184 { # A list of locations used for targeting. 185 "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. 186 "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. 187 "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. 188 "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. 189 "name": "A String", # Output only. The resource name of the location list. 190 }, 191 ], 192 "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. 193}</pre> 194</div> 195 196<div class="method"> 197 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 198 <pre>Retrieves the next page of results. 199 200Args: 201 previous_request: The request for the previous page. (required) 202 previous_response: The response from the request for the previous page. (required) 203 204Returns: 205 A request object that you can call 'execute()' on to request the next 206 page. Returns None if there are no more items in the collection. 207 </pre> 208</div> 209 210<div class="method"> 211 <code class="details" id="patch">patch(advertiserId, locationListId, body=None, updateMask=None, x__xgafv=None)</code> 212 <pre>Updates a location list. Returns the updated location list if successful. 213 214Args: 215 advertiserId: string, Required. The ID of the DV360 advertiser to which the location lists belongs. (required) 216 locationListId: string, Output only. The unique ID of the location list. Assigned by the system. (required) 217 body: object, The request body. 218 The object takes the form of: 219 220{ # A list of locations used for targeting. 221 "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. 222 "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. 223 "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. 224 "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. 225 "name": "A String", # Output only. The resource name of the location list. 226} 227 228 updateMask: string, Required. The mask to control which fields to update. 229 x__xgafv: string, V1 error format. 230 Allowed values 231 1 - v1 error format 232 2 - v2 error format 233 234Returns: 235 An object of the form: 236 237 { # A list of locations used for targeting. 238 "advertiserId": "A String", # Required. Immutable. The unique ID of the advertiser the location list belongs to. 239 "displayName": "A String", # Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. 240 "locationListId": "A String", # Output only. The unique ID of the location list. Assigned by the system. 241 "locationType": "A String", # Required. Immutable. The type of location. All locations in the list will share this type. 242 "name": "A String", # Output only. The resource name of the location list. 243}</pre> 244</div> 245 246</body></html>