REST Resource: advertisers.lineItems.targetingTypes.assignedTargetingOptions

Resource: AssignedTargetingOption

A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.

JSON representation
{
  "name": string,
  "assignedTargetingOptionId": string,
  "targetingType": enum (TargetingType),
  "inheritance": enum (Inheritance),

  // Union field details can be only one of the following:
  "channelDetails": {
    object (ChannelAssignedTargetingOptionDetails)
  },
  "appCategoryDetails": {
    object (AppCategoryAssignedTargetingOptionDetails)
  },
  "appDetails": {
    object (AppAssignedTargetingOptionDetails)
  },
  "urlDetails": {
    object (UrlAssignedTargetingOptionDetails)
  },
  "dayAndTimeDetails": {
    object (DayAndTimeAssignedTargetingOptionDetails)
  },
  "ageRangeDetails": {
    object (AgeRangeAssignedTargetingOptionDetails)
  },
  "regionalLocationListDetails": {
    object (RegionalLocationListAssignedTargetingOptionDetails)
  },
  "proximityLocationListDetails": {
    object (ProximityLocationListAssignedTargetingOptionDetails)
  },
  "genderDetails": {
    object (GenderAssignedTargetingOptionDetails)
  },
  "videoPlayerSizeDetails": {
    object (VideoPlayerSizeAssignedTargetingOptionDetails)
  },
  "userRewardedContentDetails": {
    object (UserRewardedContentAssignedTargetingOptionDetails)
  },
  "parentalStatusDetails": {
    object (ParentalStatusAssignedTargetingOptionDetails)
  },
  "contentInstreamPositionDetails": {
    object (ContentInstreamPositionAssignedTargetingOptionDetails)
  },
  "contentOutstreamPositionDetails": {
    object (ContentOutstreamPositionAssignedTargetingOptionDetails)
  },
  "deviceTypeDetails": {
    object (DeviceTypeAssignedTargetingOptionDetails)
  },
  "audienceGroupDetails": {
    object (AudienceGroupAssignedTargetingOptionDetails)
  },
  "browserDetails": {
    object (BrowserAssignedTargetingOptionDetails)
  },
  "householdIncomeDetails": {
    object (HouseholdIncomeAssignedTargetingOptionDetails)
  },
  "onScreenPositionDetails": {
    object (OnScreenPositionAssignedTargetingOptionDetails)
  },
  "carrierAndIspDetails": {
    object (CarrierAndIspAssignedTargetingOptionDetails)
  },
  "keywordDetails": {
    object (KeywordAssignedTargetingOptionDetails)
  },
  "negativeKeywordListDetails": {
    object (NegativeKeywordListAssignedTargetingOptionDetails)
  },
  "operatingSystemDetails": {
    object (OperatingSystemAssignedTargetingOptionDetails)
  },
  "deviceMakeModelDetails": {
    object (DeviceMakeModelAssignedTargetingOptionDetails)
  },
  "environmentDetails": {
    object (EnvironmentAssignedTargetingOptionDetails)
  },
  "inventorySourceDetails": {
    object (InventorySourceAssignedTargetingOptionDetails)
  },
  "categoryDetails": {
    object (CategoryAssignedTargetingOptionDetails)
  },
  "viewabilityDetails": {
    object (ViewabilityAssignedTargetingOptionDetails)
  },
  "authorizedSellerStatusDetails": {
    object (AuthorizedSellerStatusAssignedTargetingOptionDetails)
  },
  "languageDetails": {
    object (LanguageAssignedTargetingOptionDetails)
  },
  "geoRegionDetails": {
    object (GeoRegionAssignedTargetingOptionDetails)
  },
  "inventorySourceGroupDetails": {
    object (InventorySourceGroupAssignedTargetingOptionDetails)
  },
  "digitalContentLabelExclusionDetails": {
    object (DigitalContentLabelAssignedTargetingOptionDetails)
  },
  "sensitiveCategoryExclusionDetails": {
    object (SensitiveCategoryAssignedTargetingOptionDetails)
  },
  "exchangeDetails": {
    object (ExchangeAssignedTargetingOptionDetails)
  },
  "subExchangeDetails": {
    object (SubExchangeAssignedTargetingOptionDetails)
  },
  "thirdPartyVerifierDetails": {
    object (ThirdPartyVerifierAssignedTargetingOptionDetails)
  }
  // End of list of possible types for union field details.
}
Fields
name

string

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

assignedTargetingOptionId

string

Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts.

targetingType

enum (TargetingType)

Output only. Identifies the type of this assigned targeting option.

inheritance

enum (Inheritance)

Output only. The inheritance status of the assigned targeting option.

Union field details. Detailed information about the targeting option being assigned. Only one field in details may be filled out, and it must correspond to targeting_type; details can be only one of the following:
channelDetails

object (ChannelAssignedTargetingOptionDetails)

Channel details. This field will be populated when the TargetingType is TARGETING_TYPE_CHANNEL.

appCategoryDetails

object (AppCategoryAssignedTargetingOptionDetails)

App category details. This field will be populated when the TargetingType is TARGETING_TYPE_APP_CATEGORY.

appDetails

object (AppAssignedTargetingOptionDetails)

App details. This field will be populated when the TargetingType is TARGETING_TYPE_APP.

urlDetails

object (UrlAssignedTargetingOptionDetails)

URL details. This field will be populated when the TargetingType is TARGETING_TYPE_URL.

dayAndTimeDetails

object (DayAndTimeAssignedTargetingOptionDetails)

Day and time details. This field will be populated when the TargetingType is TARGETING_TYPE_DAY_AND_TIME.

ageRangeDetails

object (AgeRangeAssignedTargetingOptionDetails)

Age range details. This field will be populated when the TargetingType is TARGETING_TYPE_AGE_RANGE.

regionalLocationListDetails

object (RegionalLocationListAssignedTargetingOptionDetails)

Regional location list details. This field will be populated when the TargetingType is TARGETING_TYPE_REGIONAL_LOCATION_LIST.

proximityLocationListDetails

object (ProximityLocationListAssignedTargetingOptionDetails)

Proximity location list details. This field will be populated when the TargetingType is TARGETING_TYPE_PROXIMITY_LOCATION_LIST.

genderDetails

object (GenderAssignedTargetingOptionDetails)

Gender details. This field will be populated when the TargetingType is TARGETING_TYPE_GENDER.

videoPlayerSizeDetails

object (VideoPlayerSizeAssignedTargetingOptionDetails)

Video player size details. This field will be populated when the TargetingType is TARGETING_TYPE_VIDEO_PLAYER_SIZE.

