Class Proposal.Builder (0.62.0)

public static final class Proposal.Builder extends GeneratedMessage.Builder<Proposal.Builder> implements ProposalOrBuilder

A Proposal represents an agreement between an interactive advertising seller and a buyer that specifies the details of an advertising campaign.

Protobuf type google.ads.admanager.v1.Proposal

Implements

ProposalOrBuilder

Static Methods

getDescriptor()

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

Methods

addAgencies(ProposalCompanyAssociation value)

public Proposal.Builder addAgencies(ProposalCompanyAssociation value)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ProposalCompanyAssociation
Returns
Type Description
Proposal.Builder

addAgencies(ProposalCompanyAssociation.Builder builderForValue)

public Proposal.Builder addAgencies(ProposalCompanyAssociation.Builder builderForValue)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ProposalCompanyAssociation.Builder
Returns
Type Description
Proposal.Builder

addAgencies(int index, ProposalCompanyAssociation value)

public Proposal.Builder addAgencies(int index, ProposalCompanyAssociation value)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value ProposalCompanyAssociation
Returns
Type Description
Proposal.Builder

addAgencies(int index, ProposalCompanyAssociation.Builder builderForValue)

public Proposal.Builder addAgencies(int index, ProposalCompanyAssociation.Builder builderForValue)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue ProposalCompanyAssociation.Builder
Returns
Type Description
Proposal.Builder

addAgenciesBuilder()

public ProposalCompanyAssociation.Builder addAgenciesBuilder()

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProposalCompanyAssociation.Builder

addAgenciesBuilder(int index)

public ProposalCompanyAssociation.Builder addAgenciesBuilder(int index)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ProposalCompanyAssociation.Builder

addAllAgencies(Iterable<? extends ProposalCompanyAssociation> values)

public Proposal.Builder addAllAgencies(Iterable<? extends ProposalCompanyAssociation> values)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.ProposalCompanyAssociation>
Returns
Type Description
Proposal.Builder

addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

public Proposal.Builder addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
Proposal.Builder

addAllAppliedTeams(Iterable<String> values)

public Proposal.Builder addAllAppliedTeams(Iterable<String> values)

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The appliedTeams to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addAllCustomFieldValues(Iterable<? extends CustomFieldValue> values)

public Proposal.Builder addAllCustomFieldValues(Iterable<? extends CustomFieldValue> values)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.CustomFieldValue>
Returns
Type Description
Proposal.Builder

addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

public Proposal.Builder addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
Proposal.Builder

addAllSalesPlannerUsers(Iterable<String> values)

public Proposal.Builder addAllSalesPlannerUsers(Iterable<String> values)

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The salesPlannerUsers to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addAllSellerContactUsers(Iterable<String> values)

public Proposal.Builder addAllSellerContactUsers(Iterable<String> values)

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The sellerContactUsers to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addAppliedLabels(AppliedLabel value)

public Proposal.Builder addAppliedLabels(AppliedLabel value)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AppliedLabel
Returns
Type Description
Proposal.Builder

addAppliedLabels(AppliedLabel.Builder builderForValue)

public Proposal.Builder addAppliedLabels(AppliedLabel.Builder builderForValue)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AppliedLabel.Builder
Returns
Type Description
Proposal.Builder

addAppliedLabels(int index, AppliedLabel value)

public Proposal.Builder addAppliedLabels(int index, AppliedLabel value)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Proposal.Builder

addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Proposal.Builder addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Proposal.Builder

addAppliedLabelsBuilder()

public AppliedLabel.Builder addAppliedLabelsBuilder()

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppliedLabel.Builder

addAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addAppliedLabelsBuilder(int index)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

addAppliedTeams(String value)

public Proposal.Builder addAppliedTeams(String value)

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The appliedTeams to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addAppliedTeamsBytes(ByteString value)

public Proposal.Builder addAppliedTeamsBytes(ByteString value)

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the appliedTeams to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addCustomFieldValues(CustomFieldValue value)

public Proposal.Builder addCustomFieldValues(CustomFieldValue value)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CustomFieldValue
Returns
Type Description
Proposal.Builder

