Proposal (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.Proposal

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Proposal
extends GenericJson
```
Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: You can't update, create, or otherwise modify Private Auction deals through the API. Fields are updatable unless noted otherwise.
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

Proposal()

Constructors
Constructor and Description
`Proposal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Proposal`	`clone()`
`Buyer`	`getBilledBuyer()` Output only.
`Buyer`	`getBuyer()` Reference to the buyer on the proposal.
`List<ContactInformation>`	`getBuyerContacts()` Contact information for the buyer.
`PrivateData`	`getBuyerPrivateData()` Private data for buyer.
`List<Deal>`	`getDeals()` The deals associated with this proposal.
`String`	`getDisplayName()` The name for the proposal.
`Boolean`	`getIsRenegotiating()` Output only.
`Boolean`	`getIsSetupComplete()` Output only.
`String`	`getLastUpdaterOrCommentorRole()` Output only.
`List<Note>`	`getNotes()` Output only.
`String`	`getOriginatorRole()` Output only.
`String`	`getPrivateAuctionId()` Output only.
`String`	`getProposalId()` Output only.
`Long`	`getProposalRevision()` Output only.
`String`	`getProposalState()` Output only.
`Seller`	`getSeller()` Reference to the seller on the proposal.
`List<ContactInformation>`	`getSellerContacts()` Output only.
`String`	`getTermsAndConditions()` Output only.
`String`	`getUpdateTime()` Output only.
`Proposal`	`set(String fieldName, Object value)`
`Proposal`	`setBilledBuyer(Buyer billedBuyer)` Output only.
`Proposal`	`setBuyer(Buyer buyer)` Reference to the buyer on the proposal.
`Proposal`	`setBuyerContacts(List<ContactInformation> buyerContacts)` Contact information for the buyer.
`Proposal`	`setBuyerPrivateData(PrivateData buyerPrivateData)` Private data for buyer.
`Proposal`	`setDeals(List<Deal> deals)` The deals associated with this proposal.
`Proposal`	`setDisplayName(String displayName)` The name for the proposal.
`Proposal`	`setIsRenegotiating(Boolean isRenegotiating)` Output only.
`Proposal`	`setIsSetupComplete(Boolean isSetupComplete)` Output only.
`Proposal`	`setLastUpdaterOrCommentorRole(String lastUpdaterOrCommentorRole)` Output only.
`Proposal`	`setNotes(List<Note> notes)` Output only.
`Proposal`	`setOriginatorRole(String originatorRole)` Output only.
`Proposal`	`setPrivateAuctionId(String privateAuctionId)` Output only.
`Proposal`	`setProposalId(String proposalId)` Output only.
`Proposal`	`setProposalRevision(Long proposalRevision)` Output only.
`Proposal`	`setProposalState(String proposalState)` Output only.
`Proposal`	`setSeller(Seller seller)` Reference to the seller on the proposal.
`Proposal`	`setSellerContacts(List<ContactInformation> sellerContacts)` Output only.
`Proposal`	`setTermsAndConditions(String termsAndConditions)` Output only.
`Proposal`	`setUpdateTime(String updateTime)` Output only.

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
  - Proposal
```
public Proposal()
```
- Method Detail
  - getBilledBuyer
```
public Buyer getBilledBuyer()
```
    Output only. Reference to the buyer that will get billed for this proposal.
    
    Returns:
    
    value or null for none
  - setBilledBuyer
```
public Proposal setBilledBuyer(Buyer billedBuyer)
```
    Output only. Reference to the buyer that will get billed for this proposal.
    
    Parameters:
    
    billedBuyer - billedBuyer or null for none
  - getBuyer
```
public Buyer getBuyer()
```
    Reference to the buyer on the proposal. 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
  - setBuyer
```
public Proposal setBuyer(Buyer buyer)
```
    Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Parameters:
    
    buyer - buyer or null for none
  - getBuyerContacts
```
public List<ContactInformation> getBuyerContacts()
```
    Contact information for the buyer.
    
    Returns:
    
    value or null for none
  - setBuyerContacts
```
public Proposal setBuyerContacts(List<ContactInformation> buyerContacts)
```
    Contact information for the buyer.
    
    Parameters:
    
    buyerContacts - buyerContacts or null for none
  - getBuyerPrivateData
```
public PrivateData getBuyerPrivateData()
```
    Private data for buyer. (hidden from seller).
    
    Returns:
    
    value or null for none
  - setBuyerPrivateData
```
public Proposal setBuyerPrivateData(PrivateData buyerPrivateData)
```
    Private data for buyer. (hidden from seller).
    
    Parameters:
    
    buyerPrivateData - buyerPrivateData or null for none
  - getDeals
```
public List<Deal> getDeals()
```
    The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
    
    Returns:
    
    value or null for none
  - setDeals
```
public Proposal setDeals(List<Deal> deals)
```
    The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
    
    Parameters:
    
    deals - deals or null for none
  - getDisplayName
```
public String getDisplayName()
```
    The name for the proposal.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Proposal setDisplayName(String displayName)
```
    The name for the proposal.
    
    Parameters:
    
    displayName - displayName or null for none
  - getIsRenegotiating
```
public Boolean getIsRenegotiating()
```
    Output only. True if the proposal is being renegotiated.
    
    Returns:
    
    value or null for none
  - setIsRenegotiating
```
public Proposal setIsRenegotiating(Boolean isRenegotiating)
```
    Output only. True if the proposal is being renegotiated.
    
    Parameters:
    
    isRenegotiating - isRenegotiating or null for none
  - getIsSetupComplete
```
public Boolean getIsSetupComplete()
```
    Output only. True, if the buyside inventory setup is complete for this proposal.
    
    Returns:
    
    value or null for none
  - setIsSetupComplete
```
public Proposal setIsSetupComplete(Boolean isSetupComplete)
```
    Output only. True, if the buyside inventory setup is complete for this proposal.
    
    Parameters:
    
    isSetupComplete - isSetupComplete or null for none
  - getLastUpdaterOrCommentorRole
```
public String getLastUpdaterOrCommentorRole()
```
    Output only. The role of the last user that either updated the proposal or left a comment.
    
    Returns:
    
    value or null for none
  - setLastUpdaterOrCommentorRole
```
public Proposal setLastUpdaterOrCommentorRole(String lastUpdaterOrCommentorRole)
```
    Output only. The role of the last user that either updated the proposal or left a comment.
    
    Parameters:
    
    lastUpdaterOrCommentorRole - lastUpdaterOrCommentorRole or null for none
  - getNotes
```
public List<Note> getNotes()
```
    Output only. The notes associated with this proposal.
    
    Returns:
    
    value or null for none
  - setNotes
```
public Proposal setNotes(List<Note> notes)
```
    Output only. The notes associated with this proposal.
    
    Parameters:
    
    notes - notes or null for none
  - getOriginatorRole
```
public String getOriginatorRole()
```
    Output only. Indicates whether the buyer/seller created the proposal.
    
    Returns:
    
    value or null for none
  - setOriginatorRole
```
public Proposal setOriginatorRole(String originatorRole)
```
    Output only. Indicates whether the buyer/seller created the proposal.
    
    Parameters:
    
    originatorRole - originatorRole or null for none
  - getPrivateAuctionId
```
public String getPrivateAuctionId()
```
    Output only. Private auction ID if this proposal is a private auction proposal.
    
    Returns:
    
    value or null for none
  - setPrivateAuctionId
```
public Proposal setPrivateAuctionId(String privateAuctionId)
```
    Output only. Private auction ID if this proposal is a private auction proposal.
    
    Parameters:
    
    privateAuctionId - privateAuctionId or null for none
  - getProposalId
```
public String getProposalId()
```
    Output only. The unique ID of the proposal.
    
    Returns:
    
    value or null for none
  - setProposalId
```
public Proposal setProposalId(String proposalId)
```
    Output only. The unique ID of the proposal.
    
    Parameters:
    
    proposalId - proposalId or null for none
  - getProposalRevision
```
public Long getProposalRevision()
```
    Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
    
    Returns:
    
    value or null for none
  - setProposalRevision
```
public Proposal setProposalRevision(Long proposalRevision)
```
    Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
    
    Parameters:
    
    proposalRevision - proposalRevision or null for none
  - getProposalState
```
public String getProposalState()
```
    Output only. The current state of the proposal.
    
    Returns:
    
    value or null for none
  - setProposalState
```
public Proposal setProposalState(String proposalState)
```
    Output only. The current state of the proposal.
    
    Parameters:
    
    proposalState - proposalState or null for none
  - getSeller
```
public Seller getSeller()
```
    Reference to the seller on the proposal. 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
  - setSeller
```
public Proposal setSeller(Seller seller)
```
    Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
    
    Parameters:
    
    seller - seller or null for none
  - getSellerContacts
```
public List<ContactInformation> getSellerContacts()
```
    Output only. Contact information for the seller.
    
    Returns:
    
    value or null for none
  - setSellerContacts
```
public Proposal setSellerContacts(List<ContactInformation> sellerContacts)
```
    Output only. Contact information for the seller.
    
    Parameters:
    
    sellerContacts - sellerContacts or null for none
  - getTermsAndConditions
```
public String getTermsAndConditions()
```
    Output only. The terms and conditions set by the publisher for this proposal.
    
    Returns:
    
    value or null for none
  - setTermsAndConditions
```
public Proposal setTermsAndConditions(String termsAndConditions)
```
    Output only. The terms and conditions set by the publisher for this proposal.
    
    Parameters:
    
    termsAndConditions - termsAndConditions or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The time when the proposal was last revised.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Proposal setUpdateTime(String updateTime)
```
    Output only. The time when the proposal was last revised.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Proposal set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Proposal clone()
```
    Overrides:
    
    clone in class GenericJson

Class Proposal

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

Proposal

Method Detail

getBilledBuyer

setBilledBuyer

getBuyer

setBuyer

getBuyerContacts

setBuyerContacts

getBuyerPrivateData

setBuyerPrivateData

getDeals

setDeals

getDisplayName

setDisplayName

getIsRenegotiating

setIsRenegotiating

getIsSetupComplete

setIsSetupComplete

getLastUpdaterOrCommentorRole

setLastUpdaterOrCommentorRole

getNotes

setNotes

getOriginatorRole

setOriginatorRole

getPrivateAuctionId

setPrivateAuctionId

getProposalId

setProposalId

getProposalRevision

setProposalRevision

getProposalState

setProposalState

getSeller

setSeller

getSellerContacts

setSellerContacts

getTermsAndConditions

setTermsAndConditions

getUpdateTime

setUpdateTime

set

clone