docs/dyn/displayvideo_v1.advertisers.locationLists.assignedLocations.html - external/github.com/google/google-api-python-client - Git at Google

 <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> . <a href="displayvideo_v1.advertisers.locationLists.assignedLocations.html">assignedLocations</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#bulkEdit">bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)</a></code></p>
 <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>
 <p class="toc_element">
   <code><a href="#create">create(advertiserId, locationListId, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Creates an assignment between a location and a location list.</p>
 <p class="toc_element">
   <code><a href="#delete">delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes the assignment between a location and a location list.</p>
 <p class="toc_element">
   <code><a href="#list">list(advertiserId, locationListId, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists locations assigned to a location list.</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="bulkEdit">bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)</code>
   <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.

 Args:
   advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
   locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required)
   body: object, The request body.
     The object takes the form of:

 { # Request message for AssignedLocationService.BulkEditAssignedLocations.
     &quot;createdAssignedLocations&quot;: [ # The assigned locations to create in bulk, specified as a list of AssignedLocations.
       { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
           &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
           &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned location.
           &quot;assignedLocationId&quot;: &quot;A String&quot;, # 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.
         },
     ],
     &quot;deletedAssignedLocations&quot;: [ # The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids.
       &quot;A String&quot;,
     ],
   }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Response message for AssignedLocationService.BulkEditAssignedLocations.
     &quot;assignedLocations&quot;: [ # The list of assigned locations that have been successfully created. This list will be absent if empty.
       { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
           &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
           &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned location.
           &quot;assignedLocationId&quot;: &quot;A String&quot;, # 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.
         },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="create">create(advertiserId, locationListId, body=None, x__xgafv=None)</code>
   <pre>Creates an assignment between a location and a location list.

 Args:
   advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
   locationListId: string, Required. The ID of the location list for which the assignment will be created. (required)
   body: object, The request body.
     The object takes the form of:

 { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
     &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
     &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned location.
     &quot;assignedLocationId&quot;: &quot;A String&quot;, # 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.
   }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
       &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
       &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned location.
       &quot;assignedLocationId&quot;: &quot;A String&quot;, # 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.
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)</code>
   <pre>Deletes the assignment between a location and a location list.

 Args:
   advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
   locationListId: string, Required. The ID of the location list to which this assignment is assigned. (required)
   assignedLocationId: string, Required. The ID of the assigned location to delete. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # 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 `{}`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(advertiserId, locationListId, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
   <pre>Lists locations assigned to a location list.

 Args:
   advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
   locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required)
   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 &quot; desc&quot; should be added to the field name. Example: `assignedLocationId desc`.
   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.
   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.
   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.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Response message for AssignedLocationService.ListAssignedLocations.
     &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
     &quot;assignedLocations&quot;: [ # The list of assigned locations. This list will be absent if empty.
       { # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
           &quot;targetingOptionId&quot;: &quot;A String&quot;, # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
           &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the assigned location.
           &quot;assignedLocationId&quot;: &quot;A String&quot;, # 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.
         },
     ],
   }</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 &#x27;execute()&#x27; on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>
	<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> . <a href="displayvideo_v1.advertisers.locationLists.assignedLocations.html">assignedLocations</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#bulkEdit">bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)</a></code></p>
	<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>
	<p class="toc_element">
	<code><a href="#create">create(advertiserId, locationListId, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Creates an assignment between a location and a location list.</p>
	<p class="toc_element">
	<code><a href="#delete">delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)</a></code></p>
	<p class="firstline">Deletes the assignment between a location and a location list.</p>
	<p class="toc_element">
	<code><a href="#list">list(advertiserId, locationListId, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Lists locations assigned to a location list.</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="bulkEdit">bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)</code>
	<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.

	Args:
	advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
	locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required)
	body: object, The request body.
	The object takes the form of:

	{ # Request message for AssignedLocationService.BulkEditAssignedLocations.
	"createdAssignedLocations": [ # The assigned locations to create in bulk, specified as a list of AssignedLocations.
	{ # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
	"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
	"name": "A String", # Output only. The resource name of the assigned location.
	"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.
	},
	],
	"deletedAssignedLocations": [ # The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids.
	"A String",
	],
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Response message for AssignedLocationService.BulkEditAssignedLocations.
	"assignedLocations": [ # The list of assigned locations that have been successfully created. This list will be absent if empty.
	{ # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
	"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
	"name": "A String", # Output only. The resource name of the assigned location.
	"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.
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="create">create(advertiserId, locationListId, body=None, x__xgafv=None)</code>
	<pre>Creates an assignment between a location and a location list.

	Args:
	advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
	locationListId: string, Required. The ID of the location list for which the assignment will be created. (required)
	body: object, The request body.
	The object takes the form of:

	{ # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
	"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
	"name": "A String", # Output only. The resource name of the assigned location.
	"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.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
	"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
	"name": "A String", # Output only. The resource name of the assigned location.
	"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.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="delete">delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)</code>
	<pre>Deletes the assignment between a location and a location list.

	Args:
	advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
	locationListId: string, Required. The ID of the location list to which this assignment is assigned. (required)
	assignedLocationId: string, Required. The ID of the assigned location to delete. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # 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 `{}`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(advertiserId, locationListId, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
	<pre>Lists locations assigned to a location list.

	Args:
	advertiserId: string, Required. The ID of the DV360 advertiser to which the location list belongs. (required)
	locationListId: string, Required. The ID of the location list to which these assignments are assigned. (required)
	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`.
	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.
	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.
	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.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Response message for AssignedLocationService.ListAssignedLocations.
	"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.
	"assignedLocations": [ # The list of assigned locations. This list will be absent if empty.
	{ # An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment.
	"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
	"name": "A String", # Output only. The resource name of the assigned location.
	"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.
	},
	],
	}</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>