Targeting

Targeting expression.

JSON representation 
{
  "inventoryUrlTargeting": {
    object (InventoryUrlTargeting)
  },
  "geoTargeting": {
    object (GeoTargeting)
  },
  "technologyTargeting": {
    object (TechnologyTargeting)
  },
  "inventorySizeTargeting": {
    object (InventorySizeTargeting)
  },
  "inventoryTargeting": {
    object (InventoryTargeting)
  },
  "requestPlatformTargeting": {
    object (RequestPlatformTargeting)
  },
  "customTargeting": {
    object (CustomTargeting)
  },
  "dateTimeRangeTargeting": {
    object (DateTimeRangeTargeting)
  },
  "publisherProvidedSignalsTargeting": {
    object (PublisherProvidedSignalsTargeting)
  },
  "userDomainTargeting": {
    object (UserDomainTargeting)
  },
  "contextualTargeting": {
    object (ContextualTargeting)
  },
  "videoPositionTargeting": {
    object (VideoPositionTargeting)
  },
  "dataSegmentTargeting": {
    object (DataSegmentTargeting)
  },
  "requestFormatTargeting": {
    object (RequestFormatTargeting)
  },
  "contentTargeting": {
    object (ContentTargeting)
  },
  "mobileApplicationTargeting": {
    object (MobileApplicationTargeting)
  },
  "dayPartTargeting": {
    object (DayPartTargeting)
  },
  "buyerUserListTargeting": {
    object (BuyerUserListTargeting)
  }
}
Fields
inventoryUrlTargeting

object (InventoryUrlTargeting)

Optional. Used to target/exclude specific websites.
geoTargeting

object (GeoTargeting)

Optional. Used to target/exclude various geo targets.
technologyTargeting

object (TechnologyTargeting)

Optional. Used to target various technology targeting dimensions.
inventorySizeTargeting

object (InventorySizeTargeting)

Optional. Used to target/exclude ad requests for specific ad slot sizes.
inventoryTargeting

object (InventoryTargeting)

Optional. Used to target/exclude various ad units and/or placements.
requestPlatformTargeting

object (RequestPlatformTargeting)

Optional. Used to target specific request platforms.
customTargeting

object (CustomTargeting)

Optional. Used to target key/values, audience segments, and/or CMS metadata.
dateTimeRangeTargeting

object (DateTimeRangeTargeting)

Optional. Used to target a datetime range.
publisherProvidedSignalsTargeting

object (PublisherProvidedSignalsTargeting)

Optional. Used to target publisher provided signals.
userDomainTargeting

object (UserDomainTargeting)

Optional. Used to target user domains.
contextualTargeting

object (ContextualTargeting)

Optional. Used to target verticals / content labels
videoPositionTargeting

object (VideoPositionTargeting)

Optional. Used to target video positions.
dataSegmentTargeting

object (DataSegmentTargeting)

Optional. Used to target data segments.
requestFormatTargeting

object (RequestFormatTargeting)

Optional. Used to target inventory formats.
contentTargeting

object (ContentTargeting)

Optional. Used to target content.
mobileApplicationTargeting

object (MobileApplicationTargeting)

Optional. Used to target mobile applications.
dayPartTargeting

object (DayPartTargeting)

Optional. Used to target day parts.
buyerUserListTargeting

object (BuyerUserListTargeting)

Optional. Used to target buyer user lists.

InventoryUrlTargeting

Represents a list of targeted and excluded inventory URLs and Sites.

JSON representation 
{
  "targetedInventoryUrls": [
    string
  ],
  "excludedInventoryUrls": [
    string
  ]
}
Fields
targetedInventoryUrls[]

string

Optional. A list of inventory URL resource names that should be targeted/included.
excludedInventoryUrls[]

string

Optional. A list of inventory URL resource names that should be excluded.

GeoTargeting

Represents a list of targeted and excluded geos.

JSON representation 
{
  "targetedGeos": [
    string
  ],
  "excludedGeos": [
    string
  ]
}
Fields
targetedGeos[]

string

Optional. A list of geo resource names that should be targeted/included.
excludedGeos[]

string

Optional. A list of geo resource names that should be excluded.

