com.google.api.ads.dfp.axis.v201311

Class Order

java.lang.Object

com.google.api.ads.dfp.axis.v201311.Order

All Implemented Interfaces:

Serializable

public class Order
extends Object
implements Serializable

An Order represents a grouping of individual LineItem objects, each of which fulfill an ad request from a particular advertiser.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Order()
Order(Long id, String name, DateTime startDateTime, DateTime endDateTime, Boolean unlimitedEndDateTime, OrderStatus status, Boolean isArchived, String notes, Integer externalOrderId, String poNumber, String currencyCode, Long advertiserId, long[] advertiserContactIds, Long agencyId, long[] agencyContactIds, Long creatorId, Long traffickerId, long[] secondaryTraffickerIds, Long salespersonId, long[] secondarySalespersonIds, Long totalImpressionsDelivered, Long totalClicksDelivered, Money totalBudget, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, String lastModifiedByApp, long[] appliedTeamIds, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
long[]	getAdvertiserContactIds() Gets the advertiserContactIds value for this Order.
long	getAdvertiserContactIds(int i)
Long	getAdvertiserId() Gets the advertiserId value for this Order.
long[]	getAgencyContactIds() Gets the agencyContactIds value for this Order.
long	getAgencyContactIds(int i)
Long	getAgencyId() Gets the agencyId value for this Order.
AppliedLabel[]	getAppliedLabels() Gets the appliedLabels value for this Order.
AppliedLabel	getAppliedLabels(int i)
long[]	getAppliedTeamIds() Gets the appliedTeamIds value for this Order.
long	getAppliedTeamIds(int i)
Long	getCreatorId() Gets the creatorId value for this Order.
String	getCurrencyCode() Gets the currencyCode value for this Order.
BaseCustomFieldValue[]	getCustomFieldValues() Gets the customFieldValues value for this Order.
BaseCustomFieldValue	getCustomFieldValues(int i)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
AppliedLabel[]	getEffectiveAppliedLabels() Gets the effectiveAppliedLabels value for this Order.
AppliedLabel	getEffectiveAppliedLabels(int i)
DateTime	getEndDateTime() Gets the endDateTime value for this Order.
Integer	getExternalOrderId() Gets the externalOrderId value for this Order.
Long	getId() Gets the id value for this Order.
Boolean	getIsArchived() Gets the isArchived value for this Order.
String	getLastModifiedByApp() Gets the lastModifiedByApp value for this Order.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this Order.
String	getName() Gets the name value for this Order.
String	getNotes() Gets the notes value for this Order.
String	getPoNumber() Gets the poNumber value for this Order.
Long	getSalespersonId() Gets the salespersonId value for this Order.
long[]	getSecondarySalespersonIds() Gets the secondarySalespersonIds value for this Order.
long	getSecondarySalespersonIds(int i)
long[]	getSecondaryTraffickerIds() Gets the secondaryTraffickerIds value for this Order.
long	getSecondaryTraffickerIds(int i)
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
DateTime	getStartDateTime() Gets the startDateTime value for this Order.
OrderStatus	getStatus() Gets the status value for this Order.
Money	getTotalBudget() Gets the totalBudget value for this Order.
Long	getTotalClicksDelivered() Gets the totalClicksDelivered value for this Order.
Long	getTotalImpressionsDelivered() Gets the totalImpressionsDelivered value for this Order.
Long	getTraffickerId() Gets the traffickerId value for this Order.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Boolean	getUnlimitedEndDateTime() Gets the unlimitedEndDateTime value for this Order.
int	hashCode()
void	setAdvertiserContactIds(int i, long _value)
void	setAdvertiserContactIds(long[] advertiserContactIds) Sets the advertiserContactIds value for this Order.
void	setAdvertiserId(Long advertiserId) Sets the advertiserId value for this Order.
void	setAgencyContactIds(int i, long _value)
void	setAgencyContactIds(long[] agencyContactIds) Sets the agencyContactIds value for this Order.
void	setAgencyId(Long agencyId) Sets the agencyId value for this Order.
void	setAppliedLabels(AppliedLabel[] appliedLabels) Sets the appliedLabels value for this Order.
void	setAppliedLabels(int i, AppliedLabel _value)
void	setAppliedTeamIds(int i, long _value)
void	setAppliedTeamIds(long[] appliedTeamIds) Sets the appliedTeamIds value for this Order.
void	setCreatorId(Long creatorId) Sets the creatorId value for this Order.
void	setCurrencyCode(String currencyCode) Sets the currencyCode value for this Order.
void	setCustomFieldValues(BaseCustomFieldValue[] customFieldValues) Sets the customFieldValues value for this Order.
void	setCustomFieldValues(int i, BaseCustomFieldValue _value)
void	setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels) Sets the effectiveAppliedLabels value for this Order.
void	setEffectiveAppliedLabels(int i, AppliedLabel _value)
void	setEndDateTime(DateTime endDateTime) Sets the endDateTime value for this Order.
void	setExternalOrderId(Integer externalOrderId) Sets the externalOrderId value for this Order.
void	setId(Long id) Sets the id value for this Order.
void	setIsArchived(Boolean isArchived) Sets the isArchived value for this Order.
void	setLastModifiedByApp(String lastModifiedByApp) Sets the lastModifiedByApp value for this Order.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this Order.
void	setName(String name) Sets the name value for this Order.
void	setNotes(String notes) Sets the notes value for this Order.
void	setPoNumber(String poNumber) Sets the poNumber value for this Order.
void	setSalespersonId(Long salespersonId) Sets the salespersonId value for this Order.
void	setSecondarySalespersonIds(int i, long _value)
void	setSecondarySalespersonIds(long[] secondarySalespersonIds) Sets the secondarySalespersonIds value for this Order.
void	setSecondaryTraffickerIds(int i, long _value)
void	setSecondaryTraffickerIds(long[] secondaryTraffickerIds) Sets the secondaryTraffickerIds value for this Order.
void	setStartDateTime(DateTime startDateTime) Sets the startDateTime value for this Order.
void	setStatus(OrderStatus status) Sets the status value for this Order.
void	setTotalBudget(Money totalBudget) Sets the totalBudget value for this Order.
void	setTotalClicksDelivered(Long totalClicksDelivered) Sets the totalClicksDelivered value for this Order.
void	setTotalImpressionsDelivered(Long totalImpressionsDelivered) Sets the totalImpressionsDelivered value for this Order.
void	setTraffickerId(Long traffickerId) Sets the traffickerId value for this Order.
void	setUnlimitedEndDateTime(Boolean unlimitedEndDateTime) Sets the unlimitedEndDateTime value for this Order.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Order

