public class Order extends Object implements Serializable
Order represents a grouping of individual LineItem
objects, each of which fulfill an ad request from a particular advertiser.| 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,
Long totalViewableImpressionsDelivered,
Money totalBudget,
AppliedLabel[] appliedLabels,
AppliedLabel[] effectiveAppliedLabels,
String lastModifiedByApp,
Boolean isProgrammatic,
long[] appliedTeamIds,
DateTime lastModifiedDateTime,
BaseCustomFieldValue[] customFieldValues) |
| 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.
|
Boolean |
getIsProgrammatic()
Gets the isProgrammatic 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 |
getTotalViewableImpressionsDelivered()
Gets the totalViewableImpressionsDelivered 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 |
setIsProgrammatic(Boolean isProgrammatic)
Sets the isProgrammatic 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 |
setTotalViewableImpressionsDelivered(Long totalViewableImpressionsDelivered)
Sets the totalViewableImpressionsDelivered 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.
|
String |
toString() |
public 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, Long totalViewableImpressionsDelivered, Money totalBudget, AppliedLabel[] appliedLabels, AppliedLabel[] effectiveAppliedLabels, String lastModifiedByApp, Boolean isProgrammatic, long[] appliedTeamIds, DateTime lastModifiedDateTime, BaseCustomFieldValue[] customFieldValues)
public Long getId()
Order. This value is readonly
and is assigned
by Google.public void setId(Long id)
id - * The unique ID of the Order. This value is readonly
and is assigned
by Google.public String getName()
Order. This value is required to create
an order
and has a maximum length of 255 characters.public void setName(String name)
name - * The name of the Order. This value is required to create
an order
and has a maximum length of 255 characters.public DateTime getStartDateTime()
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.public void setStartDateTime(DateTime startDateTime)
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.public DateTime getEndDateTime()
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.public void setEndDateTime(DateTime endDateTime)
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.public Boolean getUnlimitedEndDateTime()
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.public void setUnlimitedEndDateTime(Boolean unlimitedEndDateTime)
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.public OrderStatus getStatus()
Order. This attribute is read-only.public void setStatus(OrderStatus status)
status - * The status of the Order. This attribute is read-only.public Boolean getIsArchived()
Order. This attribute is
readonly.public void setIsArchived(Boolean isArchived)
isArchived - * The archival status of the Order. This attribute is
readonly.public String getNotes()
Order. This
attribute is optional and has a maximum length of
65,535 characters.public void setNotes(String notes)
notes - * Provides any additional notes that may annotate the Order. This
attribute is optional and has a maximum length of
65,535 characters.public Integer getExternalOrderId()
Order, which can
be used as a
key to an external system. This value is optional.public void setExternalOrderId(Integer externalOrderId)
externalOrderId - * An arbitrary ID to associate to the Order, which can
be used as a
key to an external system. This value is optional.public String getPoNumber()
Order. This value
is optional
and has a maximum length of 63 characters.public void setPoNumber(String poNumber)
poNumber - * The purchase order number for the Order. This value
is optional
and has a maximum length of 63 characters.public String getCurrencyCode()
Order.
This
value is read-only and is the network's currency code.public void setCurrencyCode(String currencyCode)
currencyCode - * The ISO currency code for the currency used by the Order.
This
value is read-only and is the network's currency code.public Long getAdvertiserId()
Company, which is of type
Company.Type#ADVERTISER, to which this order
belongs. This
attribute is required.public void setAdvertiserId(Long advertiserId)
advertiserId - * The unique ID of the Company, which is of type
Company.Type#ADVERTISER, to which this order
belongs. This
attribute is required.public long[] getAdvertiserContactIds()
public void setAdvertiserContactIds(long[] advertiserContactIds)
advertiserContactIds - * List of IDs for advertiser contacts of the order.public long getAdvertiserContactIds(int i)
public void setAdvertiserContactIds(int i,
long _value)
public Long getAgencyId()
Company, which is of type
Company.Type#AGENCY, with which this order
is associated. This
attribute is optional.public void setAgencyId(Long agencyId)
agencyId - * The unique ID of the Company, which is of type
Company.Type#AGENCY, with which this order
is associated. This
attribute is optional.public long[] getAgencyContactIds()
public void setAgencyContactIds(long[] agencyContactIds)
agencyContactIds - * List of IDs for agency contacts of the order.public long getAgencyContactIds(int i)
public void setAgencyContactIds(int i,
long _value)
public Long getCreatorId()
User who created the Order
on behalf
of the advertiser. This value is readonly and is assigned
by Google.public void setCreatorId(Long creatorId)
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.public Long getTraffickerId()
User responsible for trafficking
the Order. This value is required for creating an order.public void setTraffickerId(Long traffickerId)
traffickerId - * The unique ID of the User responsible for trafficking
the Order. This value is required for creating an order.public long[] getSecondaryTraffickerIds()
public void setSecondaryTraffickerIds(long[] secondaryTraffickerIds)
secondaryTraffickerIds - * The IDs of the secondary traffickers associated with the order.
This value
is optional.public long getSecondaryTraffickerIds(int i)
public void setSecondaryTraffickerIds(int i,
long _value)
public Long getSalespersonId()
User responsible for the sales
of the Order. This value is optional.public void setSalespersonId(Long salespersonId)
salespersonId - * The unique ID of the User responsible for the sales
of the Order. This value is optional.public long[] getSecondarySalespersonIds()
public void setSecondarySalespersonIds(long[] secondarySalespersonIds)
secondarySalespersonIds - * The IDs of the secondary salespeople associated with the order.
This value
is optional.public long getSecondarySalespersonIds(int i)
public void setSecondarySalespersonIds(int i,
long _value)
public Long getTotalImpressionsDelivered()
Order. This
value is read-only and is assigned by Google.public void setTotalImpressionsDelivered(Long totalImpressionsDelivered)
totalImpressionsDelivered - * Total impressions delivered for all line items of this Order. This
value is read-only and is assigned by Google.public Long getTotalClicksDelivered()
Order.
This value
is read-only and is assigned by Google.public void setTotalClicksDelivered(Long totalClicksDelivered)
totalClicksDelivered - * Total clicks delivered for all line items of this Order.
This value
is read-only and is assigned by Google.public Long getTotalViewableImpressionsDelivered()
Order.
This value is read-only and is assigned by Google.
Starting in v201705, this will be null when the order does
not have line items
trafficked against a viewable impressions goal.public void setTotalViewableImpressionsDelivered(Long totalViewableImpressionsDelivered)
totalViewableImpressionsDelivered - * Total viewable impressions delivered for all line items of
this Order.
This value is read-only and is assigned by Google.
Starting in v201705, this will be null when the order does
not have line items
trafficked against a viewable impressions goal.public Money getTotalBudget()
Order. This
value is a
readonly field assigned by Google and is calculated
from the associated
LineItemSummary.costPerUnit values.public void setTotalBudget(Money totalBudget)
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.public AppliedLabel[] getAppliedLabels()
public void setAppliedLabels(AppliedLabel[] appliedLabels)
appliedLabels - * The set of labels applied directly to this order.public AppliedLabel getAppliedLabels(int i)
public void setAppliedLabels(int i,
AppliedLabel _value)
public AppliedLabel[] getEffectiveAppliedLabels()
public void setEffectiveAppliedLabels(AppliedLabel[] effectiveAppliedLabels)
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.public AppliedLabel getEffectiveAppliedLabels(int i)
public void setEffectiveAppliedLabels(int i,
AppliedLabel _value)
public String getLastModifiedByApp()
public void setLastModifiedByApp(String lastModifiedByApp)
lastModifiedByApp - * The application which modified this order. This attribute is
read only and
is assigned by Google.public Boolean getIsProgrammatic()
Order is a programmatic
order. This
value is optional and defaults to false.public void setIsProgrammatic(Boolean isProgrammatic)
isProgrammatic - * Specifies whether or not the Order is a programmatic
order. This
value is optional and defaults to false.public long[] getAppliedTeamIds()
public void setAppliedTeamIds(long[] appliedTeamIds)
appliedTeamIds - * The IDs of all teams that this order is on directly.public long getAppliedTeamIds(int i)
public void setAppliedTeamIds(int i,
long _value)
public DateTime getLastModifiedDateTime()
public void setLastModifiedDateTime(DateTime lastModifiedDateTime)
lastModifiedDateTime - * The date and time this order was last modified.public BaseCustomFieldValue[] getCustomFieldValues()
public void setCustomFieldValues(BaseCustomFieldValue[] customFieldValues)
customFieldValues - * The values of the custom fields associated with this order.public BaseCustomFieldValue getCustomFieldValues(int i)
public void setCustomFieldValues(int i,
BaseCustomFieldValue _value)
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(String mechType, Class _javaType, QName _xmlType)
Copyright © 2022. All rights reserved.