TechnologyTargeting

Various types of technology targeting expressed by child messages are applied with logical AND.

JSON representation 
{
  "bandwidthTargeting": {
    object (BandwidthTargeting)
  },
  "browserTargeting": {
    object (BrowserTargeting)
  },
  "browserLanguageTargeting": {
    object (BrowserLanguageTargeting)
  },
  "deviceCapabilityTargeting": {
    object (DeviceCapabilityTargeting)
  },
  "deviceCategoryTargeting": {
    object (DeviceCategoryTargeting)
  },
  "deviceManufacturerTargeting": {
    object (DeviceManufacturerTargeting)
  },
  "mobileCarrierTargeting": {
    object (MobileCarrierTargeting)
  },
  "operatingSystemTargeting": {
    object (OperatingSystemTargeting)
  }
}
Fields
bandwidthTargeting

object (BandwidthTargeting)

Optional. Bandwidth targeting dimension.
browserTargeting

object (BrowserTargeting)

Optional. Browser targeting dimension.
browserLanguageTargeting

object (BrowserLanguageTargeting)

Optional. Browser language targeting dimension.
deviceCapabilityTargeting

object (DeviceCapabilityTargeting)

Optional. Device capability targeting dimension.
deviceCategoryTargeting

object (DeviceCategoryTargeting)

Optional. Device category targeting dimension.
deviceManufacturerTargeting

object (DeviceManufacturerTargeting)

Optional. Device manufacturer targeting dimension.
mobileCarrierTargeting

object (MobileCarrierTargeting)

Optional. Mobile carrier targeting dimension.
operatingSystemTargeting

object (OperatingSystemTargeting)

Optional. Operating system targeting dimension.

BandwidthTargeting

Bandwidth Targeting.

Reach users accessing the internet through various means of connection, such as cable, DSL, or dial-up. Can be useful to target campaigns using low-resolution creatives or text ads for users with low bandwidth.

JSON representation 
{
  "targetedBandwidthGroups": [
    string
  ],
  "excludedBandwidthGroups": [
    string
  ]
}
Fields
targetedBandwidthGroups[]

string

Optional. A list of resource names of the bandwidth groups that should be targeted/included.
excludedBandwidthGroups[]

string

Optional. A list of resource names of the bandwidth groups that should be excluded.

BrowserTargeting

Browser Targeting.

Allows publishers to target/exclude a browser type (e.g. Chrome, Firefox, Safari). For more information, see https://support.google.com/admanager/answer/2884033 (Targeting types > Browser).

JSON representation 
{
  "targetedBrowsers": [
    string
  ],
  "excludedBrowsers": [
    string
  ]
}
Fields
targetedBrowsers[]

string

Optional. A list of browser resource names that should be targeted/included.
excludedBrowsers[]

string

Optional. A list of browser resource names that should be excluded.

BrowserLanguageTargeting

Browser Language Targeting.

For ads targeting mobile apps and their associated WebViews, the language used is based on the language specified by the user in their mobile device settings. If a browser has more than one language assigned to it, each language generates an impression.

JSON representation 
{
  "targetedBrowserLanguages": [
    string
  ],
  "excludedBrowserLanguages": [
    string
  ]
}
Fields
targetedBrowserLanguages[]

string

Optional. A list of browser language resource names that should be targeted/included.
excludedBrowserLanguages[]

string

Optional. A list of browser language resource names that should be excluded.

DeviceCapabilityTargeting

Device Capability Targeting.

Can be used to target/exclude users using mobile apps, ad requests resulting from apps built on the MRAID standard, or users on devices that are able to make phone calls versus devices that aren't able to make phone calls, such as tablets.

JSON representation 
{
  "targetedCapabilities": [
    string
  ],
  "excludedCapabilities": [
    string
  ]
}
Fields
targetedCapabilities[]

string

Optional. A list of device capability resource names that should be targeted/included.
excludedCapabilities[]

string

Optional. A list of device capability resource names that should be excluded.

DeviceCategoryTargeting

Represents a list of targeted and excluded device categories.

JSON representation 
{
  "targetedCategories": [
    string
  ],
  "excludedCategories": [
    string
  ]
}
Fields
targetedCategories[]

