Class ProposalMarketplaceInfo.Builder (0.62.0)

public static final class ProposalMarketplaceInfo.Builder extends GeneratedMessage.Builder<ProposalMarketplaceInfo.Builder> implements ProposalMarketplaceInfoOrBuilder

Marketplace info for a Proposal with a corresponding order in Marketplace.

Protobuf type google.ads.admanager.v1.ProposalMarketplaceInfo

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ProposalMarketplaceInfo build()
Returns
Type Description
ProposalMarketplaceInfo

buildPartial()

public ProposalMarketplaceInfo buildPartial()
Returns
Type Description
ProposalMarketplaceInfo

clear()

public ProposalMarketplaceInfo.Builder clear()
Returns
Type Description
ProposalMarketplaceInfo.Builder
Overrides

clearBuyerAccountId()

public ProposalMarketplaceInfo.Builder clearBuyerAccountId()

Required. The account ID of the buyer that this Proposal is being negotiated with.

optional int64 buyer_account_id = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

clearDraftProposal()

public ProposalMarketplaceInfo.Builder clearDraftProposal()

Output only. Whether the non-free-editable fields of a 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 newVersionFromBuyer to true. You will then need to call ProposalService.BatchDiscardDraftProposals to revert your edits to get the buyer's latest changes.

optional bool draft_proposal = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

clearMarketplaceComment()

public ProposalMarketplaceInfo.Builder clearMarketplaceComment()

Optional. The comment on the Proposal to be sent to the buyer.

optional string marketplace_comment = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

clearMarketplaceOrderId()

public ProposalMarketplaceInfo.Builder clearMarketplaceOrderId()

Output only. The 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.

optional string marketplace_order_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

clearNegotiationStatus()

public ProposalMarketplaceInfo.Builder clearNegotiationStatus()

Output only. The negotiation status of the Proposal.

optional .google.ads.admanager.v1.ProposalNegotiationStatusEnum.ProposalNegotiationStatus negotiation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

clearNewVersionFromBuyer()

public ProposalMarketplaceInfo.Builder clearNewVersionFromBuyer()

Output only. Indicates 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., draftProposal is true).

optional bool new_version_from_buyer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

clearPartnerClientId()

public ProposalMarketplaceInfo.Builder clearPartnerClientId()

Output only. The ID used to represent the Display & Video 360 client buyer partner ID (if Display & Video 360) or the Authorized Buyers client buyer account ID.

optional string partner_client_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

getBuyerAccountId()

public long getBuyerAccountId()

Required. The account ID of the buyer that this Proposal is being negotiated with.

optional int64 buyer_account_id = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The buyerAccountId.

getDefaultInstanceForType()

public ProposalMarketplaceInfo getDefaultInstanceForType()
Returns
Type Description
ProposalMarketplaceInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDraftProposal()

public boolean getDraftProposal()

Output only. Whether the non-free-editable fields of a 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 newVersionFromBuyer to true. You will then need to call ProposalService.BatchDiscardDraftProposals to revert your edits to get the buyer's latest changes.

optional bool draft_proposal = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The draftProposal.

getMarketplaceComment()

public String getMarketplaceComment()

Optional. The comment on the Proposal to be sent to the buyer.

optional string marketplace_comment = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The marketplaceComment.

getMarketplaceCommentBytes()

public ByteString getMarketplaceCommentBytes()

Optional. The comment on the Proposal to be sent to the buyer.

optional string marketplace_comment = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for marketplaceComment.

getMarketplaceOrderId()

public String getMarketplaceOrderId()

Output only. The 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.

optional string marketplace_order_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The marketplaceOrderId.

getMarketplaceOrderIdBytes()

public ByteString getMarketplaceOrderIdBytes()

Output only. The 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.

optional string marketplace_order_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for marketplaceOrderId.

getNegotiationStatus()

public ProposalNegotiationStatusEnum.ProposalNegotiationStatus getNegotiationStatus()

Output only. The negotiation status of the Proposal.

optional .google.ads.admanager.v1.ProposalNegotiationStatusEnum.ProposalNegotiationStatus negotiation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProposalNegotiationStatusEnum.ProposalNegotiationStatus

The negotiationStatus.

getNegotiationStatusValue()

public int getNegotiationStatusValue()

Output only. The negotiation status of the Proposal.

optional .google.ads.admanager.v1.ProposalNegotiationStatusEnum.ProposalNegotiationStatus negotiation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for negotiationStatus.

getNewVersionFromBuyer()

public boolean getNewVersionFromBuyer()

Output only. Indicates 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., draftProposal is true).

optional bool new_version_from_buyer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The newVersionFromBuyer.

getPartnerClientId()

public String getPartnerClientId()

Output only. The ID used to represent the Display & Video 360 client buyer partner ID (if Display & Video 360) or the Authorized Buyers client buyer account ID.

optional string partner_client_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The partnerClientId.

getPartnerClientIdBytes()

public ByteString getPartnerClientIdBytes()

Output only. The ID used to represent the Display & Video 360 client buyer partner ID (if Display & Video 360) or the Authorized Buyers client buyer account ID.

optional string partner_client_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for partnerClientId.

hasBuyerAccountId()

public boolean hasBuyerAccountId()

Required. The account ID of the buyer that this Proposal is being negotiated with.

