REST Resource: targetingTypes.targetingOptions

Resource: TargetingOption

Represents a single targeting option, which is a targetable concept in DV360.

JSON representation 
{
  "name": string,
  "targetingOptionId": string,
  "targetingType": enum (TargetingType),

  // Union field details can be only one of the following:
  "digitalContentLabelDetails": {
    object (DigitalContentLabelTargetingOptionDetails)
  },
  "sensitiveCategoryDetails": {
    object (SensitiveCategoryTargetingOptionDetails)
  },
  "appCategoryDetails": {
    object (AppCategoryTargetingOptionDetails)
  },
  "onScreenPositionDetails": {
    object (OnScreenPositionTargetingOptionDetails)
  },
  "contentOutstreamPositionDetails": {
    object (ContentOutstreamPositionTargetingOptionDetails)
  },
  "contentInstreamPositionDetails": {
    object (ContentInstreamPositionTargetingOptionDetails)
  },
  "videoPlayerSizeDetails": {
    object (VideoPlayerSizeTargetingOptionDetails)
  },
  "ageRangeDetails": {
    object (AgeRangeTargetingOptionDetails)
  },
  "parentalStatusDetails": {
    object (ParentalStatusTargetingOptionDetails)
  },
  "userRewardedContentDetails": {
    object (UserRewardedContentTargetingOptionDetails)
  },
  "householdIncomeDetails": {
    object (HouseholdIncomeTargetingOptionDetails)
  },
  "genderDetails": {
    object (GenderTargetingOptionDetails)
  },
  "deviceTypeDetails": {
    object (DeviceTypeTargetingOptionDetails)
  },
  "browserDetails": {
    object (BrowserTargetingOptionDetails)
  },
  "carrierAndIspDetails": {
    object (CarrierAndIspTargetingOptionDetails)
  },
  "environmentDetails": {
    object (EnvironmentTargetingOptionDetails)
  },
  "operatingSystemDetails": {
    object (OperatingSystemTargetingOptionDetails)
  },
  "deviceMakeModelDetails": {
    object (DeviceMakeModelTargetingOptionDetails)
  },
  "viewabilityDetails": {
    object (ViewabilityTargetingOptionDetails)
  },
  "categoryDetails": {
    object (CategoryTargetingOptionDetails)
  },
  "languageDetails": {
    object (LanguageTargetingOptionDetails)
  },
  "authorizedSellerStatusDetails": {
    object (AuthorizedSellerStatusTargetingOptionDetails)
  },
  "geoRegionDetails": {
    object (GeoRegionTargetingOptionDetails)
  },
  "exchangeDetails": {
    object (ExchangeTargetingOptionDetails)
  },
  "subExchangeDetails": {
    object (SubExchangeTargetingOptionDetails)
  },
  "poiDetails": {
    object (PoiTargetingOptionDetails)
  },
  "businessChainDetails": {
    object (BusinessChainTargetingOptionDetails)
  },
  "nativeContentPositionDetails": {
    object (NativeContentPositionTargetingOptionDetails)
  },
  "omidDetails": {
    object (OmidTargetingOptionDetails)
  },
  "audioContentTypeDetails": {
    object (AudioContentTypeTargetingOptionDetails)
  }
  // End of list of possible types for union field details.
}
Fields
name

string

Output only. The resource name for this targeting option.
targetingOptionId

string

Output only. A unique identifier for this targeting option. The tuple {targetingType, targetingOptionId} will be unique.
targetingType

enum (TargetingType)

Output only. The type of this targeting option.
Union field details. Detailed information about the targeting options. Only one field in details may be filled out, and it must correspond to targeting_type; details can be only one of the following:
digitalContentLabelDetails

object (DigitalContentLabelTargetingOptionDetails)

Digital content label details.
sensitiveCategoryDetails

object (SensitiveCategoryTargetingOptionDetails)

Sensitive Category details.
appCategoryDetails

object (AppCategoryTargetingOptionDetails)

App category details.
onScreenPositionDetails

object (OnScreenPositionTargetingOptionDetails)

On screen position details.
contentOutstreamPositionDetails

object (ContentOutstreamPositionTargetingOptionDetails)

Content outstream position details.
contentInstreamPositionDetails

object (ContentInstreamPositionTargetingOptionDetails)

Content instream position details.
videoPlayerSizeDetails

object (VideoPlayerSizeTargetingOptionDetails)

Video player size details.
ageRangeDetails

