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> . <a href="displayvideo_v1.advertisers.locationLists.assignedLocations.html">assignedLocations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#bulkEdit">bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(advertiserId, locationListId, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates an assignment between a location and a location list.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the assignment between a location and a location list.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(advertiserId, locationListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists locations assigned to a location list.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="bulkEdit">bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)</code> 98 <pre>Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create the assigned locations provided in BulkEditAssignedLocationsRequest.created_assigned_locations. 99 100Args: 101 advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required) 102 locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required) 103 body: object, The request body. 104 The object takes the form of: 105 106{ # Request message for AssignedLocationService.BulkEditAssignedLocations. 107 "createdAssignedLocations": [ # The assigned locations to create in bulk, specified as a list of AssignedLocations. 108 { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. 109 "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. 110 "name": "A String", # Output only. The resource name of the assigned location. 111 "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION. 112 }, 113 ], 114 "deletedAssignedLocations": [ # The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids. 115 "A String", 116 ], 117} 118 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124Returns: 125 An object of the form: 126 127 { # Response message for AssignedLocationService.BulkEditAssignedLocations. 128 "assignedLocations": [ # The list of assigned locations that have been successfully created. This list will be absent if empty. 129 { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. 130 "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. 131 "name": "A String", # Output only. The resource name of the assigned location. 132 "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION. 133 }, 134 ], 135}</pre> 136</div> 137 138<div class="method"> 139 <code class="details" id="close">close()</code> 140 <pre>Close httplib2 connections.</pre> 141</div> 142 143<div class="method"> 144 <code class="details" id="create">create(advertiserId, locationListId, body=None, x__xgafv=None)</code> 145 <pre>Creates an assignment between a location and a location list. 146 147Args: 148 advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required) 149 locationListId: string, Required. The ID of the location list for which the assignment will be created. (required) 150 body: object, The request body. 151 The object takes the form of: 152 153{ # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. 154 "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. 155 "name": "A String", # Output only. The resource name of the assigned location. 156 "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION. 157} 158 159 x__xgafv: string, V1 error format. 160 Allowed values 161 1 - v1 error format 162 2 - v2 error format 163 164Returns: 165 An object of the form: 166 167 { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. 168 "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. 169 "name": "A String", # Output only. The resource name of the assigned location. 170 "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION. 171}</pre> 172</div> 173 174<div class="method"> 175 <code class="details" id="delete">delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)</code> 176 <pre>Deletes the assignment between a location and a location list. 177 178Args: 179 advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required) 180 locationListId: string, Required. The ID of the location list to which this assignment is assigned. (required) 181 assignedLocationId: string, Required. The ID of the assigned location to delete. (required) 182 x__xgafv: string, V1 error format. 183 Allowed values 184 1 - v1 error format 185 2 - v2 error format 186 187Returns: 188 An object of the form: 189 190 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 191}</pre> 192</div> 193 194<div class="method"> 195 <code class="details" id="list">list(advertiserId, locationListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 196 <pre>Lists locations assigned to a location list. 197 198Args: 199 advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required) 200 locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required) 201 filter: string, Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedLocationId` The length of this field should be no more than 500 characters. 202 orderBy: string, Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `assignedLocationId desc`. 203 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. 204 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 `ListAssignedLocations` method. If not specified, the first page of results will be returned. 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # Response message for AssignedLocationService.ListAssignedLocations. 214 "assignedLocations": [ # The list of assigned locations. This list will be absent if empty. 215 { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. 216 "assignedLocationId": "A String", # Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts. 217 "name": "A String", # Output only. The resource name of the assigned location. 218 "targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION. 219 }, 220 ], 221 "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 `ListAssignedLocations` method to retrieve the next page of results. 222}</pre> 223</div> 224 225<div class="method"> 226 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 227 <pre>Retrieves the next page of results. 228 229Args: 230 previous_request: The request for the previous page. (required) 231 previous_response: The response from the request for the previous page. (required) 232 233Returns: 234 A request object that you can call 'execute()' on to request the next 235 page. Returns None if there are no more items in the collection. 236 </pre> 237</div> 238 239</body></html>