Method: targetingTypes.targetingOptions.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists targeting options of a given type.
HTTP request
GET https://displayvideo.googleapis.com/v1beta2/targetingTypes/{targetingType}/targetingOptions
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
targetingType |
enum (TargetingType )
Required. The type of targeting option to be listed. Accepted values are:
TARGETING_TYPE_APP_CATEGORY
TARGETING_TYPE_AGE_RANGE
TARGETING_TYPE_GENDER
TARGETING_TYPE_VIDEO_PLAYER_SIZE
TARGETING_TYPE_USER_REWARDED_CONTENT
TARGETING_TYPE_PARENTAL_STATUS
TARGETING_TYPE_CONTENT_INSTREAM_POSITION
TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
TARGETING_TYPE_DEVICE_TYPE
TARGETING_TYPE_BROWSER
TARGETING_TYPE_HOUSEHOLD_INCOME
TARGETING_TYPE_ON_SCREEN_POSITION
TARGETING_TYPE_CARRIER_AND_ISP
TARGETING_TYPE_OPERATING_SYSTEM
TARGETING_TYPE_DEVICE_MAKE_MODEL
TARGETING_TYPE_ENVIRONMENT
TARGETING_TYPE_CATEGORY
TARGETING_TYPE_VIEWABILITY
TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
TARGETING_TYPE_LANGUAGE
TARGETING_TYPE_GEO_REGION
TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
TARGETING_TYPE_EXCHANGE
TARGETING_TYPE_SUB_EXCHANGE
TARGETING_TYPE_NATIVE_CONTENT_POSITION
TARGETING_TYPE_OMID
|
Query parameters
Parameters |
advertiserId |
string (int64 format)
Required. The Advertiser this request is being made in the context of.
|
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 targetingOptions.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:
targetingOptionId (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: targetingOptionId desc .
|
filter |
string
Allows filtering by targeting option properties. Supported syntax:
- Filter expressions are made up of one or more restrictions.
- Restrictions can be combined by
OR logical operators.
- A restriction has the form of
{field} {operator} {value} .
- The operator must be "=" (equal sign).
- Supported fields:
carrierAndIspDetails.type
geoRegionDetails.geoRegionType
targetingOptionId
Examples:
- All
GEO REGION targeting options that belong to sub type GEO_REGION_TYPE_COUNTRY or GEO_REGION_TYPE_STATE : geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR
geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"
- All
CARRIER AND ISP targeting options that belong to sub type CARRIER_AND_ISP_TYPE_CARRIER : carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER" .
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 targetingOptions.list
.
JSON representation |
{
"targetingOptions": [
{
object (TargetingOption )
}
],
"nextPageToken": string
} |
Fields |
targetingOptions[] |
object (TargetingOption )
The list of targeting options. 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 targetingOptions.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 2022-06-10 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]