object (AgeRangeTargetingOptionDetails)

Age range details.
parentalStatusDetails

object (ParentalStatusTargetingOptionDetails)

Parental status details.
userRewardedContentDetails

object (UserRewardedContentTargetingOptionDetails)

User rewarded content details.
householdIncomeDetails

object (HouseholdIncomeTargetingOptionDetails)

Household income details.
genderDetails

object (GenderTargetingOptionDetails)

Gender details.
deviceTypeDetails

object (DeviceTypeTargetingOptionDetails)

Device type details.
browserDetails

object (BrowserTargetingOptionDetails)

Browser details.
carrierAndIspDetails

object (CarrierAndIspTargetingOptionDetails)

Carrier and ISP details.
environmentDetails

object (EnvironmentTargetingOptionDetails)

Environment details.
operatingSystemDetails

object (OperatingSystemTargetingOptionDetails)

Operating system resources details.
deviceMakeModelDetails

object (DeviceMakeModelTargetingOptionDetails)

Device make and model resource details.
viewabilityDetails

object (ViewabilityTargetingOptionDetails)

Viewability resource details.
categoryDetails

object (CategoryTargetingOptionDetails)

Category resource details.
languageDetails

object (LanguageTargetingOptionDetails)

Language resource details.
authorizedSellerStatusDetails

object (AuthorizedSellerStatusTargetingOptionDetails)

Authorized seller status resource details.
geoRegionDetails

object (GeoRegionTargetingOptionDetails)

Geographic region resource details.
exchangeDetails

object (ExchangeTargetingOptionDetails)

Exchange details.
subExchangeDetails

object (SubExchangeTargetingOptionDetails)

Sub-exchange details.
poiDetails

object (PoiTargetingOptionDetails)

POI resource details.
businessChainDetails

object (BusinessChainTargetingOptionDetails)

Business chain resource details.
nativeContentPositionDetails

object (NativeContentPositionTargetingOptionDetails)

Native content position details.
omidDetails

object (OmidTargetingOptionDetails)

Open Measurement enabled inventory details.
audioContentTypeDetails

object (AudioContentTypeTargetingOptionDetails)

Audio content type details.

DigitalContentLabelTargetingOptionDetails

Represents a targetable digital content label rating tier. This will be populated in the digitalContentLabelDetails field of the TargetingOption when targetingType is TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION.

JSON representation 
{
  "contentRatingTier": enum (ContentRatingTier)
}
Fields
contentRatingTier

enum (ContentRatingTier)

Output only. An enum for the content label brand safety tiers.

SensitiveCategoryTargetingOptionDetails

Represents a targetable sensitive category. This will be populated in the sensitiveCategoryDetails field of the TargetingOption when targetingType is TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION.

JSON representation 
{
  "sensitiveCategory": enum (SensitiveCategory)
}
Fields
sensitiveCategory

enum (SensitiveCategory)

Output only. An enum for the DV360 Sensitive category content classifier.

AppCategoryTargetingOptionDetails

Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example All Apps/Google Play/Games. This will be populated in the appCategoryDetails field when targetingType is TARGETING_TYPE_APP_CATEGORY.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

Output only. The name of the app collection.

OnScreenPositionTargetingOptionDetails

Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the onScreenPositionDetails field when targetingType is TARGETING_TYPE_ON_SCREEN_POSITION.

JSON representation 
{
  "onScreenPosition": enum (OnScreenPosition)
}
Fields
onScreenPosition

enum (OnScreenPosition)

Output only. The on screen position.

ContentOutstreamPositionTargetingOptionDetails

Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the contentOutstreamPositionDetails field when targetingType is TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION.

JSON representation 
{
  "contentOutstreamPosition": enum (ContentOutstreamPosition)
}
Fields
contentOutstreamPosition

enum (ContentOutstreamPosition)

Output only. The content outstream position.

ContentInstreamPositionTargetingOptionDetails

Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the contentInstreamPositionDetails field when targetingType is TARGETING_TYPE_CONTENT_INSTREAM_POSITION.

JSON representation 
{
  "contentInstreamPosition": enum (ContentInstreamPosition)
}
Fields
contentInstreamPosition

enum (ContentInstreamPosition)

Output only. The content instream position.

VideoPlayerSizeTargetingOptionDetails

Represents a targetable video player size. This will be populated in the videoPlayerSizeDetails field when targetingType is TARGETING_TYPE_VIDEO_PLAYER_SIZE.