addCustomFieldValues(CustomFieldValue.Builder builderForValue)

public Proposal.Builder addCustomFieldValues(CustomFieldValue.Builder builderForValue)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CustomFieldValue.Builder
Returns
Type Description
Proposal.Builder

addCustomFieldValues(int index, CustomFieldValue value)

public Proposal.Builder addCustomFieldValues(int index, CustomFieldValue value)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value CustomFieldValue
Returns
Type Description
Proposal.Builder

addCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

public Proposal.Builder addCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue CustomFieldValue.Builder
Returns
Type Description
Proposal.Builder

addCustomFieldValuesBuilder()

public CustomFieldValue.Builder addCustomFieldValuesBuilder()

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomFieldValue.Builder

addCustomFieldValuesBuilder(int index)

public CustomFieldValue.Builder addCustomFieldValuesBuilder(int index)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValue.Builder

addEffectiveAppliedLabels(AppliedLabel value)

public Proposal.Builder addEffectiveAppliedLabels(AppliedLabel value)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value AppliedLabel
Returns
Type Description
Proposal.Builder

addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

public Proposal.Builder addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue AppliedLabel.Builder
Returns
Type Description
Proposal.Builder

addEffectiveAppliedLabels(int index, AppliedLabel value)

public Proposal.Builder addEffectiveAppliedLabels(int index, AppliedLabel value)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Proposal.Builder

addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Proposal.Builder addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Proposal.Builder

addEffectiveAppliedLabelsBuilder()

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder()

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AppliedLabel.Builder

addEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder(int index)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

addSalesPlannerUsers(String value)

public Proposal.Builder addSalesPlannerUsers(String value)

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The salesPlannerUsers to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addSalesPlannerUsersBytes(ByteString value)

public Proposal.Builder addSalesPlannerUsersBytes(ByteString value)

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the salesPlannerUsers to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addSellerContactUsers(String value)

public Proposal.Builder addSellerContactUsers(String value)

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The sellerContactUsers to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

addSellerContactUsersBytes(ByteString value)

public Proposal.Builder addSellerContactUsersBytes(ByteString value)

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the sellerContactUsers to add.

Returns
Type Description
Proposal.Builder

This builder for chaining.

build()

public Proposal build()
Returns
Type Description
Proposal

buildPartial()

public Proposal buildPartial()
Returns
Type Description
Proposal

clear()

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

clearAdvertiser()

public Proposal.Builder clearAdvertiser()

Required. The resource name of the Company of type ADVERTISER to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to Order.advertiser. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{network_code}/companies/{company_id}

optional string advertiser = 57 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearAgencies()

public Proposal.Builder clearAgencies()

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Proposal.Builder

clearAppliedLabels()

public Proposal.Builder clearAppliedLabels()

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Proposal.Builder

clearAppliedTeams()

public Proposal.Builder clearAppliedTeams()

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearArchived()

public Proposal.Builder clearArchived()

Output only. Whether the Proposal is archived or not.

optional bool archived = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearBuyerRfp()

public Proposal.Builder clearBuyerRfp()

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Proposal.Builder

clearCurrencyCode()

public Proposal.Builder clearCurrencyCode()

Optional. The currency code of this Proposal. If not directly set, the currency code will be the network's currency code.

string currency_code = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearCustomFieldValues()

public Proposal.Builder clearCustomFieldValues()

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Proposal.Builder

clearDeliveryPausingEnabled()

public Proposal.Builder clearDeliveryPausingEnabled()

Optional. Non-empty default. Whether delivery of the Proposal can be paused. Defaults to true. If false, the buyer and the seller agree that the Proposal should not be paused.

optional bool delivery_pausing_enabled = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearDisplayName()

public Proposal.Builder clearDisplayName()

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.displayName when the proposal turns into an order.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearEffectiveAppliedLabels()

public Proposal.Builder clearEffectiveAppliedLabels()

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Proposal.Builder

clearEndTime()

public Proposal.Builder clearEndTime()

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Proposal.Builder