userRewardedContentDetails

object (UserRewardedContentAssignedTargetingOptionDetails)

User rewarded content details. This field will be populated when the TargetingType is TARGETING_TYPE_USER_REWARDED_CONTENT.

parentalStatusDetails

object (ParentalStatusAssignedTargetingOptionDetails)

Parental status details. This field will be populated when the TargetingType is TARGETING_TYPE_PARENTAL_STATUS.

contentInstreamPositionDetails

object (ContentInstreamPositionAssignedTargetingOptionDetails)

Content instream position details. This field will be populated when the TargetingType is TARGETING_TYPE_CONTENT_INSTREAM_POSITION.

contentOutstreamPositionDetails

object (ContentOutstreamPositionAssignedTargetingOptionDetails)

Content outstream position details. This field will be populated when the TargetingType is TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION.

deviceTypeDetails

object (DeviceTypeAssignedTargetingOptionDetails)

Device Type details. This field will be populated when the TargetingType is TARGETING_TYPE_DEVICE_TYPE.

audienceGroupDetails

object (AudienceGroupAssignedTargetingOptionDetails)

Audience targeting details. This field will be populated when the TargetingType is TARGETING_TYPE_AUDIENCE_GROUP. You can only target one audience group option per line item.

browserDetails

object (BrowserAssignedTargetingOptionDetails)

Browser details. This field will be populated when the TargetingType is TARGETING_TYPE_BROWSER.

householdIncomeDetails

object (HouseholdIncomeAssignedTargetingOptionDetails)

Household income details. This field will be populated when the TargetingType is TARGETING_TYPE_HOUSEHOLD_INCOME.

onScreenPositionDetails

object (OnScreenPositionAssignedTargetingOptionDetails)

On screen position details. This field will be populated when the TargetingType is TARGETING_TYPE_ON_SCREEN_POSITION.

carrierAndIspDetails

object (CarrierAndIspAssignedTargetingOptionDetails)

Carrier and ISP details. This field will be populated when the TargetingType is TARGETING_TYPE_CARRIER_AND_ISP.

keywordDetails

object (KeywordAssignedTargetingOptionDetails)

Keyword details. This field will be populated when the TargetingType is TARGETING_TYPE_KEYWORD.

A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned.

negativeKeywordListDetails

object (NegativeKeywordListAssignedTargetingOptionDetails)

Keyword details. This field will be populated when the TargetingType is TARGETING_TYPE_NEGATIVE_KEYWORD_LIST.

A maximum of 4 negative keyword lists can be assigned to a line item.

operatingSystemDetails

object (OperatingSystemAssignedTargetingOptionDetails)

Operating system details. This field will be populated when the TargetingType is TARGETING_TYPE_OPERATING_SYSTEM.

deviceMakeModelDetails

object (DeviceMakeModelAssignedTargetingOptionDetails)

Device make and model details. This field will be populated when the TargetingType is TARGETING_TYPE_DEVICE_MAKE_MODEL.

environmentDetails

object (EnvironmentAssignedTargetingOptionDetails)

Environment details. This field will be populated when the TargetingType is TARGETING_TYPE_ENVIRONMENT.

inventorySourceDetails

object (InventorySourceAssignedTargetingOptionDetails)

Inventory source details. This field will be populated when the TargetingType is TARGETING_TYPE_INVENTORY_SOURCE.

categoryDetails

object (CategoryAssignedTargetingOptionDetails)

Category details. This field will be populated when the TargetingType is TARGETING_TYPE_CATEGORY.

Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.

viewabilityDetails

object (ViewabilityAssignedTargetingOptionDetails)

Viewability details. This field will be populated when the TargetingType is TARGETING_TYPE_VIEWABILITY.

You can only target one viewability option per line item.

authorizedSellerStatusDetails

object (AuthorizedSellerStatusAssignedTargetingOptionDetails)

Authorized seller status details. This field will be populated when the TargetingType is TARGETING_TYPE_AUTHORIZED_SELLER_STATUS.

You can only target one authorized seller status option per line item.

If a line item doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.

languageDetails

object (LanguageAssignedTargetingOptionDetails)

Language details. This field will be populated when the TargetingType is TARGETING_TYPE_LANGUAGE.

geoRegionDetails

object (GeoRegionAssignedTargetingOptionDetails)

Geographic region details. This field will be populated when the TargetingType is TARGETING_TYPE_GEO_REGION.

inventorySourceGroupDetails

object (InventorySourceGroupAssignedTargetingOptionDetails)

Inventory source group details. This field will be populated when the TargetingType is TARGETING_TYPE_INVENTORY_SOURCE_GROUP.

digitalContentLabelExclusionDetails

object (DigitalContentLabelAssignedTargetingOptionDetails)

Digital content label details. This field will be populated when the TargetingType is TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION.

Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in line item settings). Line item settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.

sensitiveCategoryExclusionDetails

object (SensitiveCategoryAssignedTargetingOptionDetails)

Sensitive category details. This field will be populated when the TargetingType is TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION.

Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.

exchangeDetails

object (ExchangeAssignedTargetingOptionDetails)

Exchange details. This field will be populated when the TargetingType is TARGETING_TYPE_EXCHANGE.

subExchangeDetails

object (SubExchangeAssignedTargetingOptionDetails)

Sub-exchange details. This field will be populated when the TargetingType is TARGETING_TYPE_SUB_EXCHANGE.

thirdPartyVerifierDetails

object (ThirdPartyVerifierAssignedTargetingOptionDetails)

Third party verification details. This field will be populated when the TargetingType is TARGETING_TYPE_THIRD_PARTY_VERIFIER.

Inheritance

Indicates whether the assigned targeting option is inherited from a higher level entity like a partner or an advertiser. Inherited assigned targeting options take precedent, are always applied in serving over targeting assigned at the current level and cannot be modified through the current entity service. They must be modified through the entity service from which they are inherited. The inheritance only applies to negatively targeted Channels, Sensitive Category exclusions and Digital Content Label exclusions if they are configured at the parent level.

Enums
INHERITANCE_UNSPECIFIED The inheritance is unspecified or unknown.
NOT_INHERITED The assigned targeting option is not inherited from higher level entity.
INHERITED_FROM_PARTNER The assigned targeting option is inherited from partner targeting settings.
INHERITED_FROM_ADVERTISER The assigned targeting option is inherited from advertiser targeting settings.

ChannelAssignedTargetingOptionDetails

Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_CHANNEL.

JSON representation
{
  "channelId": string,
  "negative": boolean
}
Fields
channelId

string (int64 format)

