- Resource: AssignedTargetingOption
- JSON representation
- Inheritance
- ChannelAssignedTargetingOptionDetails
- AppCategoryAssignedTargetingOptionDetails
- AppAssignedTargetingOptionDetails
- AppPlatform
- UrlAssignedTargetingOptionDetails
- DayAndTimeAssignedTargetingOptionDetails
- DayOfWeek
- TimeZoneResolution
- AgeRangeAssignedTargetingOptionDetails
- RegionalLocationListAssignedTargetingOptionDetails
- ProximityLocationListAssignedTargetingOptionDetails
- ProximityRadiusUnit
- GenderAssignedTargetingOptionDetails
- VideoPlayerSizeAssignedTargetingOptionDetails
- UserRewardedContentAssignedTargetingOptionDetails
- ParentalStatusAssignedTargetingOptionDetails
- ContentInstreamPositionAssignedTargetingOptionDetails
- AdType
- ContentOutstreamPositionAssignedTargetingOptionDetails
- DeviceTypeAssignedTargetingOptionDetails
- AudienceGroupAssignedTargetingOptionDetails
- FirstAndThirdPartyAudienceGroup
- FirstAndThirdPartyAudienceTargetingSetting
- Recency
- GoogleAudienceGroup
- GoogleAudienceTargetingSetting
- CustomListGroup
- CustomListTargetingSetting
- CombinedAudienceGroup
- CombinedAudienceTargetingSetting
- BrowserAssignedTargetingOptionDetails
- HouseholdIncomeAssignedTargetingOptionDetails
- OnScreenPositionAssignedTargetingOptionDetails
- CarrierAndIspAssignedTargetingOptionDetails
- KeywordAssignedTargetingOptionDetails
- NegativeKeywordListAssignedTargetingOptionDetails
- OperatingSystemAssignedTargetingOptionDetails
- DeviceMakeModelAssignedTargetingOptionDetails
- EnvironmentAssignedTargetingOptionDetails
- InventorySourceAssignedTargetingOptionDetails
- CategoryAssignedTargetingOptionDetails
- ViewabilityAssignedTargetingOptionDetails
- AuthorizedSellerStatusAssignedTargetingOptionDetails
- LanguageAssignedTargetingOptionDetails
- GeoRegionAssignedTargetingOptionDetails
- InventorySourceGroupAssignedTargetingOptionDetails
- DigitalContentLabelAssignedTargetingOptionDetails
- SensitiveCategoryAssignedTargetingOptionDetails
- ExchangeAssignedTargetingOptionDetails
- SubExchangeAssignedTargetingOptionDetails
- ThirdPartyVerifierAssignedTargetingOptionDetails
- Adloox
- AdlooxCategory
- FraudIvtMfaCategory
- GarmRiskExclusion
- DisplayIabViewability
- VideoIabViewability
- DoubleVerify
- BrandSafetyCategories
- HighSeverityCategory
- MediumSeverityCategory
- AgeRating
- AppStarRating
- StarRating
- DisplayViewability
- IAB
- ViewableDuring
- VideoViewability
- VideoIAB
- VideoViewableRate
- PlayerImpressionRate
- FraudInvalidTraffic
- FraudOption
- IntegralAdScience
- TRAQScore
- Adult
- Alcohol
- IllegalDownloads
- Drugs
- HateSpeech
- OffensiveLanguage
- Violence
- Gambling
- AdFraudPrevention
- DisplayViewability
- VideoViewability
- PoiAssignedTargetingOptionDetails
- DistanceUnit
- BusinessChainAssignedTargetingOptionDetails
- ContentDurationAssignedTargetingOptionDetails
- ContentStreamTypeAssignedTargetingOptionDetails
- NativeContentPositionAssignedTargetingOptionDetails
- OmidAssignedTargetingOptionDetails
- AudioContentTypeAssignedTargetingOptionDetails
- ContentGenreAssignedTargetingOptionDetails
- YoutubeVideoAssignedTargetingOptionDetails
- YoutubeChannelAssignedTargetingOptionDetails
- SessionPositionAssignedTargetingOptionDetails
- SessionPosition
- Methods
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, "assignedTargetingOptionIdAlias": string, "targetingType": enum ( |
Fields | |
---|---|
name |
Output only. The resource name for this assigned targeting option. |
assignedTargetingOptionId |
Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts. |
assignedTargetingOptionIdAlias |
Output only. An alias for the This field will only be supported for all assigned targeting options of the following targeting types:
This field is also supported for line item assigned targeting options of the following targeting types:
|
targetingType |
Output only. Identifies the type of this assigned targeting option. |
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 |
Channel details. This field will be populated when the |
appCategoryDetails |
App category details. This field will be populated when the |
appDetails |
App details. This field will be populated when the |
urlDetails |
URL details. This field will be populated when the |
dayAndTimeDetails |
Day and time details. This field will be populated when the |
ageRangeDetails |
Age range details. This field will be populated when the |
regionalLocationListDetails |
Regional location list details. This field will be populated when the |
proximityLocationListDetails |
Proximity location list details. This field will be populated when the |
genderDetails |
Gender details. This field will be populated when the |
videoPlayerSizeDetails |
Video player size details. This field will be populated when the |
userRewardedContentDetails |
User rewarded content details. This field will be populated when the |
parentalStatusDetails |
Parental status details. This field will be populated when the |
contentInstreamPositionDetails |
Content instream position details. This field will be populated when the |
contentOutstreamPositionDetails |
Content outstream position details. This field will be populated when the |
deviceTypeDetails |
Device Type details. This field will be populated when the |
audienceGroupDetails |
Audience targeting details. This field will be populated when the |
browserDetails |
Browser details. This field will be populated when the |
householdIncomeDetails |
Household income details. This field will be populated when the |
onScreenPositionDetails |
On screen position details. This field will be populated when the |
carrierAndIspDetails |
Carrier and ISP details. This field will be populated when the |
keywordDetails |
Keyword details. This field will be populated when the A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. |
negativeKeywordListDetails |
Keyword details. This field will be populated when the A maximum of 4 negative keyword lists can be assigned to a resource. |
operatingSystemDetails |
Operating system details. This field will be populated when the |
deviceMakeModelDetails |
Device make and model details. This field will be populated when the |
environmentDetails |
Environment details. This field will be populated when the |
inventorySourceDetails |
Inventory source details. This field will be populated when the |
categoryDetails |
Category details. This field will be populated when the 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 |
Viewability details. This field will be populated when the You can only target one viewability option per resource. |
authorizedSellerStatusDetails |
Authorized seller status details. This field will be populated when the You can only target one authorized seller status option per resource. If a resource 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 |
Language details. This field will be populated when the |
geoRegionDetails |
Geographic region details. This field will be populated when the |
inventorySourceGroupDetails |
Inventory source group details. This field will be populated when the |
digitalContentLabelExclusionDetails |
Digital content label details. This field will be populated when the 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 resource settings). Resource 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 |
Sensitive category details. This field will be populated when the Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. |
exchangeDetails |
Exchange details. This field will be populated when the |
subExchangeDetails |
Sub-exchange details. This field will be populated when the |
thirdPartyVerifierDetails |
Third party verification details. This field will be populated when the |
poiDetails |
POI details. This field will be populated when the |
businessChainDetails |
Business chain details. This field will be populated when the |
contentDurationDetails |
Content duration details. This field will be populated when the |
contentStreamTypeDetails |
Content duration details. This field will be populated when the TargetingType is |
nativeContentPositionDetails |
Native content position details. This field will be populated when the |
omidDetails |
Open Measurement enabled inventory details. This field will be populated when the |
audioContentTypeDetails |
Audio content type details. This field will be populated when the |
contentGenreDetails |
Content genre details. This field will be populated when the |
youtubeVideoDetails |
YouTube video details. This field will be populated when the |
youtubeChannelDetails |
YouTube channel details. This field will be populated when the |
sessionPositionDetails |
Session position details. This field will be populated when the |
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 |
Required. ID of the channel. Should refer to the channel ID field on a Partner-owned channel or advertiser-owned channel resource. |
negative |
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 |
Output only. The display name of the app category. |
targetingOptionId |
Required. The |
negative |
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,
"appPlatform": enum ( |
Fields | |
---|---|
appId |
Required. The ID of the app. Android's Play store app uses bundle ID, for example |
displayName |
Output only. The display name of the app. |
negative |
Indicates if this option is being negatively targeted. |
appPlatform |
Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID. |
AppPlatform
Possible app platform targeting options.
Enums | |
---|---|
APP_PLATFORM_UNSPECIFIED |
Default value when app platform is not specified in this version. This enum is a placeholder for default value and does not represent a real platform option. |
APP_PLATFORM_IOS |
The app platform is iOS. |
APP_PLATFORM_ANDROID |
The app platform is Android. |
APP_PLATFORM_ROKU |
The app platform is Roku. |
APP_PLATFORM_AMAZON_FIRETV |
The app platform is Amazon FireTV. |
APP_PLATFORM_PLAYSTATION |
The app platform is Playstation. |
APP_PLATFORM_APPLE_TV |
The app platform is Apple TV. |
APP_PLATFORM_XBOX |
The app platform is Xbox. |
APP_PLATFORM_SAMSUNG_TV |
The app platform is Samsung TV. |
APP_PLATFORM_ANDROID_TV |
The app platform is Android TV. |
APP_PLATFORM_GENERIC_CTV |
The app platform is a CTV platform that is not explicitly listed elsewhere. |
APP_PLATFORM_LG_TV |
The app platform is LG TV. |
APP_PLATFORM_VIZIO_TV |
The app platform is VIZIO TV. |
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 |
Required. The URL, for example DV360 supports two levels of subdirectory targeting, for example |
negative |
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 ( |
Fields | |
---|---|
dayOfWeek |
Required. The day of the week for this day and time targeting setting. |
startHour |
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 |
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 |
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 ( |
Fields | |
---|---|
ageRange |
Required. 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. |
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 |
Required. ID of the regional location list. Should refer to the |
negative |
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,
"proximityRadius": number,
"proximityRadiusUnit": enum ( |
Fields | |
---|---|
proximityLocationListId |
Required. ID of the proximity location list. Should refer to the |
proximityRadius |
Required. Radius expressed in the distance units set in |
proximityRadiusUnit |
Required. Radius distance units. |
ProximityRadiusUnit
Distance units enum for ProximityRadius.
Enums | |
---|---|
PROXIMITY_RADIUS_UNIT_UNSPECIFIED |
Default value when distance units is not specified in this version. This enum is a place holder for default value and does not represent a real distance unit. |
PROXIMITY_RADIUS_UNIT_MILES |
Radius distance unit in miles. |
PROXIMITY_RADIUS_UNIT_KILOMETERS |
Radius distance unit in kilometeres |
GenderAssignedTargetingOptionDetails
Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType
is TARGETING_TYPE_GENDER
.
JSON representation |
---|
{
"gender": enum ( |
Fields | |
---|---|
gender |
Required. The gender of the audience. |
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 |
---|
{
"videoPlayerSize": enum ( |
Fields | |
---|---|
videoPlayerSize |
Required. 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 ( |
Fields | |
---|---|
targetingOptionId |
Required. The |
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 TARGETING_TYPE_PARENTAL_STATUS
.
JSON representation |
---|
{
"parentalStatus": enum ( |
Fields | |
---|---|
parentalStatus |
Required. The parental status of the audience. |
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 |
---|
{ "contentInstreamPosition": enum ( |
Fields | |
---|---|
contentInstreamPosition |
Required. The content instream position for video or audio ads. |
adType |
Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are:
|
AdType
Represents the creative type associated with the ads.
Enums | |
---|---|
AD_TYPE_UNSPECIFIED |
Ad type is not specified or is unknown in this version. |
AD_TYPE_DISPLAY |
Display creatives, e.g. image and HTML5. |
AD_TYPE_VIDEO |
Video creatives, e.g. video ads that play during streaming content in video players. |
AD_TYPE_AUDIO |
Audio creatives, e.g. audio ads that play during audio content. |
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 |
---|
{ "contentOutstreamPosition": enum ( |
Fields | |
---|---|
contentOutstreamPosition |
Required. The content outstream position. |
adType |
Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are:
|
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 |
---|
{
"deviceType": enum ( |
Fields | |
---|---|
deviceType |
Required. The display name of the device type. |
youtubeAndPartnersBidMultiplier |
Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. |
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 used as an INTERSECTION with other groups.
JSON representation |
---|
{ "includedFirstAndThirdPartyAudienceGroups": [ { object ( |
Fields | |
---|---|
includedFirstAndThirdPartyAudienceGroups[] |
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 |
The Google audience ids of the included Google audience group. Contains Google audience ids only. |
includedCustomListGroup |
The custom list ids of the included custom list group. Contains custom list ids only. |
includedCombinedAudienceGroup |
The combined audience ids of the included combined audience group. Contains combined audience ids only. |
excludedFirstAndThirdPartyAudienceGroup |
The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other. |
excludedGoogleAudienceGroup |
The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. 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 ( |
Fields | |
---|---|
settings[] |
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 ( |
Fields | |
---|---|
firstAndThirdPartyAudienceId |
Required. First and third party audience id of the first and third party audience targeting setting. This id is |
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_45_DAYS |
Recency is 45 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 ( |
Fields | |
---|---|
settings[] |
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 |
Required. Google audience id of the Google audience targeting setting. This id is |
CustomListGroup
Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other.
JSON representation |
---|
{
"settings": [
{
object ( |
Fields | |
---|---|
settings[] |
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 |
Required. Custom id of custom list targeting setting. This id is |
CombinedAudienceGroup
Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other.
JSON representation |
---|
{
"settings": [
{
object ( |
Fields | |
---|---|
settings[] |
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 |
Required. Combined audience id of combined audience targeting setting. This id is |
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 |
Output only. The display name of the browser. |
targetingOptionId |
Required. The |
negative |
Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource 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 ( |
Fields | |
---|---|
householdIncome |
Required. The household income of the audience. |
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 ( |
Fields | |
---|---|
targetingOptionId |
Required. The |
onScreenPosition |
Output only. The on screen position. |
adType |
Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are:
|
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 |
Output only. The display name of the carrier or ISP. |
targetingOptionId |
Required. The |
negative |
Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource 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 |
Required. The keyword, for example 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 |
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 |
Required. ID of the negative keyword list. Should refer to the |
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 |
Output only. The display name of the operating system. |
targetingOptionId |
Required. The targeting option ID populated in |
negative |
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 |
Output only. The display name of the device make and model. |
targetingOptionId |
Required. The |
negative |
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 ( |
Fields | |
---|---|
environment |
Required. The serving environment. |
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 |
Required. ID of the inventory source. Should refer to the |
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 |
Output only. The display name of the category. |
targetingOptionId |
Required. The |
negative |
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 ( |
Fields | |
---|---|
viewability |
Required. The predicted viewability percentage. |
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
.
If a resource does not have an TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option.
JSON representation |
---|
{
"authorizedSellerStatus": enum ( |
Fields | |
---|---|
authorizedSellerStatus |
Output only. The authorized seller status to target. |
targetingOptionId |
Required. The |
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 |
Output only. The display name of the language (e.g., "French"). |
targetingOptionId |
Required. The |
negative |
Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource 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 ( |
Fields | |
---|---|
displayName |
Output only. The display name of the geographic region (e.g., "Ontario, Canada"). |
targetingOptionId |
Required. The |
geoRegionType |
Output only. The type of geographic region targeting. |
negative |
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 |
Required. ID of the inventory source group. Should refer to the |
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 |
---|
{
"excludedContentRatingTier": enum ( |
Fields | |
---|---|
excludedContentRatingTier |
Required. The display name of the digital content label rating tier to be EXCLUDED. |
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 |
---|
{
"excludedSensitiveCategory": enum ( |
Fields | |
---|---|
excludedSensitiveCategory |
Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. |
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 |
---|
{
"exchange": enum ( |
Fields | |
---|---|
exchange |
Required. The enum value for the 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 |
Required. The |
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 |
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 |
Third party brand verifier -- Adloox. |
doubleVerify |
Third party brand verifier -- DoubleVerify. |
integralAdScience |
Third party brand verifier -- Integral Ad Science. |
Adloox
Details of Adloox brand safety settings.
JSON representation |
---|
{ "excludedAdlooxCategories": [ enum ( |
Fields | |
---|---|
excludedAdlooxCategories[] |
Adloox categories to exclude. |
excludedFraudIvtMfaCategories[] |
Optional. Adloox's fraud IVT MFA categories to exclude. |
adultExplicitSexualContent |
Optional. Adult and Explicit Sexual Content GARM risk ranges to exclude. |
crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent |
Optional. Crime and Harmful Acts Content GARM risk ranges to exclude. |
armsAmmunitionContent |
Optional. Arms and Ammunition Content GARM risk ranges to exclude. |
deathInjuryMilitaryConflictContent |
Optional. Death, Injury, or Military Conflict Content GARM risk ranges to exclude. |
debatedSensitiveSocialIssueContent |
Optional. Debated Sensitive Social Issue Content GARM risk ranges to exclude. |
illegalDrugsTobaccoEcigarettesVapingAlcoholContent |
Optional. Illegal Drugs/Alcohol Content GARM risk ranges to exclude. |
onlinePiracyContent |
Optional. Online Piracy Content GARM risk ranges to exclude. |
hateSpeechActsAggressionContent |
Optional. Hate Speech and Acts of Aggression Content GARM risk ranges to exclude. |
obscenityProfanityContent |
Optional. Obscenity and Profanity Content GARM risk ranges to exclude. |
spamHarmfulContent |
Optional. Spam or Harmful Content GARM risk ranges to exclude. |
terrorismContent |
Optional. Terrorism Content GARM risk ranges to exclude. |
misinformationContent |
Optional. Misinformation Content GARM risk ranges to exclude. |
displayIabViewability |
Optional. IAB viewability threshold for display ads. |
videoIabViewability |
Optional. IAB viewability threshold for video ads. |
AdlooxCategory
Available Adloox categories.
Enums | |
---|---|
ADLOOX_UNSPECIFIED |
Default value when a Adloox category is not specified or is unknown in this version. |
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. |
FraudIvtMfaCategory
Available Adloox Fraud, IVT, MFA categories.
Enums | |
---|---|
FRAUD_IVT_MFA_CATEGORY_UNSPECIFIED |
Default value when a Adloox Fraud, IVT, MFA category is not specified or is unknown in this version. |
FRAUD_IVT_MFA |
FRAUD, IVT, MFA. |
GarmRiskExclusion
Available GARM risk level exclusion options.
Enums | |
---|---|
GARM_RISK_EXCLUSION_UNSPECIFIED |
This enum is only a placeholder and it doesn't specify any GARM risk exclusion option. |
GARM_RISK_EXCLUSION_FLOOR |
Exclude floor risk. |
GARM_RISK_EXCLUSION_HIGH |
Exclude high and floor risk. |
GARM_RISK_EXCLUSION_MEDIUM |
Exclude medium, high, and floor risk. |
GARM_RISK_EXCLUSION_LOW |
Exclude all levels of risk (low, medium, high and floor). |
DisplayIabViewability
Available Adloox IAB display viewability thresholds.
Enums | |
---|---|
DISPLAY_IAB_VIEWABILITY_UNSPECIFIED |
Default value when not specified or is unknown in this version. |
DISPLAY_IAB_VIEWABILITY_10 |
10%+ in view (IAB display viewability standard). |
DISPLAY_IAB_VIEWABILITY_20 |
20%+ in view (IAB display viewability standard). |
DISPLAY_IAB_VIEWABILITY_35 |
35%+ in view (IAB display viewability standard). |
DISPLAY_IAB_VIEWABILITY_50 |
50%+ in view (IAB display viewability standard). |
DISPLAY_IAB_VIEWABILITY_75 |
75%+ in view (IAB display viewability standard). |
VideoIabViewability
Available Adloox IAB video viewability thresholds.
Enums | |
---|---|
VIDEO_IAB_VIEWABILITY_UNSPECIFIED |
Default value when not specified or is unknown in this version. |
VIDEO_IAB_VIEWABILITY_10 |
10%+ in view (IAB video viewability standard). |
VIDEO_IAB_VIEWABILITY_20 |
20%+ in view (IAB video viewability standard). |
VIDEO_IAB_VIEWABILITY_35 |
35%+ in view (IAB video viewability standard). |
VIDEO_IAB_VIEWABILITY_50 |
50%+ in view (IAB video viewability standard). |
VIDEO_IAB_VIEWABILITY_75 |
75%+ in view (IAB video viewability standard). |
DoubleVerify
Details of DoubleVerify settings.
JSON representation |
---|
{ "brandSafetyCategories": { object ( |
Fields | |
---|---|
brandSafetyCategories |
DV Brand Safety Controls. |
avoidedAgeRatings[] |
Avoid bidding on apps with the age rating. |
appStarRating |
Avoid bidding on apps with the star ratings. |
displayViewability |
Display viewability settings (applicable to display line items only). |
videoViewability |
Video viewability settings (applicable to video line items only). |
fraudInvalidTraffic |
Avoid Sites and Apps with historical Fraud & IVT Rates. |
customSegmentId |
The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: |
BrandSafetyCategories
Settings for brand safety controls.
JSON representation |
---|
{ "avoidUnknownBrandSafetyCategory": boolean, "avoidedHighSeverityCategories": [ enum ( |
Fields | |
---|---|
avoidUnknownBrandSafetyCategory |
Unknown or unrateable. |
avoidedHighSeverityCategories[] |
Brand safety high severity avoidance categories. |
avoidedMediumSeverityCategories[] |
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 ( |
Fields | |
---|---|
avoidedStarRating |
Avoid bidding on apps with the star ratings. |
avoidInsufficientStarRating |
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 ( |
Fields | |
---|---|
iab |
Target web and app inventory to maximize IAB viewable rate. |
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 ( |
Fields | |
---|---|
videoIab |
Target web inventory to maximize IAB viewable rate. |
videoViewableRate |
Target web inventory to maximize fully viewable rate. |
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 ( |
Fields | |
---|---|
avoidedFraudOption |
Avoid Sites and Apps with historical Fraud & IVT. |
avoidInsufficientOption |
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 ( |
Fields | |
---|---|
traqScoreOption |
True advertising quality (applicable to Display line items only). |
excludeUnrateable |
Brand Safety - Unrateable. |
excludedAdultRisk |
Brand Safety - Adult content. |
excludedAlcoholRisk |
Brand Safety - Alcohol. |
excludedIllegalDownloadsRisk |
Brand Safety - Illegal downloads. |
excludedDrugsRisk |
Brand Safety - Drugs. |
excludedHateSpeechRisk |
Brand Safety - Hate speech. |
excludedOffensiveLanguageRisk |
Brand Safety - Offensive language. |
excludedViolenceRisk |
Brand Safety - Violence. |
excludedGamblingRisk |
Brand Safety - Gambling. |
excludedAdFraudRisk |
Ad Fraud settings. |
displayViewability |
Display Viewability section (applicable to display line items only). |
videoViewability |
Video Viewability Section (applicable to video line items only). |
customSegmentId[] |
The custom segment ID provided by Integral Ad Science. The ID must be between |
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). |
PoiAssignedTargetingOptionDetails
Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType
is TARGETING_TYPE_POI
.
JSON representation |
---|
{
"displayName": string,
"targetingOptionId": string,
"latitude": number,
"longitude": number,
"proximityRadiusAmount": number,
"proximityRadiusUnit": enum ( |
Fields | |
---|---|
displayName |
Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. |
targetingOptionId |
Required. The Accepted POI targeting option IDs can be retrieved using If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". Upon creation, this field value will be updated to append a semicolon and alphanumerical hash value if only latitude/longitude coordinates are provided. |
latitude |
Output only. Latitude of the POI rounding to 6th decimal place. |
longitude |
Output only. Longitude of the POI rounding to 6th decimal place. |
proximityRadiusAmount |
Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by |
proximityRadiusUnit |
Required. The unit of distance by which the targeting radius is measured. |
DistanceUnit
Possible distance unit options.
Enums | |
---|---|
DISTANCE_UNIT_UNSPECIFIED |
Type value is not specified or is unknown in this version. |
DISTANCE_UNIT_MILES |
Miles. |
DISTANCE_UNIT_KILOMETERS |
Kilometers. |
BusinessChainAssignedTargetingOptionDetails
Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targetingType
is TARGETING_TYPE_BUSINESS_CHAIN
.
JSON representation |
---|
{
"displayName": string,
"targetingOptionId": string,
"proximityRadiusAmount": number,
"proximityRadiusUnit": enum ( |
Fields | |
---|---|
displayName |
Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". |
targetingOptionId |
Required. The Accepted business chain targeting option IDs can be retrieved using |
proximityRadiusAmount |
Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by |
proximityRadiusUnit |
Required. The unit of distance by which the targeting radius is measured. |
ContentDurationAssignedTargetingOptionDetails
Details for content duration assigned targeting option. This will be populated in the contentDurationDetails
field when targetingType
is TARGETING_TYPE_CONTENT_DURATION
. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect.
JSON representation |
---|
{
"targetingOptionId": string,
"contentDuration": enum ( |
Fields | |
---|---|
targetingOptionId |
Required. The |
contentDuration |
Output only. The content duration. |
ContentStreamTypeAssignedTargetingOptionDetails
Details for content stream type assigned targeting option. This will be populated in the contentStreamTypeDetails
field when targetingType
is TARGETING_TYPE_CONTENT_STREAM_TYPE
. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect.
JSON representation |
---|
{
"targetingOptionId": string,
"contentStreamType": enum ( |
Fields | |
---|---|
targetingOptionId |
Required. The |
contentStreamType |
Output only. The content stream type. |
NativeContentPositionAssignedTargetingOptionDetails
Details for native content position assigned targeting option. This will be populated in the nativeContentPositionDetails
field when targetingType
is TARGETING_TYPE_NATIVE_CONTENT_POSITION
. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect.
JSON representation |
---|
{
"contentPosition": enum ( |
Fields | |
---|---|
contentPosition |
Required. The content position. |
OmidAssignedTargetingOptionDetails
Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targetingType
is TARGETING_TYPE_OMID
.
JSON representation |
---|
{
"omid": enum ( |
Fields | |
---|---|
omid |
Required. The type of Open Measurement enabled inventory. |
AudioContentTypeAssignedTargetingOptionDetails
Details for audio content type assigned targeting option. This will be populated in the audioContentTypeDetails
field when targetingType
is TARGETING_TYPE_AUDIO_CONTENT_TYPE
. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect.
JSON representation |
---|
{
"audioContentType": enum ( |
Fields | |
---|---|
audioContentType |
Required. The audio content type. |
ContentGenreAssignedTargetingOptionDetails
Details for content genre assigned targeting option. This will be populated in the contentGenreDetails
field when targetingType
is TARGETING_TYPE_CONTENT_GENRE
. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect.
JSON representation |
---|
{ "targetingOptionId": string, "displayName": string, "negative": boolean } |
Fields | |
---|---|
targetingOptionId |
Required. The |
displayName |
Output only. The display name of the content genre. |
negative |
Indicates if this option is being negatively targeted. |
YoutubeVideoAssignedTargetingOptionDetails
Details for YouTube video assigned targeting option. This will be populated in the youtubeVideoDetails
field when targetingType
is TARGETING_TYPE_YOUTUBE_VIDEO
.
JSON representation |
---|
{ "videoId": string, "negative": boolean } |
Fields | |
---|---|
videoId |
YouTube video id as it appears on the YouTube watch page. |
negative |
Indicates if this option is being negatively targeted. |
YoutubeChannelAssignedTargetingOptionDetails
Details for YouTube channel assigned targeting option. This will be populated in the youtubeChannelDetails
field when targetingType
is TARGETING_TYPE_YOUTUBE_CHANNEL
.
JSON representation |
---|
{ "channelId": string, "negative": boolean } |
Fields | |
---|---|
channelId |
The YouTube uploader channel id or the channel code of a YouTube channel. |
negative |
Indicates if this option is being negatively targeted. |
SessionPositionAssignedTargetingOptionDetails
Details for session position assigned targeting option. This will be populated in the sessionPositionDetails
field when targetingType
is TARGETING_TYPE_SESSION_POSITION
.
JSON representation |
---|
{
"sessionPosition": enum ( |
Fields | |
---|---|
sessionPosition |
The position where the ad will show in a session. |
SessionPosition
Possible positions in a session.
Enums | |
---|---|
SESSION_POSITION_UNSPECIFIED |
This is a placeholder, does not indicate any positions. |
SESSION_POSITION_FIRST_IMPRESSION |
The first impression of the session. |
Methods |
|
---|---|
|
Gets a single targeting option assigned to an ad group. |
|
Lists the targeting options assigned to an ad group. |