Method: advertisers.lineItems.targetingTypes.assignedTargetingOptions.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the targeting options assigned to a line item.
HTTP request
GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems/{lineItemId}/targetingTypes/{targetingType}/assignedTargetingOptions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
advertiserId |
string (int64 format)
Required. The ID of the advertiser the line item belongs to.
|
lineItemId |
string (int64 format)
Required. The ID of the line item to list assigned targeting options for.
|
targetingType |
enum (TargetingType)
Required. Identifies the type of assigned targeting options to list.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. Must be between 1 and 5000. 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 assignedTargetingOptions.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:
assignedTargetingOptionId (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: assignedTargetingOptionId desc.
|
filter |
string
Allows filtering by assigned targeting option properties. 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:
assignedTargetingOptionIdinheritance
Examples:
- AssignedTargetingOptions with ID 1 or 2
assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
- AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER
inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"
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:
| JSON representation |
{
"assignedTargetingOptions": [
{
object (AssignedTargetingOption)
}
],
"nextPageToken": string
} |
| Fields |
assignedTargetingOptions[] |
object (AssignedTargetingOption)
The list of assigned targeting options. This list will be absent if empty.
|
nextPageToken |
string
A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assignedTargetingOptions to return.
|
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 assigned targeting options for a given line item, advertiser, and targeting type."],["Supports pagination, filtering by assignedTargetingOptionId or inheritance, and sorting by assignedTargetingOptionId."],["Requires an HTTP GET request to a specific endpoint with advertiserId, lineItemId, and targetingType as path parameters."],["The response includes a list of assigned targeting options and a token for retrieving subsequent pages if available."],["Authorization requires the `https://www.googleapis.com/auth/display-video` scope."]]],["This document outlines how to retrieve a list of targeting options assigned to a line item via an API. The `GET` request uses a URL with path parameters: `advertiserId`, `lineItemId`, and `targetingType`. It accepts query parameters: `pageSize`, `pageToken`, `orderBy`, and `filter` for pagination, sorting, and filtering. The request body is empty. The response includes `assignedTargetingOptions` and a `nextPageToken` for pagination. The API requires the `https://www.googleapis.com/auth/display-video` authorization scope.\n"]]