JSON representation 
{
  "videoPlayerSize": enum (VideoPlayerSize)
}
Fields
videoPlayerSize

enum (VideoPlayerSize)

Output only. The video player size.

AgeRangeTargetingOptionDetails

Represents a targetable age range. This will be populated in the ageRangeDetails field when targetingType is TARGETING_TYPE_AGE_RANGE.

JSON representation 
{
  "ageRange": enum (AgeRange)
}
Fields
ageRange

enum (AgeRange)

Output only. The age range of an audience.

ParentalStatusTargetingOptionDetails

Represents a targetable parental status. This will be populated in the parentalStatusDetails field of a TargetingOption when targetingType is TARGETING_TYPE_PARENTAL_STATUS.

JSON representation 
{
  "parentalStatus": enum (ParentalStatus)
}
Fields
parentalStatus

enum (ParentalStatus)

Output only. The parental status of an audience.

UserRewardedContentTargetingOptionDetails

Represents a targetable user rewarded content status for video ads only. This will be populated in the userRewardedContentDetails field when targetingType is TARGETING_TYPE_USER_REWARDED_CONTENT.

JSON representation 
{
  "userRewardedContent": enum (UserRewardedContent)
}
Fields
userRewardedContent

enum (UserRewardedContent)

Output only. User rewarded content status for video ads.

HouseholdIncomeTargetingOptionDetails

Represents a targetable household income. This will be populated in the householdIncomeDetails field of a TargetingOption when targetingType is TARGETING_TYPE_HOUSEHOLD_INCOME.

JSON representation 
{
  "householdIncome": enum (HouseholdIncome)
}
Fields
householdIncome

enum (HouseholdIncome)

Output only. The household income of an audience.

GenderTargetingOptionDetails

Represents a targetable gender. This will be populated in the genderDetails field of a TargetingOption when targetingType is TARGETING_TYPE_GENDER.

JSON representation 
{
  "gender": enum (Gender)
}
Fields
gender

enum (Gender)

Output only. The gender of an audience.

DeviceTypeTargetingOptionDetails

Represents a targetable device type. This will be populated in the deviceTypeDetails field of a TargetingOption when targetingType is TARGETING_TYPE_DEVICE_TYPE.

JSON representation 
{
  "deviceType": enum (DeviceType)
}
Fields
deviceType

enum (DeviceType)

Output only. The device type that is used to be targeted.

BrowserTargetingOptionDetails

Represents a targetable browser. This will be populated in the browserDetails field when targetingType is TARGETING_TYPE_BROWSER.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

Output only. The display name of the browser.

CarrierAndIspTargetingOptionDetails

Represents a targetable carrier or ISP. This will be populated in the carrierAndIspDetails field of a TargetingOption when targetingType is TARGETING_TYPE_CARRIER_AND_ISP.

JSON representation 
{
  "displayName": string,
  "type": enum (CarrierAndIspType)
}
Fields
displayName

string

Output only. The display name of the carrier or ISP.
type

enum (CarrierAndIspType)

Output only. The type indicating if it's carrier or ISP.

CarrierAndIspType

Type of the CarrierAndIspTargetingOption.

Enums
CARRIER_AND_ISP_TYPE_UNSPECIFIED Default value when type is not specified or is unknown in this version.
CARRIER_AND_ISP_TYPE_ISP Indicates this targeting resource refers to an ISP.
CARRIER_AND_ISP_TYPE_CARRIER Indicates this targeting resource refers to a mobile carrier.

EnvironmentTargetingOptionDetails

Represents a targetable environment. This will be populated in the environmentDetails field of a TargetingOption when targetingType is TARGETING_TYPE_ENVIRONMENT.

JSON representation 
{
  "environment": enum (Environment)
}
Fields
environment

enum (Environment)

Output only. The serving environment.

OperatingSystemTargetingOptionDetails

Represents a targetable operating system. This will be populated in the operatingSystemDetails field of a TargetingOption when targetingType is TARGETING_TYPE_OPERATING_SYSTEM.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

Output only. The display name of the operating system.

DeviceMakeModelTargetingOptionDetails

Represents a targetable device make and model. This will be populated in the deviceMakeModelDetails field of a TargetingOption when targetingType is TARGETING_TYPE_DEVICE_MAKE_MODEL.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

Output only. The display name of the device make and model.

ViewabilityTargetingOptionDetails

Represents a targetable viewability. This will be populated in the viewabilityDetails field of a TargetingOption when targetingType is TARGETING_TYPE_VIEWABILITY.

