Web Service: AdjustmentService
Port AdjustmentServiceInterfacePort Port typeSource code
- calculateDailyAdOpportunityCountsDetailSource code
- createForecastAdjustmentsDetailSource code
- createTrafficForecastSegmentsDetailSource code
- getForecastAdjustmentsByStatementDetailSource code
- getTrafficForecastSegmentsByStatementDetailSource code
- performForecastAdjustmentActionDetailSource code
- updateForecastAdjustmentsDetailSource code
- updateTrafficForecastSegmentsDetailSource code
Operations
- calculateDailyAdOpportunityCountsDescription:Takes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:calculateDailyAdOpportunityCountsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type calculateDailyAdOpportunityCountsTakes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings.
- forecastAdjustment - optional; type ForecastAdjustmentProvides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.
- id - optional; type longThe unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.
- trafficForecastSegmentId - optional; type longThe ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.
- name - optional; type stringName of the ForecastAdjustment. This attribute is required.
- dateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The start and end date range of the adjustment. This attribute is required. - startDate - optional; type Date
- status - optional; type ForecastAdjustmentStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }The status of the adjustment. Changes to this field should be made via {@code performForecastAdjustmentAction} This attribute is read-only.
- volumeType - optional; type ForecastAdjustmentVolumeType - type string with restriction - enum { 'UNKNOWN', 'DAILY_VOLUME', 'TOTAL_VOLUME', 'HISTORICAL_BASIS_VOLUME' }The volume type of the adjustment. This attribute is required.
- allowAdjustingForecastAboveRecommendedLimit - optional; type booleanWhether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.
Note that this field will not persist on the adjustment itself, and will only affect the current request.
- dailyVolumeSettings - optional; type DailyVolumeSettingsSettings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment.
For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.
- adOpportunityCounts - optional, unbounded; type longThe list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range.
The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7. This attribute is required.
The daily number of ad opportunities for each day in the adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#DAILY_VOLUME} and ignored othewise. - adOpportunityCounts - optional, unbounded; type long
- totalVolumeSettings - optional; type TotalVolumeSettingsThe total number of ad opportunities for the entire adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#TOTAL_VOLUME} and ignored othewise.Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment.
For example, an {@code adOpportunityCount} of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.
- adOpportunityCount - optional; type longThe total ad opportunity count over the entire forecast adjustment date range. This attribute is required.
- adOpportunityCount - optional; type long
- historicalBasisVolumeSettings - optional; type HistoricalBasisVolumeSettingsThe daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME} and ignored othewise.Settings to specify the volume of ad opportunities per day over the {@link ForecastAdjustment} date range based on the traffic volume of a historical reference period.
The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment.
The number of days included in the historical date range does *not* need to be the same as the number of days included in the adjustment date range.
- useParentTrafficForecastSegmentTargeting - optional; type booleanWhether the parent traffic forecast segment targeting's or the {@code targeting}'s historical volume data should be used. This attribute is required.
- targeting - optional; type TargetingThe targeting criteria to use as the source of the historical volume data. This field is required if {@code useParentTrafficForecastSegmentTargeting} is false and ignored otherwise.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- historicalDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range to use for the historical ad opportunity volume. This attribute is required. - startDate - optional; type Date
- multiplierMilliPercent - optional; type longThe multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000. This attribute is required.
- useParentTrafficForecastSegmentTargeting - optional; type boolean
- calculatedDailyAdOpportunityCounts - optional, unbounded; type longThe daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a {@code dateRange} of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.
This field is read-only and is populated by Google after forecast adjustment creation or update. This attribute is read-only.
- id - optional; type long
Output:calculateDailyAdOpportunityCountsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type calculateDailyAdOpportunityCountsResponse- rval - optional; type ForecastAdjustmentProvides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.
- id - optional; type longThe unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.
- trafficForecastSegmentId - optional; type longThe ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.
- name - optional; type stringName of the ForecastAdjustment. This attribute is required.
- dateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The start and end date range of the adjustment. This attribute is required. - startDate - optional; type Date
- status - optional; type ForecastAdjustmentStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }The status of the adjustment. Changes to this field should be made via {@code performForecastAdjustmentAction} This attribute is read-only.
- volumeType - optional; type ForecastAdjustmentVolumeType - type string with restriction - enum { 'UNKNOWN', 'DAILY_VOLUME', 'TOTAL_VOLUME', 'HISTORICAL_BASIS_VOLUME' }The volume type of the adjustment. This attribute is required.
- allowAdjustingForecastAboveRecommendedLimit - optional; type booleanWhether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.
Note that this field will not persist on the adjustment itself, and will only affect the current request.
- dailyVolumeSettings - optional; type DailyVolumeSettingsSettings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment.
For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.
- adOpportunityCounts - optional, unbounded; type longThe list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range.
The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7. This attribute is required.
The daily number of ad opportunities for each day in the adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#DAILY_VOLUME} and ignored othewise. - adOpportunityCounts - optional, unbounded; type long
- totalVolumeSettings - optional; type TotalVolumeSettingsThe total number of ad opportunities for the entire adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#TOTAL_VOLUME} and ignored othewise.Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment.
For example, an {@code adOpportunityCount} of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.
- adOpportunityCount - optional; type longThe total ad opportunity count over the entire forecast adjustment date range. This attribute is required.
- adOpportunityCount - optional; type long
- historicalBasisVolumeSettings - optional; type HistoricalBasisVolumeSettingsThe daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME} and ignored othewise.Settings to specify the volume of ad opportunities per day over the {@link ForecastAdjustment} date range based on the traffic volume of a historical reference period.
The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment.
The number of days included in the historical date range does *not* need to be the same as the number of days included in the adjustment date range.
- useParentTrafficForecastSegmentTargeting - optional; type booleanWhether the parent traffic forecast segment targeting's or the {@code targeting}'s historical volume data should be used. This attribute is required.
- targeting - optional; type TargetingThe targeting criteria to use as the source of the historical volume data. This field is required if {@code useParentTrafficForecastSegmentTargeting} is false and ignored otherwise.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- historicalDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range to use for the historical ad opportunity volume. This attribute is required. - startDate - optional; type Date
- multiplierMilliPercent - optional; type longThe multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000. This attribute is required.
- useParentTrafficForecastSegmentTargeting - optional; type boolean
- calculatedDailyAdOpportunityCounts - optional, unbounded; type longThe daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a {@code dateRange} of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.
This field is read-only and is populated by Google after forecast adjustment creation or update. This attribute is read-only.
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - forecastAdjustment - optional; type ForecastAdjustment
- createForecastAdjustmentsDescription:Creates new {@link ForecastAdjustment} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:createForecastAdjustmentsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type createForecastAdjustmentsCreates new {@link ForecastAdjustment} objects.
- forecastAdjustments - optional, unbounded; type ForecastAdjustmentProvides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.
- id - optional; type longThe unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.
- trafficForecastSegmentId - optional; type longThe ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.
- name - optional; type stringName of the ForecastAdjustment. This attribute is required.
- dateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The start and end date range of the adjustment. This attribute is required. - startDate - optional; type Date
- status - optional; type ForecastAdjustmentStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }The status of the adjustment. Changes to this field should be made via {@code performForecastAdjustmentAction} This attribute is read-only.
- volumeType - optional; type ForecastAdjustmentVolumeType - type string with restriction - enum { 'UNKNOWN', 'DAILY_VOLUME', 'TOTAL_VOLUME', 'HISTORICAL_BASIS_VOLUME' }The volume type of the adjustment. This attribute is required.
- allowAdjustingForecastAboveRecommendedLimit - optional; type booleanWhether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.
Note that this field will not persist on the adjustment itself, and will only affect the current request.
- dailyVolumeSettings - optional; type DailyVolumeSettingsSettings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment.
For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.
- adOpportunityCounts - optional, unbounded; type longThe list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range.
The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7. This attribute is required.
The daily number of ad opportunities for each day in the adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#DAILY_VOLUME} and ignored othewise. - adOpportunityCounts - optional, unbounded; type long
- totalVolumeSettings - optional; type TotalVolumeSettingsThe total number of ad opportunities for the entire adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#TOTAL_VOLUME} and ignored othewise.Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment.
For example, an {@code adOpportunityCount} of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.
- adOpportunityCount - optional; type longThe total ad opportunity count over the entire forecast adjustment date range. This attribute is required.
- adOpportunityCount - optional; type long
- historicalBasisVolumeSettings - optional; type HistoricalBasisVolumeSettingsThe daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME} and ignored othewise.Settings to specify the volume of ad opportunities per day over the {@link ForecastAdjustment} date range based on the traffic volume of a historical reference period.
The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment.
The number of days included in the historical date range does *not* need to be the same as the number of days included in the adjustment date range.
- useParentTrafficForecastSegmentTargeting - optional; type booleanWhether the parent traffic forecast segment targeting's or the {@code targeting}'s historical volume data should be used. This attribute is required.
- targeting - optional; type TargetingThe targeting criteria to use as the source of the historical volume data. This field is required if {@code useParentTrafficForecastSegmentTargeting} is false and ignored otherwise.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- historicalDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range to use for the historical ad opportunity volume. This attribute is required. - startDate - optional; type Date
- multiplierMilliPercent - optional; type longThe multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000. This attribute is required.
- useParentTrafficForecastSegmentTargeting - optional; type boolean
- calculatedDailyAdOpportunityCounts - optional, unbounded; type longThe daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a {@code dateRange} of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.
This field is read-only and is populated by Google after forecast adjustment creation or update. This attribute is read-only.
- id - optional; type long
Output:createForecastAdjustmentsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type createForecastAdjustmentsResponse- rval - optional, unbounded; type ForecastAdjustmentProvides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.
- id - optional; type longThe unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.
- trafficForecastSegmentId - optional; type longThe ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.
- name - optional; type stringName of the ForecastAdjustment. This attribute is required.
- dateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The start and end date range of the adjustment. This attribute is required. - startDate - optional; type Date
- status - optional; type ForecastAdjustmentStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }The status of the adjustment. Changes to this field should be made via {@code performForecastAdjustmentAction} This attribute is read-only.
- volumeType - optional; type ForecastAdjustmentVolumeType - type string with restriction - enum { 'UNKNOWN', 'DAILY_VOLUME', 'TOTAL_VOLUME', 'HISTORICAL_BASIS_VOLUME' }The volume type of the adjustment. This attribute is required.
- allowAdjustingForecastAboveRecommendedLimit - optional; type booleanWhether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.
Note that this field will not persist on the adjustment itself, and will only affect the current request.
- dailyVolumeSettings - optional; type DailyVolumeSettingsSettings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment.
For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.
- adOpportunityCounts - optional, unbounded; type longThe list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range.
The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7. This attribute is required.
The daily number of ad opportunities for each day in the adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#DAILY_VOLUME} and ignored othewise. - adOpportunityCounts - optional, unbounded; type long
- totalVolumeSettings - optional; type TotalVolumeSettingsThe total number of ad opportunities for the entire adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#TOTAL_VOLUME} and ignored othewise.Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment.
For example, an {@code adOpportunityCount} of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.
- adOpportunityCount - optional; type longThe total ad opportunity count over the entire forecast adjustment date range. This attribute is required.
- adOpportunityCount - optional; type long
- historicalBasisVolumeSettings - optional; type HistoricalBasisVolumeSettingsThe daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME} and ignored othewise.Settings to specify the volume of ad opportunities per day over the {@link ForecastAdjustment} date range based on the traffic volume of a historical reference period.
The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment.
The number of days included in the historical date range does *not* need to be the same as the number of days included in the adjustment date range.
- useParentTrafficForecastSegmentTargeting - optional; type booleanWhether the parent traffic forecast segment targeting's or the {@code targeting}'s historical volume data should be used. This attribute is required.
- targeting - optional; type TargetingThe targeting criteria to use as the source of the historical volume data. This field is required if {@code useParentTrafficForecastSegmentTargeting} is false and ignored otherwise.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- historicalDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range to use for the historical ad opportunity volume. This attribute is required. - startDate - optional; type Date
- multiplierMilliPercent - optional; type longThe multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000. This attribute is required.
- useParentTrafficForecastSegmentTargeting - optional; type boolean
- calculatedDailyAdOpportunityCounts - optional, unbounded; type longThe daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a {@code dateRange} of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.
This field is read-only and is populated by Google after forecast adjustment creation or update. This attribute is read-only.
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - forecastAdjustments - optional, unbounded; type ForecastAdjustment
- createTrafficForecastSegmentsDescription:Creates new {@link TrafficForecastSegment} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:createTrafficForecastSegmentsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type createTrafficForecastSegmentsCreates new {@link TrafficForecastSegment} objects.
- trafficForecastSegments - optional, unbounded; type TrafficForecastSegmentAn entity that defines a segment of traffic that will be adjusted or explored.
- id - optional; type longThe unique ID of the TrafficForecastSegment. This field is read-only and set by Google. This attribute is read-only.
- name - optional; type stringName of the TrafficForecastSegment. This field must be unique among all segments for this network. This attribute is required.
- targeting - optional; type TargetingContains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
The targeting that defines a segment of traffic. Targeting cannot be changed after segment creation. This attribute is required. - geoTargeting - optional; type GeoTargeting
- activeForecastAdjustmentCount - optional; type intThe number of active forecast adjustments associated with the TrafficForecastSegment. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time that the TrafficForecastSegment was created. This attribute is read-only. - date - optional; type Date
- id - optional; type long
Output:createTrafficForecastSegmentsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type createTrafficForecastSegmentsResponse- rval - optional, unbounded; type TrafficForecastSegmentAn entity that defines a segment of traffic that will be adjusted or explored.
- id - optional; type longThe unique ID of the TrafficForecastSegment. This field is read-only and set by Google. This attribute is read-only.
- name - optional; type stringName of the TrafficForecastSegment. This field must be unique among all segments for this network. This attribute is required.
- targeting - optional; type TargetingContains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
The targeting that defines a segment of traffic. Targeting cannot be changed after segment creation. This attribute is required. - geoTargeting - optional; type GeoTargeting
- activeForecastAdjustmentCount - optional; type intThe number of active forecast adjustments associated with the TrafficForecastSegment. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time that the TrafficForecastSegment was created. This attribute is read-only. - date - optional; type Date
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - trafficForecastSegments - optional, unbounded; type TrafficForecastSegment
- getForecastAdjustmentsByStatementDescription:Gets a {@link ForecastAdjustmentPage} of {@link ForecastAdjustment} objects that satisfy the given {@link Statement#query}.
The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link ForecastAdjustment#id} {@code trafficForecastSegmentId} {@link ForecastAdjustment#trafficForecastSegmentId} {@code name} {@link ForecastAdjustment#name} {@code startDate} {@link ForecastAdjustment#startDate} {@code endDate} {@link ForecastAdjustment#endDate} {@code status} {@link ForecastAdjustment#status} Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getForecastAdjustmentsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getForecastAdjustmentsByStatementGets a {@link ForecastAdjustmentPage} of {@link ForecastAdjustment} objects that satisfy the given {@link Statement#query}.The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link ForecastAdjustment#id} {@code trafficForecastSegmentId} {@link ForecastAdjustment#trafficForecastSegmentId} {@code name} {@link ForecastAdjustment#name} {@code startDate} {@link ForecastAdjustment#startDate} {@code endDate} {@link ForecastAdjustment#endDate} {@code status} {@link ForecastAdjustment#status} - filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:getForecastAdjustmentsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getForecastAdjustmentsByStatementResponse- rval - optional; type ForecastAdjustmentPageA page of {@link ForecastAdjustmentDto} objects.
- totalResultSetSize - optional; type intThe size of the total result set to which this page belongs.
- startIndex - optional; type intThe absolute index in the total result set on which this page begins.
- results - optional, unbounded; type ForecastAdjustmentProvides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.
- id - optional; type longThe unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.
- trafficForecastSegmentId - optional; type longThe ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.
- name - optional; type stringName of the ForecastAdjustment. This attribute is required.
- dateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The start and end date range of the adjustment. This attribute is required. - startDate - optional; type Date
- status - optional; type ForecastAdjustmentStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }The status of the adjustment. Changes to this field should be made via {@code performForecastAdjustmentAction} This attribute is read-only.
- volumeType - optional; type ForecastAdjustmentVolumeType - type string with restriction - enum { 'UNKNOWN', 'DAILY_VOLUME', 'TOTAL_VOLUME', 'HISTORICAL_BASIS_VOLUME' }The volume type of the adjustment. This attribute is required.
- allowAdjustingForecastAboveRecommendedLimit - optional; type booleanWhether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.
Note that this field will not persist on the adjustment itself, and will only affect the current request.
- dailyVolumeSettings - optional; type DailyVolumeSettingsSettings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment.
For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.
- adOpportunityCounts - optional, unbounded; type longThe list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range.
The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7. This attribute is required.
The daily number of ad opportunities for each day in the adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#DAILY_VOLUME} and ignored othewise. - adOpportunityCounts - optional, unbounded; type long
- totalVolumeSettings - optional; type TotalVolumeSettingsThe total number of ad opportunities for the entire adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#TOTAL_VOLUME} and ignored othewise.Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment.
For example, an {@code adOpportunityCount} of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.
- adOpportunityCount - optional; type longThe total ad opportunity count over the entire forecast adjustment date range. This attribute is required.
- adOpportunityCount - optional; type long
- historicalBasisVolumeSettings - optional; type HistoricalBasisVolumeSettingsThe daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME} and ignored othewise.Settings to specify the volume of ad opportunities per day over the {@link ForecastAdjustment} date range based on the traffic volume of a historical reference period.
The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment.
The number of days included in the historical date range does *not* need to be the same as the number of days included in the adjustment date range.
- useParentTrafficForecastSegmentTargeting - optional; type booleanWhether the parent traffic forecast segment targeting's or the {@code targeting}'s historical volume data should be used. This attribute is required.
- targeting - optional; type TargetingThe targeting criteria to use as the source of the historical volume data. This field is required if {@code useParentTrafficForecastSegmentTargeting} is false and ignored otherwise.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- historicalDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range to use for the historical ad opportunity volume. This attribute is required. - startDate - optional; type Date
- multiplierMilliPercent - optional; type longThe multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000. This attribute is required.
- useParentTrafficForecastSegmentTargeting - optional; type boolean
- calculatedDailyAdOpportunityCounts - optional, unbounded; type longThe daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a {@code dateRange} of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.
This field is read-only and is populated by Google after forecast adjustment creation or update. This attribute is read-only.
The collection of forecast adjustments contained within this page. - id - optional; type long
- totalResultSetSize - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - filterStatement - optional; type Statement
- getTrafficForecastSegmentsByStatementDescription:Gets a {@link TrafficForecastSegmentPage} of {@link TrafficForecastSegment} objects that satisfy the given {@link Statement#query}.
The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link TrafficForecastSegment#id} {@code name} {@link TrafficForecastSegment#name} {@code creationTime} {@link TrafficForecastSegment#creationTime} Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getTrafficForecastSegmentsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getTrafficForecastSegmentsByStatementGets a {@link TrafficForecastSegmentPage} of {@link TrafficForecastSegment} objects that satisfy the given {@link Statement#query}.The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link TrafficForecastSegment#id} {@code name} {@link TrafficForecastSegment#name} {@code creationTime} {@link TrafficForecastSegment#creationTime} - filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:getTrafficForecastSegmentsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getTrafficForecastSegmentsByStatementResponse- rval - optional; type TrafficForecastSegmentPageA page of {@link TrafficForecastSegmentDto} objects.
- totalResultSetSize - optional; type intThe size of the total result set to which this page belongs.
- startIndex - optional; type intThe absolute index in the total result set on which this page begins.
- results - optional, unbounded; type TrafficForecastSegmentAn entity that defines a segment of traffic that will be adjusted or explored.
- id - optional; type longThe unique ID of the TrafficForecastSegment. This field is read-only and set by Google. This attribute is read-only.
- name - optional; type stringName of the TrafficForecastSegment. This field must be unique among all segments for this network. This attribute is required.
- targeting - optional; type TargetingContains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
The targeting that defines a segment of traffic. Targeting cannot be changed after segment creation. This attribute is required. - geoTargeting - optional; type GeoTargeting
- activeForecastAdjustmentCount - optional; type intThe number of active forecast adjustments associated with the TrafficForecastSegment. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time that the TrafficForecastSegment was created. This attribute is read-only. - date - optional; type Date
The collection of traffic forecast segments contained within this page. - id - optional; type long
- totalResultSetSize - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - filterStatement - optional; type Statement
- performForecastAdjustmentActionDescription:Performs actions on {@link ForecastAdjustment} objects that match the given {@link Statement#query}.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:performForecastAdjustmentActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type performForecastAdjustmentActionPerforms actions on {@link ForecastAdjustment} objects that match the given {@link Statement#query}.
- forecastAdjustmentAction - optional; type ForecastAdjustmentActionRepresents the actions that can be performed on {@link com.google.ads.publisher.api.service.adjustment.ForecastAdjustment} objects.
- filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:performForecastAdjustmentActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type performForecastAdjustmentActionResponse- rval - optional; type UpdateResultRepresents the result of performing an action on objects.
- numChanges - optional; type intThe number of objects that were changed as a result of performing the action.
- numChanges - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - forecastAdjustmentAction - optional; type ForecastAdjustmentAction
- updateForecastAdjustmentsDescription:Updates the specified {@link ForecastAdjustment} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:updateForecastAdjustmentsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type updateForecastAdjustmentsUpdates the specified {@link ForecastAdjustment} objects.
- forecastAdjustments - optional, unbounded; type ForecastAdjustmentProvides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.
- id - optional; type longThe unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.
- trafficForecastSegmentId - optional; type longThe ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.
- name - optional; type stringName of the ForecastAdjustment. This attribute is required.
- dateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The start and end date range of the adjustment. This attribute is required. - startDate - optional; type Date
- status - optional; type ForecastAdjustmentStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }The status of the adjustment. Changes to this field should be made via {@code performForecastAdjustmentAction} This attribute is read-only.
- volumeType - optional; type ForecastAdjustmentVolumeType - type string with restriction - enum { 'UNKNOWN', 'DAILY_VOLUME', 'TOTAL_VOLUME', 'HISTORICAL_BASIS_VOLUME' }The volume type of the adjustment. This attribute is required.
- allowAdjustingForecastAboveRecommendedLimit - optional; type booleanWhether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.
Note that this field will not persist on the adjustment itself, and will only affect the current request.
- dailyVolumeSettings - optional; type DailyVolumeSettingsSettings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment.
For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.
- adOpportunityCounts - optional, unbounded; type longThe list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range.
The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7. This attribute is required.
The daily number of ad opportunities for each day in the adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#DAILY_VOLUME} and ignored othewise. - adOpportunityCounts - optional, unbounded; type long
- totalVolumeSettings - optional; type TotalVolumeSettingsThe total number of ad opportunities for the entire adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#TOTAL_VOLUME} and ignored othewise.Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment.
For example, an {@code adOpportunityCount} of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.
- adOpportunityCount - optional; type longThe total ad opportunity count over the entire forecast adjustment date range. This attribute is required.
- adOpportunityCount - optional; type long
- historicalBasisVolumeSettings - optional; type HistoricalBasisVolumeSettingsThe daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME} and ignored othewise.Settings to specify the volume of ad opportunities per day over the {@link ForecastAdjustment} date range based on the traffic volume of a historical reference period.
The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment.
The number of days included in the historical date range does *not* need to be the same as the number of days included in the adjustment date range.
- useParentTrafficForecastSegmentTargeting - optional; type booleanWhether the parent traffic forecast segment targeting's or the {@code targeting}'s historical volume data should be used. This attribute is required.
- targeting - optional; type TargetingThe targeting criteria to use as the source of the historical volume data. This field is required if {@code useParentTrafficForecastSegmentTargeting} is false and ignored otherwise.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- historicalDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range to use for the historical ad opportunity volume. This attribute is required. - startDate - optional; type Date
- multiplierMilliPercent - optional; type longThe multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000. This attribute is required.
- useParentTrafficForecastSegmentTargeting - optional; type boolean
- calculatedDailyAdOpportunityCounts - optional, unbounded; type longThe daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a {@code dateRange} of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.
This field is read-only and is populated by Google after forecast adjustment creation or update. This attribute is read-only.
- id - optional; type long
Output:updateForecastAdjustmentsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type updateForecastAdjustmentsResponse- rval - optional, unbounded; type ForecastAdjustmentProvides information about the expected volume and composition of traffic over a date range for a traffic forecast segment.
- id - optional; type longThe unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.
- trafficForecastSegmentId - optional; type longThe ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.
- name - optional; type stringName of the ForecastAdjustment. This attribute is required.
- dateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The start and end date range of the adjustment. This attribute is required. - startDate - optional; type Date
- status - optional; type ForecastAdjustmentStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }The status of the adjustment. Changes to this field should be made via {@code performForecastAdjustmentAction} This attribute is read-only.
- volumeType - optional; type ForecastAdjustmentVolumeType - type string with restriction - enum { 'UNKNOWN', 'DAILY_VOLUME', 'TOTAL_VOLUME', 'HISTORICAL_BASIS_VOLUME' }The volume type of the adjustment. This attribute is required.
- allowAdjustingForecastAboveRecommendedLimit - optional; type booleanWhether to allow provided volume settings to increase the current forecast by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.
Note that this field will not persist on the adjustment itself, and will only affect the current request.
- dailyVolumeSettings - optional; type DailyVolumeSettingsSettings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment.
For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.
- adOpportunityCounts - optional, unbounded; type longThe list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range.
The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7. This attribute is required.
The daily number of ad opportunities for each day in the adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#DAILY_VOLUME} and ignored othewise. - adOpportunityCounts - optional, unbounded; type long
- totalVolumeSettings - optional; type TotalVolumeSettingsThe total number of ad opportunities for the entire adjustment date range. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#TOTAL_VOLUME} and ignored othewise.Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment.
For example, an {@code adOpportunityCount} of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.
- adOpportunityCount - optional; type longThe total ad opportunity count over the entire forecast adjustment date range. This attribute is required.
- adOpportunityCount - optional; type long
- historicalBasisVolumeSettings - optional; type HistoricalBasisVolumeSettingsThe daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if {@code volumeType} is {@code ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME} and ignored othewise.Settings to specify the volume of ad opportunities per day over the {@link ForecastAdjustment} date range based on the traffic volume of a historical reference period.
The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment.
The number of days included in the historical date range does *not* need to be the same as the number of days included in the adjustment date range.
- useParentTrafficForecastSegmentTargeting - optional; type booleanWhether the parent traffic forecast segment targeting's or the {@code targeting}'s historical volume data should be used. This attribute is required.
- targeting - optional; type TargetingThe targeting criteria to use as the source of the historical volume data. This field is required if {@code useParentTrafficForecastSegmentTargeting} is false and ignored otherwise.Contains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
- geoTargeting - optional; type GeoTargeting
- historicalDateRange - optional; type DateRangeRepresents a range of dates that has an upper and a lower bound.
An open ended date range can be described by only setting either one of the bounds, the upper bound or the lower bound.
- startDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The start date of this range. This field is optional and if it is not set then there is no lower bound on the date range. If this field is not set then {@code endDate} must be specified. - year - optional; type int
- endDate - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
The end date of this range. This field is optional and if it is not set then there is no upper bound on the date range. If this field is not set then {@code startDate} must be specified. - year - optional; type int
The date range to use for the historical ad opportunity volume. This attribute is required. - startDate - optional; type Date
- multiplierMilliPercent - optional; type longThe multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000. This attribute is required.
- useParentTrafficForecastSegmentTargeting - optional; type boolean
- calculatedDailyAdOpportunityCounts - optional, unbounded; type longThe daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range. For example: for a {@code dateRange} of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.
This field is read-only and is populated by Google after forecast adjustment creation or update. This attribute is read-only.
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - forecastAdjustments - optional, unbounded; type ForecastAdjustment
- updateTrafficForecastSegmentsDescription:Updates the specified {@link TrafficForecastSegment} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:updateTrafficForecastSegmentsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type updateTrafficForecastSegmentsUpdates the specified {@link TrafficForecastSegment} objects.
- trafficForecastSegments - optional, unbounded; type TrafficForecastSegmentAn entity that defines a segment of traffic that will be adjusted or explored.
- id - optional; type longThe unique ID of the TrafficForecastSegment. This field is read-only and set by Google. This attribute is read-only.
- name - optional; type stringName of the TrafficForecastSegment. This field must be unique among all segments for this network. This attribute is required.
- targeting - optional; type TargetingContains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
The targeting that defines a segment of traffic. Targeting cannot be changed after segment creation. This attribute is required. - geoTargeting - optional; type GeoTargeting
- activeForecastAdjustmentCount - optional; type intThe number of active forecast adjustments associated with the TrafficForecastSegment. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time that the TrafficForecastSegment was created. This attribute is read-only. - date - optional; type Date
- id - optional; type long
Output:updateTrafficForecastSegmentsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type updateTrafficForecastSegmentsResponse- rval - optional, unbounded; type TrafficForecastSegmentAn entity that defines a segment of traffic that will be adjusted or explored.
- id - optional; type longThe unique ID of the TrafficForecastSegment. This field is read-only and set by Google. This attribute is read-only.
- name - optional; type stringName of the TrafficForecastSegment. This field must be unique among all segments for this network. This attribute is required.
- targeting - optional; type TargetingContains targeting criteria for {@link LineItem} objects. See {@link LineItem#targeting}.
- geoTargeting - optional; type GeoTargetingProvides line items the ability to target geographical locations. By default, line items target all countries and their subdivisions. With geographical targeting, you can target line items to specific countries, regions, metro areas, and cities. You can also exclude the same.
The following rules apply for geographical targeting:
- You cannot target and exclude the same location.
- You cannot target a child whose parent has been excluded. For example, if the state of Illinois has been excluded, then you cannot target Chicago.
- You must not target a location if you are also targeting its parent. For example, if you are targeting New York City, you must not have the state of New York as one of the targeted locations.
- You cannot explicitly define inclusions or exclusions that are already implicit. For example, if you explicitly include California, you implicitly exclude all other states. You therefore cannot explicitly exclude Florida, because it is already implicitly excluded. Conversely if you explicitly exclude Florida, you cannot explicitly include California.
- targetedLocations - optional, unbounded; type LocationThe geographical locations being targeted by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
- excludedLocations - optional, unbounded; type LocationThe geographical locations being excluded by the {@link LineItem}.A {@link Location} represents a geographical entity that can be targeted. If a location type is not available because of the API version you are using, the location will be represented as just the base class, otherwise it will be sub-classed correctly.
- id - optional; type longUniquely identifies each {@code Location}.
- type - optional; type stringThe location type for this geographical entity (ex. "COUNTRY", "CITY", "STATE", "COUNTY", etc.)
- canonicalParentId - optional; type intThe nearest location parent's ID for this geographical entity.
- displayName - optional; type stringThe localized name of the geographical entity.
- id - optional; type long
Specifies what geographical locations are targeted by the {@link LineItem}. This attribute is optional. - inventoryTargeting - optional; type InventoryTargetingA collection of targeted and excluded ad units and placements.
- targetedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of targeted {@link AdUnitTargeting}. - adUnitId - optional; type string
- excludedAdUnits - optional, unbounded; type AdUnitTargetingRepresents targeted or excluded ad units.
- adUnitId - optional; type stringIncluded or excluded ad unit id.
- includeDescendants - optional; type booleanWhether or not all descendants are included (or excluded) as part of including (or excluding) this ad unit. By default, the value is {@code true} which means targeting this ad unit will target all of its descendants.
A list of excluded {@link AdUnitTargeting}. - adUnitId - optional; type string
- targetedPlacementIds - optional, unbounded; type longA list of targeted {@link Placement} ids.
Specifies what inventory is targeted by the {@link LineItem}. This attribute is required. The line item must target at least one ad unit or placement. - targetedAdUnits - optional, unbounded; type AdUnitTargeting
- dayPartTargeting - optional; type DayPartTargetingModify the delivery times of line items for particular days of the week. By default, line items are served at all days and times.
- dayParts - optional, unbounded; type DayPart{@code DayPart} represents a time-period within a day of the week which is targeted by a {@link LineItem}.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }Day of the week the target applies to. This field is required.
- startTime - optional; type TimeOfDayRepresents the start time of the targeted period (inclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
- endTime - optional; type TimeOfDayRepresents the end time of the targeted period (exclusive).Represents a specific time in a day.
- hour - optional; type intHour in 24 hour time (0..24). This field must be between 0 and 24, inclusive. This field is required.
- minute - optional; type MinuteOfHour - type string with restriction - enum { 'ZERO', 'FIFTEEN', 'THIRTY', 'FORTY_FIVE' }Minutes in an hour. Currently, only 0, 15, 30, and 45 are supported. This field is required.
- hour - optional; type int
Specifies days of the week and times at which a {@code LineItem} will be delivered.If targeting all days and times, this value will be ignored.
- dayOfWeek - optional; type DayOfWeek - type string with restriction - enum { 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY' }
- timeZone - optional; type DeliveryTimeZone - type string with restriction - enum { 'PUBLISHER', 'BROWSER' }Specifies the time zone to be used for delivering {@link LineItem} objects. This attribute is optional and defaults to {@link DeliveryTimeZone#BROWSER}.
Setting this has no effect if targeting all days and times.
Specifies the days of the week and times that are targeted by the {@link LineItem}. This attribute is optional. - dayParts - optional, unbounded; type DayPart
- dateTimeRangeTargeting - optional; type DateTimeRangeTargetingThe date time ranges that the line item is eligible to serve.
- targetedDateTimeRanges - optional, unbounded; type DateTimeRangeRepresents a range of dates (combined with time of day) that has an upper and/or lower bound.
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date time of this range. This field is optional and if it is not set then there is no lower bound on the date time range. If this field is not set then {@code endDateTime} must be specified. - date - optional; type Date
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The end date time of this range. This field is optional and if it is not set then there is no upper bound on the date time range. If this field is not set then {@code startDateTime} must be specified. - date - optional; type Date
- startDateTime - optional; type DateTime
Specifies the dates and time ranges that are targeted by the {@link LineItem}. This attribute is optional. - targetedDateTimeRanges - optional, unbounded; type DateTimeRange
- technologyTargeting - optional; type TechnologyTargetingProvides {@link LineItem} objects the ability to target or exclude technologies.
- bandwidthGroupTargeting - optional; type BandwidthGroupTargetingThe bandwidth groups being targeted by the {@link LineItem}.Represents bandwidth groups that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- bandwidthGroups - optional, unbounded; type TechnologyThe bandwidth groups that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserTargeting - optional; type BrowserTargetingThe browsers being targeted by the {@link LineItem}.Represents browsers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browsers - optional, unbounded; type TechnologyBrowsers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- browserLanguageTargeting - optional; type BrowserLanguageTargetingThe languages of browsers being targeted by the {@link LineItem}.Represents browser languages that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- browserLanguages - optional, unbounded; type TechnologyBrowser languages that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- deviceCapabilityTargeting - optional; type DeviceCapabilityTargetingThe device capabilities being targeted by the {@link LineItem}.Represents device capabilities that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCapabilities - optional, unbounded; type TechnologyDevice capabilities that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCapabilities - optional, unbounded; type Technology
- deviceCategoryTargeting - optional; type DeviceCategoryTargetingThe device categories being targeted by the {@link LineItem}.Represents device categories that are being targeted or excluded by the {@link LineItem}.
- targetedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedDeviceCategories - optional, unbounded; type TechnologyDevice categories that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedDeviceCategories - optional, unbounded; type Technology
- deviceManufacturerTargeting - optional; type DeviceManufacturerTargetingThe device manufacturers being targeted by the {@link LineItem}.Represents device manufacturer that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- deviceManufacturers - optional, unbounded; type TechnologyDevice manufacturers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileCarrierTargeting - optional; type MobileCarrierTargetingThe mobile carriers being targeted by the {@link LineItem}.Represents mobile carriers that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- mobileCarriers - optional, unbounded; type TechnologyMobile carriers that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- mobileDeviceTargeting - optional; type MobileDeviceTargetingThe mobile devices being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDevices - optional, unbounded; type TechnologyMobile devices that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDevices - optional, unbounded; type Technology
- mobileDeviceSubmodelTargeting - optional; type MobileDeviceSubmodelTargetingThe mobile device submodels being targeted by the {@link LineItem}.Represents mobile devices that are being targeted or excluded by the {@link LineItem}.
- targetedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedMobileDeviceSubmodels - optional, unbounded; type TechnologyMobile device submodels that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedMobileDeviceSubmodels - optional, unbounded; type Technology
- operatingSystemTargeting - optional; type OperatingSystemTargetingThe operating systems being targeted by the {@link LineItem}.Represents operating systems that are being targeted or excluded by the {@link LineItem}.
- isTargeted - optional; type booleanIndicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- operatingSystems - optional, unbounded; type TechnologyOperating systems that are being targeted or excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- isTargeted - optional; type boolean
- operatingSystemVersionTargeting - optional; type OperatingSystemVersionTargetingThe operating system versions being targeted by the {@link LineItem}.Represents operating system versions that are being targeted or excluded by the {@link LineItem}.
- targetedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being targeted by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- excludedOperatingSystemVersions - optional, unbounded; type TechnologyOperating system versions that are being excluded by the {@link LineItem}.Represents a technology entity that can be targeted.
- id - optional; type longThe unique ID of the {@code Technology}. This value is required for all forms of {@code TechnologyTargeting}.
- name - optional; type stringThe name of the technology being targeting. This value is read-only and is assigned by Google.
- id - optional; type long
- targetedOperatingSystemVersions - optional, unbounded; type Technology
Specifies the browsing technologies that are targeted by the {@link LineItem}. This attribute is optional. - bandwidthGroupTargeting - optional; type BandwidthGroupTargeting
- customTargeting - optional; type CustomCriteriaSet - extension of abstract type CustomCriteriaNodeA {@link CustomCriteriaSet} comprises of a set of {@link CustomCriteriaNode} objects combined by the {@link CustomCriteriaSet.LogicalOperator#logicalOperator}. The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }The logical operator to be applied to {@link CustomCriteriaSet#children}. This attribute is required. This attribute is required.
- children - optional, unbounded; type CustomCriteriaNodeThe custom criteria. This attribute is required.A {@link CustomCriteriaNode} is a node in the custom targeting tree. A custom criteria node can either be a {@link CustomCriteriaSet} (a non-leaf node) or a {@link CustomCriteria} (a leaf node). The custom criteria targeting tree is subject to the rules defined on {@link Targeting#customTargeting}.
Specifies the collection of custom criteria that is targeted by the {@link LineItem}.Once the {@link LineItem} is updated or modified with custom targeting, the server may return a normalized, but equivalent representation of the custom targeting expression.
{@code customTargeting} will have up to three levels of expressions including itself.
The top level {@code CustomCriteriaSet} i.e. the {@code customTargeting} object can only contain a {@link CustomCriteriaSet.LogicalOperator#OR} of all its children.
The second level of {@code CustomCriteriaSet} objects can only contain {@link CustomCriteriaSet.LogicalOperator#AND} of all their children. If a {@link CustomCriteria} is placed on this level, the server will wrap it in a {@link CustomCriteriaSet}.
The third level can only comprise of {@link CustomCriteria} objects.
The resulting custom targeting tree would be of the form:
- logicalOperator - optional; type CustomCriteriaSet.LogicalOperator - type string with restriction - enum { 'AND', 'OR' }
- userDomainTargeting - optional; type UserDomainTargetingSpecifies the domains or subdomains that are targeted or excluded by the {@link LineItem}. Users visiting from an IP address associated with those domains will be targeted or excluded. This attribute is optional.Provides line items the ability to target or exclude users visiting their websites from a list of domains or subdomains.
- domains - optional, unbounded; type stringThe domains or subdomains that are being targeted or excluded by the {@link LineItem}. This attribute is required and the maximum length of each domain is 67 characters.
- targeted - optional; type booleanIndicates whether domains should be targeted or excluded. This attribute is optional and defaults to {@code true}.
- domains - optional, unbounded; type string
- contentTargeting - optional; type ContentTargetingUsed to target {@link LineItem}s to specific videos on a publisher's site.
- targetedContentIds - optional, unbounded; type longThe IDs of content being targeted by the {@code LineItem}.
- excludedContentIds - optional, unbounded; type longThe IDs of content being excluded by the {@code LineItem}.
- targetedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being targeted by the {@code LineItem}.
- excludedVideoContentBundleIds - optional, unbounded; type longA list of video content bundles, represented by {@link ContentBundle} IDs, that are being excluded by the {@code LineItem}.
Specifies the video categories and individual videos targeted by the {@link LineItem}. - targetedContentIds - optional, unbounded; type long
- videoPositionTargeting - optional; type VideoPositionTargetingSpecifies targeting against video position types.Represents positions within and around a video where ads can be targeted to.
Example positions could be {@code pre-roll} (before the video plays), {@code post-roll} (after a video has completed playback) and {@code mid-roll} (during video playback).
Empty video position targeting means that all video positions are allowed. If a bumper line item has empty video position targeting it will be updated to target all bumper positions.
- targetedPositions - optional, unbounded; type VideoPositionTargetThe {@link VideoTargetingPosition} objects being targeted by the video {@link LineItem}.Represents the options for targetable positions within a video.
- videoPosition - optional; type VideoPositionRepresents a targetable position within a video. A video ad can be targeted to a position (pre-roll, all mid-rolls, or post-roll), or to a specific mid-roll index.
- positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }The type of video position (pre-roll, mid-roll, or post-roll).
- midrollIndex - optional; type intThe index of the mid-roll to target. Only valid if the {@link positionType} is {@link VideoPositionType#MIDROLL}, otherwise this field will be ignored.
The video position to target. This attribute is required. - positionType - optional; type VideoPosition.Type - type string with restriction - enum { 'UNKNOWN', 'ALL', 'PREROLL', 'MIDROLL', 'POSTROLL' }
- videoBumperType - optional; type VideoBumperType - type string with restriction - enum { 'BEFORE', 'AFTER' }The video bumper type to target. To target a video position or a pod position, this value must be null. To target a bumper position this value must be populated and the line item must have a bumper type. To target a custom ad spot, this value must be null.
- videoPositionWithinPod - optional; type VideoPositionWithinPodRepresents a targetable position within a pod within a video stream. A video ad can be targeted to any position in the pod (first, second, third ... last). If there is only 1 ad in a pod, either first or last will target that position.
- index - optional; type intThe specific index of the pod. The index is defined as:
- 1 = first
- 2 = second
- 3 = third
- ....
- 100 = last
Positions over 100 are not supported.
The video position within a pod to target. To target a video position or a bumper position, this value must be null. To target a position within a pod this value must be populated. To target a custom ad spot, this value must be null. - index - optional; type int
- adSpotId - optional; type longA custom spot {@link AdSpot} to target. To target a video position, a bumper type or a video position within a pod this value must be null.
- videoPosition - optional; type VideoPosition
- targetedPositions - optional, unbounded; type VideoPositionTarget
- mobileApplicationTargeting - optional; type MobileApplicationTargetingProvides the ability to target or exclude users' mobile applications.
- mobileApplicationIds - optional, unbounded; type longThe {@link MobileApplication#id IDs} that are being targeted or excluded.
- isTargeted - optional; type booleanIndicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to {@code true}.
Specifies targeting against mobile applications. - mobileApplicationIds - optional, unbounded; type long
- buyerUserListTargeting - optional; type BuyerUserListTargetingThe {@code BuyerUserListTargeting} associated with a programmatic {@link LineItem} or {@link ProposalLineItem} object.
- hasBuyerUserListTargeting - optional; type booleanWhether the programmatic {@code LineItem} or {@code ProposalLineItem} object has buyer user list targeting.
Specifies whether buyer user lists are targeted on a programmatic {@link LineItem} or {@link ProposalLineItem}. This attribute is readonly and is populated by Google. - hasBuyerUserListTargeting - optional; type boolean
- inventoryUrlTargeting - optional; type InventoryUrlTargetingA collection of targeted inventory urls.
- targetedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
- excludedUrls - optional, unbounded; type InventoryUrlThe representation of an inventory Url that is used in targeting.
- id - optional; type long
Specifies the URLs that are targeted by the entity. This is currently only supported by {@link YieldGroup}. - targetedUrls - optional, unbounded; type InventoryUrl
- verticalTargeting - optional; type VerticalTargetingSpecifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.Vertical targeting information.
- targetedVerticalIds - optional, unbounded; type long
- excludedVerticalIds - optional, unbounded; type long
- contentLabelTargeting - optional; type ContentLabelTargetingContent label targeting information.
- excludedContentLabelIds - optional, unbounded; type long
Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table. - requestPlatformTargeting - optional; type RequestPlatformTargetingProvides line items the ability to target the platform that requests and renders the ad.
The following rules apply for {@link RequestPlatformTargeting}
- {@link RequestPlatformTargeting} must be specified for {@link ProposalLineItem}s.
- {@link RequestPlatformTargeting} must be specified for video line items. Empty values for {@link RequestPlatformTargeting#targetedRequestPlatforms} mean that all request platforms will be targeted.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for non-video line items.
- {@link RequestPlatformTargeting} is read-only and assigned by Google for line items generated from proposal line items.
- targetedRequestPlatforms - optional, unbounded; type RequestPlatform - type string with restriction - enum { 'UNKNOWN', 'BROWSER', 'MOBILE_APP', 'VIDEO_PLAYER' }
Specifies the request platforms that are targeted by the {@link LineItem}. This attribute is required for video line items and for {@link ProposalLineItem}.This value is modifiable for video line items, but read-only for non-video line items.
This value is read-only for video line items generated from proposal line items.
- inventorySizeTargeting - optional; type InventorySizeTargetingRepresents a collection of targeted and excluded inventory sizes. This is currently only available on {@link YieldGroup} and {@link TrafficDataRequest}.
- isTargeted - optional; type booleanWhether the inventory sizes should be targeted or excluded.
- targetedSizes - optional, unbounded; type TargetedSizeA list of {@link TargetedSizeDto}s.A size that is targeted on a request.
- size - optional; type SizeRepresents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.
For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.
- width - optional; type intThe width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- height - optional; type intThe height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
- isAspectRatio - optional; type booleanWhether this size represents an aspect ratio.
- width - optional; type int
- size - optional; type Size
Specifies the sizes that are targeted by the entity. This is currently only supported on {@link YieldGroup} and {@link TrafficDataRequest}. - isTargeted - optional; type boolean
The targeting that defines a segment of traffic. Targeting cannot be changed after segment creation. This attribute is required. - geoTargeting - optional; type GeoTargeting
- activeForecastAdjustmentCount - optional; type intThe number of active forecast adjustments associated with the TrafficForecastSegment. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time that the TrafficForecastSegment was created. This attribute is read-only. - date - optional; type Date
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - trafficForecastSegments - optional, unbounded; type TrafficForecastSegment
Port type AdjustmentServiceInterfaceSource code
WSDL source code
About wsdl-viewer.xsl
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.
The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT