com.google.api.ads.admanager.jaxws.v202405.ImageOverlayCreative 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 overlay {@code Creative} that displays an image and is served via VAST 2.0 XML. Overlays cover
* part of the video content they are displayed on top of. This creative is read only prior to
* v201705.
*
*
* Java class for ImageOverlayCreative complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="ImageOverlayCreative">
* <complexContent>
* <extension base="{https://www.google.com/apis/ads/publisher/v202405}BaseImageCreative">
* <sequence>
* <element name="companionCreativeIds" type="{http://www.w3.org/2001/XMLSchema}long" maxOccurs="unbounded" minOccurs="0"/>
* <element name="trackingUrls" type="{https://www.google.com/apis/ads/publisher/v202405}ConversionEvent_TrackingUrlsMapEntry" maxOccurs="unbounded" minOccurs="0"/>
* <element name="lockedOrientation" type="{https://www.google.com/apis/ads/publisher/v202405}LockedOrientation" minOccurs="0"/>
* <element name="customParameters" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="duration" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
* <element name="vastPreviewUrl" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ImageOverlayCreative", propOrder = {
"companionCreativeIds",
"trackingUrls",
"lockedOrientation",
"customParameters",
"duration",
"vastPreviewUrl"
})
public class ImageOverlayCreative
extends BaseImageCreative
{
@XmlElement(type = Long.class)
protected List companionCreativeIds;
protected List trackingUrls;
@XmlSchemaType(name = "string")
protected LockedOrientation lockedOrientation;
protected String customParameters;
protected Integer duration;
protected String vastPreviewUrl;
/**
* Gets the value of the companionCreativeIds 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 companionCreativeIds property.
*
*
* For example, to add a new item, do as follows:
*
* getCompanionCreativeIds().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link Long }
*
*
*/
public List getCompanionCreativeIds() {
if (companionCreativeIds == null) {
companionCreativeIds = new ArrayList();
}
return this.companionCreativeIds;
}
/**
* Gets the value of the trackingUrls 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 trackingUrls property.
*
*
* For example, to add a new item, do as follows:
*
* getTrackingUrls().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link ConversionEventTrackingUrlsMapEntry }
*
*
*/
public List getTrackingUrls() {
if (trackingUrls == null) {
trackingUrls = new ArrayList();
}
return this.trackingUrls;
}
/**
* Gets the value of the lockedOrientation property.
*
* @return
* possible object is
* {@link LockedOrientation }
*
*/
public LockedOrientation getLockedOrientation() {
return lockedOrientation;
}
/**
* Sets the value of the lockedOrientation property.
*
* @param value
* allowed object is
* {@link LockedOrientation }
*
*/
public void setLockedOrientation(LockedOrientation value) {
this.lockedOrientation = value;
}
/**
* Gets the value of the customParameters property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getCustomParameters() {
return customParameters;
}
/**
* Sets the value of the customParameters property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setCustomParameters(String value) {
this.customParameters = value;
}
/**
* Gets the value of the duration property.
*
* @return
* possible object is
* {@link Integer }
*
*/
public Integer getDuration() {
return duration;
}
/**
* Sets the value of the duration property.
*
* @param value
* allowed object is
* {@link Integer }
*
*/
public void setDuration(Integer value) {
this.duration = value;
}
/**
* Gets the value of the vastPreviewUrl property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getVastPreviewUrl() {
return vastPreviewUrl;
}
/**
* Sets the value of the vastPreviewUrl property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setVastPreviewUrl(String value) {
this.vastPreviewUrl = value;
}
}