Method: advertisers.locationLists.assignedLocations.list
Stay organized with collections
Save and categorize content based on your preferences.
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:
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.
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 locations assigned to a specific location list for a given DV360 advertiser."],["Allows filtering and sorting of results by assigned location ID."],["Supports pagination to retrieve large result sets."],["Requires authorization with the `https://www.googleapis.com/auth/display-video` scope."],["Provides details of assigned locations, including their ID and associated location list."]]],["This API retrieves locations assigned to a specific location list within a DV360 advertiser account using a `GET` request. The request URL requires the `advertiserId` and `locationListId` as path parameters. Pagination is supported via `pageSize` and `pageToken` query parameters, alongside options to `orderBy` and `filter` the results. The response includes a list of `assignedLocations` and a `nextPageToken` for further pages. Authorization requires the `https://www.googleapis.com/auth/display-video` OAuth scope.\n"]]