Required. ID of the channel. Should refer to the channel ID field on a Partner-owned channel or advertiser-owned channel resource.

negative

boolean

Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.

AppCategoryAssignedTargetingOptionDetails

Details for assigned app category targeting option. This will be populated in the appCategoryDetails field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_APP_CATEGORY.

JSON representation
{
  "displayName": string,
  "targetingOptionId": string,
  "negative": boolean
}
Fields
displayName

string

Output only. The display name of the app category.

targetingOptionId

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_APP_CATEGORY.

negative

boolean

Indicates if this option is being negatively targeted.

AppAssignedTargetingOptionDetails

Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_APP.

JSON representation
{
  "appId": string,
  "displayName": string,
  "negative": boolean
}
Fields
appId

string

Required. The ID of the app.

Android's Play store app uses bundle ID, for example com.google.android.gm. Apple's App store app ID uses 9 digit string, for example 422689480.

displayName

string

Output only. The display name of the app.

negative

boolean

Indicates if this option is being negatively targeted.

UrlAssignedTargetingOptionDetails

Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_URL.

JSON representation
{
  "url": string,
  "negative": boolean
}
Fields
url

string

Required. The URL, for example example.com.

DV360 supports two levels of subdirectory targeting, for example www.example.com/one-subdirectory-level/second-level, and five levels of subdomain targeting, for example five.four.three.two.one.example.com.

negative

boolean

Indicates if this option is being negatively targeted.

DayAndTimeAssignedTargetingOptionDetails

Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by startHour must be before the time represented by endHour.

JSON representation
{
  "dayOfWeek": enum (DayOfWeek),
  "startHour": integer,
  "endHour": integer,
  "timeZoneResolution": enum (TimeZoneResolution)
}
Fields
dayOfWeek

enum (DayOfWeek)

Required. The day of the week for this day and time targeting setting.

startHour

integer

Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).

endHour

integer

Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).

timeZoneResolution

enum (TimeZoneResolution)

Required. The mechanism used to determine which timezone to use for this day and time targeting setting.

DayOfWeek

Represents a day of the week.

Enums
DAY_OF_WEEK_UNSPECIFIED The day of the week is unspecified.
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY Wednesday
THURSDAY Thursday
FRIDAY Friday
SATURDAY Saturday
SUNDAY Sunday

TimeZoneResolution

Possible approaches to resolve the timezone.

Enums
TIME_ZONE_RESOLUTION_UNSPECIFIED Time zone resolution is either unspecific or unknown.
TIME_ZONE_RESOLUTION_END_USER Times are resolved in the time zone of the user that saw the ad.
TIME_ZONE_RESOLUTION_ADVERTISER Times are resolved in the time zone of the advertiser that served the ad.

AgeRangeAssignedTargetingOptionDetails

Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_AGE_RANGE.

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

enum (AgeRange)

Output only. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_AGE_RANGE.

RegionalLocationListAssignedTargetingOptionDetails

Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_REGIONAL_LOCATION_LIST.

JSON representation
{
  "regionalLocationListId": string,
  "negative": boolean
}
Fields
regionalLocationListId

string (int64 format)

Required. ID of the regional location list. Should refer to the locationListId field of a LocationList resource whose type is TARGETING_LOCATION_TYPE_REGIONAL.

negative

boolean

Indicates if this option is being negatively targeted.

ProximityLocationListAssignedTargetingOptionDetails

Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_PROXIMITY_LOCATION_LIST.

JSON representation
{
  "proximityLocationListId": string,
  "proximityRadiusRange": enum (ProximityRadiusRange)
}
Fields
proximityLocationListId

string (int64 format)

Required. ID of the proximity location list. Should refer to the locationListId field of a LocationList resource whose type is TARGETING_LOCATION_TYPE_PROXIMITY.

proximityRadiusRange

enum (ProximityRadiusRange)

Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted.

All proximity location targeting under a single line item must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the line item.

ProximityRadiusRange

Type of a radius range for a proximity geo typed assigned options. Radius range is relative to population density. For example, PROXIMITY_RADIUS_RANGE_SMALL in a rural area will be different than PROXIMITY_RADIUS_RANGE_SMALL in a heavily populated city.

Enums
PROXIMITY_RADIUS_RANGE_UNSPECIFIED The targeted radius range is not specified or is unknown. Default value when radius range is not specified in this version. This enum is a placeholder for default value and does not represent a real radius range option.
PROXIMITY_RADIUS_RANGE_SMALL The targeted radius range is small.
PROXIMITY_RADIUS_RANGE_MEDIUM The targeted radius range is medium.
PROXIMITY_RADIUS_RANGE_LARGE The targeted radius range is large.

GenderAssignedTargetingOptionDetails

Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARTGETING_TYPE_GENDER.

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

enum (Gender)

Output only. The gender of the audience.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_GENDER.

VideoPlayerSizeAssignedTargetingOptionDetails

Video player size targeting option details. This will be populated in the videoPlayerSizeDetails field when targetingType is TARGETING_TYPE_VIDEO_PLAYER_SIZE. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect.

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

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_VIDEO_PLAYER_SIZE.

videoPlayerSize

enum (VideoPlayerSize)

Output only. The video player size.

UserRewardedContentAssignedTargetingOptionDetails

User rewarded content targeting option details. This will be populated in the userRewardedContentDetails field when targetingType is TARGETING_TYPE_USER_REWARDED_CONTENT.

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

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_USER_REWARDED_CONTENT.

userRewardedContent

enum (UserRewardedContent)

Output only. User rewarded content status for video ads.

ParentalStatusAssignedTargetingOptionDetails

Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARTGETING_TYPE_PARENTAL_STATUS.

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

enum (ParentalStatus)

Output only. The parental status of the audience.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_PARENTAL_STATUS.

ContentInstreamPositionAssignedTargetingOptionDetails

Assigned content instream position targeting option details. This will be populated in the contentInstreamPositionDetails field when targetingType is TARGETING_TYPE_CONTENT_INSTREAM_POSITION.

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

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_CONTENT_INSTREAM_POSITION.

contentInstreamPosition

enum (ContentInstreamPosition)

Output only. The content instream position for video or audio ads.

ContentOutstreamPositionAssignedTargetingOptionDetails

Assigned content outstream position targeting option details. This will be populated in the contentOutstreamPositionDetails field when targetingType is TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION.

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

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION.

contentOutstreamPosition

enum (ContentOutstreamPosition)

Output only. The content outstream position.

DeviceTypeAssignedTargetingOptionDetails

Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_DEVICE_TYPE.

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

string

Required. ID of the device type.

deviceType

enum (DeviceType)

