bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)
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.
Close httplib2 connections.
create(advertiserId, locationListId, body=None, x__xgafv=None)
Creates an assignment between a location and a location list.
delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)
Deletes the assignment between a location and a location list.
Lists locations assigned to a location list.
list_next(previous_request, previous_response)
Retrieves the next page of results.
bulkEdit(advertiserId, locationListId, body=None, x__xgafv=None)
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.
"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.
"name": "A String", # Output only. The resource name of the assigned location.
"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
},
],
"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.
"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.
"name": "A String", # Output only. The resource name of the assigned location.
"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
},
],
}
close()
Close httplib2 connections.
create(advertiserId, locationListId, body=None, x__xgafv=None)
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.
"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.
"name": "A String", # Output only. The resource name of the assigned location.
"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
}
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.
"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.
"name": "A String", # Output only. The resource name of the assigned location.
"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
}
delete(advertiserId, locationListId, assignedLocationId, x__xgafv=None)
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 `{}`.
}
list(advertiserId, locationListId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
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)
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.
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`.
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.
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.
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.
"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.
"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.
"name": "A String", # Output only. The resource name of the assigned location.
"targetingOptionId": "A String", # Required. The ID of the targeting option assigned to the location list. Must be of type TARGETING_TYPE_GEO_REGION.
},
],
"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.
}
list_next(previous_request, previous_response)
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.