public final class Proposal extends GeneratedMessage implements ProposalOrBuilderA 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ProposalImplements
ProposalOrBuilderStatic Fields
ADVERTISER_FIELD_NUMBER
public static final int ADVERTISER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
AGENCIES_FIELD_NUMBER
public static final int AGENCIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
APPLIED_LABELS_FIELD_NUMBER
public static final int APPLIED_LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
APPLIED_TEAMS_FIELD_NUMBER
public static final int APPLIED_TEAMS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ARCHIVED_FIELD_NUMBER
public static final int ARCHIVED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BUYER_RFP_FIELD_NUMBER
public static final int BUYER_RFP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CURRENCY_CODE_FIELD_NUMBER
public static final int CURRENCY_CODE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_FIELD_VALUES_FIELD_NUMBER
public static final int CUSTOM_FIELD_VALUES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELIVERY_PAUSING_ENABLED_FIELD_NUMBER
public static final int DELIVERY_PAUSING_ENABLED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EFFECTIVE_APPLIED_LABELS_FIELD_NUMBER
public static final int EFFECTIVE_APPLIED_LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MARKETPLACE_INFO_FIELD_NUMBER
public static final int MARKETPLACE_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NOTES_FIELD_NUMBER
public static final int NOTES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PRIMARY_SALESPERSON_FIELD_NUMBER
public static final int PRIMARY_SALESPERSON_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SALES_PLANNER_USERS_FIELD_NUMBER
public static final int SALES_PLANNER_USERS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SELLER_CONTACT_USERS_FIELD_NUMBER
public static final int SELLER_CONTACT_USERS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SOLD_FIELD_NUMBER
public static final int SOLD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SUPPLY_PATH_FIELD_NUMBER
public static final int SUPPLY_PATH_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRAFFICKER_FIELD_NUMBER
public static final int TRAFFICKER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Proposal getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Proposal |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Proposal.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Proposal.Builder |
|
newBuilder(Proposal prototype)
public static Proposal.Builder newBuilder(Proposal prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Proposal |
| Returns | |
|---|---|
| Type | Description |
Proposal.Builder |
|
parseDelimitedFrom(InputStream input)
public static Proposal parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Proposal parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Proposal parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Proposal parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Proposal parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Proposal parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Proposal parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Proposal parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Proposal parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Proposal parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Proposal parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Proposal parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Proposal |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Proposal> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Proposal> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
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 |
|
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 |
intThe 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 |
intThe 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. |
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 |
|
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. |
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 |
|
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. |
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. |
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. |
getParserForType()
public Parser<Proposal> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Proposal> |
|
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 |
intThe 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 |
intThe 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 |
intThe 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 |
intThe 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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
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. |
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Proposal.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Proposal.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Proposal.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Proposal.Builder |
|
toBuilder()
public Proposal.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Proposal.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|