string

Optional. A list of device category resource names that should be targeted/included.
excludedCategories[]

string

Optional. A list of device category resource names that should be excluded.

DeviceManufacturerTargeting

Device Manufacturer Targeting.

Can be used to target/exclude users on devices made by specific brands or companies, such as Apple, Google, Samsung and others. For more information, see https://support.google.com/admanager/answer/2884033 ("Targeting types > Device manufacturer").

JSON representation 
{
  "targetedDeviceManufacturers": [
    string
  ],
  "excludedDeviceManufacturers": [
    string
  ],
  "targetedMobileDevices": [
    string
  ],
  "excludedMobileDevices": [
    string
  ],
  "targetedMobileDeviceSubmodels": [
    string
  ],
  "excludedMobileDeviceSubmodels": [
    string
  ]
}
Fields
targetedDeviceManufacturers[]

string

Optional. A list of device manufacturer resource names that should be targeted/included.
excludedDeviceManufacturers[]

string

Optional. A list of device manufacturer resource names that should be excluded.
targetedMobileDevices[]

string

Optional. A list of mobile device resource names that should be targeted/included.
excludedMobileDevices[]

string

Optional. A list of mobile device resource names that should be excluded.
targetedMobileDeviceSubmodels[]

string

Optional. A list of mobile device submodel resource names that should be targeted/included.
excludedMobileDeviceSubmodels[]

string

Optional. A list of mobile device submodel resource names that should be excluded.

MobileCarrierTargeting

Mobile Carrier Targeting.

Used to target or exclude mobile carriers.

JSON representation 
{
  "targetedMobileCarriers": [
    string
  ],
  "excludedMobileCarriers": [
    string
  ]
}
Fields
targetedMobileCarriers[]

string

Optional. A list of mobile carrier resource names that should be targeted/included.
excludedMobileCarriers[]

string

Optional. A list of mobile carrier resource names that should be excluded.

OperatingSystemTargeting

Operating System Targeting

JSON representation 
{
  "targetedOperatingSystems": [
    string
  ],
  "excludedOperatingSystems": [
    string
  ],
  "targetedOperatingSystemVersions": [
    string
  ],
  "excludedOperatingSystemVersions": [
    string
  ]
}
Fields
targetedOperatingSystems[]

string

Optional. A list of operating system resource names that should be targeted/included.
excludedOperatingSystems[]

string

Optional. A list of operating system resource names that should be excluded.
targetedOperatingSystemVersions[]

string

Optional. A list of operating system version resource names that should be targeted/included.
excludedOperatingSystemVersions[]

string

Optional. A list of operating system version resource names that should be excluded.

InventorySizeTargeting

Represents a list of targeted and excluded sizes.

JSON representation 
{
  "targetedInventorySizes": [
    {
      object (Size)
    }
  ],
  "excludedInventorySizes": [
    {
      object (Size)
    }
  ]
}
Fields
targetedInventorySizes[]

object (Size)

Optional. A list of sizes that should be targeted/included.
excludedInventorySizes[]

object (Size)

Optional. A list of sizes that should be excluded.

RequestPlatformTargeting

Represents a list of targeted request platforms.

JSON representation 
{
  "requestPlatforms": [
    enum (RequestPlatform)
  ]
}
Fields
requestPlatforms[]

enum (RequestPlatform)

Optional. The list of request platforms that should be targeted.

RequestPlatform

The different environments in which an ad can be shown.

Enums
REQUEST_PLATFORM_UNSPECIFIED No value specified
BROWSER Represents a request made from a web browser (incl. desktop browsers, mobile browsers, webviews, etc.).
MOBILE_APP Represents a request made from a Mobile Application.
VIDEO_PLAYER Represents a request made from a video player.

DateTimeRangeTargeting

Represents targeting for a range of datetimes.

JSON representation 
{
  "targetedRange": [
    {
      object (Interval)
    }
  ]
}
Fields
targetedRange[]

object (Interval)

Optional. The targeted datetime ranges.

Interval

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).

The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

JSON representation 
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Optional. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Optional. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

PublisherProvidedSignalsTargeting

Publisher Provided Signals Targeting