public Order()

Order

public Order(Long id,
     String name,
     DateTime startDateTime,
     DateTime endDateTime,
     Boolean unlimitedEndDateTime,
     OrderStatus status,
     Boolean isArchived,
     String notes,
     Integer externalOrderId,
     String poNumber,
     String currencyCode,
     Long advertiserId,
     long[] advertiserContactIds,
     Long agencyId,
     long[] agencyContactIds,
     Long creatorId,
     Long traffickerId,
     long[] secondaryTraffickerIds,
     Long salespersonId,
     long[] secondarySalespersonIds,
     Long totalImpressionsDelivered,
     Long totalClicksDelivered,
     Money totalBudget,
     AppliedLabel[] appliedLabels,
     AppliedLabel[] effectiveAppliedLabels,
     String lastModifiedByApp,
     long[] appliedTeamIds,
     DateTime lastModifiedDateTime,
     BaseCustomFieldValue[] customFieldValues)

Method Detail

getId

public Long getId()

Gets the id value for this Order.

Returns:

id * The unique ID of the Order. This value is readonly and is assigned by Google.

setId

public void setId(Long id)

Sets the id value for this Order.

Parameters:

id - * The unique ID of the Order. This value is readonly and is assigned by Google.

getName

public String getName()

Gets the name value for this Order.

Returns:

name * The name of the Order. This value is required to create an order and has a maximum length of 128 characters.

setName

public void setName(String name)

Sets the name value for this Order.

Parameters:

name - * The name of the Order. This value is required to create an order and has a maximum length of 128 characters.

getStartDateTime

public DateTime getStartDateTime()

Gets the startDateTime value for this Order.

Returns:

startDateTime * The date and time at which the Order and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest LineItemSummary.startDateTime.

