Deal (Ad Exchange Buyer API II v2beta1-rev20210613-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.adexchangebuyer2.v2beta1.model.Deal

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Deal
extends GenericJson
```
A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Ad Exchange Buyer API II. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Deal()

Constructors
Constructor and Description
`Deal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Deal`	`clone()`
`String`	`getAvailableEndTime()` Proposed flight end time of the deal.
`String`	`getAvailableStartTime()` Optional.
`PrivateData`	`getBuyerPrivateData()` Buyer private data (hidden from seller).
`String`	`getCreateProductId()` The product ID from which this deal was created.
`Long`	`getCreateProductRevision()` Optional.
`String`	`getCreateTime()` Output only.
`String`	`getCreativePreApprovalPolicy()` Output only.
`CreativeRestrictions`	`getCreativeRestrictions()` Output only.
`String`	`getCreativeSafeFrameCompatibility()` Output only.
`String`	`getDealId()` Output only.
`DealServingMetadata`	`getDealServingMetadata()` Output only.
`DealTerms`	`getDealTerms()` The negotiable terms of the deal.
`DeliveryControl`	`getDeliveryControl()` The set of fields around delivery control that are interesting for a buyer to see but are non- negotiable.
`String`	`getDescription()` Description for the deal terms.
`String`	`getDisplayName()` The name of the deal.
`String`	`getExternalDealId()` Output only.
`Boolean`	`getIsSetupComplete()` Output only.
`String`	`getProgrammaticCreativeSource()` Output only.
`String`	`getProposalId()` Output only.
`List<ContactInformation>`	`getSellerContacts()` Output only.
`String`	`getSyndicationProduct()` The syndication product associated with the deal.
`MarketplaceTargeting`	`getTargeting()` Output only.
`List<TargetingCriteria>`	`getTargetingCriterion()` The shared targeting visible to buyers and sellers.
`String`	`getUpdateTime()` Output only.
`String`	`getWebPropertyCode()` The web property code for the seller copied over from the product.
`Deal`	`set(String fieldName, Object value)`
`Deal`	`setAvailableEndTime(String availableEndTime)` Proposed flight end time of the deal.
`Deal`	`setAvailableStartTime(String availableStartTime)` Optional.
`Deal`	`setBuyerPrivateData(PrivateData buyerPrivateData)` Buyer private data (hidden from seller).
`Deal`	`setCreateProductId(String createProductId)` The product ID from which this deal was created.
`Deal`	`setCreateProductRevision(Long createProductRevision)` Optional.
`Deal`	`setCreateTime(String createTime)` Output only.
`Deal`	`setCreativePreApprovalPolicy(String creativePreApprovalPolicy)` Output only.
`Deal`	`setCreativeRestrictions(CreativeRestrictions creativeRestrictions)` Output only.
`Deal`	`setCreativeSafeFrameCompatibility(String creativeSafeFrameCompatibility)` Output only.
`Deal`	`setDealId(String dealId)` Output only.
`Deal`	`setDealServingMetadata(DealServingMetadata dealServingMetadata)` Output only.
`Deal`	`setDealTerms(DealTerms dealTerms)` The negotiable terms of the deal.
`Deal`	`setDeliveryControl(DeliveryControl deliveryControl)` The set of fields around delivery control that are interesting for a buyer to see but are non- negotiable.
`Deal`	`setDescription(String description)` Description for the deal terms.
`Deal`	`setDisplayName(String displayName)` The name of the deal.
`Deal`	`setExternalDealId(String externalDealId)` Output only.
`Deal`	`setIsSetupComplete(Boolean isSetupComplete)` Output only.
`Deal`	`setProgrammaticCreativeSource(String programmaticCreativeSource)` Output only.
`Deal`	`setProposalId(String proposalId)` Output only.
`Deal`	`setSellerContacts(List<ContactInformation> sellerContacts)` Output only.
`Deal`	`setSyndicationProduct(String syndicationProduct)` The syndication product associated with the deal.
`Deal`	`setTargeting(MarketplaceTargeting targeting)` Output only.
`Deal`	`setTargetingCriterion(List<TargetingCriteria> targetingCriterion)` The shared targeting visible to buyers and sellers.
`Deal`	`setUpdateTime(String updateTime)` Output only.
`Deal`	`setWebPropertyCode(String webPropertyCode)` The web property code for the seller copied over from the product.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Deal
```
public Deal()
```
- Method Detail
  - getAvailableEndTime
```
public String getAvailableEndTime()
```
    Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals.
    
    Returns:
    
    value or null for none
  - setAvailableEndTime
```
public Deal setAvailableEndTime(String availableEndTime)
```
    Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals.
    
    Parameters:
    
    availableEndTime - availableEndTime or null for none
  - getAvailableStartTime
```
public String getAvailableStartTime()
```
    Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.
    
    Returns:
    
    value or null for none
  - setAvailableStartTime
```
public Deal setAvailableStartTime(String availableStartTime)
```
    Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.
    
    Parameters:
    
    availableStartTime - availableStartTime or null for none
  - getBuyerPrivateData
```
public PrivateData getBuyerPrivateData()
```
    Buyer private data (hidden from seller).
    
    Returns:
    
    value or null for none
  - setBuyerPrivateData
```
public Deal setBuyerPrivateData(PrivateData buyerPrivateData)
```
    Buyer private data (hidden from seller).
    
    Parameters:
    
    buyerPrivateData - buyerPrivateData or null for none
  - getCreateProductId
```
public String getCreateProductId()
```
    The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Returns:
    
    value or null for none
  - setCreateProductId
```
public Deal setCreateProductId(String createProductId)
```
    The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Parameters:
    
    createProductId - createProductId or null for none
  - getCreateProductRevision
```
public Long getCreateProductRevision()
```
    Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Returns:
    
    value or null for none
  - setCreateProductRevision
```
public Deal setCreateProductRevision(Long createProductRevision)
```
    Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Parameters:
    
    createProductRevision - createProductRevision or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time of the deal creation.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Deal setCreateTime(String createTime)
```
    Output only. The time of the deal creation.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCreativePreApprovalPolicy
```
public String getCreativePreApprovalPolicy()
```
    Output only. Specifies the creative pre-approval policy.
    
    Returns:
    
    value or null for none
  - setCreativePreApprovalPolicy
```
public Deal setCreativePreApprovalPolicy(String creativePreApprovalPolicy)
```
    Output only. Specifies the creative pre-approval policy.
    
    Parameters:
    
    creativePreApprovalPolicy - creativePreApprovalPolicy or null for none
  - getCreativeRestrictions
```
public CreativeRestrictions getCreativeRestrictions()
```
    Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.
    
    Returns:
    
    value or null for none
  - setCreativeRestrictions
```
public Deal setCreativeRestrictions(CreativeRestrictions creativeRestrictions)
```
    Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.
    
    Parameters:
    
    creativeRestrictions - creativeRestrictions or null for none
  - getCreativeSafeFrameCompatibility
```
public String getCreativeSafeFrameCompatibility()
```
    Output only. Specifies whether the creative is safeFrame compatible.
    
    Returns:
    
    value or null for none
  - setCreativeSafeFrameCompatibility
```
public Deal setCreativeSafeFrameCompatibility(String creativeSafeFrameCompatibility)
```
    Output only. Specifies whether the creative is safeFrame compatible.
    
    Parameters:
    
    creativeSafeFrameCompatibility - creativeSafeFrameCompatibility or null for none
  - getDealId
```
public String getDealId()
```
    Output only. A unique deal ID for the deal (server-assigned).
    
    Returns:
    
    value or null for none
  - setDealId
```
public Deal setDealId(String dealId)
```
    Output only. A unique deal ID for the deal (server-assigned).
    
    Parameters:
    
    dealId - dealId or null for none
  - getDealServingMetadata
```
public DealServingMetadata getDealServingMetadata()
```
    Output only. Metadata about the serving status of this deal.
    
    Returns:
    
    value or null for none
  - setDealServingMetadata
```
public Deal setDealServingMetadata(DealServingMetadata dealServingMetadata)
```
    Output only. Metadata about the serving status of this deal.
    
    Parameters:
    
    dealServingMetadata - dealServingMetadata or null for none
  - getDealTerms
```
public DealTerms getDealTerms()
```
    The negotiable terms of the deal.
    
    Returns:
    
    value or null for none
  - setDealTerms
```
public Deal setDealTerms(DealTerms dealTerms)
```
    The negotiable terms of the deal.
    
    Parameters:
    
    dealTerms - dealTerms or null for none
  - getDeliveryControl
```
public DeliveryControl getDeliveryControl()
```
    The set of fields around delivery control that are interesting for a buyer to see but are non- negotiable. These are set by the publisher.
    
    Returns:
    
    value or null for none
  - setDeliveryControl
```
public Deal setDeliveryControl(DeliveryControl deliveryControl)
```
    The set of fields around delivery control that are interesting for a buyer to see but are non- negotiable. These are set by the publisher.
    
    Parameters:
    
    deliveryControl - deliveryControl or null for none
  - getDescription
```
public String getDescription()
```
    Description for the deal terms.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Deal setDescription(String description)
```
    Description for the deal terms.
    
    Parameters:
    
    description - description or null for none
  - getDisplayName
```
public String getDisplayName()
```
    The name of the deal.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Deal setDisplayName(String displayName)
```
    The name of the deal.
    
    Parameters:
    
    displayName - displayName or null for none
  - getExternalDealId
```
public String getExternalDealId()
```
    Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc.
    
    Returns:
    
    value or null for none
  - setExternalDealId
```
public Deal setExternalDealId(String externalDealId)
```
    Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc.
    
    Parameters:
    
    externalDealId - externalDealId or null for none
  - getIsSetupComplete
```
public Boolean getIsSetupComplete()
```
    Output only. True, if the buyside inventory setup is complete for this deal.
    
    Returns:
    
    value or null for none
  - setIsSetupComplete
```
public Deal setIsSetupComplete(Boolean isSetupComplete)
```
    Output only. True, if the buyside inventory setup is complete for this deal.
    
    Parameters:
    
    isSetupComplete - isSetupComplete or null for none
  - getProgrammaticCreativeSource
```
public String getProgrammaticCreativeSource()
```
    Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer.
    
    Returns:
    
    value or null for none
  - setProgrammaticCreativeSource
```
public Deal setProgrammaticCreativeSource(String programmaticCreativeSource)
```
    Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer.
    
    Parameters:
    
    programmaticCreativeSource - programmaticCreativeSource or null for none
  - getProposalId
```
public String getProposalId()
```
    Output only. ID of the proposal that this deal is part of.
    
    Returns:
    
    value or null for none
  - setProposalId
```
public Deal setProposalId(String proposalId)
```
    Output only. ID of the proposal that this deal is part of.
    
    Parameters:
    
    proposalId - proposalId or null for none
  - getSellerContacts
```
public List<ContactInformation> getSellerContacts()
```
    Output only. Seller contact information for the deal.
    
    Returns:
    
    value or null for none
  - setSellerContacts
```
public Deal setSellerContacts(List<ContactInformation> sellerContacts)
```
    Output only. Seller contact information for the deal.
    
    Parameters:
    
    sellerContacts - sellerContacts or null for none
  - getSyndicationProduct
```
public String getSyndicationProduct()
```
    The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Returns:
    
    value or null for none
  - setSyndicationProduct
```
public Deal setSyndicationProduct(String syndicationProduct)
```
    The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Parameters:
    
    syndicationProduct - syndicationProduct or null for none
  - getTargeting
```
public MarketplaceTargeting getTargeting()
```
    Output only. Specifies the subset of inventory targeted by the deal.
    
    Returns:
    
    value or null for none
  - setTargeting
```
public Deal setTargeting(MarketplaceTargeting targeting)
```
    Output only. Specifies the subset of inventory targeted by the deal.
    
    Parameters:
    
    targeting - targeting or null for none
  - getTargetingCriterion
```
public List<TargetingCriteria> getTargetingCriterion()
```
    The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.
    
    Returns:
    
    value or null for none
  - setTargetingCriterion
```
public Deal setTargetingCriterion(List<TargetingCriteria> targetingCriterion)
```
    The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.
    
    Parameters:
    
    targetingCriterion - targetingCriterion or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The time when the deal was last updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Deal setUpdateTime(String updateTime)
```
    Output only. The time when the deal was last updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getWebPropertyCode
```
public String getWebPropertyCode()
```
    The web property code for the seller copied over from the product.
    
    Returns:
    
    value or null for none
  - setWebPropertyCode
```
public Deal setWebPropertyCode(String webPropertyCode)
```
    The web property code for the seller copied over from the product.
    
    Parameters:
    
    webPropertyCode - webPropertyCode or null for none
  - set
```
public Deal set(String fieldName,
                Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Deal clone()
```
    Overrides:
    
    clone in class GenericJson

Class Deal

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Deal

Method Detail

getAvailableEndTime

setAvailableEndTime

getAvailableStartTime

setAvailableStartTime

getBuyerPrivateData

setBuyerPrivateData

getCreateProductId

setCreateProductId

getCreateProductRevision

setCreateProductRevision

getCreateTime

setCreateTime

getCreativePreApprovalPolicy

setCreativePreApprovalPolicy

getCreativeRestrictions

setCreativeRestrictions

getCreativeSafeFrameCompatibility

setCreativeSafeFrameCompatibility

getDealId

setDealId

getDealServingMetadata

setDealServingMetadata

getDealTerms

setDealTerms

getDeliveryControl

setDeliveryControl

getDescription

setDescription

getDisplayName

setDisplayName

getExternalDealId

setExternalDealId

getIsSetupComplete

setIsSetupComplete

getProgrammaticCreativeSource

setProgrammaticCreativeSource

getProposalId

setProposalId

getSellerContacts

setSellerContacts

getSyndicationProduct

setSyndicationProduct

getTargeting

setTargeting

getTargetingCriterion

setTargetingCriterion

getUpdateTime

setUpdateTime

getWebPropertyCode

setWebPropertyCode

set

clone