Web Service: ProposalService
Port ProposalServiceInterfacePort Port typeSource code
- createProposalsDetailSource code
- getMarketplaceCommentsByStatementDetailSource code
- getProposalsByStatementDetailSource code
- performProposalActionDetailSource code
- updateProposalsDetailSource code
Operations
- createProposalsDescription:Creates new {@link Proposal} objects.
For each proposal, the following fields are required:
- {@link Proposal#name}
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:createProposalsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type createProposalsCreates new {@link Proposal} objects.For each proposal, the following fields are required:
- {@link Proposal#name}
- proposals - optional, unbounded; type ProposalA {@code Proposal} represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- id - optional; type longThe unique ID of the {@code Proposal}. This attribute is read-only.
- isProgrammatic - optional; type booleanFlag that specifies whether this {@code Proposal} is for programmatic deals. This value is default to {@code false}.
- dfpOrderId - optional; type longThe unique ID of corresponding {@link Order}. This will be {@code null} if the {@code Proposal} has not been pushed to Ad Manager. This attribute is read-only.
- name - optional; type stringThe name of the {@code Proposal}. This value has a maximum length of 255 characters. This value is copied to {@link Order#name} when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
- 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 date and time at which the order and line items associated with the {@code Proposal} are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest {@link ProposalLineItem#startDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only. - 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 date and time at which the order and line items associated with the {@code Proposal} stop being served. This attribute is derived from the proposal line item of the proposal which has the latest {@link ProposalLineItem#endDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only. - date - optional; type Date
- status - optional; type ProposalStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'REJECTED', 'UNKNOWN' }The status of the {@code Proposal}. This attribute is read-only.
- isArchived - optional; type booleanThe archival status of the {@code Proposal}. This attribute is read-only.
- advertiser - optional; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
The advertiser, to which this {@code Proposal} belongs, and a set of {@link Contact} objects associated with the advertiser. The {@link ProposalCompanyAssociation#type} of this attribute should be {@link ProposalCompanyAssociationType#ADVERTISER}. This attribute is required when the proposal turns into an order, and its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#advertiserId}. This attribute becomes readonly once the {@code Proposal} has been pushed. - companyId - optional; type long
- agencies - optional, unbounded; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
List of agencies and the set of {@link Contact} objects associated with each agency. This attribute is optional. A {@code Proposal} only has at most one {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY} type, but a {@link Company} can appear more than once with different {@link ProposalCompanyAssociationType} values. If primary agency exists, its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#agencyId} when the proposal turns into an order. - companyId - optional; type long
- internalNotes - optional; type stringProvides any additional notes that may annotate the {@code Proposal}. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primarySalesperson - optional; type SalespersonSplitThe primary salesperson who brokered the transaction with the {@link #advertiser}. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.A {@code SalespersonSplit} represents a salesperson.
- userId - optional; type longThe unique ID of the {@link User} responsible for the sales of the {@link Proposal}. This attribute is required.
- userId - optional; type long
- salesPlannerIds - optional, unbounded; type longList of unique IDs of {@link User} objects who are the sales planners of the {@code Proposal}. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primaryTraffickerId - optional; type longThe unique ID of the {@link User} who is primary trafficker and is responsible for trafficking the {@code Proposal}. This attribute is required when the proposal turns into an order, and will be copied to {@link Order#primaryTraffickerId} . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- sellerContactIds - optional, unbounded; type long{@link User users} who are the seller's contacts.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that the {@code Proposal} is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with the {@code Proposal}. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. - customFieldId - optional; type long
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to the {@code Proposal}. This attribute is optional. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. - labelId - optional; type long
- currencyCode - optional; type stringThe currency code of this {@code Proposal}. This attribute is optional and defaults to network's currency code.
- isSold - optional; type booleanIndicates whether the proposal has been sold, i.e., corresponds to whether the status of an {@link Order} is {@link OrderStatus#APPROVED} or {@link OrderStatus#PAUSED}. This attribute is read-only.
- lastModifiedDateTime - 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 this {@code Proposal} was last modified. This attribute is read-only. - date - optional; type Date
- marketplaceInfo - optional; type ProposalMarketplaceInfoMarketplace info for a proposal with a corresponding order in Marketplace.
- marketplaceId - optional; type stringThe marketplace ID of this proposal. This is a shared ID between Ad Manager and the buy-side platform. This value is null if the proposal has not been sent to the buyer. This attribute is read-only.
- hasLocalVersionEdits - optional; type booleanWhether the non-free-editable fields of a {@link Proposal} are opened for edit. A proposal that is open for edit will not receive buyer updates from Marketplace. If the buyer updates the proposal while this is open for local editing, Google will set {@link #isNewVersionFromBuyer} to {@code true}. You will then need to call {@link DiscardProposalDrafts} to revert your edits to get the buyer's latest changes. This attribute is read-only.
- negotiationStatus - optional; type NegotiationStatus - type string with restriction - enum { 'SELLER_INITIATED', 'BUYER_INITIATED', 'AWAITING_SELLER_REVIEW', 'AWAITING_BUYER_REVIEW', 'ONLY_SELLER_ACCEPTED', 'FINALIZED', 'CANCELLED', 'UNKNOWN' }The negotiation status of the {@link Proposal}. This attribute is read-only.
- marketplaceComment - optional; type stringThe comment on the {@link Proposal} to be sent to the buyer.
- isNewVersionFromBuyer - optional; type booleanIndicates that the buyer has made updates to the proposal on Marketplace. This attribute is only meaningful if the proposal is open for edit (i.e., {@link #hasLocalVersionEdits} is {@code true}) This attribute is read-only.
- buyerAccountId - optional; type longThe Authorized Buyers ID of the buyer that this {@code Proposal} is being negotiated with. This attribute is required.
- partnerClientId - optional; type stringThe ID used to represent Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID. This field is readonly and assigned by Google. This attribute is read-only.
The marketplace info of this proposal if it has a corresponding order in Marketplace. - marketplaceId - optional; type string
- buyerRfp - optional; type BuyerRfpRepresents the buyer RFP information associated with a {@link Proposal} describing the requirements from the buyer.
- costPerUnit - optional; type MoneyCPM for the {@link Proposal} in question. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field should serve as guidance for publishers to create a {@link Proposal} with {@link LineItem}s reflecting this CPM. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- units - optional; type longThe number of impressions per day that a buyer wishes to see in the {@link Proposal} derived from the request for proposal in question. This attribute is read-only.
- budget - optional; type MoneyTotal amount of {@link Money} available to spend on this deal. In the case of Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given {@link Proposal}, even though the budget might not be spent entirely, as impressions are not guaranteed. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- currencyCode - optional; type stringCurrency code for this deal's budget and CPM. This attribute is read-only.
- startDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should start serving. This attribute is read-only.Represents 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
- date - optional; type Date
- endDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should end serving. This attribute is read-only.Represents 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
- date - optional; type Date
- description - optional; type stringA description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question. This attribute is read-only.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA list of inventory sizes in which creatives will be eventually served. This attribute is read-only.A {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
- size - optional; type Size
- targeting - optional; type TargetingTargeting information for the proposal in question. Currently this field only contains {@link GeoTargeting} information. This attribute is read-only.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
- additionalTerms - optional; type stringAdditional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the {@link Proposal} derived from this request for proposal. This attribute is read-only.
- adExchangeEnvironment - optional; type AdExchangeEnvironment - type string with restriction - enum { 'DISPLAY', 'VIDEO', 'GAMES', 'MOBILE', 'MOBILE_OUTSTREAM_VIDEO', 'DISPLAY_OUTSTREAM_VIDEO', 'UNKNOWN' }Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include {@link AdExchangeEnvironment#DISPLAY}, {@link AdExchangeEnvironment#VIDEO}, and {@link AdExchangeEnvironment#MOBILE}. This attribute is read-only.
- rfpType - optional; type RfpType - type string with restriction - enum { 'UNKNOWN', 'PROGRAMMATIC_GUARANTEED', 'PREFERRED_DEAL' }Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of {@link Proposal} that a buyer wishes to negotiate with a seller. This attribute is read-only.
The buyer RFP associated with this {@code Proposal}, which is optional. This field will be null if the proposal is not initiated from RFP. - costPerUnit - optional; type Money
- hasBuyerRfp - optional; type booleanWhether a {@link Proposal} contains a {@link BuyerRfp} field. If this field is true, it indicates that the {@link Proposal} in question orignated from a buyer.
- deliveryPausingEnabled - optional; type booleanWhether pausing is consented for the {@code Proposal}. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.
- id - optional; type long
Output:createProposalsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type createProposalsResponse- rval - optional, unbounded; type ProposalA {@code Proposal} represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- id - optional; type longThe unique ID of the {@code Proposal}. This attribute is read-only.
- isProgrammatic - optional; type booleanFlag that specifies whether this {@code Proposal} is for programmatic deals. This value is default to {@code false}.
- dfpOrderId - optional; type longThe unique ID of corresponding {@link Order}. This will be {@code null} if the {@code Proposal} has not been pushed to Ad Manager. This attribute is read-only.
- name - optional; type stringThe name of the {@code Proposal}. This value has a maximum length of 255 characters. This value is copied to {@link Order#name} when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
- 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 date and time at which the order and line items associated with the {@code Proposal} are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest {@link ProposalLineItem#startDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only. - 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 date and time at which the order and line items associated with the {@code Proposal} stop being served. This attribute is derived from the proposal line item of the proposal which has the latest {@link ProposalLineItem#endDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only. - date - optional; type Date
- status - optional; type ProposalStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'REJECTED', 'UNKNOWN' }The status of the {@code Proposal}. This attribute is read-only.
- isArchived - optional; type booleanThe archival status of the {@code Proposal}. This attribute is read-only.
- advertiser - optional; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
The advertiser, to which this {@code Proposal} belongs, and a set of {@link Contact} objects associated with the advertiser. The {@link ProposalCompanyAssociation#type} of this attribute should be {@link ProposalCompanyAssociationType#ADVERTISER}. This attribute is required when the proposal turns into an order, and its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#advertiserId}. This attribute becomes readonly once the {@code Proposal} has been pushed. - companyId - optional; type long
- agencies - optional, unbounded; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
List of agencies and the set of {@link Contact} objects associated with each agency. This attribute is optional. A {@code Proposal} only has at most one {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY} type, but a {@link Company} can appear more than once with different {@link ProposalCompanyAssociationType} values. If primary agency exists, its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#agencyId} when the proposal turns into an order. - companyId - optional; type long
- internalNotes - optional; type stringProvides any additional notes that may annotate the {@code Proposal}. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primarySalesperson - optional; type SalespersonSplitThe primary salesperson who brokered the transaction with the {@link #advertiser}. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.A {@code SalespersonSplit} represents a salesperson.
- userId - optional; type longThe unique ID of the {@link User} responsible for the sales of the {@link Proposal}. This attribute is required.
- userId - optional; type long
- salesPlannerIds - optional, unbounded; type longList of unique IDs of {@link User} objects who are the sales planners of the {@code Proposal}. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primaryTraffickerId - optional; type longThe unique ID of the {@link User} who is primary trafficker and is responsible for trafficking the {@code Proposal}. This attribute is required when the proposal turns into an order, and will be copied to {@link Order#primaryTraffickerId} . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- sellerContactIds - optional, unbounded; type long{@link User users} who are the seller's contacts.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that the {@code Proposal} is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with the {@code Proposal}. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. - customFieldId - optional; type long
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to the {@code Proposal}. This attribute is optional. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. - labelId - optional; type long
- currencyCode - optional; type stringThe currency code of this {@code Proposal}. This attribute is optional and defaults to network's currency code.
- isSold - optional; type booleanIndicates whether the proposal has been sold, i.e., corresponds to whether the status of an {@link Order} is {@link OrderStatus#APPROVED} or {@link OrderStatus#PAUSED}. This attribute is read-only.
- lastModifiedDateTime - 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 this {@code Proposal} was last modified. This attribute is read-only. - date - optional; type Date
- marketplaceInfo - optional; type ProposalMarketplaceInfoMarketplace info for a proposal with a corresponding order in Marketplace.
- marketplaceId - optional; type stringThe marketplace ID of this proposal. This is a shared ID between Ad Manager and the buy-side platform. This value is null if the proposal has not been sent to the buyer. This attribute is read-only.
- hasLocalVersionEdits - optional; type booleanWhether the non-free-editable fields of a {@link Proposal} are opened for edit. A proposal that is open for edit will not receive buyer updates from Marketplace. If the buyer updates the proposal while this is open for local editing, Google will set {@link #isNewVersionFromBuyer} to {@code true}. You will then need to call {@link DiscardProposalDrafts} to revert your edits to get the buyer's latest changes. This attribute is read-only.
- negotiationStatus - optional; type NegotiationStatus - type string with restriction - enum { 'SELLER_INITIATED', 'BUYER_INITIATED', 'AWAITING_SELLER_REVIEW', 'AWAITING_BUYER_REVIEW', 'ONLY_SELLER_ACCEPTED', 'FINALIZED', 'CANCELLED', 'UNKNOWN' }The negotiation status of the {@link Proposal}. This attribute is read-only.
- marketplaceComment - optional; type stringThe comment on the {@link Proposal} to be sent to the buyer.
- isNewVersionFromBuyer - optional; type booleanIndicates that the buyer has made updates to the proposal on Marketplace. This attribute is only meaningful if the proposal is open for edit (i.e., {@link #hasLocalVersionEdits} is {@code true}) This attribute is read-only.
- buyerAccountId - optional; type longThe Authorized Buyers ID of the buyer that this {@code Proposal} is being negotiated with. This attribute is required.
- partnerClientId - optional; type stringThe ID used to represent Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID. This field is readonly and assigned by Google. This attribute is read-only.
The marketplace info of this proposal if it has a corresponding order in Marketplace. - marketplaceId - optional; type string
- buyerRfp - optional; type BuyerRfpRepresents the buyer RFP information associated with a {@link Proposal} describing the requirements from the buyer.
- costPerUnit - optional; type MoneyCPM for the {@link Proposal} in question. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field should serve as guidance for publishers to create a {@link Proposal} with {@link LineItem}s reflecting this CPM. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- units - optional; type longThe number of impressions per day that a buyer wishes to see in the {@link Proposal} derived from the request for proposal in question. This attribute is read-only.
- budget - optional; type MoneyTotal amount of {@link Money} available to spend on this deal. In the case of Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given {@link Proposal}, even though the budget might not be spent entirely, as impressions are not guaranteed. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- currencyCode - optional; type stringCurrency code for this deal's budget and CPM. This attribute is read-only.
- startDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should start serving. This attribute is read-only.Represents 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
- date - optional; type Date
- endDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should end serving. This attribute is read-only.Represents 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
- date - optional; type Date
- description - optional; type stringA description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question. This attribute is read-only.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA list of inventory sizes in which creatives will be eventually served. This attribute is read-only.A {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
- size - optional; type Size
- targeting - optional; type TargetingTargeting information for the proposal in question. Currently this field only contains {@link GeoTargeting} information. This attribute is read-only.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
- additionalTerms - optional; type stringAdditional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the {@link Proposal} derived from this request for proposal. This attribute is read-only.
- adExchangeEnvironment - optional; type AdExchangeEnvironment - type string with restriction - enum { 'DISPLAY', 'VIDEO', 'GAMES', 'MOBILE', 'MOBILE_OUTSTREAM_VIDEO', 'DISPLAY_OUTSTREAM_VIDEO', 'UNKNOWN' }Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include {@link AdExchangeEnvironment#DISPLAY}, {@link AdExchangeEnvironment#VIDEO}, and {@link AdExchangeEnvironment#MOBILE}. This attribute is read-only.
- rfpType - optional; type RfpType - type string with restriction - enum { 'UNKNOWN', 'PROGRAMMATIC_GUARANTEED', 'PREFERRED_DEAL' }Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of {@link Proposal} that a buyer wishes to negotiate with a seller. This attribute is read-only.
The buyer RFP associated with this {@code Proposal}, which is optional. This field will be null if the proposal is not initiated from RFP. - costPerUnit - optional; type Money
- hasBuyerRfp - optional; type booleanWhether a {@link Proposal} contains a {@link BuyerRfp} field. If this field is true, it indicates that the {@link Proposal} in question orignated from a buyer.
- deliveryPausingEnabled - optional; type booleanWhether pausing is consented for the {@code Proposal}. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.
- 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. - getMarketplaceCommentsByStatementDescription:Gets a {@link MarketplaceCommentPage} of {@link MarketplaceComment} objects that satisfy the given {@link Statement#query}. This method only returns comments already sent to Marketplace, local draft {@link ProposalMarketplaceInfo#marketplaceComment} are not included. The following fields are supported for filtering:
The query must specify a {@code proposalId}, and only supports a subset of PQL syntax:PQL Property Object Property {@code proposalId} {@link MarketplaceComment#proposalId}
[WHERE{AND ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:==
:= IN
Only supports {@code ORDER BY} {@link MarketplaceComment#creationTime}.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getMarketplaceCommentsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getMarketplaceCommentsByStatementGets a {@link MarketplaceCommentPage} of {@link MarketplaceComment} objects that satisfy the given {@link Statement#query}. This method only returns comments already sent to Marketplace, local draft {@link ProposalMarketplaceInfo#marketplaceComment} are not included. The following fields are supported for filtering:
The query must specify a {@code proposalId}, and only supports a subset of PQL syntax:PQL Property Object Property {@code proposalId} {@link MarketplaceComment#proposalId}
[WHERE{AND ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:==
:= IN
Only supports {@code ORDER BY} {@link MarketplaceComment#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:getMarketplaceCommentsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getMarketplaceCommentsByStatementResponse- rval - optional; type MarketplaceCommentPageCaptures a page of {@link MarketplaceComment} objects.
- startIndex - optional; type intThe absolute index in the total result set on which this page begins.
- results - optional, unbounded; type MarketplaceCommentA comment associated with a programmatic {@link Proposal} that has been sent to Marketplace.
- proposalId - optional; type longThe unique ID of the {@link Proposal} the comment belongs to.
- comment - optional; type stringThe comment made on the {@link Proposal}.
- creationTime - 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 creation {@link DateTime} of this {@code MarketplaceComment}. - date - optional; type Date
- createdBySeller - optional; type booleanIndicates whether the {@code MarketplaceComment} was created by seller.
The collection of results contained within this page. - proposalId - optional; type long
- startIndex - 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
- getProposalsByStatementDescription:Gets a {@link ProposalPage} of {@link Proposal} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link Proposal#id} {@code dfpOrderId} {@link Proposal#dfpOrderId} {@code name} {@link Proposal#name} {@code status} {@link Proposal#status} {@code isArchived} {@link Proposal#isArchived} {@code approvalStatus} Only applicable for proposals using sales management{@link Proposal#approvalStatus} {@code lastModifiedDateTime} {@link Proposal#lastModifiedDateTime} {@code isProgrammatic} {@link Proposal#isProgrammatic} {@code negotiationStatus} Only applicable for programmatic proposals{@link ProposalMarketplaceInfo#negotiationStatus} Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getProposalsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getProposalsByStatementGets a {@link ProposalPage} of {@link Proposal} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:PQL Property Object Property {@code id} {@link Proposal#id} {@code dfpOrderId} {@link Proposal#dfpOrderId} {@code name} {@link Proposal#name} {@code status} {@link Proposal#status} {@code isArchived} {@link Proposal#isArchived} {@code approvalStatus} Only applicable for proposals using sales management{@link Proposal#approvalStatus} {@code lastModifiedDateTime} {@link Proposal#lastModifiedDateTime} {@code isProgrammatic} {@link Proposal#isProgrammatic} {@code negotiationStatus} Only applicable for programmatic proposals{@link ProposalMarketplaceInfo#negotiationStatus} - 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:getProposalsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getProposalsByStatementResponse- rval - optional; type ProposalPageCaptures a page of {@link Proposal} 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 ProposalA {@code Proposal} represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- id - optional; type longThe unique ID of the {@code Proposal}. This attribute is read-only.
- isProgrammatic - optional; type booleanFlag that specifies whether this {@code Proposal} is for programmatic deals. This value is default to {@code false}.
- dfpOrderId - optional; type longThe unique ID of corresponding {@link Order}. This will be {@code null} if the {@code Proposal} has not been pushed to Ad Manager. This attribute is read-only.
- name - optional; type stringThe name of the {@code Proposal}. This value has a maximum length of 255 characters. This value is copied to {@link Order#name} when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
- 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 date and time at which the order and line items associated with the {@code Proposal} are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest {@link ProposalLineItem#startDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only. - 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 date and time at which the order and line items associated with the {@code Proposal} stop being served. This attribute is derived from the proposal line item of the proposal which has the latest {@link ProposalLineItem#endDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only. - date - optional; type Date
- status - optional; type ProposalStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'REJECTED', 'UNKNOWN' }The status of the {@code Proposal}. This attribute is read-only.
- isArchived - optional; type booleanThe archival status of the {@code Proposal}. This attribute is read-only.
- advertiser - optional; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
The advertiser, to which this {@code Proposal} belongs, and a set of {@link Contact} objects associated with the advertiser. The {@link ProposalCompanyAssociation#type} of this attribute should be {@link ProposalCompanyAssociationType#ADVERTISER}. This attribute is required when the proposal turns into an order, and its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#advertiserId}. This attribute becomes readonly once the {@code Proposal} has been pushed. - companyId - optional; type long
- agencies - optional, unbounded; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
List of agencies and the set of {@link Contact} objects associated with each agency. This attribute is optional. A {@code Proposal} only has at most one {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY} type, but a {@link Company} can appear more than once with different {@link ProposalCompanyAssociationType} values. If primary agency exists, its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#agencyId} when the proposal turns into an order. - companyId - optional; type long
- internalNotes - optional; type stringProvides any additional notes that may annotate the {@code Proposal}. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primarySalesperson - optional; type SalespersonSplitThe primary salesperson who brokered the transaction with the {@link #advertiser}. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.A {@code SalespersonSplit} represents a salesperson.
- userId - optional; type longThe unique ID of the {@link User} responsible for the sales of the {@link Proposal}. This attribute is required.
- userId - optional; type long
- salesPlannerIds - optional, unbounded; type longList of unique IDs of {@link User} objects who are the sales planners of the {@code Proposal}. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primaryTraffickerId - optional; type longThe unique ID of the {@link User} who is primary trafficker and is responsible for trafficking the {@code Proposal}. This attribute is required when the proposal turns into an order, and will be copied to {@link Order#primaryTraffickerId} . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- sellerContactIds - optional, unbounded; type long{@link User users} who are the seller's contacts.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that the {@code Proposal} is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with the {@code Proposal}. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. - customFieldId - optional; type long
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to the {@code Proposal}. This attribute is optional. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. - labelId - optional; type long
- currencyCode - optional; type stringThe currency code of this {@code Proposal}. This attribute is optional and defaults to network's currency code.
- isSold - optional; type booleanIndicates whether the proposal has been sold, i.e., corresponds to whether the status of an {@link Order} is {@link OrderStatus#APPROVED} or {@link OrderStatus#PAUSED}. This attribute is read-only.
- lastModifiedDateTime - 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 this {@code Proposal} was last modified. This attribute is read-only. - date - optional; type Date
- marketplaceInfo - optional; type ProposalMarketplaceInfoMarketplace info for a proposal with a corresponding order in Marketplace.
- marketplaceId - optional; type stringThe marketplace ID of this proposal. This is a shared ID between Ad Manager and the buy-side platform. This value is null if the proposal has not been sent to the buyer. This attribute is read-only.
- hasLocalVersionEdits - optional; type booleanWhether the non-free-editable fields of a {@link Proposal} are opened for edit. A proposal that is open for edit will not receive buyer updates from Marketplace. If the buyer updates the proposal while this is open for local editing, Google will set {@link #isNewVersionFromBuyer} to {@code true}. You will then need to call {@link DiscardProposalDrafts} to revert your edits to get the buyer's latest changes. This attribute is read-only.
- negotiationStatus - optional; type NegotiationStatus - type string with restriction - enum { 'SELLER_INITIATED', 'BUYER_INITIATED', 'AWAITING_SELLER_REVIEW', 'AWAITING_BUYER_REVIEW', 'ONLY_SELLER_ACCEPTED', 'FINALIZED', 'CANCELLED', 'UNKNOWN' }The negotiation status of the {@link Proposal}. This attribute is read-only.
- marketplaceComment - optional; type stringThe comment on the {@link Proposal} to be sent to the buyer.
- isNewVersionFromBuyer - optional; type booleanIndicates that the buyer has made updates to the proposal on Marketplace. This attribute is only meaningful if the proposal is open for edit (i.e., {@link #hasLocalVersionEdits} is {@code true}) This attribute is read-only.
- buyerAccountId - optional; type longThe Authorized Buyers ID of the buyer that this {@code Proposal} is being negotiated with. This attribute is required.
- partnerClientId - optional; type stringThe ID used to represent Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID. This field is readonly and assigned by Google. This attribute is read-only.
The marketplace info of this proposal if it has a corresponding order in Marketplace. - marketplaceId - optional; type string
- buyerRfp - optional; type BuyerRfpRepresents the buyer RFP information associated with a {@link Proposal} describing the requirements from the buyer.
- costPerUnit - optional; type MoneyCPM for the {@link Proposal} in question. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field should serve as guidance for publishers to create a {@link Proposal} with {@link LineItem}s reflecting this CPM. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- units - optional; type longThe number of impressions per day that a buyer wishes to see in the {@link Proposal} derived from the request for proposal in question. This attribute is read-only.
- budget - optional; type MoneyTotal amount of {@link Money} available to spend on this deal. In the case of Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given {@link Proposal}, even though the budget might not be spent entirely, as impressions are not guaranteed. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- currencyCode - optional; type stringCurrency code for this deal's budget and CPM. This attribute is read-only.
- startDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should start serving. This attribute is read-only.Represents 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
- date - optional; type Date
- endDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should end serving. This attribute is read-only.Represents 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
- date - optional; type Date
- description - optional; type stringA description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question. This attribute is read-only.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA list of inventory sizes in which creatives will be eventually served. This attribute is read-only.A {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
- size - optional; type Size
- targeting - optional; type TargetingTargeting information for the proposal in question. Currently this field only contains {@link GeoTargeting} information. This attribute is read-only.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
- additionalTerms - optional; type stringAdditional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the {@link Proposal} derived from this request for proposal. This attribute is read-only.
- adExchangeEnvironment - optional; type AdExchangeEnvironment - type string with restriction - enum { 'DISPLAY', 'VIDEO', 'GAMES', 'MOBILE', 'MOBILE_OUTSTREAM_VIDEO', 'DISPLAY_OUTSTREAM_VIDEO', 'UNKNOWN' }Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include {@link AdExchangeEnvironment#DISPLAY}, {@link AdExchangeEnvironment#VIDEO}, and {@link AdExchangeEnvironment#MOBILE}. This attribute is read-only.
- rfpType - optional; type RfpType - type string with restriction - enum { 'UNKNOWN', 'PROGRAMMATIC_GUARANTEED', 'PREFERRED_DEAL' }Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of {@link Proposal} that a buyer wishes to negotiate with a seller. This attribute is read-only.
The buyer RFP associated with this {@code Proposal}, which is optional. This field will be null if the proposal is not initiated from RFP. - costPerUnit - optional; type Money
- hasBuyerRfp - optional; type booleanWhether a {@link Proposal} contains a {@link BuyerRfp} field. If this field is true, it indicates that the {@link Proposal} in question orignated from a buyer.
- deliveryPausingEnabled - optional; type booleanWhether pausing is consented for the {@code Proposal}. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.
The collection of proposals 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
- performProposalActionDescription:Performs actions on {@link Proposal} objects that match the given {@link Statement#query}.
The following fields are also required when submitting proposals for approval:
- {@link Proposal#advertiser}
- {@link Proposal#primarySalesperson}
- {@link Proposal#primaryTraffickerId}
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:performProposalActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type performProposalActionPerforms actions on {@link Proposal} objects that match the given {@link Statement#query}.The following fields are also required when submitting proposals for approval:
- {@link Proposal#advertiser}
- {@link Proposal#primarySalesperson}
- {@link Proposal#primaryTraffickerId}
- proposalAction - optional; type ProposalActionRepresents the actions that can be performed on {@link Proposal} 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:performProposalActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type performProposalActionResponse- 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. - updateProposalsDescription:Updates the specified {@link Proposal} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:updateProposalsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type updateProposalsUpdates the specified {@link Proposal} objects.
- proposals - optional, unbounded; type ProposalA {@code Proposal} represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- id - optional; type longThe unique ID of the {@code Proposal}. This attribute is read-only.
- isProgrammatic - optional; type booleanFlag that specifies whether this {@code Proposal} is for programmatic deals. This value is default to {@code false}.
- dfpOrderId - optional; type longThe unique ID of corresponding {@link Order}. This will be {@code null} if the {@code Proposal} has not been pushed to Ad Manager. This attribute is read-only.
- name - optional; type stringThe name of the {@code Proposal}. This value has a maximum length of 255 characters. This value is copied to {@link Order#name} when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
- 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 date and time at which the order and line items associated with the {@code Proposal} are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest {@link ProposalLineItem#startDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only. - 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 date and time at which the order and line items associated with the {@code Proposal} stop being served. This attribute is derived from the proposal line item of the proposal which has the latest {@link ProposalLineItem#endDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only. - date - optional; type Date
- status - optional; type ProposalStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'REJECTED', 'UNKNOWN' }The status of the {@code Proposal}. This attribute is read-only.
- isArchived - optional; type booleanThe archival status of the {@code Proposal}. This attribute is read-only.
- advertiser - optional; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
The advertiser, to which this {@code Proposal} belongs, and a set of {@link Contact} objects associated with the advertiser. The {@link ProposalCompanyAssociation#type} of this attribute should be {@link ProposalCompanyAssociationType#ADVERTISER}. This attribute is required when the proposal turns into an order, and its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#advertiserId}. This attribute becomes readonly once the {@code Proposal} has been pushed. - companyId - optional; type long
- agencies - optional, unbounded; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
List of agencies and the set of {@link Contact} objects associated with each agency. This attribute is optional. A {@code Proposal} only has at most one {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY} type, but a {@link Company} can appear more than once with different {@link ProposalCompanyAssociationType} values. If primary agency exists, its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#agencyId} when the proposal turns into an order. - companyId - optional; type long
- internalNotes - optional; type stringProvides any additional notes that may annotate the {@code Proposal}. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primarySalesperson - optional; type SalespersonSplitThe primary salesperson who brokered the transaction with the {@link #advertiser}. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.A {@code SalespersonSplit} represents a salesperson.
- userId - optional; type longThe unique ID of the {@link User} responsible for the sales of the {@link Proposal}. This attribute is required.
- userId - optional; type long
- salesPlannerIds - optional, unbounded; type longList of unique IDs of {@link User} objects who are the sales planners of the {@code Proposal}. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primaryTraffickerId - optional; type longThe unique ID of the {@link User} who is primary trafficker and is responsible for trafficking the {@code Proposal}. This attribute is required when the proposal turns into an order, and will be copied to {@link Order#primaryTraffickerId} . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- sellerContactIds - optional, unbounded; type long{@link User users} who are the seller's contacts.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that the {@code Proposal} is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with the {@code Proposal}. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. - customFieldId - optional; type long
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to the {@code Proposal}. This attribute is optional. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. - labelId - optional; type long
- currencyCode - optional; type stringThe currency code of this {@code Proposal}. This attribute is optional and defaults to network's currency code.
- isSold - optional; type booleanIndicates whether the proposal has been sold, i.e., corresponds to whether the status of an {@link Order} is {@link OrderStatus#APPROVED} or {@link OrderStatus#PAUSED}. This attribute is read-only.
- lastModifiedDateTime - 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 this {@code Proposal} was last modified. This attribute is read-only. - date - optional; type Date
- marketplaceInfo - optional; type ProposalMarketplaceInfoMarketplace info for a proposal with a corresponding order in Marketplace.
- marketplaceId - optional; type stringThe marketplace ID of this proposal. This is a shared ID between Ad Manager and the buy-side platform. This value is null if the proposal has not been sent to the buyer. This attribute is read-only.
- hasLocalVersionEdits - optional; type booleanWhether the non-free-editable fields of a {@link Proposal} are opened for edit. A proposal that is open for edit will not receive buyer updates from Marketplace. If the buyer updates the proposal while this is open for local editing, Google will set {@link #isNewVersionFromBuyer} to {@code true}. You will then need to call {@link DiscardProposalDrafts} to revert your edits to get the buyer's latest changes. This attribute is read-only.
- negotiationStatus - optional; type NegotiationStatus - type string with restriction - enum { 'SELLER_INITIATED', 'BUYER_INITIATED', 'AWAITING_SELLER_REVIEW', 'AWAITING_BUYER_REVIEW', 'ONLY_SELLER_ACCEPTED', 'FINALIZED', 'CANCELLED', 'UNKNOWN' }The negotiation status of the {@link Proposal}. This attribute is read-only.
- marketplaceComment - optional; type stringThe comment on the {@link Proposal} to be sent to the buyer.
- isNewVersionFromBuyer - optional; type booleanIndicates that the buyer has made updates to the proposal on Marketplace. This attribute is only meaningful if the proposal is open for edit (i.e., {@link #hasLocalVersionEdits} is {@code true}) This attribute is read-only.
- buyerAccountId - optional; type longThe Authorized Buyers ID of the buyer that this {@code Proposal} is being negotiated with. This attribute is required.
- partnerClientId - optional; type stringThe ID used to represent Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID. This field is readonly and assigned by Google. This attribute is read-only.
The marketplace info of this proposal if it has a corresponding order in Marketplace. - marketplaceId - optional; type string
- buyerRfp - optional; type BuyerRfpRepresents the buyer RFP information associated with a {@link Proposal} describing the requirements from the buyer.
- costPerUnit - optional; type MoneyCPM for the {@link Proposal} in question. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field should serve as guidance for publishers to create a {@link Proposal} with {@link LineItem}s reflecting this CPM. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- units - optional; type longThe number of impressions per day that a buyer wishes to see in the {@link Proposal} derived from the request for proposal in question. This attribute is read-only.
- budget - optional; type MoneyTotal amount of {@link Money} available to spend on this deal. In the case of Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given {@link Proposal}, even though the budget might not be spent entirely, as impressions are not guaranteed. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- currencyCode - optional; type stringCurrency code for this deal's budget and CPM. This attribute is read-only.
- startDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should start serving. This attribute is read-only.Represents 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
- date - optional; type Date
- endDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should end serving. This attribute is read-only.Represents 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
- date - optional; type Date
- description - optional; type stringA description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question. This attribute is read-only.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA list of inventory sizes in which creatives will be eventually served. This attribute is read-only.A {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
- size - optional; type Size
- targeting - optional; type TargetingTargeting information for the proposal in question. Currently this field only contains {@link GeoTargeting} information. This attribute is read-only.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
- additionalTerms - optional; type stringAdditional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the {@link Proposal} derived from this request for proposal. This attribute is read-only.
- adExchangeEnvironment - optional; type AdExchangeEnvironment - type string with restriction - enum { 'DISPLAY', 'VIDEO', 'GAMES', 'MOBILE', 'MOBILE_OUTSTREAM_VIDEO', 'DISPLAY_OUTSTREAM_VIDEO', 'UNKNOWN' }Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include {@link AdExchangeEnvironment#DISPLAY}, {@link AdExchangeEnvironment#VIDEO}, and {@link AdExchangeEnvironment#MOBILE}. This attribute is read-only.
- rfpType - optional; type RfpType - type string with restriction - enum { 'UNKNOWN', 'PROGRAMMATIC_GUARANTEED', 'PREFERRED_DEAL' }Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of {@link Proposal} that a buyer wishes to negotiate with a seller. This attribute is read-only.
The buyer RFP associated with this {@code Proposal}, which is optional. This field will be null if the proposal is not initiated from RFP. - costPerUnit - optional; type Money
- hasBuyerRfp - optional; type booleanWhether a {@link Proposal} contains a {@link BuyerRfp} field. If this field is true, it indicates that the {@link Proposal} in question orignated from a buyer.
- deliveryPausingEnabled - optional; type booleanWhether pausing is consented for the {@code Proposal}. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.
- id - optional; type long
Output:updateProposalsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type updateProposalsResponse- rval - optional, unbounded; type ProposalA {@code Proposal} represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.
- id - optional; type longThe unique ID of the {@code Proposal}. This attribute is read-only.
- isProgrammatic - optional; type booleanFlag that specifies whether this {@code Proposal} is for programmatic deals. This value is default to {@code false}.
- dfpOrderId - optional; type longThe unique ID of corresponding {@link Order}. This will be {@code null} if the {@code Proposal} has not been pushed to Ad Manager. This attribute is read-only.
- name - optional; type stringThe name of the {@code Proposal}. This value has a maximum length of 255 characters. This value is copied to {@link Order#name} when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. This attribute is required.
- 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 date and time at which the order and line items associated with the {@code Proposal} are eligible to begin serving. This attribute is derived from the proposal line item of the proposal which has the earliest {@link ProposalLineItem#startDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have a start time. This attribute is read-only. - 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 date and time at which the order and line items associated with the {@code Proposal} stop being served. This attribute is derived from the proposal line item of the proposal which has the latest {@link ProposalLineItem#endDateTime}. This attribute will be null, if this proposal has no related line items, or none of its line items have an end time. This attribute is read-only. - date - optional; type Date
- status - optional; type ProposalStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'REJECTED', 'UNKNOWN' }The status of the {@code Proposal}. This attribute is read-only.
- isArchived - optional; type booleanThe archival status of the {@code Proposal}. This attribute is read-only.
- advertiser - optional; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
The advertiser, to which this {@code Proposal} belongs, and a set of {@link Contact} objects associated with the advertiser. The {@link ProposalCompanyAssociation#type} of this attribute should be {@link ProposalCompanyAssociationType#ADVERTISER}. This attribute is required when the proposal turns into an order, and its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#advertiserId}. This attribute becomes readonly once the {@code Proposal} has been pushed. - companyId - optional; type long
- agencies - optional, unbounded; type ProposalCompanyAssociationA {@code ProposalCompanyAssociation} represents a {@link Company} associated with the {@link Proposal} and a set of {@link Contact} objects belonging to the company.
- companyId - optional; type longThe unique ID of the {@link Company} associated with the {@link Proposal}. This attribute is required.
- type - optional; type ProposalCompanyAssociationType - type string with restriction - enum { 'PRIMARY_AGENCY', 'BILLING_AGENCY', 'BRANDING_AGENCY', 'OTHER_AGENCY', 'ADVERTISER', 'UNKNOWN' }The association type of the {@link Company} and {@link Proposal}. This attribute is required.
- contactIds - optional, unbounded; type longList of unique IDs for {@link Contact} objects of the {@link Company}.
List of agencies and the set of {@link Contact} objects associated with each agency. This attribute is optional. A {@code Proposal} only has at most one {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY} type, but a {@link Company} can appear more than once with different {@link ProposalCompanyAssociationType} values. If primary agency exists, its {@link ProposalCompanyAssociation#companyId} will be copied to {@link Order#agencyId} when the proposal turns into an order. - companyId - optional; type long
- internalNotes - optional; type stringProvides any additional notes that may annotate the {@code Proposal}. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primarySalesperson - optional; type SalespersonSplitThe primary salesperson who brokered the transaction with the {@link #advertiser}. This attribute is required when the proposal turns into an order. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.A {@code SalespersonSplit} represents a salesperson.
- userId - optional; type longThe unique ID of the {@link User} responsible for the sales of the {@link Proposal}. This attribute is required.
- userId - optional; type long
- salesPlannerIds - optional, unbounded; type longList of unique IDs of {@link User} objects who are the sales planners of the {@code Proposal}. This attribute is optional. A proposal could have 8 sales planners at most. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- primaryTraffickerId - optional; type longThe unique ID of the {@link User} who is primary trafficker and is responsible for trafficking the {@code Proposal}. This attribute is required when the proposal turns into an order, and will be copied to {@link Order#primaryTraffickerId} . This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- sellerContactIds - optional, unbounded; type long{@link User users} who are the seller's contacts.
- appliedTeamIds - optional, unbounded; type longThe IDs of all teams that the {@code Proposal} is on directly. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.
- customFieldValues - optional, unbounded; type BaseCustomFieldValueThe value of a {@link CustomField} for a particular entity.
- customFieldId - optional; type longId of the {@code CustomField} to which this value belongs. This attribute is required.
The values of the custom fields associated with the {@code Proposal}. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration. - customFieldId - optional; type long
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of labels applied directly to the {@code Proposal}. This attribute is optional. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only. - labelId - optional; type long
- currencyCode - optional; type stringThe currency code of this {@code Proposal}. This attribute is optional and defaults to network's currency code.
- isSold - optional; type booleanIndicates whether the proposal has been sold, i.e., corresponds to whether the status of an {@link Order} is {@link OrderStatus#APPROVED} or {@link OrderStatus#PAUSED}. This attribute is read-only.
- lastModifiedDateTime - 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 this {@code Proposal} was last modified. This attribute is read-only. - date - optional; type Date
- marketplaceInfo - optional; type ProposalMarketplaceInfoMarketplace info for a proposal with a corresponding order in Marketplace.
- marketplaceId - optional; type stringThe marketplace ID of this proposal. This is a shared ID between Ad Manager and the buy-side platform. This value is null if the proposal has not been sent to the buyer. This attribute is read-only.
- hasLocalVersionEdits - optional; type booleanWhether the non-free-editable fields of a {@link Proposal} are opened for edit. A proposal that is open for edit will not receive buyer updates from Marketplace. If the buyer updates the proposal while this is open for local editing, Google will set {@link #isNewVersionFromBuyer} to {@code true}. You will then need to call {@link DiscardProposalDrafts} to revert your edits to get the buyer's latest changes. This attribute is read-only.
- negotiationStatus - optional; type NegotiationStatus - type string with restriction - enum { 'SELLER_INITIATED', 'BUYER_INITIATED', 'AWAITING_SELLER_REVIEW', 'AWAITING_BUYER_REVIEW', 'ONLY_SELLER_ACCEPTED', 'FINALIZED', 'CANCELLED', 'UNKNOWN' }The negotiation status of the {@link Proposal}. This attribute is read-only.
- marketplaceComment - optional; type stringThe comment on the {@link Proposal} to be sent to the buyer.
- isNewVersionFromBuyer - optional; type booleanIndicates that the buyer has made updates to the proposal on Marketplace. This attribute is only meaningful if the proposal is open for edit (i.e., {@link #hasLocalVersionEdits} is {@code true}) This attribute is read-only.
- buyerAccountId - optional; type longThe Authorized Buyers ID of the buyer that this {@code Proposal} is being negotiated with. This attribute is required.
- partnerClientId - optional; type stringThe ID used to represent Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID. This field is readonly and assigned by Google. This attribute is read-only.
The marketplace info of this proposal if it has a corresponding order in Marketplace. - marketplaceId - optional; type string
- buyerRfp - optional; type BuyerRfpRepresents the buyer RFP information associated with a {@link Proposal} describing the requirements from the buyer.
- costPerUnit - optional; type MoneyCPM for the {@link Proposal} in question. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field should serve as guidance for publishers to create a {@link Proposal} with {@link LineItem}s reflecting this CPM. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- units - optional; type longThe number of impressions per day that a buyer wishes to see in the {@link Proposal} derived from the request for proposal in question. This attribute is read-only.
- budget - optional; type MoneyTotal amount of {@link Money} available to spend on this deal. In the case of Preferred Deal, the budget is equal to the maximum amount of money a buyer is willing to spend on a given {@link Proposal}, even though the budget might not be spent entirely, as impressions are not guaranteed. This attribute is read-only.Represents a money amount.
- currencyCode - optional; type stringThree letter currency code in string format.
- microAmount - optional; type longMoney values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
- currencyCode - optional; type string
- currencyCode - optional; type stringCurrency code for this deal's budget and CPM. This attribute is read-only.
- startDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should start serving. This attribute is read-only.Represents 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
- date - optional; type Date
- endDateTime - optional; type DateTimeThe {@link DateTime} in which the proposed deal should end serving. This attribute is read-only.Represents 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
- date - optional; type Date
- description - optional; type stringA description of the proposed deal. This can be used for the buyer to tell the publisher more detailed information about the deal in question. This attribute is read-only.
- creativePlaceholders - optional, unbounded; type CreativePlaceholderA list of inventory sizes in which creatives will be eventually served. This attribute is read-only.A {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholderA {@code CreativePlaceholder} describes a slot that a creative is expected to fill. This is used primarily to help in forecasting, and also to validate that the correct creatives are associated with the line item. A {@code CreativePlaceholder} must contain a size, and it can optionally contain companions. Companions are only valid if the line item's environment type is {@link EnvironmentType#VIDEO_PLAYER}.
- size - optional; type SizeThe dimensions that the creative is expected to have. This attribute is required.Represents 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
- creativeTemplateId - optional; type longThe native creative template ID.
This value is only required if {@link #creativeSizeType} is {@link CreativeSizeType#NATIVE}.
- companions - optional, unbounded; type CreativePlaceholder... is recursiveThe companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}.
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has a {@link LineItem#environmentType} of {@link EnvironmentType#VIDEO_PLAYER} or {@link LineItem#roadblockingType} of {@link RoadblockingType#CREATIVE_SET}. - size - optional; type Size
- appliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
The set of label frequency caps applied directly to this creative placeholder. - labelId - optional; type long
- effectiveAppliedLabels - optional, unbounded; type AppliedLabelRepresents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
- labelId - optional; type longThe ID of a created {@link Label}.
- isNegated - optional; type boolean{@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
Contains the set of labels applied directly to this creative placeholder as well as those inherited from the creative template from which this creative placeholder was instantiated. This field is readonly and is assigned by Google. - labelId - optional; type long
- expectedCreativeCount - optional; type intExpected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served.
- creativeSizeType - optional; type CreativeSizeType - type string with restriction - enum { 'PIXEL', 'ASPECT_RATIO', 'INTERSTITIAL', 'IGNORED', 'NATIVE', 'AUDIO' }Describes the types of sizes a creative can be. By default, the creative's size is {@link CreativeSizeType#PIXEL}, which is a dimension based size (width-height pair).
- targetingName - optional; type stringThe name of the {@link CreativeTargeting} for creatives this placeholder represents.
This attribute is optional. Specifying creative targeting here is for forecasting purposes only and has no effect on serving. The same creative targeting should be specified on a {@link LineItemCreativeAssociation} when associating a {@link Creative} with the {@link LineItem}.
- isAmpOnly - optional; type booleanIndicate if the expected creative of this placeholder has an AMP only variant.
This attribute is optional. It is for forecasting purposes only and has no effect on serving.
- size - optional; type Size
- targeting - optional; type TargetingTargeting information for the proposal in question. Currently this field only contains {@link GeoTargeting} information. This attribute is read-only.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
- additionalTerms - optional; type stringAdditional terms of the deal in question. This field can be used to state more specific targeting information for the deal, as well as any additional information regarding this deal. Given that this field belongs to a request for proposal (for which initially a {@link Proposal} does not yet exist), this field can be populated by buyers to specify additional information that they wish publishers to incorporate into the {@link Proposal} derived from this request for proposal. This attribute is read-only.
- adExchangeEnvironment - optional; type AdExchangeEnvironment - type string with restriction - enum { 'DISPLAY', 'VIDEO', 'GAMES', 'MOBILE', 'MOBILE_OUTSTREAM_VIDEO', 'DISPLAY_OUTSTREAM_VIDEO', 'UNKNOWN' }Identifies the format of the inventory or "channel" through which the ad serves. Environments currently supported include {@link AdExchangeEnvironment#DISPLAY}, {@link AdExchangeEnvironment#VIDEO}, and {@link AdExchangeEnvironment#MOBILE}. This attribute is read-only.
- rfpType - optional; type RfpType - type string with restriction - enum { 'UNKNOWN', 'PROGRAMMATIC_GUARANTEED', 'PREFERRED_DEAL' }Deal type; either Programmatic Guaranteed or Preferred Deal. This field corresponds to the type of {@link Proposal} that a buyer wishes to negotiate with a seller. This attribute is read-only.
The buyer RFP associated with this {@code Proposal}, which is optional. This field will be null if the proposal is not initiated from RFP. - costPerUnit - optional; type Money
- hasBuyerRfp - optional; type booleanWhether a {@link Proposal} contains a {@link BuyerRfp} field. If this field is true, it indicates that the {@link Proposal} in question orignated from a buyer.
- deliveryPausingEnabled - optional; type booleanWhether pausing is consented for the {@code Proposal}. This field is optional and defaults to true. If false, it indicates that the buyer and the seller agree that the proposal should not be paused.
- 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. - proposals - optional, unbounded; type Proposal
Port type ProposalServiceInterfaceSource 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