optional int64 buyer_account_id = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the buyerAccountId field is set.

hasDraftProposal()

public boolean hasDraftProposal()

Output only. Whether the non-free-editable fields of a 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 newVersionFromBuyer to true. You will then need to call ProposalService.BatchDiscardDraftProposals to revert your edits to get the buyer's latest changes.

optional bool draft_proposal = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the draftProposal field is set.

hasMarketplaceComment()

public boolean hasMarketplaceComment()

Optional. The comment on the Proposal to be sent to the buyer.

optional string marketplace_comment = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the marketplaceComment field is set.

hasMarketplaceOrderId()

public boolean hasMarketplaceOrderId()

Output only. The 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.

optional string marketplace_order_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the marketplaceOrderId field is set.

hasNegotiationStatus()

public boolean hasNegotiationStatus()

Output only. The negotiation status of the Proposal.

optional .google.ads.admanager.v1.ProposalNegotiationStatusEnum.ProposalNegotiationStatus negotiation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the negotiationStatus field is set.

hasNewVersionFromBuyer()

public boolean hasNewVersionFromBuyer()

Output only. Indicates 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., draftProposal is true).

optional bool new_version_from_buyer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the newVersionFromBuyer field is set.

hasPartnerClientId()

public boolean hasPartnerClientId()

Output only. The ID used to represent the Display & Video 360 client buyer partner ID (if Display & Video 360) or the Authorized Buyers client buyer account ID.

optional string partner_client_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the partnerClientId field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ProposalMarketplaceInfo other)

public ProposalMarketplaceInfo.Builder mergeFrom(ProposalMarketplaceInfo other)
Parameter
Name Description
other ProposalMarketplaceInfo
Returns
Type Description
ProposalMarketplaceInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProposalMarketplaceInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProposalMarketplaceInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ProposalMarketplaceInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ProposalMarketplaceInfo.Builder
Overrides

setBuyerAccountId(long value)

public ProposalMarketplaceInfo.Builder setBuyerAccountId(long value)

Required. The account ID of the buyer that this Proposal is being negotiated with.

optional int64 buyer_account_id = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value long

The buyerAccountId to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setDraftProposal(boolean value)

public ProposalMarketplaceInfo.Builder setDraftProposal(boolean value)

Output only. Whether the non-free-editable fields of a 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 newVersionFromBuyer to true. You will then need to call ProposalService.BatchDiscardDraftProposals to revert your edits to get the buyer's latest changes.

optional bool draft_proposal = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The draftProposal to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setMarketplaceComment(String value)

public ProposalMarketplaceInfo.Builder setMarketplaceComment(String value)

Optional. The comment on the Proposal to be sent to the buyer.

optional string marketplace_comment = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The marketplaceComment to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setMarketplaceCommentBytes(ByteString value)

public ProposalMarketplaceInfo.Builder setMarketplaceCommentBytes(ByteString value)

Optional. The comment on the Proposal to be sent to the buyer.

optional string marketplace_comment = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for marketplaceComment to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setMarketplaceOrderId(String value)

public ProposalMarketplaceInfo.Builder setMarketplaceOrderId(String value)

Output only. The 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.

optional string marketplace_order_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The marketplaceOrderId to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setMarketplaceOrderIdBytes(ByteString value)

public ProposalMarketplaceInfo.Builder setMarketplaceOrderIdBytes(ByteString value)

Output only. The 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.

optional string marketplace_order_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for marketplaceOrderId to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setNegotiationStatus(ProposalNegotiationStatusEnum.ProposalNegotiationStatus value)

public ProposalMarketplaceInfo.Builder setNegotiationStatus(ProposalNegotiationStatusEnum.ProposalNegotiationStatus value)

Output only. The negotiation status of the Proposal.

optional .google.ads.admanager.v1.ProposalNegotiationStatusEnum.ProposalNegotiationStatus negotiation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ProposalNegotiationStatusEnum.ProposalNegotiationStatus

The negotiationStatus to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setNegotiationStatusValue(int value)

public ProposalMarketplaceInfo.Builder setNegotiationStatusValue(int value)

Output only. The negotiation status of the Proposal.

optional .google.ads.admanager.v1.ProposalNegotiationStatusEnum.ProposalNegotiationStatus negotiation_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for negotiationStatus to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setNewVersionFromBuyer(boolean value)

public ProposalMarketplaceInfo.Builder setNewVersionFromBuyer(boolean value)

Output only. Indicates 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., draftProposal is true).

optional bool new_version_from_buyer = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The newVersionFromBuyer to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setPartnerClientId(String value)

public ProposalMarketplaceInfo.Builder setPartnerClientId(String value)

Output only. The ID used to represent the Display & Video 360 client buyer partner ID (if Display & Video 360) or the Authorized Buyers client buyer account ID.

optional string partner_client_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The partnerClientId to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.

setPartnerClientIdBytes(ByteString value)

public ProposalMarketplaceInfo.Builder setPartnerClientIdBytes(ByteString value)

Output only. The ID used to represent the Display & Video 360 client buyer partner ID (if Display & Video 360) or the Authorized Buyers client buyer account ID.

optional string partner_client_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for partnerClientId to set.

Returns
Type Description
ProposalMarketplaceInfo.Builder

This builder for chaining.