REST Resource: advertisers.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.

Methods

create

Assigns a targeting option to an advertiser.

delete

Deletes an assigned targeting option from an advertiser.

get

Gets a single targeting option assigned to an advertiser.

list

Lists the targeting options assigned to an advertiser.