com.google.api.ads.admanager.jaxws.v202408.CreativeWrapper 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.v202408;
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.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
/**
*
* A {@code CreativeWrapper} allows the wrapping of HTML snippets to be served along with {@code
* Creative} objects.
*
* Creative wrappers must be associated with a {@link LabelType#CREATIVE_WRAPPER} label and
* applied to ad units by {@link AdUnit#appliedLabels}.
*
*
*
Java class for CreativeWrapper complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="CreativeWrapper">
* <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="labelId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
* <element name="creativeWrapperType" type="{https://www.google.com/apis/ads/publisher/v202408}CreativeWrapperType" minOccurs="0"/>
* <element name="htmlHeader" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="htmlFooter" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="ampHead" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="ampBody" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="videoTrackingUrls" type="{https://www.google.com/apis/ads/publisher/v202408}ConversionEvent_TrackingUrlsMapEntry" maxOccurs="unbounded" minOccurs="0"/>
* <element name="thirdPartyDataDeclaration" type="{https://www.google.com/apis/ads/publisher/v202408}ThirdPartyDataDeclaration" minOccurs="0"/>
* <element name="ordering" type="{https://www.google.com/apis/ads/publisher/v202408}CreativeWrapperOrdering" minOccurs="0"/>
* <element name="status" type="{https://www.google.com/apis/ads/publisher/v202408}CreativeWrapperStatus" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CreativeWrapper", propOrder = {
"id",
"labelId",
"creativeWrapperType",
"htmlHeader",
"htmlFooter",
"ampHead",
"ampBody",
"videoTrackingUrls",
"thirdPartyDataDeclaration",
"ordering",
"status"
})
public class CreativeWrapper {
protected Long id;
protected Long labelId;
@XmlSchemaType(name = "string")
protected CreativeWrapperType creativeWrapperType;
protected String htmlHeader;
protected String htmlFooter;
protected String ampHead;
protected String ampBody;
protected List videoTrackingUrls;
protected ThirdPartyDataDeclaration thirdPartyDataDeclaration;
@XmlSchemaType(name = "string")
protected CreativeWrapperOrdering ordering;
@XmlSchemaType(name = "string")
protected CreativeWrapperStatus status;
/**
* 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 labelId property.
*
* @return
* possible object is
* {@link Long }
*
*/
public Long getLabelId() {
return labelId;
}
/**
* Sets the value of the labelId property.
*
* @param value
* allowed object is
* {@link Long }
*
*/
public void setLabelId(Long value) {
this.labelId = value;
}
/**
* Gets the value of the creativeWrapperType property.
*
* @return
* possible object is
* {@link CreativeWrapperType }
*
*/
public CreativeWrapperType getCreativeWrapperType() {
return creativeWrapperType;
}
/**
* Sets the value of the creativeWrapperType property.
*
* @param value
* allowed object is
* {@link CreativeWrapperType }
*
*/
public void setCreativeWrapperType(CreativeWrapperType value) {
this.creativeWrapperType = value;
}
/**
* Gets the value of the htmlHeader property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getHtmlHeader() {
return htmlHeader;
}
/**
* Sets the value of the htmlHeader property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setHtmlHeader(String value) {
this.htmlHeader = value;
}
/**
* Gets the value of the htmlFooter property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getHtmlFooter() {
return htmlFooter;
}
/**
* Sets the value of the htmlFooter property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setHtmlFooter(String value) {
this.htmlFooter = value;
}
/**
* Gets the value of the ampHead property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getAmpHead() {
return ampHead;
}
/**
* Sets the value of the ampHead property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setAmpHead(String value) {
this.ampHead = value;
}
/**
* Gets the value of the ampBody property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getAmpBody() {
return ampBody;
}
/**
* Sets the value of the ampBody property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setAmpBody(String value) {
this.ampBody = value;
}
/**
* Gets the value of the videoTrackingUrls 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 videoTrackingUrls property.
*
*
* For example, to add a new item, do as follows:
*
* getVideoTrackingUrls().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link ConversionEventTrackingUrlsMapEntry }
*
*
*/
public List getVideoTrackingUrls() {
if (videoTrackingUrls == null) {
videoTrackingUrls = new ArrayList();
}
return this.videoTrackingUrls;
}
/**
* Gets the value of the thirdPartyDataDeclaration property.
*
* @return
* possible object is
* {@link ThirdPartyDataDeclaration }
*
*/
public ThirdPartyDataDeclaration getThirdPartyDataDeclaration() {
return thirdPartyDataDeclaration;
}
/**
* Sets the value of the thirdPartyDataDeclaration property.
*
* @param value
* allowed object is
* {@link ThirdPartyDataDeclaration }
*
*/
public void setThirdPartyDataDeclaration(ThirdPartyDataDeclaration value) {
this.thirdPartyDataDeclaration = value;
}
/**
* Gets the value of the ordering property.
*
* @return
* possible object is
* {@link CreativeWrapperOrdering }
*
*/
public CreativeWrapperOrdering getOrdering() {
return ordering;
}
/**
* Sets the value of the ordering property.
*
* @param value
* allowed object is
* {@link CreativeWrapperOrdering }
*
*/
public void setOrdering(CreativeWrapperOrdering value) {
this.ordering = value;
}
/**
* Gets the value of the status property.
*
* @return
* possible object is
* {@link CreativeWrapperStatus }
*
*/
public CreativeWrapperStatus getStatus() {
return status;
}
/**
* Sets the value of the status property.
*
* @param value
* allowed object is
* {@link CreativeWrapperStatus }
*
*/
public void setStatus(CreativeWrapperStatus value) {
this.status = value;
}
}