Output only. The display name of the device type.

AudienceGroupAssignedTargetingOptionDetails

Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_AUDIENCE_GROUP. The relation between each group is UNION, except for excludedFirstAndThirdPartyAudienceGroup and excludedGoogleAudienceGroup, of which COMPLEMENT is UNION'ed with other groups.

JSON representation
{
  "includedFirstAndThirdPartyAudienceGroups": [
    {
      object (FirstAndThirdPartyAudienceGroup)
    }
  ],
  "includedGoogleAudienceGroup": {
    object (GoogleAudienceGroup)
  },
  "includedCustomListGroup": {
    object (CustomListGroup)
  },
  "includedCombinedAudienceGroup": {
    object (CombinedAudienceGroup)
  },
  "excludedFirstAndThirdPartyAudienceGroup": {
    object (FirstAndThirdPartyAudienceGroup)
  },
  "excludedGoogleAudienceGroup": {
    object (GoogleAudienceGroup)
  }
}
Fields
includedFirstAndThirdPartyAudienceGroups[]

object (FirstAndThirdPartyAudienceGroup)

The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored.

includedGoogleAudienceGroup

object (GoogleAudienceGroup)

The Google audience ids of the included Google audience group. Contains Google audience ids only.

includedCustomListGroup

object (CustomListGroup)

The custom list ids of the included custom list group. Contains custom list ids only.

includedCombinedAudienceGroup

object (CombinedAudienceGroup)

The combined audience ids of the included combined audience group. Contains combined audience ids only.

excludedFirstAndThirdPartyAudienceGroup

object (FirstAndThirdPartyAudienceGroup)

The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. Its COMPLEMENT is used to UNION other audience groups.

excludedGoogleAudienceGroup

object (GoogleAudienceGroup)

The Google audience ids of the excluded Google audience group. Used for negative targeting. It's COMPLEMENT is used to UNION other audience groups. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.

FirstAndThirdPartyAudienceGroup

Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other.

JSON representation
{
  "settings": [
    {
      object (FirstAndThirdPartyAudienceTargetingSetting)
    }
  ]
}
Fields
settings[]

object (FirstAndThirdPartyAudienceTargetingSetting)

Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed.

FirstAndThirdPartyAudienceTargetingSetting

Details of first and third party audience targeting setting.

JSON representation
{
  "firstAndThirdPartyAudienceId": string,
  "recency": enum (Recency)
}
Fields
firstAndThirdPartyAudienceId

string (int64 format)

Required. First and third party audience id of the first and third party audience targeting setting. This id is firstAndThirdPartyAudienceId.

recency

enum (Recency)

The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.

Recency

All supported first and third party audience recency values.

Enums
RECENCY_NO_LIMIT No limit of recency.
RECENCY_1_MINUTE Recency is 1 minute.
RECENCY_5_MINUTES Recency is 5 minutes.
RECENCY_10_MINUTES Recency is 10 minutes.
RECENCY_15_MINUTES Recency is 15 minutes.
RECENCY_30_MINUTES Recency is 30 minutes.
RECENCY_1_HOUR Recency is 1 hour.
RECENCY_2_HOURS Recency is 2 hours.
RECENCY_3_HOURS Recency is 3 hours.
RECENCY_6_HOURS Recency is 6 hours.
RECENCY_12_HOURS Recency is 12 hours.
RECENCY_1_DAY Recency is 1 day.
RECENCY_2_DAYS Recency is 2 days.
RECENCY_3_DAYS Recency is 3 days.
RECENCY_5_DAYS Recency is 5 days.
RECENCY_7_DAYS Recency is 7 days.
RECENCY_10_DAYS Recency is 10 days.
RECENCY_14_DAYS Recency is 14 days.
RECENCY_15_DAYS Recency is 15 days.
RECENCY_21_DAYS Recency is 21 days.
RECENCY_28_DAYS Recency is 28 days.
RECENCY_30_DAYS Recency is 30 days.
RECENCY_40_DAYS Recency is 40 days.
RECENCY_60_DAYS Recency is 60 days.
RECENCY_90_DAYS Recency is 90 days.
RECENCY_120_DAYS Recency is 120 days.
RECENCY_180_DAYS Recency is 180 days.
RECENCY_270_DAYS Recency is 270 days.
RECENCY_365_DAYS Recency is 365 days.

GoogleAudienceGroup

Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other.

JSON representation
{
  "settings": [
    {
      object (GoogleAudienceTargetingSetting)
    }
  ]
}
Fields
settings[]

object (GoogleAudienceTargetingSetting)

Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored.

GoogleAudienceTargetingSetting

Details of Google audience targeting setting.

JSON representation
{
  "googleAudienceId": string
}
Fields
googleAudienceId

string (int64 format)

Required. Google audience id of the Google audience targeting setting. This id is googleAudienceId.

CustomListGroup

Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other.

JSON representation
{
  "settings": [
    {
      object (CustomListTargetingSetting)
    }
  ]
}
Fields
settings[]

object (CustomListTargetingSetting)

Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored.

CustomListTargetingSetting

Details of custom list targeting setting.

JSON representation
{
  "customListId": string
}
Fields
customListId

string (int64 format)

Required. Custom id of custom list targeting setting. This id is customListId.

CombinedAudienceGroup

Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other.

JSON representation
{
  "settings": [
    {
      object (CombinedAudienceTargetingSetting)
    }
  ]
}
Fields
settings[]

object (CombinedAudienceTargetingSetting)

Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.

CombinedAudienceTargetingSetting

Details of combined audience targeting setting.

JSON representation
{
  "combinedAudienceId": string
}
Fields
combinedAudienceId

string (int64 format)

Required. Combined audience id of combined audience targeting setting. This id is combinedAudienceId.

BrowserAssignedTargetingOptionDetails

Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_BROWSER.

JSON representation
{
  "displayName": string,
  "targetingOptionId": string,
  "negative": boolean
}
Fields
displayName

string

Output only. The display name of the browser.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_BROWSER.

negative

boolean

Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field.

HouseholdIncomeAssignedTargetingOptionDetails

Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_HOUSEHOLD_INCOME.

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

enum (HouseholdIncome)

Output only. The household income of the audience.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_HOUSEHOLD_INCOME.

OnScreenPositionAssignedTargetingOptionDetails

On screen position targeting option details. This will be populated in the onScreenPositionDetails field when targetingType is TARGETING_TYPE_ON_SCREEN_POSITION.

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

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_ON_SCREEN_POSITION.

onScreenPosition

enum (OnScreenPosition)

Output only. The on screen position.

