Method: advertisers.locationLists.assignedLocations.list

  • This method lists locations assigned to a specified location list.

  • The HTTP request uses a GET method and includes advertiserId and locationListId as required path parameters.

  • Optional query parameters allow for controlling pagination, sorting, and filtering of the results.

  • The request body must be empty.

  • The successful response body contains a list of assignedLocations and potentially a nextPageToken for retrieving additional results.

Lists locations assigned to a location list.

HTTP request

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the DV360 advertiser to which the location list belongs.
locationListId

string (int64 format)

Required. The ID of the location list to which these assignments are assigned.

Query parameters

Parameters
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 nextPageToken returned from the previous call to assignedLocations.list method. If not specified, the first page of results will be returned.
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.
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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for AssignedLocationService.ListAssignedLocations.

JSON representation 
{
  "assignedLocations": [
    {
      object (AssignedLocation)
    }
  ],
  "nextPageToken": string
}
Fields
assignedLocations[]

object (AssignedLocation)

The list of assigned locations.

This list will be absent if empty.
nextPageToken

string

A token to retrieve the next page of results.

Pass this value in the pageToken field in the subsequent call to assignedLocations.list method to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.