setStartDateTime

public void setStartDateTime(DateTime startDateTime)

Sets the startDateTime value for this Order.

Parameters:

startDateTime - * The date and time at which the Order and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest LineItemSummary.startDateTime.

getEndDateTime

public DateTime getEndDateTime()

Gets the endDateTime value for this Order.

Returns:

endDateTime * The date and time at which the Order and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest LineItemSummary.endDateTime.

setEndDateTime

public void setEndDateTime(DateTime endDateTime)

Sets the endDateTime value for this Order.

Parameters:

endDateTime - * The date and time at which the Order and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest LineItemSummary.endDateTime.

getUnlimitedEndDateTime

public Boolean getUnlimitedEndDateTime()

Gets the unlimitedEndDateTime value for this Order.

Returns:

unlimitedEndDateTime * Specifies whether or not the Order has an unlimited end date. This attribute is readonly and is true if any of the order's line items has LineItemSummary.unlimitedEndDateTime set to true.

setUnlimitedEndDateTime

public void setUnlimitedEndDateTime(Boolean unlimitedEndDateTime)

Sets the unlimitedEndDateTime value for this Order.

Parameters:

unlimitedEndDateTime - * Specifies whether or not the Order has an unlimited end date. This attribute is readonly and is true if any of the order's line items has LineItemSummary.unlimitedEndDateTime set to true.

getStatus

public OrderStatus getStatus()

Gets the status value for this Order.

Returns:

status * The status of the Order. This attribute is read-only.

setStatus

public void setStatus(OrderStatus status)

Sets the status value for this Order.

Parameters:

status - * The status of the Order. This attribute is read-only.

getIsArchived

public Boolean getIsArchived()

Gets the isArchived value for this Order.

Returns:

isArchived * The archival status of the Order. This attribute is readonly.

setIsArchived

public void setIsArchived(Boolean isArchived)

Sets the isArchived value for this Order.

Parameters:

isArchived - * The archival status of the Order. This attribute is readonly.

getNotes

public String getNotes()

Gets the notes value for this Order.

Returns:

notes * Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters.

setNotes

public void setNotes(String notes)

Sets the notes value for this Order.

Parameters:

notes - * Provides any additional notes that may annotate the Order. This attribute is optional and has a maximum length of 65,535 characters.

getExternalOrderId

public Integer getExternalOrderId()

Gets the externalOrderId value for this Order.

Returns:

externalOrderId * An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional.

setExternalOrderId

public void setExternalOrderId(Integer externalOrderId)

Sets the externalOrderId value for this Order.

Parameters:

externalOrderId - * An arbitrary ID to associate to the Order, which can be used as a key to an external system. This value is optional.

getPoNumber

public String getPoNumber()

Gets the poNumber value for this Order.

Returns:

poNumber * The purchase order number for the Order. This value is optional and has a maximum length of 63 characters.

setPoNumber

public void setPoNumber(String poNumber)

Sets the poNumber value for this Order.

Parameters:

poNumber - * The purchase order number for the Order. This value is optional and has a maximum length of 63 characters.

getCurrencyCode

public String getCurrencyCode()

Gets the currencyCode value for this Order.

Returns:

currencyCode * The ISO currency code for the currency used by the Order. This value is optional and defaults to "USD".

setCurrencyCode

public void setCurrencyCode(String currencyCode)

Sets the currencyCode value for this Order.

Parameters:

currencyCode - * The ISO currency code for the currency used by the Order. This value is optional and defaults to "USD".

getAdvertiserId

public Long getAdvertiserId()

Gets the advertiserId value for this Order.

Returns:

advertiserId * The unique ID of the Company, which is of type Company.Type#ADVERTISER, to which this order belongs. This attribute is required.

setAdvertiserId

public void setAdvertiserId(Long advertiserId)

Sets the advertiserId value for this Order.

Parameters:

advertiserId - * The unique ID of the Company, which is of type Company.Type#ADVERTISER, to which this order belongs. This attribute is required.

getAdvertiserContactIds

public long[] getAdvertiserContactIds()

Gets the advertiserContactIds value for this Order.

Returns:

advertiserContactIds * List of IDs for advertiser contacts of the order.

setAdvertiserContactIds

