Method: advertisers.locationLists.list

  • This method lists location lists based on a given advertiser ID.

  • The request uses a GET HTTP method and includes the advertiser ID as a required path parameter.

  • Optional query parameters allow for pagination (pageSize, pageToken), sorting (orderBy), and filtering (filter) of the results.

  • The request body must be empty, and the response body contains a list of location lists and a token for the next page of results.

  • The method requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Lists location lists based on a given advertiser id.

HTTP request

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/locationLists

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the DV360 advertiser to which the fetched location lists belong.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 200. Defaults to 100 if not set. 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 locationLists.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:

  • 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.
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}.
  • All fields must use the EQUALS (=) operator.

Supported fields:

  • locationType

Examples:

  • All regional location list: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • All proximity location list: locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

The length of this field should be no more than 500 characters.

Reference our filter LIST requests guide for more information.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "locationLists": [
    {
      object (LocationList)
    }
  ],
  "nextPageToken": string
}
Fields
locationLists[]

object (LocationList)

The list of location lists.

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 locationLists.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.