com.google.api.ads.dfp.axis.v201508.Proposal Maven / Gradle / Ivy
Show all versions of dfp-axis Show documentation
/**
* Proposal.java
*
* This file was auto-generated from WSDL
* by the Apache Axis 1.4 Mar 02, 2009 (07:08:06 PST) WSDL2Java emitter.
*/
package com.google.api.ads.dfp.axis.v201508;
/**
* A {@code Proposal} represents an agreement between an interactive
* advertising seller and a buyer that specifies the details of an
* advertising campaign.
*/
public class Proposal implements java.io.Serializable {
/* The unique ID of the {@code Proposal}. This attribute is readonly
* and is
* assigned by Google. */
private java.lang.Long id;
/* The unique ID of corresponding {@link Order}. This attribute
* is readonly.
* This will be {@code null} if the {@code Proposal}
* has not been pushed to DFP. */
private java.lang.Long dfpOrderId;
/* The name of the {@code Proposal}. This value is required to
* create a
* proposal and has a maximum length of 255 characters.
* This attribute is
* copied to {@link Order#name} when the proposal turns
* into an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private java.lang.String name;
/* The option to specify whether the {@code Proposal} uses the
* Net or Gross pricing model.
* This field is optional and defaults to {@link PricingModel#NET}. */
private com.google.api.ads.dfp.axis.v201508.PricingModel pricingModel;
/* The date and time at which the order and line items associated
* with
* the {@code Proposal} are eligible to begin serving.
* This attribute is readonly and
* is derived from the proposal line item of the proposal
* which has the earliest
* {@link ProposalLineItem#startDateTime}. This attribute
* will be null,
* if this proposal has no related line items, or none
* of its line items have a start time. */
private com.google.api.ads.dfp.axis.v201508.DateTime startDateTime;
/* The date and time at which the order and line items associated
* with
* the {@code Proposal} stop being served. This attribute
* is readonly and
* is derived from the proposal line item of the proposal
* which has the
* latest {@link ProposalLineItem#endDateTime}. This
* attribute will be null,
* if this proposal has no related line items, or none
* of its line items have an end time. */
private com.google.api.ads.dfp.axis.v201508.DateTime endDateTime;
/* The time zone ID in tz database format (e.g. "America/Los_Angeles")
* for this
* {@code Proposal}. The {@link #startDateTime} and {@link
* #endDateTime} will be
* returned in this time zone. This attribute is optional
* and defaults to the
* network's time zone. */
private java.lang.String timeZoneId;
/* The status of the {@code Proposal}. This attribute is readonly. */
private com.google.api.ads.dfp.axis.v201508.ProposalStatus status;
/* The archival status of the {@code Proposal}. This attribute
* is readonly. */
private java.lang.Boolean isArchived;
/* The advertiser, to which this {@code Proposal} belongs, and
* a set of
* {@link Contact} objects associated with the advertiser.
* The
* {@link ProposalCompanyAssociation#type} of this attribute
* should be
* {@link ProposalCompanyAssociationType#ADVERTISER}.
* This attribute is
* required when the proposal turns into an order, and
* its
* {@link ProposalCompanyAssociation#companyId} will
* be copied to
* {@link Order#advertiserId}.
* This attribute becomes readonly once the {@code Proposal}
* has been pushed. */
private com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation advertiser;
/* List of agencies and the set of {@link Contact} objects associated
* with each agency.
* This attribute is optional. A {@code Proposal} only
* has at most one
* {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY}
* type,
* but a {@link Company} can appear more than once with
* different
* {@link ProposalCompanyAssociationType} values. If
* primary
* agency exists, its {@link ProposalCompanyAssociation#companyId}
* will be copied to
* {@link Order#agencyId} when the proposal turns into
* an order. */
private com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation[] agencies;
/* The probability to close this {@code Proposal}. This percentage
* value is in
* terms of millipercent, and should be multiples of
* 10 with the range from 0 to
* 100000. This attribute is required and will be used
* to calculate the revenue
* in reporting. */
private java.lang.Long probabilityOfClose;
/* The billing cap of this {@code Proposal}. This attribute is
* optional and
* default value is {@link BillingCap#CAPPED_CUMULATIVE}.
* Either this attribute
* or {@link #billingSchedule} will be used, according
* to the {@link #billingSource}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.BillingCap billingCap;
/* The billing schedule of this {@code Proposal}. This attribute
* is optional and
* default value is {@link BillingSchedule#PRORATED}.
* Either this attribute
* or {@link #billingCap} will be used, according to
* the {@link #billingSource}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.BillingSchedule billingSchedule;
/* The billing source of this {@code Proposal}. This attribute
* is optional and
* default value is {@link BillingSource#THIRD_PARTY_VOLUME}.
* If the value is
* {@link BillingSource#CONTRACTED}, the {@link #billingSchedule}
* will be used for
* billing, otherwise the {@link billingCap} will be
* used.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.BillingSource billingSource;
/* The billing base of this {@code Proposal}. For example, for
* a flat fee
* {@link BillingSource#CONTRACTED contracted} {@link
* #billingSource}, set this to
* {@link BillingBase#REVENUE}. This attribute is optional
* and defaults to
* {@link BillingBase#VOLUME}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.BillingBase billingBase;
/* User defined purchase order number for the {@code Proposal}.
* This attribute is
* optional and has a maximum length of 63 characters.
* It is copied to
* {@link Order#poNumber} when the proposal turns into
* an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private java.lang.String poNumber;
/* Provides any additional notes that may annotate the {@code
* Proposal}. This
* attribute is optional and has a maximum length of
* 65,535 characters.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private java.lang.String notes;
/* The total budget allocated for all the proposal line items
* belonging to the
* {@code Proposal}. It supports precision of 2 decimal
* places in terms of
* the fundamental currency unit, so the {@link Money#microAmount}
* must be
* multiples of 10000. This attribute is optional and
* default value is 0.
* The {@link Money#currencyCode} is readonly. */
private com.google.api.ads.dfp.axis.v201508.Money budget;
/* The primary salesperson who brokered the transaction with the
* {@link #advertiser}.
* This attribute is required when the proposal turns
* into an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.SalespersonSplit primarySalesperson;
/* List of secondary salespeople who are responsible for the sales
* of
* the {@code Proposal} besides primary salesperson.
* This attribute is optional. A proposal could have
* 8 secondary salespeople at most,
* but must also have a {@link #primarySalesperson} if
* any secondary salesperson exists.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.SalespersonSplit[] secondarySalespeople;
/* List of unique IDs of {@link User} objects who are the sales
* planners of
* the {@code Proposal}. This attribute is optional.
* A proposal could have
* 8 sales planners at most.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private long[] salesPlannerIds;
/* The unique ID of the {@link User} who is primary trafficker
* and is responsible for
* trafficking the {@code Proposal}. This attribute is
* required when the proposal
* turns into an order, and will be copied to {@link
* Order#primaryTraffickerId} .
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private java.lang.Long primaryTraffickerId;
/* List of unique IDs of {@link User} objects who are responsible
* for trafficking
* the {@code Proposal} besides the primary trafficker.
* This attribute is optional.
* A proposal could have 8 secondary traffickers at most,
* but must also have a primary
* trafficker if any secondary trafficker exists.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private long[] secondaryTraffickerIds;
/* The IDs of all teams that the {@code Proposal} is on directly.
* This attribute is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private long[] appliedTeamIds;
/* The values of the custom fields associated with the {@code
* Proposal}.
* This attribute is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.BaseCustomFieldValue[] customFieldValues;
/* The set of labels applied directly to the {@code Proposal}.
* This attribute is optional. */
private com.google.api.ads.dfp.axis.v201508.AppliedLabel[] appliedLabels;
/* Contains the set of labels applied directly to the proposal
* as well as those
* inherited ones. If a label has been negated, only
* the negated label
* is returned. This field is readonly and is assigned
* by Google. */
private com.google.api.ads.dfp.axis.v201508.AppliedLabel[] effectiveAppliedLabels;
/* The discount applied to the {@code Proposal} according to the
* {@link #advertiser}.
* The percentage value is stored as millipercents, and
* must be multiples of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0. */
private java.lang.Long advertiserDiscount;
/* The proposal discount, which will be applied to all
* {@link ProposalLineItem} objects in the {@code Proposal}.
* The percentage value is stored as millipercents, and must be multiples
* of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0. */
private java.lang.Long proposalDiscount;
/* The currency code of this {@code Proposal}. This attribute
* is optional and defaults to
* network's currency code. */
private java.lang.String currencyCode;
/* The exchange rate from the {@link #currencyCode} to the
* {@link Network#currencyCode network's currency}. The
* value is stored as the exchange rate times
* 10,000,000,000 truncated to a long. This attribute
* is readonly and is assigned by Google when
* first created or updated with {@link #refreshExchangeRate}
* set to {@code true}. This attribute
* is ignored if the feature is not enabled. */
private java.lang.Long exchangeRate;
/* Set this field to {@code true} to update the {@link #exchangeRate}
* to the latest exchange rate
* when updating the proposal. This attribute is optional
* and defaults to {@code false}. This
* attribute is ignored if the feature is not enabled. */
private java.lang.Boolean refreshExchangeRate;
/* The commission for the primary agency of the {@code Proposal}.
* The percentage value is stored as millipercents, and must be multiples
* of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0. */
private java.lang.Long agencyCommission;
/* The value added tax (VAT) applied on final cost of the {@code
* Proposal}.
* The percentage value is stored as millipercents, and
* must be multiples of 10
* with the range from 0 to 100000. This attribute is
* optional and default value is 0. */
private java.lang.Long valueAddedTax;
/* Indicates whether the proposal has been sold, i.e., corresponds
* to whether the status of an
* {@link Order} is {@link OrderStatus#APPROVED} or {@link
* OrderStatus#PAUSED}. This attribute
* is readonly. */
private java.lang.Boolean isSold;
/* The approval status of the {@code Proposal} for the active
* user or {@code null} if the active
* user has no action needed. This attribute is readonly
* and is assigned by Google. */
private com.google.api.ads.dfp.axis.v201508.ProposalApprovalStatus approvalStatus;
/* The date and time this {@code Proposal} was last modified.
*
* This attribute is readonly and is assigned by Google
* when a {@code Proposal} is updated. */
private com.google.api.ads.dfp.axis.v201508.DateTime lastModifiedDateTime;
/* The list of resources on this {@code Proposal}. This attribute
* is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration. */
private com.google.api.ads.dfp.axis.v201508.ProposalLink[] resources;
/* The actual date and time at which the inventory reserved by
* the {@link Proposal} will expire.
*
* This field is read-only / assigned by Google. */
private com.google.api.ads.dfp.axis.v201508.DateTime actualExpiryTime;
/* The expected date and time at which the inventory reserved
* by the {@link Proposal} will expire.
*
*
This field is read-only / assigned by Google. */
private com.google.api.ads.dfp.axis.v201508.DateTime expectedExpiryTime;
/* A predefined third party ad server, which will be used to fill
* in reconciliation.
* All predefined third party ad servers can be found
* in the {@code Third_Party_Company}
* PQL table.
* If actual third party ad server is not in the predefined
* list, this field is set to 0, and
* actual third party ad server name is set in {@code
* customThirdPartyAdServerName}.
* Third party ad server is optional. By default, this
* field is 0, and {@code
* customThirdPartyAdServerName} is null which means
* no third party ad server is specified. */
private java.lang.Integer thirdPartyAdServerId;
/* When actual third party ad server is not in the predefined
* list, {@code thirdPartyAdServerId}
* is set to 0, and actual third party ad server name
* is set here.
* When {@code thirdPartyAdServerId} is not 0, this field
* is ignored. */
private java.lang.String customThirdPartyAdServerName;
/* Details describing the most recent proposal retraction. This
* field is readonly and assigned by
* Google. */
private com.google.api.ads.dfp.axis.v201508.RetractionDetails lastRetractionDetails;
public Proposal() {
}
public Proposal(
java.lang.Long id,
java.lang.Long dfpOrderId,
java.lang.String name,
com.google.api.ads.dfp.axis.v201508.PricingModel pricingModel,
com.google.api.ads.dfp.axis.v201508.DateTime startDateTime,
com.google.api.ads.dfp.axis.v201508.DateTime endDateTime,
java.lang.String timeZoneId,
com.google.api.ads.dfp.axis.v201508.ProposalStatus status,
java.lang.Boolean isArchived,
com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation advertiser,
com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation[] agencies,
java.lang.Long probabilityOfClose,
com.google.api.ads.dfp.axis.v201508.BillingCap billingCap,
com.google.api.ads.dfp.axis.v201508.BillingSchedule billingSchedule,
com.google.api.ads.dfp.axis.v201508.BillingSource billingSource,
com.google.api.ads.dfp.axis.v201508.BillingBase billingBase,
java.lang.String poNumber,
java.lang.String notes,
com.google.api.ads.dfp.axis.v201508.Money budget,
com.google.api.ads.dfp.axis.v201508.SalespersonSplit primarySalesperson,
com.google.api.ads.dfp.axis.v201508.SalespersonSplit[] secondarySalespeople,
long[] salesPlannerIds,
java.lang.Long primaryTraffickerId,
long[] secondaryTraffickerIds,
long[] appliedTeamIds,
com.google.api.ads.dfp.axis.v201508.BaseCustomFieldValue[] customFieldValues,
com.google.api.ads.dfp.axis.v201508.AppliedLabel[] appliedLabels,
com.google.api.ads.dfp.axis.v201508.AppliedLabel[] effectiveAppliedLabels,
java.lang.Long advertiserDiscount,
java.lang.Long proposalDiscount,
java.lang.String currencyCode,
java.lang.Long exchangeRate,
java.lang.Boolean refreshExchangeRate,
java.lang.Long agencyCommission,
java.lang.Long valueAddedTax,
java.lang.Boolean isSold,
com.google.api.ads.dfp.axis.v201508.ProposalApprovalStatus approvalStatus,
com.google.api.ads.dfp.axis.v201508.DateTime lastModifiedDateTime,
com.google.api.ads.dfp.axis.v201508.ProposalLink[] resources,
com.google.api.ads.dfp.axis.v201508.DateTime actualExpiryTime,
com.google.api.ads.dfp.axis.v201508.DateTime expectedExpiryTime,
java.lang.Integer thirdPartyAdServerId,
java.lang.String customThirdPartyAdServerName,
com.google.api.ads.dfp.axis.v201508.RetractionDetails lastRetractionDetails) {
this.id = id;
this.dfpOrderId = dfpOrderId;
this.name = name;
this.pricingModel = pricingModel;
this.startDateTime = startDateTime;
this.endDateTime = endDateTime;
this.timeZoneId = timeZoneId;
this.status = status;
this.isArchived = isArchived;
this.advertiser = advertiser;
this.agencies = agencies;
this.probabilityOfClose = probabilityOfClose;
this.billingCap = billingCap;
this.billingSchedule = billingSchedule;
this.billingSource = billingSource;
this.billingBase = billingBase;
this.poNumber = poNumber;
this.notes = notes;
this.budget = budget;
this.primarySalesperson = primarySalesperson;
this.secondarySalespeople = secondarySalespeople;
this.salesPlannerIds = salesPlannerIds;
this.primaryTraffickerId = primaryTraffickerId;
this.secondaryTraffickerIds = secondaryTraffickerIds;
this.appliedTeamIds = appliedTeamIds;
this.customFieldValues = customFieldValues;
this.appliedLabels = appliedLabels;
this.effectiveAppliedLabels = effectiveAppliedLabels;
this.advertiserDiscount = advertiserDiscount;
this.proposalDiscount = proposalDiscount;
this.currencyCode = currencyCode;
this.exchangeRate = exchangeRate;
this.refreshExchangeRate = refreshExchangeRate;
this.agencyCommission = agencyCommission;
this.valueAddedTax = valueAddedTax;
this.isSold = isSold;
this.approvalStatus = approvalStatus;
this.lastModifiedDateTime = lastModifiedDateTime;
this.resources = resources;
this.actualExpiryTime = actualExpiryTime;
this.expectedExpiryTime = expectedExpiryTime;
this.thirdPartyAdServerId = thirdPartyAdServerId;
this.customThirdPartyAdServerName = customThirdPartyAdServerName;
this.lastRetractionDetails = lastRetractionDetails;
}
/**
* Gets the id value for this Proposal.
*
* @return id * The unique ID of the {@code Proposal}. This attribute is readonly
* and is
* assigned by Google.
*/
public java.lang.Long getId() {
return id;
}
/**
* Sets the id value for this Proposal.
*
* @param id * The unique ID of the {@code Proposal}. This attribute is readonly
* and is
* assigned by Google.
*/
public void setId(java.lang.Long id) {
this.id = id;
}
/**
* Gets the dfpOrderId value for this Proposal.
*
* @return dfpOrderId * The unique ID of corresponding {@link Order}. This attribute
* is readonly.
* This will be {@code null} if the {@code Proposal}
* has not been pushed to DFP.
*/
public java.lang.Long getDfpOrderId() {
return dfpOrderId;
}
/**
* Sets the dfpOrderId value for this Proposal.
*
* @param dfpOrderId * The unique ID of corresponding {@link Order}. This attribute
* is readonly.
* This will be {@code null} if the {@code Proposal}
* has not been pushed to DFP.
*/
public void setDfpOrderId(java.lang.Long dfpOrderId) {
this.dfpOrderId = dfpOrderId;
}
/**
* Gets the name value for this Proposal.
*
* @return name * The name of the {@code Proposal}. This value is required to
* create a
* proposal and has a maximum length of 255 characters.
* This attribute is
* copied to {@link Order#name} when the proposal turns
* into an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public java.lang.String getName() {
return name;
}
/**
* Sets the name value for this Proposal.
*
* @param name * The name of the {@code Proposal}. This value is required to
* create a
* proposal and has a maximum length of 255 characters.
* This attribute is
* copied to {@link Order#name} when the proposal turns
* into an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setName(java.lang.String name) {
this.name = name;
}
/**
* Gets the pricingModel value for this Proposal.
*
* @return pricingModel * The option to specify whether the {@code Proposal} uses the
* Net or Gross pricing model.
* This field is optional and defaults to {@link PricingModel#NET}.
*/
public com.google.api.ads.dfp.axis.v201508.PricingModel getPricingModel() {
return pricingModel;
}
/**
* Sets the pricingModel value for this Proposal.
*
* @param pricingModel * The option to specify whether the {@code Proposal} uses the
* Net or Gross pricing model.
* This field is optional and defaults to {@link PricingModel#NET}.
*/
public void setPricingModel(com.google.api.ads.dfp.axis.v201508.PricingModel pricingModel) {
this.pricingModel = pricingModel;
}
/**
* Gets the startDateTime value for this Proposal.
*
* @return startDateTime * The date and time at which the order and line items associated
* with
* the {@code Proposal} are eligible to begin serving.
* This attribute is readonly and
* is derived from the proposal line item of the proposal
* which has the earliest
* {@link ProposalLineItem#startDateTime}. This attribute
* will be null,
* if this proposal has no related line items, or none
* of its line items have a start time.
*/
public com.google.api.ads.dfp.axis.v201508.DateTime getStartDateTime() {
return startDateTime;
}
/**
* Sets the startDateTime value for this Proposal.
*
* @param startDateTime * The date and time at which the order and line items associated
* with
* the {@code Proposal} are eligible to begin serving.
* This attribute is readonly and
* is derived from the proposal line item of the proposal
* which has the earliest
* {@link ProposalLineItem#startDateTime}. This attribute
* will be null,
* if this proposal has no related line items, or none
* of its line items have a start time.
*/
public void setStartDateTime(com.google.api.ads.dfp.axis.v201508.DateTime startDateTime) {
this.startDateTime = startDateTime;
}
/**
* Gets the endDateTime value for this Proposal.
*
* @return endDateTime * The date and time at which the order and line items associated
* with
* the {@code Proposal} stop being served. This attribute
* is readonly and
* is derived from the proposal line item of the proposal
* which has the
* latest {@link ProposalLineItem#endDateTime}. This
* attribute will be null,
* if this proposal has no related line items, or none
* of its line items have an end time.
*/
public com.google.api.ads.dfp.axis.v201508.DateTime getEndDateTime() {
return endDateTime;
}
/**
* Sets the endDateTime value for this Proposal.
*
* @param endDateTime * The date and time at which the order and line items associated
* with
* the {@code Proposal} stop being served. This attribute
* is readonly and
* is derived from the proposal line item of the proposal
* which has the
* latest {@link ProposalLineItem#endDateTime}. This
* attribute will be null,
* if this proposal has no related line items, or none
* of its line items have an end time.
*/
public void setEndDateTime(com.google.api.ads.dfp.axis.v201508.DateTime endDateTime) {
this.endDateTime = endDateTime;
}
/**
* Gets the timeZoneId value for this Proposal.
*
* @return timeZoneId * The time zone ID in tz database format (e.g. "America/Los_Angeles")
* for this
* {@code Proposal}. The {@link #startDateTime} and {@link
* #endDateTime} will be
* returned in this time zone. This attribute is optional
* and defaults to the
* network's time zone.
*/
public java.lang.String getTimeZoneId() {
return timeZoneId;
}
/**
* Sets the timeZoneId value for this Proposal.
*
* @param timeZoneId * The time zone ID in tz database format (e.g. "America/Los_Angeles")
* for this
* {@code Proposal}. The {@link #startDateTime} and {@link
* #endDateTime} will be
* returned in this time zone. This attribute is optional
* and defaults to the
* network's time zone.
*/
public void setTimeZoneId(java.lang.String timeZoneId) {
this.timeZoneId = timeZoneId;
}
/**
* Gets the status value for this Proposal.
*
* @return status * The status of the {@code Proposal}. This attribute is readonly.
*/
public com.google.api.ads.dfp.axis.v201508.ProposalStatus getStatus() {
return status;
}
/**
* Sets the status value for this Proposal.
*
* @param status * The status of the {@code Proposal}. This attribute is readonly.
*/
public void setStatus(com.google.api.ads.dfp.axis.v201508.ProposalStatus status) {
this.status = status;
}
/**
* Gets the isArchived value for this Proposal.
*
* @return isArchived * The archival status of the {@code Proposal}. This attribute
* is readonly.
*/
public java.lang.Boolean getIsArchived() {
return isArchived;
}
/**
* Sets the isArchived value for this Proposal.
*
* @param isArchived * The archival status of the {@code Proposal}. This attribute
* is readonly.
*/
public void setIsArchived(java.lang.Boolean isArchived) {
this.isArchived = isArchived;
}
/**
* Gets the advertiser value for this Proposal.
*
* @return advertiser * The advertiser, to which this {@code Proposal} belongs, and
* a set of
* {@link Contact} objects associated with the advertiser.
* The
* {@link ProposalCompanyAssociation#type} of this attribute
* should be
* {@link ProposalCompanyAssociationType#ADVERTISER}.
* This attribute is
* required when the proposal turns into an order, and
* its
* {@link ProposalCompanyAssociation#companyId} will
* be copied to
* {@link Order#advertiserId}.
* This attribute becomes readonly once the {@code Proposal}
* has been pushed.
*/
public com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation getAdvertiser() {
return advertiser;
}
/**
* Sets the advertiser value for this Proposal.
*
* @param advertiser * The advertiser, to which this {@code Proposal} belongs, and
* a set of
* {@link Contact} objects associated with the advertiser.
* The
* {@link ProposalCompanyAssociation#type} of this attribute
* should be
* {@link ProposalCompanyAssociationType#ADVERTISER}.
* This attribute is
* required when the proposal turns into an order, and
* its
* {@link ProposalCompanyAssociation#companyId} will
* be copied to
* {@link Order#advertiserId}.
* This attribute becomes readonly once the {@code Proposal}
* has been pushed.
*/
public void setAdvertiser(com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation advertiser) {
this.advertiser = advertiser;
}
/**
* Gets the agencies value for this Proposal.
*
* @return agencies * List of agencies and the set of {@link Contact} objects associated
* with each agency.
* This attribute is optional. A {@code Proposal} only
* has at most one
* {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY}
* type,
* but a {@link Company} can appear more than once with
* different
* {@link ProposalCompanyAssociationType} values. If
* primary
* agency exists, its {@link ProposalCompanyAssociation#companyId}
* will be copied to
* {@link Order#agencyId} when the proposal turns into
* an order.
*/
public com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation[] getAgencies() {
return agencies;
}
/**
* Sets the agencies value for this Proposal.
*
* @param agencies * List of agencies and the set of {@link Contact} objects associated
* with each agency.
* This attribute is optional. A {@code Proposal} only
* has at most one
* {@link Company} with {@link ProposalCompanyAssociationType#PRIMARY_AGENCY}
* type,
* but a {@link Company} can appear more than once with
* different
* {@link ProposalCompanyAssociationType} values. If
* primary
* agency exists, its {@link ProposalCompanyAssociation#companyId}
* will be copied to
* {@link Order#agencyId} when the proposal turns into
* an order.
*/
public void setAgencies(com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation[] agencies) {
this.agencies = agencies;
}
public com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation getAgencies(int i) {
return this.agencies[i];
}
public void setAgencies(int i, com.google.api.ads.dfp.axis.v201508.ProposalCompanyAssociation _value) {
this.agencies[i] = _value;
}
/**
* Gets the probabilityOfClose value for this Proposal.
*
* @return probabilityOfClose * The probability to close this {@code Proposal}. This percentage
* value is in
* terms of millipercent, and should be multiples of
* 10 with the range from 0 to
* 100000. This attribute is required and will be used
* to calculate the revenue
* in reporting.
*/
public java.lang.Long getProbabilityOfClose() {
return probabilityOfClose;
}
/**
* Sets the probabilityOfClose value for this Proposal.
*
* @param probabilityOfClose * The probability to close this {@code Proposal}. This percentage
* value is in
* terms of millipercent, and should be multiples of
* 10 with the range from 0 to
* 100000. This attribute is required and will be used
* to calculate the revenue
* in reporting.
*/
public void setProbabilityOfClose(java.lang.Long probabilityOfClose) {
this.probabilityOfClose = probabilityOfClose;
}
/**
* Gets the billingCap value for this Proposal.
*
* @return billingCap * The billing cap of this {@code Proposal}. This attribute is
* optional and
* default value is {@link BillingCap#CAPPED_CUMULATIVE}.
* Either this attribute
* or {@link #billingSchedule} will be used, according
* to the {@link #billingSource}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.BillingCap getBillingCap() {
return billingCap;
}
/**
* Sets the billingCap value for this Proposal.
*
* @param billingCap * The billing cap of this {@code Proposal}. This attribute is
* optional and
* default value is {@link BillingCap#CAPPED_CUMULATIVE}.
* Either this attribute
* or {@link #billingSchedule} will be used, according
* to the {@link #billingSource}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setBillingCap(com.google.api.ads.dfp.axis.v201508.BillingCap billingCap) {
this.billingCap = billingCap;
}
/**
* Gets the billingSchedule value for this Proposal.
*
* @return billingSchedule * The billing schedule of this {@code Proposal}. This attribute
* is optional and
* default value is {@link BillingSchedule#PRORATED}.
* Either this attribute
* or {@link #billingCap} will be used, according to
* the {@link #billingSource}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.BillingSchedule getBillingSchedule() {
return billingSchedule;
}
/**
* Sets the billingSchedule value for this Proposal.
*
* @param billingSchedule * The billing schedule of this {@code Proposal}. This attribute
* is optional and
* default value is {@link BillingSchedule#PRORATED}.
* Either this attribute
* or {@link #billingCap} will be used, according to
* the {@link #billingSource}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setBillingSchedule(com.google.api.ads.dfp.axis.v201508.BillingSchedule billingSchedule) {
this.billingSchedule = billingSchedule;
}
/**
* Gets the billingSource value for this Proposal.
*
* @return billingSource * The billing source of this {@code Proposal}. This attribute
* is optional and
* default value is {@link BillingSource#THIRD_PARTY_VOLUME}.
* If the value is
* {@link BillingSource#CONTRACTED}, the {@link #billingSchedule}
* will be used for
* billing, otherwise the {@link billingCap} will be
* used.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.BillingSource getBillingSource() {
return billingSource;
}
/**
* Sets the billingSource value for this Proposal.
*
* @param billingSource * The billing source of this {@code Proposal}. This attribute
* is optional and
* default value is {@link BillingSource#THIRD_PARTY_VOLUME}.
* If the value is
* {@link BillingSource#CONTRACTED}, the {@link #billingSchedule}
* will be used for
* billing, otherwise the {@link billingCap} will be
* used.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setBillingSource(com.google.api.ads.dfp.axis.v201508.BillingSource billingSource) {
this.billingSource = billingSource;
}
/**
* Gets the billingBase value for this Proposal.
*
* @return billingBase * The billing base of this {@code Proposal}. For example, for
* a flat fee
* {@link BillingSource#CONTRACTED contracted} {@link
* #billingSource}, set this to
* {@link BillingBase#REVENUE}. This attribute is optional
* and defaults to
* {@link BillingBase#VOLUME}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.BillingBase getBillingBase() {
return billingBase;
}
/**
* Sets the billingBase value for this Proposal.
*
* @param billingBase * The billing base of this {@code Proposal}. For example, for
* a flat fee
* {@link BillingSource#CONTRACTED contracted} {@link
* #billingSource}, set this to
* {@link BillingBase#REVENUE}. This attribute is optional
* and defaults to
* {@link BillingBase#VOLUME}.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setBillingBase(com.google.api.ads.dfp.axis.v201508.BillingBase billingBase) {
this.billingBase = billingBase;
}
/**
* Gets the poNumber value for this Proposal.
*
* @return poNumber * User defined purchase order number for the {@code Proposal}.
* This attribute is
* optional and has a maximum length of 63 characters.
* It is copied to
* {@link Order#poNumber} when the proposal turns into
* an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public java.lang.String getPoNumber() {
return poNumber;
}
/**
* Sets the poNumber value for this Proposal.
*
* @param poNumber * User defined purchase order number for the {@code Proposal}.
* This attribute is
* optional and has a maximum length of 63 characters.
* It is copied to
* {@link Order#poNumber} when the proposal turns into
* an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setPoNumber(java.lang.String poNumber) {
this.poNumber = poNumber;
}
/**
* Gets the notes value for this Proposal.
*
* @return notes * Provides any additional notes that may annotate the {@code
* Proposal}. This
* attribute is optional and has a maximum length of
* 65,535 characters.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public java.lang.String getNotes() {
return notes;
}
/**
* Sets the notes value for this Proposal.
*
* @param notes * Provides any additional notes that may annotate the {@code
* Proposal}. This
* attribute is optional and has a maximum length of
* 65,535 characters.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setNotes(java.lang.String notes) {
this.notes = notes;
}
/**
* Gets the budget value for this Proposal.
*
* @return budget * The total budget allocated for all the proposal line items
* belonging to the
* {@code Proposal}. It supports precision of 2 decimal
* places in terms of
* the fundamental currency unit, so the {@link Money#microAmount}
* must be
* multiples of 10000. This attribute is optional and
* default value is 0.
* The {@link Money#currencyCode} is readonly.
*/
public com.google.api.ads.dfp.axis.v201508.Money getBudget() {
return budget;
}
/**
* Sets the budget value for this Proposal.
*
* @param budget * The total budget allocated for all the proposal line items
* belonging to the
* {@code Proposal}. It supports precision of 2 decimal
* places in terms of
* the fundamental currency unit, so the {@link Money#microAmount}
* must be
* multiples of 10000. This attribute is optional and
* default value is 0.
* The {@link Money#currencyCode} is readonly.
*/
public void setBudget(com.google.api.ads.dfp.axis.v201508.Money budget) {
this.budget = budget;
}
/**
* Gets the primarySalesperson value for this Proposal.
*
* @return primarySalesperson * The primary salesperson who brokered the transaction with the
* {@link #advertiser}.
* This attribute is required when the proposal turns
* into an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.SalespersonSplit getPrimarySalesperson() {
return primarySalesperson;
}
/**
* Sets the primarySalesperson value for this Proposal.
*
* @param primarySalesperson * The primary salesperson who brokered the transaction with the
* {@link #advertiser}.
* This attribute is required when the proposal turns
* into an order.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setPrimarySalesperson(com.google.api.ads.dfp.axis.v201508.SalespersonSplit primarySalesperson) {
this.primarySalesperson = primarySalesperson;
}
/**
* Gets the secondarySalespeople value for this Proposal.
*
* @return secondarySalespeople * List of secondary salespeople who are responsible for the sales
* of
* the {@code Proposal} besides primary salesperson.
* This attribute is optional. A proposal could have
* 8 secondary salespeople at most,
* but must also have a {@link #primarySalesperson} if
* any secondary salesperson exists.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.SalespersonSplit[] getSecondarySalespeople() {
return secondarySalespeople;
}
/**
* Sets the secondarySalespeople value for this Proposal.
*
* @param secondarySalespeople * List of secondary salespeople who are responsible for the sales
* of
* the {@code Proposal} besides primary salesperson.
* This attribute is optional. A proposal could have
* 8 secondary salespeople at most,
* but must also have a {@link #primarySalesperson} if
* any secondary salesperson exists.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setSecondarySalespeople(com.google.api.ads.dfp.axis.v201508.SalespersonSplit[] secondarySalespeople) {
this.secondarySalespeople = secondarySalespeople;
}
public com.google.api.ads.dfp.axis.v201508.SalespersonSplit getSecondarySalespeople(int i) {
return this.secondarySalespeople[i];
}
public void setSecondarySalespeople(int i, com.google.api.ads.dfp.axis.v201508.SalespersonSplit _value) {
this.secondarySalespeople[i] = _value;
}
/**
* Gets the salesPlannerIds value for this Proposal.
*
* @return salesPlannerIds * List of unique IDs of {@link User} objects who are the sales
* planners of
* the {@code Proposal}. This attribute is optional.
* A proposal could have
* 8 sales planners at most.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public long[] getSalesPlannerIds() {
return salesPlannerIds;
}
/**
* Sets the salesPlannerIds value for this Proposal.
*
* @param salesPlannerIds * List of unique IDs of {@link User} objects who are the sales
* planners of
* the {@code Proposal}. This attribute is optional.
* A proposal could have
* 8 sales planners at most.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setSalesPlannerIds(long[] salesPlannerIds) {
this.salesPlannerIds = salesPlannerIds;
}
public long getSalesPlannerIds(int i) {
return this.salesPlannerIds[i];
}
public void setSalesPlannerIds(int i, long _value) {
this.salesPlannerIds[i] = _value;
}
/**
* Gets the primaryTraffickerId value for this Proposal.
*
* @return primaryTraffickerId * The unique ID of the {@link User} who is primary trafficker
* and is responsible for
* trafficking the {@code Proposal}. This attribute is
* required when the proposal
* turns into an order, and will be copied to {@link
* Order#primaryTraffickerId} .
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public java.lang.Long getPrimaryTraffickerId() {
return primaryTraffickerId;
}
/**
* Sets the primaryTraffickerId value for this Proposal.
*
* @param primaryTraffickerId * The unique ID of the {@link User} who is primary trafficker
* and is responsible for
* trafficking the {@code Proposal}. This attribute is
* required when the proposal
* turns into an order, and will be copied to {@link
* Order#primaryTraffickerId} .
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setPrimaryTraffickerId(java.lang.Long primaryTraffickerId) {
this.primaryTraffickerId = primaryTraffickerId;
}
/**
* Gets the secondaryTraffickerIds value for this Proposal.
*
* @return secondaryTraffickerIds * List of unique IDs of {@link User} objects who are responsible
* for trafficking
* the {@code Proposal} besides the primary trafficker.
* This attribute is optional.
* A proposal could have 8 secondary traffickers at most,
* but must also have a primary
* trafficker if any secondary trafficker exists.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public long[] getSecondaryTraffickerIds() {
return secondaryTraffickerIds;
}
/**
* Sets the secondaryTraffickerIds value for this Proposal.
*
* @param secondaryTraffickerIds * List of unique IDs of {@link User} objects who are responsible
* for trafficking
* the {@code Proposal} besides the primary trafficker.
* This attribute is optional.
* A proposal could have 8 secondary traffickers at most,
* but must also have a primary
* trafficker if any secondary trafficker exists.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setSecondaryTraffickerIds(long[] secondaryTraffickerIds) {
this.secondaryTraffickerIds = secondaryTraffickerIds;
}
public long getSecondaryTraffickerIds(int i) {
return this.secondaryTraffickerIds[i];
}
public void setSecondaryTraffickerIds(int i, long _value) {
this.secondaryTraffickerIds[i] = _value;
}
/**
* Gets the appliedTeamIds value for this Proposal.
*
* @return appliedTeamIds * The IDs of all teams that the {@code Proposal} is on directly.
* This attribute is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public long[] getAppliedTeamIds() {
return appliedTeamIds;
}
/**
* Sets the appliedTeamIds value for this Proposal.
*
* @param appliedTeamIds * The IDs of all teams that the {@code Proposal} is on directly.
* This attribute is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setAppliedTeamIds(long[] appliedTeamIds) {
this.appliedTeamIds = appliedTeamIds;
}
public long getAppliedTeamIds(int i) {
return this.appliedTeamIds[i];
}
public void setAppliedTeamIds(int i, long _value) {
this.appliedTeamIds[i] = _value;
}
/**
* Gets the customFieldValues value for this Proposal.
*
* @return customFieldValues * The values of the custom fields associated with the {@code
* Proposal}.
* This attribute is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.BaseCustomFieldValue[] getCustomFieldValues() {
return customFieldValues;
}
/**
* Sets the customFieldValues value for this Proposal.
*
* @param customFieldValues * The values of the custom fields associated with the {@code
* Proposal}.
* This attribute is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setCustomFieldValues(com.google.api.ads.dfp.axis.v201508.BaseCustomFieldValue[] customFieldValues) {
this.customFieldValues = customFieldValues;
}
public com.google.api.ads.dfp.axis.v201508.BaseCustomFieldValue getCustomFieldValues(int i) {
return this.customFieldValues[i];
}
public void setCustomFieldValues(int i, com.google.api.ads.dfp.axis.v201508.BaseCustomFieldValue _value) {
this.customFieldValues[i] = _value;
}
/**
* Gets the appliedLabels value for this Proposal.
*
* @return appliedLabels * The set of labels applied directly to the {@code Proposal}.
* This attribute is optional.
*/
public com.google.api.ads.dfp.axis.v201508.AppliedLabel[] getAppliedLabels() {
return appliedLabels;
}
/**
* Sets the appliedLabels value for this Proposal.
*
* @param appliedLabels * The set of labels applied directly to the {@code Proposal}.
* This attribute is optional.
*/
public void setAppliedLabels(com.google.api.ads.dfp.axis.v201508.AppliedLabel[] appliedLabels) {
this.appliedLabels = appliedLabels;
}
public com.google.api.ads.dfp.axis.v201508.AppliedLabel getAppliedLabels(int i) {
return this.appliedLabels[i];
}
public void setAppliedLabels(int i, com.google.api.ads.dfp.axis.v201508.AppliedLabel _value) {
this.appliedLabels[i] = _value;
}
/**
* Gets the effectiveAppliedLabels value for this Proposal.
*
* @return effectiveAppliedLabels * Contains the set of labels applied directly to the proposal
* as well as those
* inherited ones. If a label has been negated, only
* the negated label
* is returned. This field is readonly and is assigned
* by Google.
*/
public com.google.api.ads.dfp.axis.v201508.AppliedLabel[] getEffectiveAppliedLabels() {
return effectiveAppliedLabels;
}
/**
* Sets the effectiveAppliedLabels value for this Proposal.
*
* @param effectiveAppliedLabels * Contains the set of labels applied directly to the proposal
* as well as those
* inherited ones. If a label has been negated, only
* the negated label
* is returned. This field is readonly and is assigned
* by Google.
*/
public void setEffectiveAppliedLabels(com.google.api.ads.dfp.axis.v201508.AppliedLabel[] effectiveAppliedLabels) {
this.effectiveAppliedLabels = effectiveAppliedLabels;
}
public com.google.api.ads.dfp.axis.v201508.AppliedLabel getEffectiveAppliedLabels(int i) {
return this.effectiveAppliedLabels[i];
}
public void setEffectiveAppliedLabels(int i, com.google.api.ads.dfp.axis.v201508.AppliedLabel _value) {
this.effectiveAppliedLabels[i] = _value;
}
/**
* Gets the advertiserDiscount value for this Proposal.
*
* @return advertiserDiscount * The discount applied to the {@code Proposal} according to the
* {@link #advertiser}.
* The percentage value is stored as millipercents, and
* must be multiples of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0.
*/
public java.lang.Long getAdvertiserDiscount() {
return advertiserDiscount;
}
/**
* Sets the advertiserDiscount value for this Proposal.
*
* @param advertiserDiscount * The discount applied to the {@code Proposal} according to the
* {@link #advertiser}.
* The percentage value is stored as millipercents, and
* must be multiples of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0.
*/
public void setAdvertiserDiscount(java.lang.Long advertiserDiscount) {
this.advertiserDiscount = advertiserDiscount;
}
/**
* Gets the proposalDiscount value for this Proposal.
*
* @return proposalDiscount * The proposal discount, which will be applied to all
* {@link ProposalLineItem} objects in the {@code Proposal}.
* The percentage value is stored as millipercents, and must be multiples
* of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0.
*/
public java.lang.Long getProposalDiscount() {
return proposalDiscount;
}
/**
* Sets the proposalDiscount value for this Proposal.
*
* @param proposalDiscount * The proposal discount, which will be applied to all
* {@link ProposalLineItem} objects in the {@code Proposal}.
* The percentage value is stored as millipercents, and must be multiples
* of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0.
*/
public void setProposalDiscount(java.lang.Long proposalDiscount) {
this.proposalDiscount = proposalDiscount;
}
/**
* Gets the currencyCode value for this Proposal.
*
* @return currencyCode * The currency code of this {@code Proposal}. This attribute
* is optional and defaults to
* network's currency code.
*/
public java.lang.String getCurrencyCode() {
return currencyCode;
}
/**
* Sets the currencyCode value for this Proposal.
*
* @param currencyCode * The currency code of this {@code Proposal}. This attribute
* is optional and defaults to
* network's currency code.
*/
public void setCurrencyCode(java.lang.String currencyCode) {
this.currencyCode = currencyCode;
}
/**
* Gets the exchangeRate value for this Proposal.
*
* @return exchangeRate * The exchange rate from the {@link #currencyCode} to the
* {@link Network#currencyCode network's currency}. The
* value is stored as the exchange rate times
* 10,000,000,000 truncated to a long. This attribute
* is readonly and is assigned by Google when
* first created or updated with {@link #refreshExchangeRate}
* set to {@code true}. This attribute
* is ignored if the feature is not enabled.
*/
public java.lang.Long getExchangeRate() {
return exchangeRate;
}
/**
* Sets the exchangeRate value for this Proposal.
*
* @param exchangeRate * The exchange rate from the {@link #currencyCode} to the
* {@link Network#currencyCode network's currency}. The
* value is stored as the exchange rate times
* 10,000,000,000 truncated to a long. This attribute
* is readonly and is assigned by Google when
* first created or updated with {@link #refreshExchangeRate}
* set to {@code true}. This attribute
* is ignored if the feature is not enabled.
*/
public void setExchangeRate(java.lang.Long exchangeRate) {
this.exchangeRate = exchangeRate;
}
/**
* Gets the refreshExchangeRate value for this Proposal.
*
* @return refreshExchangeRate * Set this field to {@code true} to update the {@link #exchangeRate}
* to the latest exchange rate
* when updating the proposal. This attribute is optional
* and defaults to {@code false}. This
* attribute is ignored if the feature is not enabled.
*/
public java.lang.Boolean getRefreshExchangeRate() {
return refreshExchangeRate;
}
/**
* Sets the refreshExchangeRate value for this Proposal.
*
* @param refreshExchangeRate * Set this field to {@code true} to update the {@link #exchangeRate}
* to the latest exchange rate
* when updating the proposal. This attribute is optional
* and defaults to {@code false}. This
* attribute is ignored if the feature is not enabled.
*/
public void setRefreshExchangeRate(java.lang.Boolean refreshExchangeRate) {
this.refreshExchangeRate = refreshExchangeRate;
}
/**
* Gets the agencyCommission value for this Proposal.
*
* @return agencyCommission * The commission for the primary agency of the {@code Proposal}.
* The percentage value is stored as millipercents, and must be multiples
* of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0.
*/
public java.lang.Long getAgencyCommission() {
return agencyCommission;
}
/**
* Sets the agencyCommission value for this Proposal.
*
* @param agencyCommission * The commission for the primary agency of the {@code Proposal}.
* The percentage value is stored as millipercents, and must be multiples
* of 10
* with the range from 0 to 99990. This attribute is
* optional and default value is 0.
*/
public void setAgencyCommission(java.lang.Long agencyCommission) {
this.agencyCommission = agencyCommission;
}
/**
* Gets the valueAddedTax value for this Proposal.
*
* @return valueAddedTax * The value added tax (VAT) applied on final cost of the {@code
* Proposal}.
* The percentage value is stored as millipercents, and
* must be multiples of 10
* with the range from 0 to 100000. This attribute is
* optional and default value is 0.
*/
public java.lang.Long getValueAddedTax() {
return valueAddedTax;
}
/**
* Sets the valueAddedTax value for this Proposal.
*
* @param valueAddedTax * The value added tax (VAT) applied on final cost of the {@code
* Proposal}.
* The percentage value is stored as millipercents, and
* must be multiples of 10
* with the range from 0 to 100000. This attribute is
* optional and default value is 0.
*/
public void setValueAddedTax(java.lang.Long valueAddedTax) {
this.valueAddedTax = valueAddedTax;
}
/**
* Gets the isSold value for this Proposal.
*
* @return isSold * Indicates whether the proposal has been sold, i.e., corresponds
* to whether the status of an
* {@link Order} is {@link OrderStatus#APPROVED} or {@link
* OrderStatus#PAUSED}. This attribute
* is readonly.
*/
public java.lang.Boolean getIsSold() {
return isSold;
}
/**
* Sets the isSold value for this Proposal.
*
* @param isSold * Indicates whether the proposal has been sold, i.e., corresponds
* to whether the status of an
* {@link Order} is {@link OrderStatus#APPROVED} or {@link
* OrderStatus#PAUSED}. This attribute
* is readonly.
*/
public void setIsSold(java.lang.Boolean isSold) {
this.isSold = isSold;
}
/**
* Gets the approvalStatus value for this Proposal.
*
* @return approvalStatus * The approval status of the {@code Proposal} for the active
* user or {@code null} if the active
* user has no action needed. This attribute is readonly
* and is assigned by Google.
*/
public com.google.api.ads.dfp.axis.v201508.ProposalApprovalStatus getApprovalStatus() {
return approvalStatus;
}
/**
* Sets the approvalStatus value for this Proposal.
*
* @param approvalStatus * The approval status of the {@code Proposal} for the active
* user or {@code null} if the active
* user has no action needed. This attribute is readonly
* and is assigned by Google.
*/
public void setApprovalStatus(com.google.api.ads.dfp.axis.v201508.ProposalApprovalStatus approvalStatus) {
this.approvalStatus = approvalStatus;
}
/**
* Gets the lastModifiedDateTime value for this Proposal.
*
* @return lastModifiedDateTime * The date and time this {@code Proposal} was last modified.
*
* This attribute is readonly and is assigned by Google
* when a {@code Proposal} is updated.
*/
public com.google.api.ads.dfp.axis.v201508.DateTime getLastModifiedDateTime() {
return lastModifiedDateTime;
}
/**
* Sets the lastModifiedDateTime value for this Proposal.
*
* @param lastModifiedDateTime * The date and time this {@code Proposal} was last modified.
*
* This attribute is readonly and is assigned by Google
* when a {@code Proposal} is updated.
*/
public void setLastModifiedDateTime(com.google.api.ads.dfp.axis.v201508.DateTime lastModifiedDateTime) {
this.lastModifiedDateTime = lastModifiedDateTime;
}
/**
* Gets the resources value for this Proposal.
*
* @return resources * The list of resources on this {@code Proposal}. This attribute
* is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public com.google.api.ads.dfp.axis.v201508.ProposalLink[] getResources() {
return resources;
}
/**
* Sets the resources value for this Proposal.
*
* @param resources * The list of resources on this {@code Proposal}. This attribute
* is optional.
* This attribute can be configured as editable after
* the proposal has been submitted.
* Please check with your network administrator for editable
* fields configuration.
*/
public void setResources(com.google.api.ads.dfp.axis.v201508.ProposalLink[] resources) {
this.resources = resources;
}
public com.google.api.ads.dfp.axis.v201508.ProposalLink getResources(int i) {
return this.resources[i];
}
public void setResources(int i, com.google.api.ads.dfp.axis.v201508.ProposalLink _value) {
this.resources[i] = _value;
}
/**
* Gets the actualExpiryTime value for this Proposal.
*
* @return actualExpiryTime * The actual date and time at which the inventory reserved by
* the {@link Proposal} will expire.
*
*
This field is read-only / assigned by Google.
*/
public com.google.api.ads.dfp.axis.v201508.DateTime getActualExpiryTime() {
return actualExpiryTime;
}
/**
* Sets the actualExpiryTime value for this Proposal.
*
* @param actualExpiryTime * The actual date and time at which the inventory reserved by
* the {@link Proposal} will expire.
*
*
This field is read-only / assigned by Google.
*/
public void setActualExpiryTime(com.google.api.ads.dfp.axis.v201508.DateTime actualExpiryTime) {
this.actualExpiryTime = actualExpiryTime;
}
/**
* Gets the expectedExpiryTime value for this Proposal.
*
* @return expectedExpiryTime * The expected date and time at which the inventory reserved
* by the {@link Proposal} will expire.
*
*
This field is read-only / assigned by Google.
*/
public com.google.api.ads.dfp.axis.v201508.DateTime getExpectedExpiryTime() {
return expectedExpiryTime;
}
/**
* Sets the expectedExpiryTime value for this Proposal.
*
* @param expectedExpiryTime * The expected date and time at which the inventory reserved
* by the {@link Proposal} will expire.
*
*
This field is read-only / assigned by Google.
*/
public void setExpectedExpiryTime(com.google.api.ads.dfp.axis.v201508.DateTime expectedExpiryTime) {
this.expectedExpiryTime = expectedExpiryTime;
}
/**
* Gets the thirdPartyAdServerId value for this Proposal.
*
* @return thirdPartyAdServerId * A predefined third party ad server, which will be used to fill
* in reconciliation.
* All predefined third party ad servers can be found
* in the {@code Third_Party_Company}
* PQL table.
* If actual third party ad server is not in the predefined
* list, this field is set to 0, and
* actual third party ad server name is set in {@code
* customThirdPartyAdServerName}.
* Third party ad server is optional. By default, this
* field is 0, and {@code
* customThirdPartyAdServerName} is null which means
* no third party ad server is specified.
*/
public java.lang.Integer getThirdPartyAdServerId() {
return thirdPartyAdServerId;
}
/**
* Sets the thirdPartyAdServerId value for this Proposal.
*
* @param thirdPartyAdServerId * A predefined third party ad server, which will be used to fill
* in reconciliation.
* All predefined third party ad servers can be found
* in the {@code Third_Party_Company}
* PQL table.
* If actual third party ad server is not in the predefined
* list, this field is set to 0, and
* actual third party ad server name is set in {@code
* customThirdPartyAdServerName}.
* Third party ad server is optional. By default, this
* field is 0, and {@code
* customThirdPartyAdServerName} is null which means
* no third party ad server is specified.
*/
public void setThirdPartyAdServerId(java.lang.Integer thirdPartyAdServerId) {
this.thirdPartyAdServerId = thirdPartyAdServerId;
}
/**
* Gets the customThirdPartyAdServerName value for this Proposal.
*
* @return customThirdPartyAdServerName * When actual third party ad server is not in the predefined
* list, {@code thirdPartyAdServerId}
* is set to 0, and actual third party ad server name
* is set here.
* When {@code thirdPartyAdServerId} is not 0, this field
* is ignored.
*/
public java.lang.String getCustomThirdPartyAdServerName() {
return customThirdPartyAdServerName;
}
/**
* Sets the customThirdPartyAdServerName value for this Proposal.
*
* @param customThirdPartyAdServerName * When actual third party ad server is not in the predefined
* list, {@code thirdPartyAdServerId}
* is set to 0, and actual third party ad server name
* is set here.
* When {@code thirdPartyAdServerId} is not 0, this field
* is ignored.
*/
public void setCustomThirdPartyAdServerName(java.lang.String customThirdPartyAdServerName) {
this.customThirdPartyAdServerName = customThirdPartyAdServerName;
}
/**
* Gets the lastRetractionDetails value for this Proposal.
*
* @return lastRetractionDetails * Details describing the most recent proposal retraction. This
* field is readonly and assigned by
* Google.
*/
public com.google.api.ads.dfp.axis.v201508.RetractionDetails getLastRetractionDetails() {
return lastRetractionDetails;
}
/**
* Sets the lastRetractionDetails value for this Proposal.
*
* @param lastRetractionDetails * Details describing the most recent proposal retraction. This
* field is readonly and assigned by
* Google.
*/
public void setLastRetractionDetails(com.google.api.ads.dfp.axis.v201508.RetractionDetails lastRetractionDetails) {
this.lastRetractionDetails = lastRetractionDetails;
}
private java.lang.Object __equalsCalc = null;
public synchronized boolean equals(java.lang.Object obj) {
if (!(obj instanceof Proposal)) return false;
Proposal other = (Proposal) obj;
if (obj == null) return false;
if (this == obj) return true;
if (__equalsCalc != null) {
return (__equalsCalc == obj);
}
__equalsCalc = obj;
boolean _equals;
_equals = true &&
((this.id==null && other.getId()==null) ||
(this.id!=null &&
this.id.equals(other.getId()))) &&
((this.dfpOrderId==null && other.getDfpOrderId()==null) ||
(this.dfpOrderId!=null &&
this.dfpOrderId.equals(other.getDfpOrderId()))) &&
((this.name==null && other.getName()==null) ||
(this.name!=null &&
this.name.equals(other.getName()))) &&
((this.pricingModel==null && other.getPricingModel()==null) ||
(this.pricingModel!=null &&
this.pricingModel.equals(other.getPricingModel()))) &&
((this.startDateTime==null && other.getStartDateTime()==null) ||
(this.startDateTime!=null &&
this.startDateTime.equals(other.getStartDateTime()))) &&
((this.endDateTime==null && other.getEndDateTime()==null) ||
(this.endDateTime!=null &&
this.endDateTime.equals(other.getEndDateTime()))) &&
((this.timeZoneId==null && other.getTimeZoneId()==null) ||
(this.timeZoneId!=null &&
this.timeZoneId.equals(other.getTimeZoneId()))) &&
((this.status==null && other.getStatus()==null) ||
(this.status!=null &&
this.status.equals(other.getStatus()))) &&
((this.isArchived==null && other.getIsArchived()==null) ||
(this.isArchived!=null &&
this.isArchived.equals(other.getIsArchived()))) &&
((this.advertiser==null && other.getAdvertiser()==null) ||
(this.advertiser!=null &&
this.advertiser.equals(other.getAdvertiser()))) &&
((this.agencies==null && other.getAgencies()==null) ||
(this.agencies!=null &&
java.util.Arrays.equals(this.agencies, other.getAgencies()))) &&
((this.probabilityOfClose==null && other.getProbabilityOfClose()==null) ||
(this.probabilityOfClose!=null &&
this.probabilityOfClose.equals(other.getProbabilityOfClose()))) &&
((this.billingCap==null && other.getBillingCap()==null) ||
(this.billingCap!=null &&
this.billingCap.equals(other.getBillingCap()))) &&
((this.billingSchedule==null && other.getBillingSchedule()==null) ||
(this.billingSchedule!=null &&
this.billingSchedule.equals(other.getBillingSchedule()))) &&
((this.billingSource==null && other.getBillingSource()==null) ||
(this.billingSource!=null &&
this.billingSource.equals(other.getBillingSource()))) &&
((this.billingBase==null && other.getBillingBase()==null) ||
(this.billingBase!=null &&
this.billingBase.equals(other.getBillingBase()))) &&
((this.poNumber==null && other.getPoNumber()==null) ||
(this.poNumber!=null &&
this.poNumber.equals(other.getPoNumber()))) &&
((this.notes==null && other.getNotes()==null) ||
(this.notes!=null &&
this.notes.equals(other.getNotes()))) &&
((this.budget==null && other.getBudget()==null) ||
(this.budget!=null &&
this.budget.equals(other.getBudget()))) &&
((this.primarySalesperson==null && other.getPrimarySalesperson()==null) ||
(this.primarySalesperson!=null &&
this.primarySalesperson.equals(other.getPrimarySalesperson()))) &&
((this.secondarySalespeople==null && other.getSecondarySalespeople()==null) ||
(this.secondarySalespeople!=null &&
java.util.Arrays.equals(this.secondarySalespeople, other.getSecondarySalespeople()))) &&
((this.salesPlannerIds==null && other.getSalesPlannerIds()==null) ||
(this.salesPlannerIds!=null &&
java.util.Arrays.equals(this.salesPlannerIds, other.getSalesPlannerIds()))) &&
((this.primaryTraffickerId==null && other.getPrimaryTraffickerId()==null) ||
(this.primaryTraffickerId!=null &&
this.primaryTraffickerId.equals(other.getPrimaryTraffickerId()))) &&
((this.secondaryTraffickerIds==null && other.getSecondaryTraffickerIds()==null) ||
(this.secondaryTraffickerIds!=null &&
java.util.Arrays.equals(this.secondaryTraffickerIds, other.getSecondaryTraffickerIds()))) &&
((this.appliedTeamIds==null && other.getAppliedTeamIds()==null) ||
(this.appliedTeamIds!=null &&
java.util.Arrays.equals(this.appliedTeamIds, other.getAppliedTeamIds()))) &&
((this.customFieldValues==null && other.getCustomFieldValues()==null) ||
(this.customFieldValues!=null &&
java.util.Arrays.equals(this.customFieldValues, other.getCustomFieldValues()))) &&
((this.appliedLabels==null && other.getAppliedLabels()==null) ||
(this.appliedLabels!=null &&
java.util.Arrays.equals(this.appliedLabels, other.getAppliedLabels()))) &&
((this.effectiveAppliedLabels==null && other.getEffectiveAppliedLabels()==null) ||
(this.effectiveAppliedLabels!=null &&
java.util.Arrays.equals(this.effectiveAppliedLabels, other.getEffectiveAppliedLabels()))) &&
((this.advertiserDiscount==null && other.getAdvertiserDiscount()==null) ||
(this.advertiserDiscount!=null &&
this.advertiserDiscount.equals(other.getAdvertiserDiscount()))) &&
((this.proposalDiscount==null && other.getProposalDiscount()==null) ||
(this.proposalDiscount!=null &&
this.proposalDiscount.equals(other.getProposalDiscount()))) &&
((this.currencyCode==null && other.getCurrencyCode()==null) ||
(this.currencyCode!=null &&
this.currencyCode.equals(other.getCurrencyCode()))) &&
((this.exchangeRate==null && other.getExchangeRate()==null) ||
(this.exchangeRate!=null &&
this.exchangeRate.equals(other.getExchangeRate()))) &&
((this.refreshExchangeRate==null && other.getRefreshExchangeRate()==null) ||
(this.refreshExchangeRate!=null &&
this.refreshExchangeRate.equals(other.getRefreshExchangeRate()))) &&
((this.agencyCommission==null && other.getAgencyCommission()==null) ||
(this.agencyCommission!=null &&
this.agencyCommission.equals(other.getAgencyCommission()))) &&
((this.valueAddedTax==null && other.getValueAddedTax()==null) ||
(this.valueAddedTax!=null &&
this.valueAddedTax.equals(other.getValueAddedTax()))) &&
((this.isSold==null && other.getIsSold()==null) ||
(this.isSold!=null &&
this.isSold.equals(other.getIsSold()))) &&
((this.approvalStatus==null && other.getApprovalStatus()==null) ||
(this.approvalStatus!=null &&
this.approvalStatus.equals(other.getApprovalStatus()))) &&
((this.lastModifiedDateTime==null && other.getLastModifiedDateTime()==null) ||
(this.lastModifiedDateTime!=null &&
this.lastModifiedDateTime.equals(other.getLastModifiedDateTime()))) &&
((this.resources==null && other.getResources()==null) ||
(this.resources!=null &&
java.util.Arrays.equals(this.resources, other.getResources()))) &&
((this.actualExpiryTime==null && other.getActualExpiryTime()==null) ||
(this.actualExpiryTime!=null &&
this.actualExpiryTime.equals(other.getActualExpiryTime()))) &&
((this.expectedExpiryTime==null && other.getExpectedExpiryTime()==null) ||
(this.expectedExpiryTime!=null &&
this.expectedExpiryTime.equals(other.getExpectedExpiryTime()))) &&
((this.thirdPartyAdServerId==null && other.getThirdPartyAdServerId()==null) ||
(this.thirdPartyAdServerId!=null &&
this.thirdPartyAdServerId.equals(other.getThirdPartyAdServerId()))) &&
((this.customThirdPartyAdServerName==null && other.getCustomThirdPartyAdServerName()==null) ||
(this.customThirdPartyAdServerName!=null &&
this.customThirdPartyAdServerName.equals(other.getCustomThirdPartyAdServerName()))) &&
((this.lastRetractionDetails==null && other.getLastRetractionDetails()==null) ||
(this.lastRetractionDetails!=null &&
this.lastRetractionDetails.equals(other.getLastRetractionDetails())));
__equalsCalc = null;
return _equals;
}
private boolean __hashCodeCalc = false;
public synchronized int hashCode() {
if (__hashCodeCalc) {
return 0;
}
__hashCodeCalc = true;
int _hashCode = 1;
if (getId() != null) {
_hashCode += getId().hashCode();
}
if (getDfpOrderId() != null) {
_hashCode += getDfpOrderId().hashCode();
}
if (getName() != null) {
_hashCode += getName().hashCode();
}
if (getPricingModel() != null) {
_hashCode += getPricingModel().hashCode();
}
if (getStartDateTime() != null) {
_hashCode += getStartDateTime().hashCode();
}
if (getEndDateTime() != null) {
_hashCode += getEndDateTime().hashCode();
}
if (getTimeZoneId() != null) {
_hashCode += getTimeZoneId().hashCode();
}
if (getStatus() != null) {
_hashCode += getStatus().hashCode();
}
if (getIsArchived() != null) {
_hashCode += getIsArchived().hashCode();
}
if (getAdvertiser() != null) {
_hashCode += getAdvertiser().hashCode();
}
if (getAgencies() != null) {
for (int i=0;
i