JSON representation 
{
  "targetedTaxonomyCategories": [
    string
  ],
  "excludedTaxonomyCategories": [
    string
  ]
}
Fields
targetedTaxonomyCategories[]

string

Optional. The resource names of the taxonomy categories that should be targeted/included.
excludedTaxonomyCategories[]

string

Optional. The resource names of the taxonomy categories that should be excluded.

UserDomainTargeting

User Domain Targeting

JSON representation 
{
  "targetedUserDomains": [
    string
  ],
  "excludedUserDomains": [
    string
  ]
}
Fields
targetedUserDomains[]

string

Optional. A list of user domains that should be targeted/included.
excludedUserDomains[]

string

Optional. A list of user domains that should be excluded.

ContextualTargeting

Contextual Targeting

JSON representation 
{
  "excludedContentLabels": [
    string
  ]
}
Fields
excludedContentLabels[]

string

Optional. A list of content labels that should be excluded.

VideoPositionTargeting

Video Position Targeting

JSON representation 
{
  "videoPositions": [
    {
      object (VideoPosition)
    }
  ]
}
Fields
videoPositions[]

object (VideoPosition)

Optional. A list of video position targeting criterion (applied with a logical AND).

VideoPosition

Video Position Targeting Criterion

JSON representation 
{
  "midrollIndex": string,
  "reverseMidrollIndex": string,
  "podPosition": string,
  "positionType": enum (VideoPosition),
  "bumperType": enum (TargetedVideoBumperType)
}
Fields
midrollIndex

string (int64 format)

Optional. The index of the mid-roll to target. This field is ignored when targeting any video position (e.g. positionType) other than MIDROLL.
reverseMidrollIndex

string (int64 format)

Optional. The index from the back of the pod of the mid-roll to target. This field is ignored when targeting any video position (e.g. positionType) other than MIDROLL or if targeting a specific midroll index (e.g. midrollIndex != 0).
podPosition

string (int64 format)

Optional. The video position within a pod to target. This field must be unset in order to target a specific video position (e.g. positionType), bumper type (e.g. bumperType), or custom ad spot (e.g. customSpotId).
positionType

enum (VideoPosition)

Optional. The position within a video to target. A video ad can target a position (pre-roll, all mid-rolls, or post-roll) or a specific mid-roll index.
bumperType

enum (TargetedVideoBumperType)

Optional. The video bumper type to target. This field must be unset in order to target a specific video position (e.g. positionType), pod position (e.g. podPosition), or custom ad spot (e.g. customSpotId).

VideoPosition

Represents a targetable position within a video.

Enums
VIDEO_POSITION_UNSPECIFIED Default value. This value is unused.
ALL Allow ad placement at any position within the video.
MIDROLL Target ad placement during the video.
POSTROLL Target ad placement after the video ends.
PREROLL Target ad placement before the video starts.

TargetedVideoBumperType

Represents the options for targetable bumper positions, surrounding an ad pod, within a video stream. This includes before and after the supported ad pod positions, VideoPositionEnum.VideoPosition.PREROLL, VideoPositionEnum.VideoPosition.MIDROLL, and VideoPositionEnum.VideoPosition.POSTROLL.

Enums
TARGETED_VIDEO_BUMPER_TYPE_UNSPECIFIED Default value. This value is unused.
AFTER Represents the bumper position after the ad pod.
BEFORE Represents the bumper position before the ad pod.

DataSegmentTargeting

Data Segment Targeting

JSON representation 
{
  "hasDataSegmentTargeting": boolean
}
Fields
hasDataSegmentTargeting

boolean

Output only. Whether any data segments are currently targeted.

RequestFormatTargeting

Request Format Targeting

This message specifies inclusion or exclusion of various request formats for targeting. Each optional boolean field controls the targeting of a specific request format:

  • If set to true, the corresponding format is included in targeting.
  • If set to false, the corresponding format is excluded from targeting.
  • If unset, the format is neither explicitly included nor excluded.
