com.google.api.ads.admanager.jaxws.v202311.Order Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.ads.admanager.jaxws.v202311;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
/**
*
* An {@code Order} represents a grouping of individual {@link 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/v202311}DateTime" minOccurs="0"/>
* <element name="endDateTime" type="{https://www.google.com/apis/ads/publisher/v202311}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/v202311}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/v202311}Money" minOccurs="0"/>
* <element name="appliedLabels" type="{https://www.google.com/apis/ads/publisher/v202311}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
* <element name="effectiveAppliedLabels" type="{https://www.google.com/apis/ads/publisher/v202311}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/v202311}DateTime" minOccurs="0"/>
* <element name="customFieldValues" type="{https://www.google.com/apis/ads/publisher/v202311}BaseCustomFieldValue" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Order", propOrder = {
"id",
"name",
"startDateTime",
"endDateTime",
"unlimitedEndDateTime",
"status",
"isArchived",
"notes",
"externalOrderId",
"poNumber",
"currencyCode",
"advertiserId",
"advertiserContactIds",
"agencyId",
"agencyContactIds",
"creatorId",
"traffickerId",
"secondaryTraffickerIds",
"salespersonId",
"secondarySalespersonIds",
"totalImpressionsDelivered",
"totalClicksDelivered",
"totalViewableImpressionsDelivered",
"totalBudget",
"appliedLabels",
"effectiveAppliedLabels",
"lastModifiedByApp",
"isProgrammatic",
"appliedTeamIds",
"lastModifiedDateTime",
"customFieldValues"
})
public class Order {
protected Long id;
protected String name;
protected DateTime startDateTime;
protected DateTime endDateTime;
protected Boolean unlimitedEndDateTime;
@XmlSchemaType(name = "string")
protected OrderStatus status;
protected Boolean isArchived;
protected String notes;
protected Integer externalOrderId;
protected String poNumber;
protected String currencyCode;
protected Long advertiserId;
@XmlElement(type = Long.class)
protected List advertiserContactIds;
protected Long agencyId;
@XmlElement(type = Long.class)
protected List agencyContactIds;
protected Long creatorId;
protected Long traffickerId;
@XmlElement(type = Long.class)
protected List secondaryTraffickerIds;
protected Long salespersonId;
@XmlElement(type = Long.class)
protected List secondarySalespersonIds;
protected Long totalImpressionsDelivered;
protected Long totalClicksDelivered;
protected Long totalViewableImpressionsDelivered;
protected Money totalBudget;
protected List appliedLabels;
protected List effectiveAppliedLabels;
protected String lastModifiedByApp;
protected Boolean isProgrammatic;
@XmlElement(type = Long.class)
protected List appliedTeamIds;
protected DateTime lastModifiedDateTime;
protected List customFieldValues;
/**
* Gets the value of the id property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getId() {
return id;
}
/**
* Sets the value of the id property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setId(Long value) {
this.id = value;
}
/**
* Gets the value of the name property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getName() {
return name;
}
/**
* Sets the value of the name property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setName(String value) {
this.name = value;
}
/**
* Gets the value of the startDateTime property.
*
* @return
* possible object is
* {@link DateTime }
*
*/
public DateTime getStartDateTime() {
return startDateTime;
}
/**
* Sets the value of the startDateTime property.
*
* @param value
* allowed object is
* {@link DateTime }
*
*/
public void setStartDateTime(DateTime value) {
this.startDateTime = value;
}
/**
* Gets the value of the endDateTime property.
*
* @return
* possible object is
* {@link DateTime }
*
*/
public DateTime getEndDateTime() {
return endDateTime;
}
/**
* Sets the value of the endDateTime property.
*
* @param value
* allowed object is
* {@link DateTime }
*
*/
public void setEndDateTime(DateTime value) {
this.endDateTime = value;
}
/**
* Gets the value of the unlimitedEndDateTime property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isUnlimitedEndDateTime() {
return unlimitedEndDateTime;
}
/**
* Sets the value of the unlimitedEndDateTime property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setUnlimitedEndDateTime(Boolean value) {
this.unlimitedEndDateTime = value;
}
/**
* Gets the value of the status property.
*
* @return
* possible object is
* {@link OrderStatus }
*
*/
public OrderStatus getStatus() {
return status;
}
/**
* Sets the value of the status property.
*
* @param value
* allowed object is
* {@link OrderStatus }
*
*/
public void setStatus(OrderStatus value) {
this.status = value;
}
/**
* Gets the value of the isArchived property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIsArchived() {
return isArchived;
}
/**
* Sets the value of the isArchived property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setIsArchived(Boolean value) {
this.isArchived = value;
}
/**
* Gets the value of the notes property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getNotes() {
return notes;
}
/**
* Sets the value of the notes property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setNotes(String value) {
this.notes = value;
}
/**
* Gets the value of the externalOrderId property.
*
* @return
* possible object is
* {@link Integer }
*
*/
public Integer getExternalOrderId() {
return externalOrderId;
}
/**
* Sets the value of the externalOrderId property.
*
* @param value
* allowed object is
* {@link Integer }
*
*/
public void setExternalOrderId(Integer value) {
this.externalOrderId = value;
}
/**
* Gets the value of the poNumber property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getPoNumber() {
return poNumber;
}
/**
* Sets the value of the poNumber property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setPoNumber(String value) {
this.poNumber = value;
}
/**
* Gets the value of the currencyCode property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getCurrencyCode() {
return currencyCode;
}
/**
* Sets the value of the currencyCode property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setCurrencyCode(String value) {
this.currencyCode = value;
}
/**
* Gets the value of the advertiserId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getAdvertiserId() {
return advertiserId;
}
/**
* Sets the value of the advertiserId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setAdvertiserId(Long value) {
this.advertiserId = value;
}
/**
* Gets the value of the advertiserContactIds property.
*
*
* 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
* {@link Long }
*
*
*/
public List getAdvertiserContactIds() {
if (advertiserContactIds == null) {
advertiserContactIds = new ArrayList();
}
return this.advertiserContactIds;
}
/**
* Gets the value of the agencyId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getAgencyId() {
return agencyId;
}
/**
* Sets the value of the agencyId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setAgencyId(Long value) {
this.agencyId = value;
}
/**
* Gets the value of the agencyContactIds property.
*
*
* 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
* {@link Long }
*
*
*/
public List getAgencyContactIds() {
if (agencyContactIds == null) {
agencyContactIds = new ArrayList();
}
return this.agencyContactIds;
}
/**
* Gets the value of the creatorId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getCreatorId() {
return creatorId;
}
/**
* Sets the value of the creatorId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setCreatorId(Long value) {
this.creatorId = value;
}
/**
* Gets the value of the traffickerId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getTraffickerId() {
return traffickerId;
}
/**
* Sets the value of the traffickerId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setTraffickerId(Long value) {
this.traffickerId = value;
}
/**
* Gets the value of the secondaryTraffickerIds property.
*
*
* 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
* {@link Long }
*
*
*/
public List getSecondaryTraffickerIds() {
if (secondaryTraffickerIds == null) {
secondaryTraffickerIds = new ArrayList();
}
return this.secondaryTraffickerIds;
}
/**
* Gets the value of the salespersonId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getSalespersonId() {
return salespersonId;
}
/**
* Sets the value of the salespersonId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setSalespersonId(Long value) {
this.salespersonId = value;
}
/**
* Gets the value of the secondarySalespersonIds property.
*
*
* 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
* {@link Long }
*
*
*/
public List getSecondarySalespersonIds() {
if (secondarySalespersonIds == null) {
secondarySalespersonIds = new ArrayList();
}
return this.secondarySalespersonIds;
}
/**
* Gets the value of the totalImpressionsDelivered property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getTotalImpressionsDelivered() {
return totalImpressionsDelivered;
}
/**
* Sets the value of the totalImpressionsDelivered property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setTotalImpressionsDelivered(Long value) {
this.totalImpressionsDelivered = value;
}
/**
* Gets the value of the totalClicksDelivered property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getTotalClicksDelivered() {
return totalClicksDelivered;
}
/**
* Sets the value of the totalClicksDelivered property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setTotalClicksDelivered(Long value) {
this.totalClicksDelivered = value;
}
/**
* Gets the value of the totalViewableImpressionsDelivered property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getTotalViewableImpressionsDelivered() {
return totalViewableImpressionsDelivered;
}
/**
* Sets the value of the totalViewableImpressionsDelivered property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setTotalViewableImpressionsDelivered(Long value) {
this.totalViewableImpressionsDelivered = value;
}
/**
* Gets the value of the totalBudget property.
*
* @return
* possible object is
* {@link Money }
*
*/
public Money getTotalBudget() {
return totalBudget;
}
/**
* Sets the value of the totalBudget property.
*
* @param value
* allowed object is
* {@link Money }
*
*/
public void setTotalBudget(Money value) {
this.totalBudget = value;
}
/**
* Gets the value of the appliedLabels property.
*
*
* 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
* {@link AppliedLabel }
*
*
*/
public List getAppliedLabels() {
if (appliedLabels == null) {
appliedLabels = new ArrayList();
}
return this.appliedLabels;
}
/**
* Gets the value of the effectiveAppliedLabels property.
*
*
* 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
* {@link AppliedLabel }
*
*
*/
public List getEffectiveAppliedLabels() {
if (effectiveAppliedLabels == null) {
effectiveAppliedLabels = new ArrayList();
}
return this.effectiveAppliedLabels;
}
/**
* Gets the value of the lastModifiedByApp property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getLastModifiedByApp() {
return lastModifiedByApp;
}
/**
* Sets the value of the lastModifiedByApp property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setLastModifiedByApp(String value) {
this.lastModifiedByApp = value;
}
/**
* Gets the value of the isProgrammatic property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIsProgrammatic() {
return isProgrammatic;
}
/**
* Sets the value of the isProgrammatic property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setIsProgrammatic(Boolean value) {
this.isProgrammatic = value;
}
/**
* Gets the value of the appliedTeamIds property.
*
*
* 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
* {@link Long }
*
*
*/
public List getAppliedTeamIds() {
if (appliedTeamIds == null) {
appliedTeamIds = new ArrayList();
}
return this.appliedTeamIds;
}
/**
* Gets the value of the lastModifiedDateTime property.
*
* @return
* possible object is
* {@link DateTime }
*
*/
public DateTime getLastModifiedDateTime() {
return lastModifiedDateTime;
}
/**
* Sets the value of the lastModifiedDateTime property.
*
* @param value
* allowed object is
* {@link DateTime }
*
*/
public void setLastModifiedDateTime(DateTime value) {
this.lastModifiedDateTime = value;
}
/**
* Gets the value of the customFieldValues property.
*
*
* 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
* {@link BaseCustomFieldValue }
*
*
*/
public List getCustomFieldValues() {
if (customFieldValues == null) {
customFieldValues = new ArrayList();
}
return this.customFieldValues;
}
}