CarrierAndIspAssignedTargetingOptionDetails

Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_CARRIER_AND_ISP.

JSON representation
{
  "displayName": string,
  "targetingOptionId": string,
  "negative": boolean
}
Fields
displayName

string

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

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_CARRIER_AND_ISP.

negative

boolean

Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field.

KeywordAssignedTargetingOptionDetails

Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_KEYWORD.

JSON representation
{
  "keyword": string,
  "negative": boolean
}
Fields
keyword

string

Required. The keyword, for example car insurance.

Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.

negative

boolean

Indicates if this option is being negatively targeted.

NegativeKeywordListAssignedTargetingOptionDetails

Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_NEGATIVE_KEYWORD_LIST.

JSON representation
{
  "negativeKeywordListId": string
}
Fields
negativeKeywordListId

string (int64 format)

Required. ID of the negative keyword list. Should refer to the negativeKeywordListId field of a NegativeKeywordList resource.

OperatingSystemAssignedTargetingOptionDetails

Assigned operating system targeting option details. This will be populated in the operatingSystemDetails field when targetingType is TARGETING_TYPE_OPERATING_SYSTEM.

JSON representation
{
  "displayName": string,
  "targetingOptionId": string,
  "negative": boolean
}
Fields
displayName

string

Output only. The display name of the operating system.

targetingOptionId

string

Required. The targeting option ID populated in targetingOptionId field when targetingType is TARGETING_TYPE_OPERATING_SYSTEM.

negative

boolean

Indicates if this option is being negatively targeted.

DeviceMakeModelAssignedTargetingOptionDetails

Assigned device make and model targeting option details. This will be populated in the deviceMakeModelDetails field when targetingType is TARGETING_TYPE_DEVICE_MAKE_MODEL.

JSON representation
{
  "displayName": string,
  "targetingOptionId": string,
  "negative": boolean
}
Fields
displayName

string

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

targetingOptionId

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_DEVICE_MAKE_MODEL.

negative

boolean

Indicates if this option is being negatively targeted.

EnvironmentAssignedTargetingOptionDetails

Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_ENVIRONMENT.

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

enum (Environment)

Output only. The serving environment.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_ENVIRONMENT (e.g., "508010" for targeting the ENVIRONMENT_WEB_OPTIMIZED option).

InventorySourceAssignedTargetingOptionDetails

Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_INVENTORY_SOURCE.

JSON representation
{
  "inventorySourceId": string
}
Fields
inventorySourceId

string (int64 format)

Required. ID of the inventory source. Should refer to the inventorySourceId field of an InventorySource resource.

CategoryAssignedTargetingOptionDetails

Assigned category targeting option details. This will be populated in the categoryDetails field when targetingType is TARGETING_TYPE_CATEGORY.

JSON representation
{
  "displayName": string,
  "targetingOptionId": string,
  "negative": boolean
}
Fields
displayName

string

Output only. The display name of the category.

targetingOptionId

string

Required. The targetingOptionId field when targetingType is TARGETING_TYPE_CATEGORY.

negative

boolean

Indicates if this option is being negatively targeted.

ViewabilityAssignedTargetingOptionDetails

Assigned viewability targeting option details. This will be populated in the viewabilityDetails field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_VIEWABILITY.

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

enum (Viewability)

Output only. The predicted viewability percentage.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_VIEWABILITY (e.g., "509010" for targeting the VIEWABILITY_10_PERCENT_OR_MORE option).

AuthorizedSellerStatusAssignedTargetingOptionDetails

Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_AUTHORIZED_SELLER_STATUS.

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

enum (AuthorizedSellerStatus)

Output only. The authorized seller status to target.

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_AUTHORIZED_SELLER_STATUS.

LanguageAssignedTargetingOptionDetails

Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_LANGUAGE.

JSON representation
{
  "displayName": string,
  "targetingOptionId": string,
  "negative": boolean
}
Fields
displayName

string

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

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_LANGUAGE.

negative

boolean

Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field.

GeoRegionAssignedTargetingOptionDetails

Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_GEO_REGION.

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

string

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

targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_GEO_REGION.

geoRegionType

enum (GeoRegionType)

Output only. The type of geographic region targeting.

negative

boolean

Indicates if this option is being negatively targeted.

InventorySourceGroupAssignedTargetingOptionDetails

Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_INVENTORY_SOURCE_GROUP.

JSON representation
{
  "inventorySourceGroupId": string
}
Fields
inventorySourceGroupId

string (int64 format)

Required. ID of the inventory source group. Should refer to the inventorySourceGroupId field of an InventorySourceGroup resource.

DigitalContentLabelAssignedTargetingOptionDetails

Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION.

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

string

Required. ID of the digital content label to be EXCLUDED.

contentRatingTier

enum (ContentRatingTier)

Output only. The display name of the digital content label rating tier.

SensitiveCategoryAssignedTargetingOptionDetails

Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION.

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

string

Required. ID of the sensitive category to be EXCLUDED.

sensitiveCategory

enum (SensitiveCategory)

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

ExchangeAssignedTargetingOptionDetails

Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_EXCHANGE.

JSON representation
{
  "targetingOptionId": string
}
Fields
targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_EXCHANGE.

SubExchangeAssignedTargetingOptionDetails

Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_SUB_EXCHANGE.

JSON representation
{
  "targetingOptionId": string
}
Fields
targetingOptionId

string

Required. The targetingOptionId of a TargetingOption of type TARGETING_TYPE_SUB_EXCHANGE.

ThirdPartyVerifierAssignedTargetingOptionDetails

Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targetingType is TARGETING_TYPE_THIRD_PARTY_VERIFIER.

JSON representation
{

  // Union field verifier can be only one of the following:
  "adloox": {
    object (Adloox)
  },
  "doubleVerify": {
    object (DoubleVerify)
  },
  "integralAdScience": {
    object (IntegralAdScience)
  }
  // End of list of possible types for union field verifier.
}
Fields
Union field verifier. Can target one of third-party verifier to enforce brand safety thresholds for impressions. verifier can be only one of the following:
adloox

object (Adloox)

Third party brand verifier -- Adloox.

doubleVerify

object (DoubleVerify)

Third party brand verifier -- DoubleVerify.

integralAdScience

object (IntegralAdScience)

Third party brand verifier -- Integral Ad Science.

Adloox

Details of Adloox settings.

JSON representation
{
  "excludedAdlooxCategories": [
    enum (AdlooxCategory)
  ]
}
Fields
excludedAdlooxCategories[]

enum (AdlooxCategory)

Adloox's brand safety settings.

AdlooxCategory

Possible Adloox options.