JSON representation 
{
  "appOpenEnabled": boolean,
  "rewardedEnabled": boolean,
  "rewardedInterstitialEnabled": boolean,
  "interstitialEnabled": boolean,
  "anchorEnabled": boolean,
  "bannerEnabled": boolean,
  "instreamVideoEnabled": boolean,
  "instreamAudioEnabled": boolean,
  "nativeAdvancedEnabled": boolean
}
Fields
appOpenEnabled

boolean

Optional. Controls app open format targeting. Set to true to include, false to exclude, or leave unset for neither.
rewardedEnabled

boolean

Optional. Controls rewarded format targeting. Set to true to include, false to exclude, or leave unset for neither.
rewardedInterstitialEnabled

boolean

Optional. Controls rewarded interstitial format targeting. Set to true to include, false to exclude, or leave unset for neither.
interstitialEnabled

boolean

Optional. Controls interstitial format targeting. Set to true to include, false to exclude, or leave unset for neither.
anchorEnabled

boolean

Optional. Controls anchor format targeting. Set to true to include, false to exclude, or leave unset for neither.
bannerEnabled

boolean

Optional. Controls banner format targeting. Set to true to include, false to exclude, or leave unset for neither.
instreamVideoEnabled

boolean

Optional. Controls instream video format targeting. Set to true to include, false to exclude, or leave unset for neither.
instreamAudioEnabled

boolean

Optional. Controls instream audio format targeting. Set to true to include, false to exclude, or leave unset for neither.
nativeAdvancedEnabled

boolean

Optional. Controls native advanced format targeting. Set to true to include, false to exclude, or leave unset for neither.

ContentTargeting

Content Targeting

Targeted/excluded content entities and bundles.

JSON representation 
{
  "targetedContent": [
    string
  ],
  "excludedContent": [
    string
  ],
  "targetedContentBundles": [
    string
  ],
  "excludedContentBundles": [
    string
  ]
}
Fields
targetedContent[]

string

Optional. The resource names of the Content that should be targeted/included.
excludedContent[]

string

Optional. The resource names of the Content that should be excluded.
targetedContentBundles[]

string

Optional. The resource names of the ContentBundles that should be targeted/included.
excludedContentBundles[]

string

Optional. The resource names of the ContentBundles that should be excluded.

MobileApplicationTargeting

Mobile Application Targeting

JSON representation 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "firstPartyTargeting": {
    object (FirstPartyMobileApplicationTargeting)
  }
  // End of mutually exclusive fields.
}
Fields
The mobile application targeting. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
firstPartyTargeting

object (FirstPartyMobileApplicationTargeting)

Optional. The targeted/excluded first-party mobile applications.
End of mutually exclusive fields.

FirstPartyMobileApplicationTargeting

First-party mobile application targeting.

JSON representation 
{
  "targetedApplications": [
    string
  ],
  "excludedApplications": [
    string
  ]
}
Fields
targetedApplications[]

string

Optional. The resource names of the first-party applications that should be targeted.
excludedApplications[]

string

Optional. The resource names of the first-party applications that should be excluded.

DayPartTargeting

Day Part Targeting

JSON representation 
{
  "targetedDayParts": [
    {
      object (DayPart)
    }
  ],
  "daypartingTimeZone": enum (DaypartingTimeZone)
}
Fields
targetedDayParts[]

object (DayPart)

Optional. The targeted day parts.
daypartingTimeZone

enum (DaypartingTimeZone)

Required. The time zone to use for the day parts.

DayPart

A day of the week and time interval within the day.

JSON representation 
{
  "dayOfWeek": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  }
}
Fields
dayOfWeek

enum (DayOfWeek)

Required. The day of the week.
startTime

object (TimeOfDay)

Required. The start time of the day part.
endTime

object (TimeOfDay)

Required. The end time of the day part.

DaypartingTimeZone

Represents the time zone to be used for daypart targeting.

Enums
DAYPARTING_TIME_ZONE_UNSPECIFIED Default value. This value is unused.
PUBLISHER Use the time zone of the publisher for daypart targeting.
USER Use the time zone of the browser for daypart targeting.

BuyerUserListTargeting

Buyer User List Targeting.

JSON representation 
{
  "hasBuyerUserListTargeting": boolean
}
Fields
hasBuyerUserListTargeting

boolean

Output only. Whether any buyer user lists are currently targeted.