Method: advertisers.locationLists.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists location lists based on a given advertiser id.
HTTP request
GET https://displayvideo.googleapis.com/v1beta2/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 100 . 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} .
- The operator must be
EQUALS (=) .
- Supported fields:
Examples:
- All regional location list:
locationType="TARGETING_LOCATION_TYPE_REGIONAL"
- All proximity location list:
locationType="TARGETING_LOCATION_TYPE_PROXIMITY"
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["Lists location lists associated with a specific advertiser ID in Display & Video 360."],["Allows filtering and sorting of location lists by parameters like location type and display name."],["Supports pagination to retrieve large sets of location lists."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."],["Provides details such as location list ID, display name, and location type in the response."]]],[]]