Enums
ADLOOX_UNSPECIFIED This enum is only a placeholder and it doesn't specify any Adloox option.
ADULT_CONTENT_HARD Adult content (hard).
ADULT_CONTENT_SOFT Adult content (soft).
ILLEGAL_CONTENT Illegal content.
BORDERLINE_CONTENT Borderline content.
DISCRIMINATORY_CONTENT Discriminatory content.
VIOLENT_CONTENT_WEAPONS Violent content & weapons.
LOW_VIEWABILITY_DOMAINS Low viewability domains.
FRAUD Fraud.

DoubleVerify

Details of DoubleVerify settings.

JSON representation
{
  "brandSafetyCategories": {
    object (BrandSafetyCategories)
  },
  "avoidedAgeRatings": [
    enum (AgeRating)
  ],
  "appStarRating": {
    object (AppStarRating)
  },
  "displayViewability": {
    object (DisplayViewability)
  },
  "videoViewability": {
    object (VideoViewability)
  },
  "fraudInvalidTraffic": {
    object (FraudInvalidTraffic)
  }
}
Fields
brandSafetyCategories

object (BrandSafetyCategories)

DV Brand Safety Controls.

avoidedAgeRatings[]

enum (AgeRating)

Avoid bidding on apps with the age rating.

appStarRating

object (AppStarRating)

Avoid bidding on apps with the star ratings.

displayViewability

object (DisplayViewability)

Display viewability settings (applicable to display line items only).

videoViewability

object (VideoViewability)

Video viewability settings (applicable to video line items only).

fraudInvalidTraffic

object (FraudInvalidTraffic)

Avoid Sites and Apps with historical Fraud & IVT Rates.

BrandSafetyCategories

Settings for brand safety controls.

JSON representation
{
  "avoidUnknownBrandSafetyCategory": boolean,
  "avoidedHighSeverityCategories": [
    enum (HighSeverityCategory)
  ],
  "avoidedMediumSeverityCategories": [
    enum (MediumSeverityCategory)
  ]
}
Fields
avoidUnknownBrandSafetyCategory

boolean

Unknown or unrateable.

avoidedHighSeverityCategories[]

enum (HighSeverityCategory)

Brand safety high severity avoidance categories.

avoidedMediumSeverityCategories[]

enum (MediumSeverityCategory)

Brand safety medium severity avoidance categories.

HighSeverityCategory

Possible options for high severity categories.

Enums
HIGHER_SEVERITY_UNSPECIFIED This enum is only a placeholder and it doesn't specify any high severity categories.
ADULT_CONTENT_PORNOGRAPHY Adult Content: Pornography, Mature Topics & Nudity.
COPYRIGHT_INFRINGEMENT Copyright Infringement.
SUBSTANCE_ABUSE Drugs/Alcohol/Controlled Substances: Substance Abuse.
GRAPHIC_VIOLENCE_WEAPONS Extreme Graphic/Explicit Violence/Weapons.
HATE_PROFANITY Hate/Profanity.
CRIMINAL_SKILLS Illegal Activities: Criminal Skills.
NUISANCE_INCENTIVIZED_MALWARE_CLUTTER Incentivized/Malware/Clutter.

MediumSeverityCategory

Possible options for medium severity categories.

Enums
MEDIUM_SEVERITY_UNSPECIFIED This enum is only a placeholder and it doesn't specify any medium severity categories.
AD_SERVERS Ad Servers.
ADULT_CONTENT_SWIMSUIT Adult Content: Swimsuit.
ALTERNATIVE_LIFESTYLES Controversial Subjects: Alternative Lifestyles.
CELEBRITY_GOSSIP Controversial Subjects: Celebrity Gossip.
GAMBLING Controversial Subjects: Gambling.
OCCULT Controversial Subjects: Occult.
SEX_EDUCATION Controversial Subjects: Sex Education.
DISASTER_AVIATION Disaster: Aviation.
DISASTER_MAN_MADE Disaster: Man-made.
DISASTER_NATURAL Disaster: Natural.
DISASTER_TERRORIST_EVENTS Disaster: Terrorist Events.
DISASTER_VEHICLE Disaster: Vehicle.
ALCOHOL Drugs/Alcohol/Controlled Substances: Alcohol.
SMOKING Drugs/Alcohol/Controlled Substances: Smoking.
NEGATIVE_NEWS_FINANCIAL Negative News: Financial.
NON_ENGLISH Non-Std Content: Non-English.
PARKING_PAGE Non-Std Content: Parking Page.
UNMODERATED_UGC Unmoderated UGC: Forums, Images & Video.
INFLAMMATORY_POLITICS_AND_NEWS Controversial Subjects: Inflammatory Politics and News.
NEGATIVE_NEWS_PHARMACEUTICAL Negative News: Pharmaceutical.

AgeRating

Possible options for age ratings.

Enums
AGE_RATING_UNSPECIFIED This enum is only a placeholder and it doesn't specify any age rating options.
APP_AGE_RATE_UNKNOWN Apps with unknown age rating.
APP_AGE_RATE_4_PLUS Apps rated for Everyone (4+).
APP_AGE_RATE_9_PLUS Apps rated for Everyone (9+).
APP_AGE_RATE_12_PLUS Apps rated for Teens (12+).
APP_AGE_RATE_17_PLUS Apps rated for Mature (17+).
APP_AGE_RATE_18_PLUS Apps rated for Adults Only (18+).

AppStarRating

Details of DoubleVerify star ratings settings.

JSON representation
{
  "avoidedStarRating": enum (StarRating),
  "avoidInsufficientStarRating": boolean
}
Fields
avoidedStarRating

enum (StarRating)

Avoid bidding on apps with the star ratings.

avoidInsufficientStarRating

boolean

Avoid bidding on apps with insufficient star ratings.

StarRating

Possible options for star ratings.

Enums
APP_STAR_RATE_UNSPECIFIED This enum is only a placeholder and it doesn't specify any app star rating options.
APP_STAR_RATE_1_POINT_5_LESS Official Apps with rating < 1.5 Stars.
APP_STAR_RATE_2_LESS Official Apps with rating < 2 Stars.
APP_STAR_RATE_2_POINT_5_LESS Official Apps with rating < 2.5 Stars.
APP_STAR_RATE_3_LESS Official Apps with rating < 3 Stars.
APP_STAR_RATE_3_POINT_5_LESS Official Apps with rating < 3.5 Stars.
APP_STAR_RATE_4_LESS Official Apps with rating < 4 Stars.
APP_STAR_RATE_4_POINT_5_LESS Official Apps with rating < 4.5 Stars.

DisplayViewability