clearMarketplaceInfo()

public Proposal.Builder clearMarketplaceInfo()

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Proposal.Builder

clearName()

public Proposal.Builder clearName()

Identifier. The resource name of the Proposal. Format: networks/{network_code}/proposals/{proposal_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearNotes()

public Proposal.Builder clearNotes()

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.

optional string notes = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearOrder()

public Proposal.Builder clearOrder()

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{network_code}/orders/{order_id}

optional string order = 41 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearPrimarySalesperson()

public Proposal.Builder clearPrimarySalesperson()

Optional. The resource name of the User representing the primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. Format: networks/{network_code}/users/{user_id}

optional string primary_salesperson = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearSalesPlannerUsers()

public Proposal.Builder clearSalesPlannerUsers()

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearSellerContactUsers()

public Proposal.Builder clearSellerContactUsers()

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearSold()

public Proposal.Builder clearSold()

Output only. Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is APPROVED or PAUSED.

optional bool sold = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearStartTime()

public Proposal.Builder clearStartTime()

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Proposal.Builder

clearSupplyPath()

public Proposal.Builder clearSupplyPath()

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to DEMAND_SIDE_PLATFORM.

optional .google.ads.admanager.v1.SupplyPathTypeEnum.SupplyPathType supply_path = 42 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearTrafficker()

public Proposal.Builder clearTrafficker()

Optional. The resource name of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.trafficker. Format: networks/{network_code}/users/{user_id}

optional string trafficker = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Proposal.Builder

This builder for chaining.

clearUpdateTime()

public Proposal.Builder clearUpdateTime()

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Proposal.Builder

getAdvertiser()

public String getAdvertiser()

Required. The resource name of the Company of type ADVERTISER to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to Order.advertiser. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{network_code}/companies/{company_id}

optional string advertiser = 57 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The advertiser.

getAdvertiserBytes()

public ByteString getAdvertiserBytes()

Required. The resource name of the Company of type ADVERTISER to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to Order.advertiser. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{network_code}/companies/{company_id}

optional string advertiser = 57 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for advertiser.

getAgencies(int index)

public ProposalCompanyAssociation getAgencies(int index)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ProposalCompanyAssociation

getAgenciesBuilder(int index)

public ProposalCompanyAssociation.Builder getAgenciesBuilder(int index)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ProposalCompanyAssociation.Builder

getAgenciesBuilderList()

public List<ProposalCompanyAssociation.Builder> getAgenciesBuilderList()

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAgenciesCount()

public int getAgenciesCount()

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAgenciesList()

public List<ProposalCompanyAssociation> getAgenciesList()

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ProposalCompanyAssociation>

getAgenciesOrBuilder(int index)

public ProposalCompanyAssociationOrBuilder getAgenciesOrBuilder(int index)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ProposalCompanyAssociationOrBuilder

getAgenciesOrBuilderList()

public List<? extends ProposalCompanyAssociationOrBuilder> getAgenciesOrBuilderList()

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ProposalCompanyAssociationOrBuilder>

getAppliedLabels(int index)

public AppliedLabel getAppliedLabels(int index)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getAppliedLabelsBuilder(int index)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

getAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getAppliedLabelsBuilderList()

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAppliedLabelsCount()

public int getAppliedLabelsCount()

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAppliedLabelsList()

public List<AppliedLabel> getAppliedLabelsList()

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AppliedLabel>

getAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getAppliedTeams(int index)

public String getAppliedTeams(int index)

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The appliedTeams at the given index.

getAppliedTeamsBytes(int index)

public ByteString getAppliedTeamsBytes(int index)

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the appliedTeams at the given index.

getAppliedTeamsCount()

public int getAppliedTeamsCount()

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of appliedTeams.

getAppliedTeamsList()

public ProtocolStringList getAppliedTeamsList()

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the appliedTeams.

getArchived()

public boolean getArchived()

Output only. Whether the Proposal is archived or not.

optional bool archived = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The archived.

getBuyerRfp()

public BuyerRfp getBuyerRfp()

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BuyerRfp

The buyerRfp.

getBuyerRfpBuilder()

public BuyerRfp.Builder getBuyerRfpBuilder()

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BuyerRfp.Builder

getBuyerRfpOrBuilder()

public BuyerRfpOrBuilder getBuyerRfpOrBuilder()

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BuyerRfpOrBuilder

getCurrencyCode()

public String getCurrencyCode()

Optional. The currency code of this Proposal. If not directly set, the currency code will be the network's currency code.

string currency_code = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

Optional. The currency code of this Proposal. If not directly set, the currency code will be the network's currency code.

string currency_code = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getCustomFieldValues(int index)

public CustomFieldValue getCustomFieldValues(int index)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValue

getCustomFieldValuesBuilder(int index)

public CustomFieldValue.Builder getCustomFieldValuesBuilder(int index)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValue.Builder

getCustomFieldValuesBuilderList()

public List<CustomFieldValue.Builder> getCustomFieldValuesBuilderList()

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getCustomFieldValuesCount()

public int getCustomFieldValuesCount()

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCustomFieldValuesList()

public List<CustomFieldValue> getCustomFieldValuesList()

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<CustomFieldValue>

getCustomFieldValuesOrBuilder(int index)

public CustomFieldValueOrBuilder getCustomFieldValuesOrBuilder(int index)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValueOrBuilder

getCustomFieldValuesOrBuilderList()

public List<? extends CustomFieldValueOrBuilder> getCustomFieldValuesOrBuilderList()

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CustomFieldValueOrBuilder>

getDefaultInstanceForType()

public Proposal getDefaultInstanceForType()
Returns
Type Description
Proposal

getDeliveryPausingEnabled()

public boolean getDeliveryPausingEnabled()

Optional. Non-empty default. Whether delivery of the Proposal can be paused. Defaults to true. If false, the buyer and the seller agree that the Proposal should not be paused.

optional bool delivery_pausing_enabled = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

The deliveryPausingEnabled.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.displayName when the proposal turns into an order.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.displayName when the proposal turns into an order.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEffectiveAppliedLabels(int index)

public AppliedLabel getEffectiveAppliedLabels(int index)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getEffectiveAppliedLabelsBuilder(int index)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

getEffectiveAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getEffectiveAppliedLabelsBuilderList()

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getEffectiveAppliedLabelsCount()

public int getEffectiveAppliedLabelsCount()

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEffectiveAppliedLabelsList()

public List<AppliedLabel> getEffectiveAppliedLabelsList()

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AppliedLabel>

getEffectiveAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getEffectiveAppliedLabelsOrBuilder(int index)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getEffectiveAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getEffectiveAppliedLabelsOrBuilderList()

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getEndTime()

public Timestamp getEndTime()

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getMarketplaceInfo()

public ProposalMarketplaceInfo getMarketplaceInfo()

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProposalMarketplaceInfo

The marketplaceInfo.

getMarketplaceInfoBuilder()

public ProposalMarketplaceInfo.Builder getMarketplaceInfoBuilder()

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProposalMarketplaceInfo.Builder

getMarketplaceInfoOrBuilder()

public ProposalMarketplaceInfoOrBuilder getMarketplaceInfoOrBuilder()

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProposalMarketplaceInfoOrBuilder

getName()

public String getName()

Identifier. The resource name of the Proposal. Format: networks/{network_code}/proposals/{proposal_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the Proposal. Format: networks/{network_code}/proposals/{proposal_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNotes()

public String getNotes()

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.

optional string notes = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The notes.

getNotesBytes()

public ByteString getNotesBytes()

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.

optional string notes = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for notes.

getOrder()

public String getOrder()

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{network_code}/orders/{order_id}

optional string order = 41 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The order.

getOrderBytes()

public ByteString getOrderBytes()

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{network_code}/orders/{order_id}

optional string order = 41 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for order.

getPrimarySalesperson()

public String getPrimarySalesperson()

Optional. The resource name of the User representing the primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. Format: networks/{network_code}/users/{user_id}

optional string primary_salesperson = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The primarySalesperson.

getPrimarySalespersonBytes()

public ByteString getPrimarySalespersonBytes()

Optional. The resource name of the User representing the primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. Format: networks/{network_code}/users/{user_id}

optional string primary_salesperson = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for primarySalesperson.

getSalesPlannerUsers(int index)

public String getSalesPlannerUsers(int index)

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The salesPlannerUsers at the given index.

getSalesPlannerUsersBytes(int index)

public ByteString getSalesPlannerUsersBytes(int index)

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the salesPlannerUsers at the given index.

getSalesPlannerUsersCount()

public int getSalesPlannerUsersCount()

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of salesPlannerUsers.

getSalesPlannerUsersList()

public ProtocolStringList getSalesPlannerUsersList()

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the salesPlannerUsers.

getSellerContactUsers(int index)

public String getSellerContactUsers(int index)

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The sellerContactUsers at the given index.

getSellerContactUsersBytes(int index)

public ByteString getSellerContactUsersBytes(int index)

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the sellerContactUsers at the given index.

getSellerContactUsersCount()

public int getSellerContactUsersCount()

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of sellerContactUsers.

getSellerContactUsersList()

public ProtocolStringList getSellerContactUsersList()

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the sellerContactUsers.

getSold()

public boolean getSold()

Output only. Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is APPROVED or PAUSED.

optional bool sold = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The sold.

getStartTime()

public Timestamp getStartTime()

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getSupplyPath()

public SupplyPathTypeEnum.SupplyPathType getSupplyPath()

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to DEMAND_SIDE_PLATFORM.

optional .google.ads.admanager.v1.SupplyPathTypeEnum.SupplyPathType supply_path = 42 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
SupplyPathTypeEnum.SupplyPathType

The supplyPath.

getSupplyPathValue()

public int getSupplyPathValue()

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to DEMAND_SIDE_PLATFORM.

optional .google.ads.admanager.v1.SupplyPathTypeEnum.SupplyPathType supply_path = 42 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for supplyPath.

getTrafficker()

public String getTrafficker()

Optional. The resource name of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.trafficker. Format: networks/{network_code}/users/{user_id}

optional string trafficker = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The trafficker.

getTraffickerBytes()

public ByteString getTraffickerBytes()

Optional. The resource name of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.trafficker. Format: networks/{network_code}/users/{user_id}

optional string trafficker = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for trafficker.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAdvertiser()

public boolean hasAdvertiser()

Required. The resource name of the Company of type ADVERTISER to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to Order.advertiser. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{network_code}/companies/{company_id}

optional string advertiser = 57 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the advertiser field is set.

hasArchived()

public boolean hasArchived()

Output only. Whether the Proposal is archived or not.

optional bool archived = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the archived field is set.

hasBuyerRfp()

public boolean hasBuyerRfp()

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the buyerRfp field is set.

hasDeliveryPausingEnabled()

public boolean hasDeliveryPausingEnabled()

Optional. Non-empty default. Whether delivery of the Proposal can be paused. Defaults to true. If false, the buyer and the seller agree that the Proposal should not be paused.

optional bool delivery_pausing_enabled = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the deliveryPausingEnabled field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.displayName when the proposal turns into an order.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasEndTime()

public boolean hasEndTime()

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasMarketplaceInfo()

public boolean hasMarketplaceInfo()

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the marketplaceInfo field is set.

hasNotes()

public boolean hasNotes()

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.

optional string notes = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the notes field is set.

hasOrder()

public boolean hasOrder()

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{network_code}/orders/{order_id}

optional string order = 41 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the order field is set.

hasPrimarySalesperson()

public boolean hasPrimarySalesperson()

Optional. The resource name of the User representing the primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. Format: networks/{network_code}/users/{user_id}

optional string primary_salesperson = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the primarySalesperson field is set.

hasSold()

public boolean hasSold()

Output only. Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is APPROVED or PAUSED.

optional bool sold = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sold field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasSupplyPath()

public boolean hasSupplyPath()

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to DEMAND_SIDE_PLATFORM.

optional .google.ads.admanager.v1.SupplyPathTypeEnum.SupplyPathType supply_path = 42 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the supplyPath field is set.

hasTrafficker()

public boolean hasTrafficker()

Optional. The resource name of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.trafficker. Format: networks/{network_code}/users/{user_id}

optional string trafficker = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the trafficker field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBuyerRfp(BuyerRfp value)

public Proposal.Builder mergeBuyerRfp(BuyerRfp value)

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BuyerRfp
Returns
Type Description
Proposal.Builder

mergeEndTime(Timestamp value)

public Proposal.Builder mergeEndTime(Timestamp value)

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Proposal.Builder

mergeFrom(Proposal other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMarketplaceInfo(ProposalMarketplaceInfo value)

public Proposal.Builder mergeMarketplaceInfo(ProposalMarketplaceInfo value)

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ProposalMarketplaceInfo
Returns
Type Description
Proposal.Builder

mergeStartTime(Timestamp value)

public Proposal.Builder mergeStartTime(Timestamp value)

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Proposal.Builder

mergeUpdateTime(Timestamp value)

public Proposal.Builder mergeUpdateTime(Timestamp value)

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Proposal.Builder

removeAgencies(int index)

public Proposal.Builder removeAgencies(int index)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Proposal.Builder

removeAppliedLabels(int index)

public Proposal.Builder removeAppliedLabels(int index)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Proposal.Builder

removeCustomFieldValues(int index)

public Proposal.Builder removeCustomFieldValues(int index)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Proposal.Builder

removeEffectiveAppliedLabels(int index)

public Proposal.Builder removeEffectiveAppliedLabels(int index)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Proposal.Builder

setAdvertiser(String value)

public Proposal.Builder setAdvertiser(String value)

Required. The resource name of the Company of type ADVERTISER to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to Order.advertiser. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{network_code}/companies/{company_id}

optional string advertiser = 57 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The advertiser to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setAdvertiserBytes(ByteString value)

public Proposal.Builder setAdvertiserBytes(ByteString value)

Required. The resource name of the Company of type ADVERTISER to which this Proposal belongs. This attribute is required when the proposal turns into an order, and will be copied to Order.advertiser. This attribute becomes read-only once the Proposal has been pushed. Format: networks/{network_code}/companies/{company_id}

optional string advertiser = 57 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for advertiser to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setAgencies(int index, ProposalCompanyAssociation value)

public Proposal.Builder setAgencies(int index, ProposalCompanyAssociation value)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value ProposalCompanyAssociation
Returns
Type Description
Proposal.Builder

setAgencies(int index, ProposalCompanyAssociation.Builder builderForValue)

public Proposal.Builder setAgencies(int index, ProposalCompanyAssociation.Builder builderForValue)

Optional. List of agencies and the set of Contacts associated with each agency. A Proposal can have at most one Company with PRIMARY_AGENCY type, but a Company can appear more than once with different ProposalCompanyAssociationType values. If a primary agency exists, its ProposalCompanyAssociation.company will be copied to Order.agency when the proposal turns into an order.

repeated .google.ads.admanager.v1.ProposalCompanyAssociation agencies = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue ProposalCompanyAssociation.Builder
Returns
Type Description
Proposal.Builder

setAppliedLabels(int index, AppliedLabel value)

public Proposal.Builder setAppliedLabels(int index, AppliedLabel value)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Proposal.Builder

setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Proposal.Builder setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Optional. The set of labels applied directly to the Proposal.

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Proposal.Builder

setAppliedTeams(int index, String value)

public Proposal.Builder setAppliedTeams(int index, String value)

Optional. The resource names of the teams directly applied to the Proposal. Format: networks/{network_code}/teams/{team_id}

repeated string applied_teams = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The appliedTeams to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setArchived(boolean value)

public Proposal.Builder setArchived(boolean value)

Output only. Whether the Proposal is archived or not.

optional bool archived = 50 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The archived to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setBuyerRfp(BuyerRfp value)

public Proposal.Builder setBuyerRfp(BuyerRfp value)

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BuyerRfp
Returns
Type Description
Proposal.Builder

setBuyerRfp(BuyerRfp.Builder builderForValue)

public Proposal.Builder setBuyerRfp(BuyerRfp.Builder builderForValue)

Output only. The buyer RFP associated with this Proposal. This field will be unset if the proposal is not initiated from an RFP.

.google.ads.admanager.v1.BuyerRfp buyer_rfp = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue BuyerRfp.Builder
Returns
Type Description
Proposal.Builder

setCurrencyCode(String value)

public Proposal.Builder setCurrencyCode(String value)

Optional. The currency code of this Proposal. If not directly set, the currency code will be the network's currency code.

string currency_code = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The currencyCode to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public Proposal.Builder setCurrencyCodeBytes(ByteString value)

Optional. The currency code of this Proposal. If not directly set, the currency code will be the network's currency code.

string currency_code = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for currencyCode to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setCustomFieldValues(int index, CustomFieldValue value)

public Proposal.Builder setCustomFieldValues(int index, CustomFieldValue value)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value CustomFieldValue
Returns
Type Description
Proposal.Builder

setCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

public Proposal.Builder setCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

Optional. The values of the custom fields associated with the Proposal.

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue CustomFieldValue.Builder
Returns
Type Description
Proposal.Builder

setDeliveryPausingEnabled(boolean value)

public Proposal.Builder setDeliveryPausingEnabled(boolean value)

Optional. Non-empty default. Whether delivery of the Proposal can be paused. Defaults to true. If false, the buyer and the seller agree that the Proposal should not be paused.

optional bool delivery_pausing_enabled = 40 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value boolean

The deliveryPausingEnabled to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setDisplayName(String value)

public Proposal.Builder setDisplayName(String value)

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.displayName when the proposal turns into an order.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Proposal.Builder setDisplayNameBytes(ByteString value)

Required. The display name of the Proposal. This value has a maximum length of 255 characters. This value is copied to Order.displayName when the proposal turns into an order.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setEffectiveAppliedLabels(int index, AppliedLabel value)

public Proposal.Builder setEffectiveAppliedLabels(int index, AppliedLabel value)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Proposal.Builder

setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Proposal.Builder setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

Output only. The set of labels applied to the Proposal including inherited values. Only labels that directly affect the entity are listed here. If they are negated, only the negated version is visible.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Proposal.Builder

setEndTime(Timestamp value)

public Proposal.Builder setEndTime(Timestamp value)

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Proposal.Builder

setEndTime(Timestamp.Builder builderForValue)

public Proposal.Builder setEndTime(Timestamp.Builder builderForValue)

Output only. The time at which the Order and LineItems associated with the Proposal stop serving. This attribute is derived from the [ProposalLineItem][] with the latest endTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have an end time.

optional .google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Proposal.Builder

setMarketplaceInfo(ProposalMarketplaceInfo value)

public Proposal.Builder setMarketplaceInfo(ProposalMarketplaceInfo value)

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ProposalMarketplaceInfo
Returns
Type Description
Proposal.Builder

setMarketplaceInfo(ProposalMarketplaceInfo.Builder builderForValue)

public Proposal.Builder setMarketplaceInfo(ProposalMarketplaceInfo.Builder builderForValue)

Optional. The marketplace info of this Proposal if it has a corresponding Order in Marketplace.

.google.ads.admanager.v1.ProposalMarketplaceInfo marketplace_info = 36 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ProposalMarketplaceInfo.Builder
Returns
Type Description
Proposal.Builder

setName(String value)

public Proposal.Builder setName(String value)

Identifier. The resource name of the Proposal. Format: networks/{network_code}/proposals/{proposal_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Proposal.Builder setNameBytes(ByteString value)

Identifier. The resource name of the Proposal. Format: networks/{network_code}/proposals/{proposal_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setNotes(String value)

public Proposal.Builder setNotes(String value)

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.

optional string notes = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The notes to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setNotesBytes(ByteString value)

public Proposal.Builder setNotesBytes(ByteString value)

Optional. Provides any additional notes that may annotate the Proposal. This attribute has a maximum length of 65,535 characters.

optional string notes = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for notes to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setOrder(String value)

public Proposal.Builder setOrder(String value)

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{network_code}/orders/{order_id}

optional string order = 41 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The order to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setOrderBytes(ByteString value)

public Proposal.Builder setOrderBytes(ByteString value)

Output only. The resource name of the corresponding Order. This will not be set if the Proposal has not been pushed to Ad Manager. Format: networks/{network_code}/orders/{order_id}

optional string order = 41 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for order to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setPrimarySalesperson(String value)

public Proposal.Builder setPrimarySalesperson(String value)

Optional. The resource name of the User representing the primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. Format: networks/{network_code}/users/{user_id}

optional string primary_salesperson = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The primarySalesperson to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setPrimarySalespersonBytes(ByteString value)

public Proposal.Builder setPrimarySalespersonBytes(ByteString value)

Optional. The resource name of the User representing the primary salesperson who brokered the transaction with the advertiser. This attribute is required when the proposal turns into an order. Format: networks/{network_code}/users/{user_id}

optional string primary_salesperson = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for primarySalesperson to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setSalesPlannerUsers(int index, String value)

public Proposal.Builder setSalesPlannerUsers(int index, String value)

Optional. The resource names of the Users representing the sales planners of the Proposal. A Proposal can have at most 8 sales planners. Format: networks/{network_code}/users/{user_id}

repeated string sales_planner_users = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The salesPlannerUsers to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setSellerContactUsers(int index, String value)

public Proposal.Builder setSellerContactUsers(int index, String value)

Optional. The resource names of the Users who are the seller's contacts. Format: networks/{network_code}/users/{user_id}

repeated string seller_contact_users = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The sellerContactUsers to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setSold(boolean value)

public Proposal.Builder setSold(boolean value)

Output only. Indicates whether the proposal has been sold, i.e., corresponds to whether the status of an Order is APPROVED or PAUSED.

optional bool sold = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The sold to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setStartTime(Timestamp value)

public Proposal.Builder setStartTime(Timestamp value)

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Proposal.Builder

setStartTime(Timestamp.Builder builderForValue)

public Proposal.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. The time at which the Order and LineItems associated with the Proposal are eligible to begin serving. This attribute is derived from the [ProposalLineItem][] with the earliest startTime. This attribute will be empty if this Proposal has no associated ProposalLineItems or if none of its ProposalLineItems have a start time.

optional .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Proposal.Builder

setSupplyPath(SupplyPathTypeEnum.SupplyPathType value)

public Proposal.Builder setSupplyPath(SupplyPathTypeEnum.SupplyPathType value)

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to DEMAND_SIDE_PLATFORM.

optional .google.ads.admanager.v1.SupplyPathTypeEnum.SupplyPathType supply_path = 42 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value SupplyPathTypeEnum.SupplyPathType

The supplyPath to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setSupplyPathValue(int value)

public Proposal.Builder setSupplyPathValue(int value)

Optional. Non-empty default. The supply path type of this Proposal. If no value is provided on creation, defaults to DEMAND_SIDE_PLATFORM.

optional .google.ads.admanager.v1.SupplyPathTypeEnum.SupplyPathType supply_path = 42 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

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

Returns
Type Description
Proposal.Builder

This builder for chaining.

setTrafficker(String value)

public Proposal.Builder setTrafficker(String value)

Optional. The resource name of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.trafficker. Format: networks/{network_code}/users/{user_id}

optional string trafficker = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The trafficker to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setTraffickerBytes(ByteString value)

public Proposal.Builder setTraffickerBytes(ByteString value)

Optional. The resource name of the User who is the primary trafficker and is responsible for trafficking the Proposal. This attribute is required when the proposal turns into an order, and will be copied to Order.trafficker. Format: networks/{network_code}/users/{user_id}

optional string trafficker = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for trafficker to set.

Returns
Type Description
Proposal.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Proposal.Builder setUpdateTime(Timestamp value)

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Proposal.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Proposal.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time this Proposal was last modified.

optional .google.protobuf.Timestamp update_time = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Proposal.Builder