com.google.api.ads.admanager.jaxws.v202405.AdUnit Maven / Gradle / Ivy
Show all versions of dfp-appengine Show documentation
// Copyright 2024 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.v202405;
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 AdUnit} represents a chunk of identified inventory for the publisher. It contains all
* the settings that need to be associated with inventory in order to serve ads to it. An {@code
* AdUnit} can also be the parent of other ad units in the inventory hierarchy.
*
*
* Java class for AdUnit complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="AdUnit">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="id" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="parentId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="hasChildren" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* <element name="parentPath" type="{https://www.google.com/apis/ads/publisher/v202405}AdUnitParent" maxOccurs="unbounded" minOccurs="0"/>
* <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="targetWindow" type="{https://www.google.com/apis/ads/publisher/v202405}AdUnit.TargetWindow" minOccurs="0"/>
* <element name="status" type="{https://www.google.com/apis/ads/publisher/v202405}InventoryStatus" minOccurs="0"/>
* <element name="adUnitCode" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="adUnitSizes" type="{https://www.google.com/apis/ads/publisher/v202405}AdUnitSize" maxOccurs="unbounded" minOccurs="0"/>
* <element name="isInterstitial" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* <element name="isNative" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* <element name="isFluid" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* <element name="explicitlyTargeted" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* <element name="adSenseSettings" type="{https://www.google.com/apis/ads/publisher/v202405}AdSenseSettings" minOccurs="0"/>
* <element name="adSenseSettingsSource" type="{https://www.google.com/apis/ads/publisher/v202405}ValueSourceType" minOccurs="0"/>
* <element name="appliedLabelFrequencyCaps" type="{https://www.google.com/apis/ads/publisher/v202405}LabelFrequencyCap" maxOccurs="unbounded" minOccurs="0"/>
* <element name="effectiveLabelFrequencyCaps" type="{https://www.google.com/apis/ads/publisher/v202405}LabelFrequencyCap" maxOccurs="unbounded" minOccurs="0"/>
* <element name="appliedLabels" type="{https://www.google.com/apis/ads/publisher/v202405}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
* <element name="effectiveAppliedLabels" type="{https://www.google.com/apis/ads/publisher/v202405}AppliedLabel" maxOccurs="unbounded" minOccurs="0"/>
* <element name="effectiveTeamIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" 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/v202405}DateTime" minOccurs="0"/>
* <element name="smartSizeMode" type="{https://www.google.com/apis/ads/publisher/v202405}SmartSizeMode" minOccurs="0"/>
* <element name="refreshRate" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
* <element name="externalSetTopBoxChannelId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="isSetTopBoxEnabled" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
* <element name="applicationId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "AdUnit", propOrder = {
"id",
"parentId",
"hasChildren",
"parentPath",
"name",
"description",
"targetWindow",
"status",
"adUnitCode",
"adUnitSizes",
"isInterstitial",
"isNative",
"isFluid",
"explicitlyTargeted",
"adSenseSettings",
"adSenseSettingsSource",
"appliedLabelFrequencyCaps",
"effectiveLabelFrequencyCaps",
"appliedLabels",
"effectiveAppliedLabels",
"effectiveTeamIds",
"appliedTeamIds",
"lastModifiedDateTime",
"smartSizeMode",
"refreshRate",
"externalSetTopBoxChannelId",
"isSetTopBoxEnabled",
"applicationId"
})
public class AdUnit {
protected String id;
protected String parentId;
protected Boolean hasChildren;
protected List parentPath;
protected String name;
protected String description;
@XmlSchemaType(name = "string")
protected AdUnitTargetWindow targetWindow;
@XmlSchemaType(name = "string")
protected InventoryStatus status;
protected String adUnitCode;
protected List adUnitSizes;
protected Boolean isInterstitial;
protected Boolean isNative;
protected Boolean isFluid;
protected Boolean explicitlyTargeted;
protected AdSenseSettings adSenseSettings;
@XmlSchemaType(name = "string")
protected ValueSourceType adSenseSettingsSource;
protected List appliedLabelFrequencyCaps;
protected List effectiveLabelFrequencyCaps;
protected List appliedLabels;
protected List effectiveAppliedLabels;
@XmlElement(type = Long.class)
protected List effectiveTeamIds;
@XmlElement(type = Long.class)
protected List appliedTeamIds;
protected DateTime lastModifiedDateTime;
@XmlSchemaType(name = "string")
protected SmartSizeMode smartSizeMode;
protected Integer refreshRate;
protected String externalSetTopBoxChannelId;
protected Boolean isSetTopBoxEnabled;
protected Long applicationId;
/**
* Gets the value of the id property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getId() {
return id;
}
/**
* Sets the value of the id property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setId(String value) {
this.id = value;
}
/**
* Gets the value of the parentId property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getParentId() {
return parentId;
}
/**
* Sets the value of the parentId property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setParentId(String value) {
this.parentId = value;
}
/**
* Gets the value of the hasChildren property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isHasChildren() {
return hasChildren;
}
/**
* Sets the value of the hasChildren property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setHasChildren(Boolean value) {
this.hasChildren = value;
}
/**
* Gets the value of the parentPath 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 parentPath property.
*
*
* For example, to add a new item, do as follows:
*
* getParentPath().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link AdUnitParent }
*
*
*/
public List getParentPath() {
if (parentPath == null) {
parentPath = new ArrayList();
}
return this.parentPath;
}
/**
* 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 description property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getDescription() {
return description;
}
/**
* Sets the value of the description property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setDescription(String value) {
this.description = value;
}
/**
* Gets the value of the targetWindow property.
*
* @return
* possible object is
* {@link AdUnitTargetWindow }
*
*/
public AdUnitTargetWindow getTargetWindow() {
return targetWindow;
}
/**
* Sets the value of the targetWindow property.
*
* @param value
* allowed object is
* {@link AdUnitTargetWindow }
*
*/
public void setTargetWindow(AdUnitTargetWindow value) {
this.targetWindow = value;
}
/**
* Gets the value of the status property.
*
* @return
* possible object is
* {@link InventoryStatus }
*
*/
public InventoryStatus getStatus() {
return status;
}
/**
* Sets the value of the status property.
*
* @param value
* allowed object is
* {@link InventoryStatus }
*
*/
public void setStatus(InventoryStatus value) {
this.status = value;
}
/**
* Gets the value of the adUnitCode property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getAdUnitCode() {
return adUnitCode;
}
/**
* Sets the value of the adUnitCode property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setAdUnitCode(String value) {
this.adUnitCode = value;
}
/**
* Gets the value of the adUnitSizes 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 adUnitSizes property.
*
*
* For example, to add a new item, do as follows:
*
* getAdUnitSizes().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link AdUnitSize }
*
*
*/
public List getAdUnitSizes() {
if (adUnitSizes == null) {
adUnitSizes = new ArrayList();
}
return this.adUnitSizes;
}
/**
* Gets the value of the isInterstitial property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIsInterstitial() {
return isInterstitial;
}
/**
* Sets the value of the isInterstitial property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setIsInterstitial(Boolean value) {
this.isInterstitial = value;
}
/**
* Gets the value of the isNative property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIsNative() {
return isNative;
}
/**
* Sets the value of the isNative property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setIsNative(Boolean value) {
this.isNative = value;
}
/**
* Gets the value of the isFluid property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIsFluid() {
return isFluid;
}
/**
* Sets the value of the isFluid property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setIsFluid(Boolean value) {
this.isFluid = value;
}
/**
* Gets the value of the explicitlyTargeted property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isExplicitlyTargeted() {
return explicitlyTargeted;
}
/**
* Sets the value of the explicitlyTargeted property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setExplicitlyTargeted(Boolean value) {
this.explicitlyTargeted = value;
}
/**
* Gets the value of the adSenseSettings property.
*
* @return
* possible object is
* {@link AdSenseSettings }
*
*/
public AdSenseSettings getAdSenseSettings() {
return adSenseSettings;
}
/**
* Sets the value of the adSenseSettings property.
*
* @param value
* allowed object is
* {@link AdSenseSettings }
*
*/
public void setAdSenseSettings(AdSenseSettings value) {
this.adSenseSettings = value;
}
/**
* Gets the value of the adSenseSettingsSource property.
*
* @return
* possible object is
* {@link ValueSourceType }
*
*/
public ValueSourceType getAdSenseSettingsSource() {
return adSenseSettingsSource;
}
/**
* Sets the value of the adSenseSettingsSource property.
*
* @param value
* allowed object is
* {@link ValueSourceType }
*
*/
public void setAdSenseSettingsSource(ValueSourceType value) {
this.adSenseSettingsSource = value;
}
/**
* Gets the value of the appliedLabelFrequencyCaps 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 appliedLabelFrequencyCaps property.
*
*
* For example, to add a new item, do as follows:
*
* getAppliedLabelFrequencyCaps().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link LabelFrequencyCap }
*
*
*/
public List getAppliedLabelFrequencyCaps() {
if (appliedLabelFrequencyCaps == null) {
appliedLabelFrequencyCaps = new ArrayList();
}
return this.appliedLabelFrequencyCaps;
}
/**
* Gets the value of the effectiveLabelFrequencyCaps 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 effectiveLabelFrequencyCaps property.
*
*
* For example, to add a new item, do as follows:
*
* getEffectiveLabelFrequencyCaps().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link LabelFrequencyCap }
*
*
*/
public List getEffectiveLabelFrequencyCaps() {
if (effectiveLabelFrequencyCaps == null) {
effectiveLabelFrequencyCaps = new ArrayList();
}
return this.effectiveLabelFrequencyCaps;
}
/**
* 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 effectiveTeamIds 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 effectiveTeamIds property.
*
*
* For example, to add a new item, do as follows:
*
* getEffectiveTeamIds().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Long }
*
*
*/
public List getEffectiveTeamIds() {
if (effectiveTeamIds == null) {
effectiveTeamIds = new ArrayList();
}
return this.effectiveTeamIds;
}
/**
* 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 smartSizeMode property.
*
* @return
* possible object is
* {@link SmartSizeMode }
*
*/
public SmartSizeMode getSmartSizeMode() {
return smartSizeMode;
}
/**
* Sets the value of the smartSizeMode property.
*
* @param value
* allowed object is
* {@link SmartSizeMode }
*
*/
public void setSmartSizeMode(SmartSizeMode value) {
this.smartSizeMode = value;
}
/**
* Gets the value of the refreshRate property.
*
* @return
* possible object is
* {@link Integer }
*
*/
public Integer getRefreshRate() {
return refreshRate;
}
/**
* Sets the value of the refreshRate property.
*
* @param value
* allowed object is
* {@link Integer }
*
*/
public void setRefreshRate(Integer value) {
this.refreshRate = value;
}
/**
* Gets the value of the externalSetTopBoxChannelId property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getExternalSetTopBoxChannelId() {
return externalSetTopBoxChannelId;
}
/**
* Sets the value of the externalSetTopBoxChannelId property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setExternalSetTopBoxChannelId(String value) {
this.externalSetTopBoxChannelId = value;
}
/**
* Gets the value of the isSetTopBoxEnabled property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIsSetTopBoxEnabled() {
return isSetTopBoxEnabled;
}
/**
* Sets the value of the isSetTopBoxEnabled property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setIsSetTopBoxEnabled(Boolean value) {
this.isSetTopBoxEnabled = value;
}
/**
* Gets the value of the applicationId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getApplicationId() {
return applicationId;
}
/**
* Sets the value of the applicationId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setApplicationId(Long value) {
this.applicationId = value;
}
}