Details of DoubleVerify display viewability settings.

JSON representation
{
  "iab": enum (IAB),
  "viewableDuring": enum (ViewableDuring)
}
Fields
iab

enum (IAB)

Target web and app inventory to maximize IAB viewable rate.

viewableDuring

enum (ViewableDuring)

Target web and app inventory to maximize 100% viewable duration.

IAB

Possible options for IAB viewable rate.

Enums
IAB_VIEWED_RATE_UNSPECIFIED This enum is only a placeholder and it doesn't specify any IAB viewed rate options.
IAB_VIEWED_RATE_80_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 80% or higher.
IAB_VIEWED_RATE_75_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 75% or higher.
IAB_VIEWED_RATE_70_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 70% or higher.
IAB_VIEWED_RATE_65_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 65% or higher.
IAB_VIEWED_RATE_60_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 60% or higher.
IAB_VIEWED_RATE_55_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 55% or higher.
IAB_VIEWED_RATE_50_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 50% or higher.
IAB_VIEWED_RATE_40_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 40% or higher.
IAB_VIEWED_RATE_30_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 30% or higher.

ViewableDuring

Possible options for viewable duration.

Enums
AVERAGE_VIEW_DURATION_UNSPECIFIED This enum is only a placeholder and it doesn't specify any average view duration options.
AVERAGE_VIEW_DURATION_5_SEC Target web and app inventory to maximize 100% viewable duration 5 seconds or more.
AVERAGE_VIEW_DURATION_10_SEC Target web and app inventory to maximize 100% viewable duration 10 seconds or more.
AVERAGE_VIEW_DURATION_15_SEC Target web and app inventory to maximize 100% viewable duration 15 seconds or more.

VideoViewability

Details of DoubleVerify video viewability settings.

JSON representation
{
  "videoIab": enum (VideoIAB),
  "videoViewableRate": enum (VideoViewableRate),
  "playerImpressionRate": enum (PlayerImpressionRate)
}
Fields
videoIab

enum (VideoIAB)

Target web inventory to maximize IAB viewable rate.

videoViewableRate

enum (VideoViewableRate)

Target web inventory to maximize fully viewable rate.

playerImpressionRate

enum (PlayerImpressionRate)

Target inventory to maximize impressions with 400x300 or greater player size.

VideoIAB

Possible options of IAB viewable rate.

Enums
VIDEO_IAB_UNSPECIFIED This enum is only a placeholder and it doesn't specify any video IAB viewable rate options.
IAB_VIEWABILITY_80_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 80% or higher.
IAB_VIEWABILITY_75_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 75% or higher.
IAB_VIEWABILITY_70_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 70% or higher.
IAB_VIEWABILITY_65_PERCENT_HIHGER Target web and app inventory to maximize IAB viewable rate 65% or higher.
IAB_VIEWABILITY_60_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 60% or higher.
IAB_VIEWABILITY_55_PERCENT_HIHGER Target web and app inventory to maximize IAB viewable rate 55% or higher.
IAB_VIEWABILITY_50_PERCENT_HIGHER Target web and app inventory to maximize IAB viewable rate 50% or higher.
IAB_VIEWABILITY_40_PERCENT_HIHGER Target web and app inventory to maximize IAB viewable rate 40% or higher.
IAB_VIEWABILITY_30_PERCENT_HIHGER Target web and app inventory to maximize IAB viewable rate 30% or higher.

VideoViewableRate

Possible options of fully viewable rate.

Enums
VIDEO_VIEWABLE_RATE_UNSPECIFIED This enum is only a placeholder and it doesn't specify any video viewable rate options.
VIEWED_PERFORMANCE_40_PERCENT_HIGHER Target web inventory to maximize fully viewable rate 40% or higher.
VIEWED_PERFORMANCE_35_PERCENT_HIGHER Target web inventory to maximize fully viewable rate 35% or higher.
VIEWED_PERFORMANCE_30_PERCENT_HIGHER Target web inventory to maximize fully viewable rate 30% or higher.
VIEWED_PERFORMANCE_25_PERCENT_HIGHER Target web inventory to maximize fully viewable rate 25% or higher.
VIEWED_PERFORMANCE_20_PERCENT_HIGHER Target web inventory to maximize fully viewable rate 20% or higher.
VIEWED_PERFORMANCE_10_PERCENT_HIGHER Target web inventory to maximize fully viewable rate 10% or higher.

PlayerImpressionRate

Possible options of impressions.

Enums
PLAYER_SIZE_400X300_UNSPECIFIED This enum is only a placeholder and it doesn't specify any impressions options.
PLAYER_SIZE_400X300_95 Sites with 95%+ of impressions.
PLAYER_SIZE_400X300_70 Sites with 70%+ of impressions.
PLAYER_SIZE_400X300_25 Sites with 25%+ of impressions.
PLAYER_SIZE_400X300_5 Sites with 5%+ of impressions.

FraudInvalidTraffic

DoubleVerify Fraud & Invalid Traffic settings.

JSON representation
{
  "avoidedFraudOption": enum (FraudOption),
  "avoidInsufficientOption": boolean
}
Fields
avoidedFraudOption

enum (FraudOption)

Avoid Sites and Apps with historical Fraud & IVT.

avoidInsufficientOption

boolean

Insufficient Historical Fraud & IVT Stats.

FraudOption

Possible options of historical Fraud & IVT rate.

Enums
FRAUD_UNSPECIFIED This enum is only a placeholder and it doesn't specify any fraud and invalid traffic options.
AD_IMPRESSION_FRAUD_100 100% Fraud & IVT.
AD_IMPRESSION_FRAUD_50 50% or Higher Fraud & IVT.
AD_IMPRESSION_FRAUD_25 25% or Higher Fraud & IVT.
AD_IMPRESSION_FRAUD_10 10% or Higher Fraud & IVT.
AD_IMPRESSION_FRAUD_8 8% or Higher Fraud & IVT.
AD_IMPRESSION_FRAUD_6 6% or Higher Fraud & IVT.
AD_IMPRESSION_FRAUD_4 4% or Higher Fraud & IVT.
AD_IMPRESSION_FRAUD_2 2% or Higher Fraud & IVT.

IntegralAdScience

Details of Integral Ad Science settings.

