com.google.api.ads.admanager.axis.v202305.ImageOverlayCreative Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dfp-axis Show documentation
Show all versions of dfp-axis Show documentation
Ad Manager specific Axis components.
// 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.
/**
* ImageOverlayCreative.java
*
* This file was auto-generated from WSDL
* by the Apache Axis 1.4 Mar 02, 2009 (07:08:06 PST) WSDL2Java emitter.
*/
package com.google.api.ads.admanager.axis.v202305;
/**
* 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.
*/
public class ImageOverlayCreative extends com.google.api.ads.admanager.axis.v202305.BaseImageCreative implements java.io.Serializable {
/* The IDs of the companion creatives that are associated with
* this creative. This attribute is
* optional. This attribute is read-only. */
private long[] companionCreativeIds;
/* A map from {@code ConversionEvent} to a list of URLs that will
* be pinged when the event
* happens. This attribute is optional. */
private com.google.api.ads.admanager.axis.v202305.ConversionEvent_TrackingUrlsMapEntry[] trackingUrls;
/* A locked orientation for this creative to be displayed in. */
private com.google.api.ads.admanager.axis.v202305.LockedOrientation lockedOrientation;
/* A comma separated key=value list of parameters that will be
* supplied to the creative, written
* into the VAST {@code AdParameters} node. This
* attribute is optional. */
private java.lang.String customParameters;
/* Minimum suggested duration in milliseconds. This attribute
* is optional. */
private java.lang.Integer duration;
/* An ad tag URL that will return a preview of the VAST XML response
* specific to this creative.
* This attribute is read-only. */
private java.lang.String vastPreviewUrl;
public ImageOverlayCreative() {
}
public ImageOverlayCreative(
java.lang.Long advertiserId,
java.lang.Long id,
java.lang.String name,
com.google.api.ads.admanager.axis.v202305.Size size,
java.lang.String previewUrl,
com.google.api.ads.admanager.axis.v202305.CreativePolicyViolation[] policyLabels,
com.google.api.ads.admanager.axis.v202305.AppliedLabel[] appliedLabels,
com.google.api.ads.admanager.axis.v202305.DateTime lastModifiedDateTime,
com.google.api.ads.admanager.axis.v202305.BaseCustomFieldValue[] customFieldValues,
com.google.api.ads.admanager.axis.v202305.ThirdPartyDataDeclaration thirdPartyDataDeclaration,
java.lang.String destinationUrl,
com.google.api.ads.admanager.axis.v202305.DestinationUrlType destinationUrlType,
java.lang.Boolean overrideSize,
com.google.api.ads.admanager.axis.v202305.CreativeAsset primaryImageAsset,
long[] companionCreativeIds,
com.google.api.ads.admanager.axis.v202305.ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
com.google.api.ads.admanager.axis.v202305.LockedOrientation lockedOrientation,
java.lang.String customParameters,
java.lang.Integer duration,
java.lang.String vastPreviewUrl) {
super(
advertiserId,
id,
name,
size,
previewUrl,
policyLabels,
appliedLabels,
lastModifiedDateTime,
customFieldValues,
thirdPartyDataDeclaration,
destinationUrl,
destinationUrlType,
overrideSize,
primaryImageAsset);
this.companionCreativeIds = companionCreativeIds;
this.trackingUrls = trackingUrls;
this.lockedOrientation = lockedOrientation;
this.customParameters = customParameters;
this.duration = duration;
this.vastPreviewUrl = vastPreviewUrl;
}
@Override
public String toString() {
return com.google.common.base.MoreObjects.toStringHelper(this.getClass())
.omitNullValues()
.add("advertiserId", getAdvertiserId())
.add("appliedLabels", getAppliedLabels())
.add("companionCreativeIds", getCompanionCreativeIds())
.add("customFieldValues", getCustomFieldValues())
.add("customParameters", getCustomParameters())
.add("destinationUrl", getDestinationUrl())
.add("destinationUrlType", getDestinationUrlType())
.add("duration", getDuration())
.add("id", getId())
.add("lastModifiedDateTime", getLastModifiedDateTime())
.add("lockedOrientation", getLockedOrientation())
.add("name", getName())
.add("overrideSize", getOverrideSize())
.add("policyLabels", getPolicyLabels())
.add("previewUrl", getPreviewUrl())
.add("primaryImageAsset", getPrimaryImageAsset())
.add("size", getSize())
.add("thirdPartyDataDeclaration", getThirdPartyDataDeclaration())
.add("trackingUrls", getTrackingUrls())
.add("vastPreviewUrl", getVastPreviewUrl())
.toString();
}
/**
* Gets the companionCreativeIds value for this ImageOverlayCreative.
*
* @return companionCreativeIds * The IDs of the companion creatives that are associated with
* this creative. This attribute is
* optional. This attribute is read-only.
*/
public long[] getCompanionCreativeIds() {
return companionCreativeIds;
}
/**
* Sets the companionCreativeIds value for this ImageOverlayCreative.
*
* @param companionCreativeIds * The IDs of the companion creatives that are associated with
* this creative. This attribute is
* optional. This attribute is read-only.
*/
public void setCompanionCreativeIds(long[] companionCreativeIds) {
this.companionCreativeIds = companionCreativeIds;
}
public long getCompanionCreativeIds(int i) {
return this.companionCreativeIds[i];
}
public void setCompanionCreativeIds(int i, long _value) {
this.companionCreativeIds[i] = _value;
}
/**
* Gets the trackingUrls value for this ImageOverlayCreative.
*
* @return trackingUrls * A map from {@code ConversionEvent} to a list of URLs that will
* be pinged when the event
* happens. This attribute is optional.
*/
public com.google.api.ads.admanager.axis.v202305.ConversionEvent_TrackingUrlsMapEntry[] getTrackingUrls() {
return trackingUrls;
}
/**
* Sets the trackingUrls value for this ImageOverlayCreative.
*
* @param trackingUrls * A map from {@code ConversionEvent} to a list of URLs that will
* be pinged when the event
* happens. This attribute is optional.
*/
public void setTrackingUrls(com.google.api.ads.admanager.axis.v202305.ConversionEvent_TrackingUrlsMapEntry[] trackingUrls) {
this.trackingUrls = trackingUrls;
}
public com.google.api.ads.admanager.axis.v202305.ConversionEvent_TrackingUrlsMapEntry getTrackingUrls(int i) {
return this.trackingUrls[i];
}
public void setTrackingUrls(int i, com.google.api.ads.admanager.axis.v202305.ConversionEvent_TrackingUrlsMapEntry _value) {
this.trackingUrls[i] = _value;
}
/**
* Gets the lockedOrientation value for this ImageOverlayCreative.
*
* @return lockedOrientation * A locked orientation for this creative to be displayed in.
*/
public com.google.api.ads.admanager.axis.v202305.LockedOrientation getLockedOrientation() {
return lockedOrientation;
}
/**
* Sets the lockedOrientation value for this ImageOverlayCreative.
*
* @param lockedOrientation * A locked orientation for this creative to be displayed in.
*/
public void setLockedOrientation(com.google.api.ads.admanager.axis.v202305.LockedOrientation lockedOrientation) {
this.lockedOrientation = lockedOrientation;
}
/**
* Gets the customParameters value for this ImageOverlayCreative.
*
* @return customParameters * A comma separated key=value list of parameters that will be
* supplied to the creative, written
* into the VAST {@code AdParameters} node. This
* attribute is optional.
*/
public java.lang.String getCustomParameters() {
return customParameters;
}
/**
* Sets the customParameters value for this ImageOverlayCreative.
*
* @param customParameters * A comma separated key=value list of parameters that will be
* supplied to the creative, written
* into the VAST {@code AdParameters} node. This
* attribute is optional.
*/
public void setCustomParameters(java.lang.String customParameters) {
this.customParameters = customParameters;
}
/**
* Gets the duration value for this ImageOverlayCreative.
*
* @return duration * Minimum suggested duration in milliseconds. This attribute
* is optional.
*/
public java.lang.Integer getDuration() {
return duration;
}
/**
* Sets the duration value for this ImageOverlayCreative.
*
* @param duration * Minimum suggested duration in milliseconds. This attribute
* is optional.
*/
public void setDuration(java.lang.Integer duration) {
this.duration = duration;
}
/**
* Gets the vastPreviewUrl value for this ImageOverlayCreative.
*
* @return vastPreviewUrl * An ad tag URL that will return a preview of the VAST XML response
* specific to this creative.
* This attribute is read-only.
*/
public java.lang.String getVastPreviewUrl() {
return vastPreviewUrl;
}
/**
* Sets the vastPreviewUrl value for this ImageOverlayCreative.
*
* @param vastPreviewUrl * An ad tag URL that will return a preview of the VAST XML response
* specific to this creative.
* This attribute is read-only.
*/
public void setVastPreviewUrl(java.lang.String vastPreviewUrl) {
this.vastPreviewUrl = vastPreviewUrl;
}
private java.lang.Object __equalsCalc = null;
public synchronized boolean equals(java.lang.Object obj) {
if (!(obj instanceof ImageOverlayCreative)) return false;
ImageOverlayCreative other = (ImageOverlayCreative) obj;
if (obj == null) return false;
if (this == obj) return true;
if (__equalsCalc != null) {
return (__equalsCalc == obj);
}
__equalsCalc = obj;
boolean _equals;
_equals = super.equals(obj) &&
((this.companionCreativeIds==null && other.getCompanionCreativeIds()==null) ||
(this.companionCreativeIds!=null &&
java.util.Arrays.equals(this.companionCreativeIds, other.getCompanionCreativeIds()))) &&
((this.trackingUrls==null && other.getTrackingUrls()==null) ||
(this.trackingUrls!=null &&
java.util.Arrays.equals(this.trackingUrls, other.getTrackingUrls()))) &&
((this.lockedOrientation==null && other.getLockedOrientation()==null) ||
(this.lockedOrientation!=null &&
this.lockedOrientation.equals(other.getLockedOrientation()))) &&
((this.customParameters==null && other.getCustomParameters()==null) ||
(this.customParameters!=null &&
this.customParameters.equals(other.getCustomParameters()))) &&
((this.duration==null && other.getDuration()==null) ||
(this.duration!=null &&
this.duration.equals(other.getDuration()))) &&
((this.vastPreviewUrl==null && other.getVastPreviewUrl()==null) ||
(this.vastPreviewUrl!=null &&
this.vastPreviewUrl.equals(other.getVastPreviewUrl())));
__equalsCalc = null;
return _equals;
}
private boolean __hashCodeCalc = false;
public synchronized int hashCode() {
if (__hashCodeCalc) {
return 0;
}
__hashCodeCalc = true;
int _hashCode = super.hashCode();
if (getCompanionCreativeIds() != null) {
for (int i=0;
i