public void setAdvertiserContactIds(long[] advertiserContactIds)

Sets the advertiserContactIds value for this Order.

Parameters:

advertiserContactIds - * List of IDs for advertiser contacts of the order.

getAdvertiserContactIds

public long getAdvertiserContactIds(int i)

setAdvertiserContactIds

public void setAdvertiserContactIds(int i,
                           long _value)

getAgencyId

public Long getAgencyId()

Gets the agencyId value for this Order.

Returns:

agencyId * The unique ID of the Company, which is of type Company.Type#AGENCY, with which this order is associated. This attribute is optional.

setAgencyId

public void setAgencyId(Long agencyId)

Sets the agencyId value for this Order.

Parameters:

agencyId - * The unique ID of the Company, which is of type Company.Type#AGENCY, with which this order is associated. This attribute is optional.

getAgencyContactIds

public long[] getAgencyContactIds()

Gets the agencyContactIds value for this Order.

Returns:

agencyContactIds * List of IDs for agency contacts of the order.

setAgencyContactIds

public void setAgencyContactIds(long[] agencyContactIds)

Sets the agencyContactIds value for this Order.

Parameters:

agencyContactIds - * List of IDs for agency contacts of the order.

getAgencyContactIds

public long getAgencyContactIds(int i)

setAgencyContactIds

public void setAgencyContactIds(int i,
                       long _value)

getCreatorId

public Long getCreatorId()

Gets the creatorId value for this Order.

Returns:

creatorId * The unique ID of the User who created the Order on behalf of the advertiser. This value is readonly and is assigned by Google.

setCreatorId

public void setCreatorId(Long creatorId)

Sets the creatorId value for this Order.

Parameters:

creatorId - * The unique ID of the User who created the Order on behalf of the advertiser. This value is readonly and is assigned by Google.

getTraffickerId

public Long getTraffickerId()

Gets the traffickerId value for this Order.

Returns:

traffickerId * The unique ID of the User responsible for trafficking the Order. This value is required for creating an order.

setTraffickerId

public void setTraffickerId(Long traffickerId)

Sets the traffickerId value for this Order.

Parameters:

traffickerId - * The unique ID of the User responsible for trafficking the Order. This value is required for creating an order.

getSecondaryTraffickerIds

public long[] getSecondaryTraffickerIds()

Gets the secondaryTraffickerIds value for this Order.

Returns:

secondaryTraffickerIds * The IDs of the secondary traffickers associated with the order. This value is optional.

setSecondaryTraffickerIds

public void setSecondaryTraffickerIds(long[] secondaryTraffickerIds)

Sets the secondaryTraffickerIds value for this Order.

Parameters:

secondaryTraffickerIds - * The IDs of the secondary traffickers associated with the order. This value is optional.

getSecondaryTraffickerIds

public long getSecondaryTraffickerIds(int i)

setSecondaryTraffickerIds

public void setSecondaryTraffickerIds(int i,
                             long _value)

getSalespersonId

public Long getSalespersonId()

Gets the salespersonId value for this Order.

Returns:

salespersonId * The unique ID of the User responsible for the sales of the Order. This value is optional.

setSalespersonId

public void setSalespersonId(Long salespersonId)

Sets the salespersonId value for this Order.

Parameters:

salespersonId - * The unique ID of the User responsible for the sales of the Order. This value is optional.

getSecondarySalespersonIds

public long[] getSecondarySalespersonIds()

Gets the secondarySalespersonIds value for this Order.

Returns:

secondarySalespersonIds * The IDs of the secondary salespeople associated with the order. This value is optional.

setSecondarySalespersonIds

public void setSecondarySalespersonIds(long[] secondarySalespersonIds)

Sets the secondarySalespersonIds value for this Order.

Parameters:

secondarySalespersonIds - * The IDs of the secondary salespeople associated with the order. This value is optional.

getSecondarySalespersonIds

public long getSecondarySalespersonIds(int i)

setSecondarySalespersonIds

public void setSecondarySalespersonIds(int i,
                              long _value)

getTotalImpressionsDelivered

public Long getTotalImpressionsDelivered()

Gets the totalImpressionsDelivered value for this Order.

Returns:

totalImpressionsDelivered * Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google.