JSON representation 
{
  "viewability": enum (Viewability)
}
Fields
viewability

enum (Viewability)

Output only. The predicted viewability percentage.

CategoryTargetingOptionDetails

Represents a targetable category. This will be populated in the categoryDetails field of a TargetingOption when targetingType is TARGETING_TYPE_CATEGORY.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

Output only. The display name of the category.

LanguageTargetingOptionDetails

Represents a targetable language. This will be populated in the languageDetails field when targetingType is TARGETING_TYPE_LANGUAGE.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

Output only. The display name of the language (e.g., "French").

AuthorizedSellerStatusTargetingOptionDetails

Represents a targetable authorized seller status. This will be populated in the authorizedSellerStatusDetails field when targetingType is TARGETING_TYPE_AUTHORIZED_SELLER_STATUS.

JSON representation 
{
  "authorizedSellerStatus": enum (AuthorizedSellerStatus)
}
Fields
authorizedSellerStatus

enum (AuthorizedSellerStatus)

Output only. The authorized seller status.

GeoRegionTargetingOptionDetails

Represents a targetable geographic region. This will be populated in the geoRegionDetails field when targetingType is TARGETING_TYPE_GEO_REGION.

JSON representation 
{
  "displayName": string,
  "geoRegionType": enum (GeoRegionType)
}
Fields
displayName

string

Output only. The display name of the geographic region (e.g., "Ontario, Canada").
geoRegionType

enum (GeoRegionType)

Output only. The type of geographic region targeting.

ExchangeTargetingOptionDetails

Represents a targetable exchange. This will be populated in the exchangeDetails field of a TargetingOption when targetingType is TARGETING_TYPE_EXCHANGE.

JSON representation 
{
  "exchange": enum (Exchange)
}
Fields
exchange

enum (Exchange)

Output only. The type of exchange.

SubExchangeTargetingOptionDetails

Represents a targetable sub-exchange. This will be populated in the subExchangeDetails field of a TargetingOption when targetingType is TARGETING_TYPE_SUB_EXCHANGE.

JSON representation 
{
  "displayName": string
}
Fields
displayName

string

Output only. The display name of the sub-exchange.

PoiTargetingOptionDetails

Represents a targetable point of interest(POI). This will be populated in the poiDetails field when targetingType is TARGETING_TYPE_POI.

JSON representation 
{
  "latitude": number,
  "longitude": number,
  "displayName": string
}
Fields
latitude

number

Output only. Latitude of the POI rounding to 6th decimal place.
longitude

number

Output only. Longitude of the POI rounding to 6th decimal place.
displayName

string

Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available.

BusinessChainTargetingOptionDetails

Represents a targetable business chain within a geo region. This will be populated in the businessChainDetails field when targetingType is TARGETING_TYPE_BUSINESS_CHAIN.

JSON representation 
{
  "businessChain": string,
  "geoRegion": string,
  "geoRegionType": enum (GeoRegionType)
}
Fields
businessChain

string

Output only. The display name of the business chain, e.g. "KFC", "Chase Bank".
geoRegion

string

Output only. The display name of the geographic region, e.g. "Ontario, Canada".
geoRegionType

enum (GeoRegionType)

Output only. The type of the geographic region.

NativeContentPositionTargetingOptionDetails

Represents a targetable native content position. This will be populated in the nativeContentPositionDetails field when targetingType is TARGETING_TYPE_NATIVE_CONTENT_POSITION.

JSON representation 
{
  "contentPosition": enum (NativeContentPosition)
}
Fields
contentPosition

enum (NativeContentPosition)

Output only. The content position.

OmidTargetingOptionDetails

Represents a targetable Open Measurement enabled inventory type. This will be populated in the omidDetails field when targetingType is TARGETING_TYPE_OMID.

JSON representation 
{
  "omid": enum (Omid)
}
Fields
omid

enum (Omid)

Output only. The type of Open Measurement enabled inventory.

AudioContentTypeTargetingOptionDetails

Represents a targetable audio content type. This will be populated in the audioContentTypeDetails field when targetingType is TARGETING_TYPE_AUDIO_CONTENT_TYPE.

JSON representation 
{
  "audioContentType": enum (AudioContentType)
}
Fields
audioContentType

enum (AudioContentType)

Output only. The audio content type.

Methods

get

 Gets a single targeting option.

list

 Lists targeting options of a given type.
Searches for targeting options of a given type based on the given search terms.