JSON representation
{
  "traqScoreOption": enum (TRAQScore),
  "excludeUnrateable": boolean,
  "excludedAdultRisk": enum (Adult),
  "excludedAlcoholRisk": enum (Alcohol),
  "excludedIllegalDownloadsRisk": enum (IllegalDownloads),
  "excludedDrugsRisk": enum (Drugs),
  "excludedHateSpeechRisk": enum (HateSpeech),
  "excludedOffensiveLanguageRisk": enum (OffensiveLanguage),
  "excludedViolenceRisk": enum (Violence),
  "excludedGamblingRisk": enum (Gambling),
  "excludedAdFraudRisk": enum (AdFraudPrevention),
  "displayViewability": enum (DisplayViewability),
  "videoViewability": enum (VideoViewability)
}
Fields
traqScoreOption

enum (TRAQScore)

True advertising quality (applicable to Display line items only).

excludeUnrateable

boolean

Brand Safety - Unrateable.

excludedAdultRisk

enum (Adult)

Brand Safety - Adult content.

excludedAlcoholRisk

enum (Alcohol)

Brand Safety - Alcohol.

excludedIllegalDownloadsRisk

enum (IllegalDownloads)

Brand Safety - Illegal downloads.

excludedDrugsRisk

enum (Drugs)

Brand Safety - Drugs.

excludedHateSpeechRisk

enum (HateSpeech)

Brand Safety - Hate speech.

excludedOffensiveLanguageRisk

enum (OffensiveLanguage)

Brand Safety - Offensive language.

excludedViolenceRisk

enum (Violence)

Brand Safety - Violence.

excludedGamblingRisk

enum (Gambling)

Brand Safety - Gambling.

excludedAdFraudRisk

enum (AdFraudPrevention)

Ad Fraud settings.

displayViewability

enum (DisplayViewability)

Display Viewability section (applicable to display line items only).

videoViewability

enum (VideoViewability)

Video Viewability Section (applicable to video line items only).

TRAQScore

Possible Integral Ad Science TRAQ (true advertising quality) score ranges.

Enums
TRAQ_UNSPECIFIED This enum is only a placeholder and it doesn't specify any true advertising quality scores.
TRAQ_250 TRAQ score 250-1000.
TRAQ_500 TRAQ score 500-1000.
TRAQ_600 TRAQ score 600-1000.
TRAQ_700 TRAQ score 700-1000.
TRAQ_750 TRAQ score 750-1000.
TRAQ_875 TRAQ score 875-1000.
TRAQ_1000 TRAQ score 1000.

Adult

Possible Integral Ad Science Adult options.

Enums
ADULT_UNSPECIFIED This enum is only a placeholder and it doesn't specify any adult options.
ADULT_HR Adult - Exclude High Risk.
ADULT_HMR Adult - Exclude High and Moderate Risk.

Alcohol

Possible Integral Ad Science Alcohol options.

Enums
ALCOHOL_UNSPECIFIED This enum is only a placeholder and it doesn't specify any alcohol options.
ALCOHOL_HR Alcohol - Exclude High Risk.
ALCOHOL_HMR Alcohol - Exclude High and Moderate Risk.

IllegalDownloads

Possible Integral Ad Science Illegal downloads options.

Enums
ILLEGAL_DOWNLOADS_UNSPECIFIED This enum is only a placeholder and it doesn't specify any illegal downloads options.
ILLEGAL_DOWNLOADS_HR Illegal Downloads - Exclude High Risk.
ILLEGAL_DOWNLOADS_HMR Illegal Downloads - Exclude High and Moderate Risk.

Drugs

Possible Integral Ad Science Drugs options.

Enums
DRUGS_UNSPECIFIED This enum is only a placeholder and it doesn't specify any drugs options.
DRUGS_HR Drugs - Exclude High Risk.
DRUGS_HMR Drugs - Exclude High and Moderate Risk.

HateSpeech

Possible Integral Ad Science Hate speech options.

Enums
HATE_SPEECH_UNSPECIFIED This enum is only a placeholder and it doesn't specify any hate speech options.
HATE_SPEECH_HR Hate Speech - Exclude High Risk.
HATE_SPEECH_HMR Hate Speech - Exclude High and Moderate Risk.

OffensiveLanguage

Possible Integral Ad Science Offensive language options.

Enums
OFFENSIVE_LANGUAGE_UNSPECIFIED This enum is only a placeholder and it doesn't specify any language options.
OFFENSIVE_LANGUAGE_HR Offensive Language - Exclude High Risk.
OFFENSIVE_LANGUAGE_HMR Offensive Language - Exclude High and Moderate Risk.

Violence

Possible Integral Ad Science Violence options.

Enums
VIOLENCE_UNSPECIFIED This enum is only a placeholder and it doesn't specify any violence options.
VIOLENCE_HR Violence - Exclude High Risk.
VIOLENCE_HMR Violence - Exclude High and Moderate Risk.

Gambling

Possible Integral Ad Science Gambling options.

Enums
GAMBLING_UNSPECIFIED This enum is only a placeholder and it doesn't specify any gambling options.
GAMBLING_HR Gambling - Exclude High Risk.
GAMBLING_HMR Gambling - Exclude High and Moderate Risk.

AdFraudPrevention

Possible Integral Ad Science Ad fraud prevention options.

Enums
SUSPICIOUS_ACTIVITY_UNSPECIFIED This enum is only a placeholder and it doesn't specify any ad fraud prevention options.
SUSPICIOUS_ACTIVITY_HR Ad Fraud - Exclude High Risk.
SUSPICIOUS_ACTIVITY_HMR Ad Fraud - Exclude High and Moderate Risk.

DisplayViewability

Possible Integral Ad Science Display viewability options.

Enums
PERFORMANCE_VIEWABILITY_UNSPECIFIED This enum is only a placeholder and it doesn't specify any display viewability options.
PERFORMANCE_VIEWABILITY_40 Target 40% Viewability or Higher.
PERFORMANCE_VIEWABILITY_50 Target 50% Viewability or Higher.
PERFORMANCE_VIEWABILITY_60 Target 60% Viewability or Higher.
PERFORMANCE_VIEWABILITY_70 Target 70% Viewability or Higher.

VideoViewability

Possible Integral Ad Science Video viewability options.

Enums
VIDEO_VIEWABILITY_UNSPECIFIED This enum is only a placeholder and it doesn't specify any video viewability options.
VIDEO_VIEWABILITY_40 40%+ in view (IAB video viewability standard).
VIDEO_VIEWABILITY_50 50%+ in view (IAB video viewability standard).
VIDEO_VIEWABILITY_60 60%+ in view (IAB video viewability standard).
VIDEO_VIEWABILITY_70 70%+ in view (IAB video viewability standard).

Methods

create

Assigns a targeting option to a line item.

delete

Deletes an assigned targeting option from a line item.

get

Gets a single targeting option assigned to a line item.

list

Lists the targeting options assigned to a line item.