public class Order extends Object
Order represents a grouping of individual LineItem
objects, each of which fulfill an ad request from a particular advertiser.
Java class for Order complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="Order">
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
<element name="id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
<element name="startDateTime" type="{https://www.google.com/apis/ads/publisher/v201805}DateTime" minOccurs="0"/>
<element name="endDateTime" type="{https://www.google.com/apis/ads/publisher/v201805}DateTime" minOccurs="0"/>
<element name="unlimitedEndDateTime" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
<element name="status" type="{https://www.google.com/apis/ads/publisher/v201805}OrderStatus" minOccurs="0"/>
<element name="isArchived" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
<element name="notes" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
<element name="externalOrderId" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
<element name="poNumber" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
<element name="currencyCode" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
<element name="advertiserId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="advertiserContactIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
<element name="agencyId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="agencyContactIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
<element name="creatorId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="traffickerId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="secondaryTraffickerIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
<element name="salespersonId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="secondarySalespersonIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
<element name="totalImpressionsDelivered" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="totalClicksDelivered" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="totalViewableImpressionsDelivered" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
<element name="totalBudget" type="{https://www.google.com/apis/ads/publisher/v201805}Money" minOccurs="0"/>
<element name="appliedLabels" type="{https://www.google.com/apis/ads/publisher/v201805}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
<element name="effectiveAppliedLabels" type="{https://www.google.com/apis/ads/publisher/v201805}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
<element name="lastModifiedByApp" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
<element name="isProgrammatic" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
<element name="appliedTeamIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
<element name="lastModifiedDateTime" type="{https://www.google.com/apis/ads/publisher/v201805}DateTime" minOccurs="0"/>
<element name="customFieldValues" type="{https://www.google.com/apis/ads/publisher/v201805}BaseCustomFieldValue" maxOccurs="unbounded" minOccurs="0"/>
</sequence>
</restriction>
</complexContent>
</complexType>
| Constructor and Description |
|---|
Order() |
| Modifier and Type | Method and Description |
|---|---|
List<Long> |
getAdvertiserContactIds()
Gets the value of the advertiserContactIds property.
|
Long |
getAdvertiserId()
Gets the value of the advertiserId property.
|
List<Long> |
getAgencyContactIds()
Gets the value of the agencyContactIds property.
|
Long |
getAgencyId()
Gets the value of the agencyId property.
|
List<AppliedLabel> |
getAppliedLabels()
Gets the value of the appliedLabels property.
|
List<Long> |
getAppliedTeamIds()
Gets the value of the appliedTeamIds property.
|
Long |
getCreatorId()
Gets the value of the creatorId property.
|
String |
getCurrencyCode()
Gets the value of the currencyCode property.
|
List<BaseCustomFieldValue> |
getCustomFieldValues()
Gets the value of the customFieldValues property.
|
List<AppliedLabel> |
getEffectiveAppliedLabels()
Gets the value of the effectiveAppliedLabels property.
|
DateTime |
getEndDateTime()
Gets the value of the endDateTime property.
|
Integer |
getExternalOrderId()
Gets the value of the externalOrderId property.
|
Long |
getId()
Gets the value of the id property.
|
String |
getLastModifiedByApp()
Gets the value of the lastModifiedByApp property.
|
DateTime |
getLastModifiedDateTime()
Gets the value of the lastModifiedDateTime property.
|
String |
getName()
Gets the value of the name property.
|
String |
getNotes()
Gets the value of the notes property.
|
String |
getPoNumber()
Gets the value of the poNumber property.
|
Long |
getSalespersonId()
Gets the value of the salespersonId property.
|
List<Long> |
getSecondarySalespersonIds()
Gets the value of the secondarySalespersonIds property.
|
List<Long> |
getSecondaryTraffickerIds()
Gets the value of the secondaryTraffickerIds property.
|
DateTime |
getStartDateTime()
Gets the value of the startDateTime property.
|
OrderStatus |
getStatus()
Gets the value of the status property.
|
Money |
getTotalBudget()
Gets the value of the totalBudget property.
|
Long |
getTotalClicksDelivered()
Gets the value of the totalClicksDelivered property.
|
Long |
getTotalImpressionsDelivered()
Gets the value of the totalImpressionsDelivered property.
|
Long |
getTotalViewableImpressionsDelivered()
Gets the value of the totalViewableImpressionsDelivered property.
|
Long |
getTraffickerId()
Gets the value of the traffickerId property.
|
Boolean |
isIsArchived()
Gets the value of the isArchived property.
|
Boolean |
isIsProgrammatic()
Gets the value of the isProgrammatic property.
|
Boolean |
isUnlimitedEndDateTime()
Gets the value of the unlimitedEndDateTime property.
|
void |
setAdvertiserId(Long value)
Sets the value of the advertiserId property.
|
void |
setAgencyId(Long value)
Sets the value of the agencyId property.
|
void |
setCreatorId(Long value)
Sets the value of the creatorId property.
|
void |
setCurrencyCode(String value)
Sets the value of the currencyCode property.
|
void |
setEndDateTime(DateTime value)
Sets the value of the endDateTime property.
|
void |
setExternalOrderId(Integer value)
Sets the value of the externalOrderId property.
|
void |
setId(Long value)
Sets the value of the id property.
|
void |
setIsArchived(Boolean value)
Sets the value of the isArchived property.
|
void |
setIsProgrammatic(Boolean value)
Sets the value of the isProgrammatic property.
|
void |
setLastModifiedByApp(String value)
Sets the value of the lastModifiedByApp property.
|
void |
setLastModifiedDateTime(DateTime value)
Sets the value of the lastModifiedDateTime property.
|
void |
setName(String value)
Sets the value of the name property.
|
void |
setNotes(String value)
Sets the value of the notes property.
|
void |
setPoNumber(String value)
Sets the value of the poNumber property.
|
void |
setSalespersonId(Long value)
Sets the value of the salespersonId property.
|
void |
setStartDateTime(DateTime value)
Sets the value of the startDateTime property.
|
void |
setStatus(OrderStatus value)
Sets the value of the status property.
|
void |
setTotalBudget(Money value)
Sets the value of the totalBudget property.
|
void |
setTotalClicksDelivered(Long value)
Sets the value of the totalClicksDelivered property.
|
void |
setTotalImpressionsDelivered(Long value)
Sets the value of the totalImpressionsDelivered property.
|
void |
setTotalViewableImpressionsDelivered(Long value)
Sets the value of the totalViewableImpressionsDelivered property.
|
void |
setTraffickerId(Long value)
Sets the value of the traffickerId property.
|
void |
setUnlimitedEndDateTime(Boolean value)
Sets the value of the unlimitedEndDateTime property.
|
protected Long id
protected String name
protected DateTime startDateTime
protected DateTime endDateTime
protected Boolean unlimitedEndDateTime
protected OrderStatus status
protected Boolean isArchived
protected String notes
protected Integer externalOrderId
protected String poNumber
protected String currencyCode
protected Long advertiserId
protected Long agencyId
protected Long creatorId
protected Long traffickerId
protected Long salespersonId
protected Long totalImpressionsDelivered
protected Long totalClicksDelivered
protected Long totalViewableImpressionsDelivered
protected Money totalBudget
protected List<AppliedLabel> appliedLabels
protected List<AppliedLabel> effectiveAppliedLabels
protected String lastModifiedByApp
protected Boolean isProgrammatic
protected DateTime lastModifiedDateTime
protected List<BaseCustomFieldValue> customFieldValues
public void setId(Long value)
value - allowed object is
Longpublic String getName()
Stringpublic void setName(String value)
value - allowed object is
Stringpublic DateTime getStartDateTime()
DateTimepublic void setStartDateTime(DateTime value)
value - allowed object is
DateTimepublic DateTime getEndDateTime()
DateTimepublic void setEndDateTime(DateTime value)
value - allowed object is
DateTimepublic Boolean isUnlimitedEndDateTime()
Booleanpublic void setUnlimitedEndDateTime(Boolean value)
value - allowed object is
Booleanpublic OrderStatus getStatus()
OrderStatuspublic void setStatus(OrderStatus value)
value - allowed object is
OrderStatuspublic Boolean isIsArchived()
Booleanpublic void setIsArchived(Boolean value)
value - allowed object is
Booleanpublic String getNotes()
Stringpublic void setNotes(String value)
value - allowed object is
Stringpublic Integer getExternalOrderId()
Integerpublic void setExternalOrderId(Integer value)
value - allowed object is
Integerpublic String getPoNumber()
Stringpublic void setPoNumber(String value)
value - allowed object is
Stringpublic String getCurrencyCode()
Stringpublic void setCurrencyCode(String value)
value - allowed object is
Stringpublic Long getAdvertiserId()
Longpublic void setAdvertiserId(Long value)
value - allowed object is
Longpublic List<Long> getAdvertiserContactIds()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the advertiserContactIds property.
For example, to add a new item, do as follows:
getAdvertiserContactIds().add(newItem);
Objects of the following type(s) are allowed in the list
Long
public Long getAgencyId()
Longpublic void setAgencyId(Long value)
value - allowed object is
Longpublic List<Long> getAgencyContactIds()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the agencyContactIds property.
For example, to add a new item, do as follows:
getAgencyContactIds().add(newItem);
Objects of the following type(s) are allowed in the list
Long
public Long getCreatorId()
Longpublic void setCreatorId(Long value)
value - allowed object is
Longpublic Long getTraffickerId()
Longpublic void setTraffickerId(Long value)
value - allowed object is
Longpublic List<Long> getSecondaryTraffickerIds()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the secondaryTraffickerIds property.
For example, to add a new item, do as follows:
getSecondaryTraffickerIds().add(newItem);
Objects of the following type(s) are allowed in the list
Long
public Long getSalespersonId()
Longpublic void setSalespersonId(Long value)
value - allowed object is
Longpublic List<Long> getSecondarySalespersonIds()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the secondarySalespersonIds property.
For example, to add a new item, do as follows:
getSecondarySalespersonIds().add(newItem);
Objects of the following type(s) are allowed in the list
Long
public Long getTotalImpressionsDelivered()
Longpublic void setTotalImpressionsDelivered(Long value)
value - allowed object is
Longpublic Long getTotalClicksDelivered()
Longpublic void setTotalClicksDelivered(Long value)
value - allowed object is
Longpublic Long getTotalViewableImpressionsDelivered()
Longpublic void setTotalViewableImpressionsDelivered(Long value)
value - allowed object is
Longpublic Money getTotalBudget()
Moneypublic void setTotalBudget(Money value)
value - allowed object is
Moneypublic List<AppliedLabel> getAppliedLabels()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the appliedLabels property.
For example, to add a new item, do as follows:
getAppliedLabels().add(newItem);
Objects of the following type(s) are allowed in the list
AppliedLabel
public List<AppliedLabel> getEffectiveAppliedLabels()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the effectiveAppliedLabels property.
For example, to add a new item, do as follows:
getEffectiveAppliedLabels().add(newItem);
Objects of the following type(s) are allowed in the list
AppliedLabel
public String getLastModifiedByApp()
Stringpublic void setLastModifiedByApp(String value)
value - allowed object is
Stringpublic Boolean isIsProgrammatic()
Booleanpublic void setIsProgrammatic(Boolean value)
value - allowed object is
Booleanpublic List<Long> getAppliedTeamIds()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the appliedTeamIds property.
For example, to add a new item, do as follows:
getAppliedTeamIds().add(newItem);
Objects of the following type(s) are allowed in the list
Long
public DateTime getLastModifiedDateTime()
DateTimepublic void setLastModifiedDateTime(DateTime value)
value - allowed object is
DateTimepublic List<BaseCustomFieldValue> getCustomFieldValues()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set method for the customFieldValues property.
For example, to add a new item, do as follows:
getCustomFieldValues().add(newItem);
Objects of the following type(s) are allowed in the list
BaseCustomFieldValue
Copyright © 2018. All Rights Reserved.