setTotalImpressionsDelivered

public void setTotalImpressionsDelivered(Long totalImpressionsDelivered)

Sets the totalImpressionsDelivered value for this Order.

Parameters:

totalImpressionsDelivered - * Total impressions delivered for all line items of this Order. This value is read-only and is assigned by Google.

getTotalClicksDelivered

public Long getTotalClicksDelivered()

Gets the totalClicksDelivered value for this Order.

Returns:

totalClicksDelivered * Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google.

setTotalClicksDelivered

public void setTotalClicksDelivered(Long totalClicksDelivered)

Sets the totalClicksDelivered value for this Order.

Parameters:

totalClicksDelivered - * Total clicks delivered for all line items of this Order. This value is read-only and is assigned by Google.

getTotalBudget

public Money getTotalBudget()

Gets the totalBudget value for this Order.

Returns:

totalBudget * Total budget for all line items of this Order. This value is a readonly field assigned by Google and is calculated from the associated LineItemSummary.costPerUnit values.

setTotalBudget

public void setTotalBudget(Money totalBudget)

Sets the totalBudget value for this Order.

Parameters:

totalBudget - * Total budget for all line items of this Order. This value is a readonly field assigned by Google and is calculated from the associated LineItemSummary.costPerUnit values.

getAppliedLabels

public AppliedLabel[] getAppliedLabels()

Gets the appliedLabels value for this Order.

Returns:

appliedLabels * The set of labels applied directly to this order.

setAppliedLabels

public void setAppliedLabels(AppliedLabel[] appliedLabels)

Sets the appliedLabels value for this Order.

Parameters:

appliedLabels - * The set of labels applied directly to this order.

getAppliedLabels

public AppliedLabel getAppliedLabels(int i)

setAppliedLabels

public void setAppliedLabels(int i,
                    AppliedLabel _value)

getEffectiveAppliedLabels

public AppliedLabel[] getEffectiveAppliedLabels()

Gets the effectiveAppliedLabels value for this Order.

Returns:

effectiveAppliedLabels * Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)

Sets the effectiveAppliedLabels value for this Order.

Parameters:

effectiveAppliedLabels - * Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

getEffectiveAppliedLabels

public AppliedLabel getEffectiveAppliedLabels(int i)

setEffectiveAppliedLabels

public void setEffectiveAppliedLabels(int i,
                             AppliedLabel _value)

getLastModifiedByApp

public String getLastModifiedByApp()

Gets the lastModifiedByApp value for this Order.

Returns:

lastModifiedByApp * The application which modified this order. This attribute is read only and is assigned by Google.

setLastModifiedByApp

public void setLastModifiedByApp(String lastModifiedByApp)

Sets the lastModifiedByApp value for this Order.

Parameters:

lastModifiedByApp - * The application which modified this order. This attribute is read only and is assigned by Google.

getAppliedTeamIds

public long[] getAppliedTeamIds()

Gets the appliedTeamIds value for this Order.

Returns:

appliedTeamIds * The IDs of all teams that this order is on directly.

setAppliedTeamIds

public void setAppliedTeamIds(long[] appliedTeamIds)

Sets the appliedTeamIds value for this Order.

Parameters:

appliedTeamIds - * The IDs of all teams that this order is on directly.

getAppliedTeamIds

public long getAppliedTeamIds(int i)

setAppliedTeamIds

public void setAppliedTeamIds(int i,
                     long _value)

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this Order.

Returns:

lastModifiedDateTime * The date and time this order was last modified.

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this Order.

Parameters:

lastModifiedDateTime - * The date and time this order was last modified.

getCustomFieldValues

public BaseCustomFieldValue[] getCustomFieldValues()

Gets the customFieldValues value for this Order.

Returns:

customFieldValues * The values of the custom fields associated with this order.

setCustomFieldValues

public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)

Sets the customFieldValues value for this Order.

Parameters:

customFieldValues - * The values of the custom fields associated with this order.

getCustomFieldValues

public BaseCustomFieldValue getCustomFieldValues(int i)

setCustomFieldValues

public void setCustomFieldValues(int i,
                        BaseCustomFieldValue _value)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                Class _javaType,
                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                    Class _javaType,
                                                    QName _xmlType)

Get Custom Deserializer