com.google.api.ads.admanager.axis.v202402.BaseVideoCreative Maven / Gradle / Ivy
Show all versions of dfp-axis 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.
/**
* BaseVideoCreative.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.v202402;
/**
* A base type for video creatives.
*/
public abstract class BaseVideoCreative extends com.google.api.ads.admanager.axis.v202402.HasDestinationUrlCreative implements java.io.Serializable {
/* The expected duration of this creative in milliseconds. */
private java.lang.Integer duration;
/* Allows the creative duration to differ from the actual asset
* durations. This attribute is
* optional. */
private java.lang.Boolean allowDurationOverride;
/* 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.v202402.ConversionEvent_TrackingUrlsMapEntry[] trackingUrls;
/* The IDs of the companion creatives that are associated with
* this creative. This attribute is
* optional. */
private long[] companionCreativeIds;
/* 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;
/* The ad id associated with the video as defined by the {@code
* adIdType} registry. This field is
* required if {@code adIdType} is not {@link AdIdType#NONE}. */
private java.lang.String adId;
/* The registry which the ad id of this creative belongs to. This
* field is optional and defaults
* to {@link AdIdType#NONE}. */
private com.google.api.ads.admanager.axis.v202402.AdIdType adIdType;
/* The type of skippable ad. */
private com.google.api.ads.admanager.axis.v202402.SkippableAdType skippableAdType;
/* 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;
/* The SSL compatibility scan result of this creative.
*
* This attribute is read-only and determined
* by Google. */
private com.google.api.ads.admanager.axis.v202402.SslScanResult sslScanResult;
/* The manual override for the SSL compatibility of this creative.
*
*
This attribute is optional and defaults to
* {@link SslManualOverride#NO_OVERRIDE}. */
private com.google.api.ads.admanager.axis.v202402.SslManualOverride sslManualOverride;
public BaseVideoCreative() {
}
public BaseVideoCreative(
java.lang.Long advertiserId,
java.lang.Long id,
java.lang.String name,
com.google.api.ads.admanager.axis.v202402.Size size,
java.lang.String previewUrl,
com.google.api.ads.admanager.axis.v202402.CreativePolicyViolation[] policyLabels,
com.google.api.ads.admanager.axis.v202402.AppliedLabel[] appliedLabels,
com.google.api.ads.admanager.axis.v202402.DateTime lastModifiedDateTime,
com.google.api.ads.admanager.axis.v202402.BaseCustomFieldValue[] customFieldValues,
com.google.api.ads.admanager.axis.v202402.ThirdPartyDataDeclaration thirdPartyDataDeclaration,
java.lang.String destinationUrl,
com.google.api.ads.admanager.axis.v202402.DestinationUrlType destinationUrlType,
java.lang.Integer duration,
java.lang.Boolean allowDurationOverride,
com.google.api.ads.admanager.axis.v202402.ConversionEvent_TrackingUrlsMapEntry[] trackingUrls,
long[] companionCreativeIds,
java.lang.String customParameters,
java.lang.String adId,
com.google.api.ads.admanager.axis.v202402.AdIdType adIdType,
com.google.api.ads.admanager.axis.v202402.SkippableAdType skippableAdType,
java.lang.String vastPreviewUrl,
com.google.api.ads.admanager.axis.v202402.SslScanResult sslScanResult,
com.google.api.ads.admanager.axis.v202402.SslManualOverride sslManualOverride) {
super(
advertiserId,
id,
name,
size,
previewUrl,
policyLabels,
appliedLabels,
lastModifiedDateTime,
customFieldValues,
thirdPartyDataDeclaration,
destinationUrl,
destinationUrlType);
this.duration = duration;
this.allowDurationOverride = allowDurationOverride;
this.trackingUrls = trackingUrls;
this.companionCreativeIds = companionCreativeIds;
this.customParameters = customParameters;
this.adId = adId;
this.adIdType = adIdType;
this.skippableAdType = skippableAdType;
this.vastPreviewUrl = vastPreviewUrl;
this.sslScanResult = sslScanResult;
this.sslManualOverride = sslManualOverride;
}
@Override
public String toString() {
return com.google.common.base.MoreObjects.toStringHelper(this.getClass())
.omitNullValues()
.add("adId", getAdId())
.add("adIdType", getAdIdType())
.add("advertiserId", getAdvertiserId())
.add("allowDurationOverride", getAllowDurationOverride())
.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("name", getName())
.add("policyLabels", getPolicyLabels())
.add("previewUrl", getPreviewUrl())
.add("size", getSize())
.add("skippableAdType", getSkippableAdType())
.add("sslManualOverride", getSslManualOverride())
.add("sslScanResult", getSslScanResult())
.add("thirdPartyDataDeclaration", getThirdPartyDataDeclaration())
.add("trackingUrls", getTrackingUrls())
.add("vastPreviewUrl", getVastPreviewUrl())
.toString();
}
/**
* Gets the duration value for this BaseVideoCreative.
*
* @return duration * The expected duration of this creative in milliseconds.
*/
public java.lang.Integer getDuration() {
return duration;
}
/**
* Sets the duration value for this BaseVideoCreative.
*
* @param duration * The expected duration of this creative in milliseconds.
*/
public void setDuration(java.lang.Integer duration) {
this.duration = duration;
}
/**
* Gets the allowDurationOverride value for this BaseVideoCreative.
*
* @return allowDurationOverride * Allows the creative duration to differ from the actual asset
* durations. This attribute is
* optional.
*/
public java.lang.Boolean getAllowDurationOverride() {
return allowDurationOverride;
}
/**
* Sets the allowDurationOverride value for this BaseVideoCreative.
*
* @param allowDurationOverride * Allows the creative duration to differ from the actual asset
* durations. This attribute is
* optional.
*/
public void setAllowDurationOverride(java.lang.Boolean allowDurationOverride) {
this.allowDurationOverride = allowDurationOverride;
}
/**
* Gets the trackingUrls value for this BaseVideoCreative.
*
* @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.v202402.ConversionEvent_TrackingUrlsMapEntry[] getTrackingUrls() {
return trackingUrls;
}
/**
* Sets the trackingUrls value for this BaseVideoCreative.
*
* @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.v202402.ConversionEvent_TrackingUrlsMapEntry[] trackingUrls) {
this.trackingUrls = trackingUrls;
}
public com.google.api.ads.admanager.axis.v202402.ConversionEvent_TrackingUrlsMapEntry getTrackingUrls(int i) {
return this.trackingUrls[i];
}
public void setTrackingUrls(int i, com.google.api.ads.admanager.axis.v202402.ConversionEvent_TrackingUrlsMapEntry _value) {
this.trackingUrls[i] = _value;
}
/**
* Gets the companionCreativeIds value for this BaseVideoCreative.
*
* @return companionCreativeIds * The IDs of the companion creatives that are associated with
* this creative. This attribute is
* optional.
*/
public long[] getCompanionCreativeIds() {
return companionCreativeIds;
}
/**
* Sets the companionCreativeIds value for this BaseVideoCreative.
*
* @param companionCreativeIds * The IDs of the companion creatives that are associated with
* this creative. This attribute is
* optional.
*/
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 customParameters value for this BaseVideoCreative.
*
* @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 BaseVideoCreative.
*
* @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 adId value for this BaseVideoCreative.
*
* @return adId * The ad id associated with the video as defined by the {@code
* adIdType} registry. This field is
* required if {@code adIdType} is not {@link AdIdType#NONE}.
*/
public java.lang.String getAdId() {
return adId;
}
/**
* Sets the adId value for this BaseVideoCreative.
*
* @param adId * The ad id associated with the video as defined by the {@code
* adIdType} registry. This field is
* required if {@code adIdType} is not {@link AdIdType#NONE}.
*/
public void setAdId(java.lang.String adId) {
this.adId = adId;
}
/**
* Gets the adIdType value for this BaseVideoCreative.
*
* @return adIdType * The registry which the ad id of this creative belongs to. This
* field is optional and defaults
* to {@link AdIdType#NONE}.
*/
public com.google.api.ads.admanager.axis.v202402.AdIdType getAdIdType() {
return adIdType;
}
/**
* Sets the adIdType value for this BaseVideoCreative.
*
* @param adIdType * The registry which the ad id of this creative belongs to. This
* field is optional and defaults
* to {@link AdIdType#NONE}.
*/
public void setAdIdType(com.google.api.ads.admanager.axis.v202402.AdIdType adIdType) {
this.adIdType = adIdType;
}
/**
* Gets the skippableAdType value for this BaseVideoCreative.
*
* @return skippableAdType * The type of skippable ad.
*/
public com.google.api.ads.admanager.axis.v202402.SkippableAdType getSkippableAdType() {
return skippableAdType;
}
/**
* Sets the skippableAdType value for this BaseVideoCreative.
*
* @param skippableAdType * The type of skippable ad.
*/
public void setSkippableAdType(com.google.api.ads.admanager.axis.v202402.SkippableAdType skippableAdType) {
this.skippableAdType = skippableAdType;
}
/**
* Gets the vastPreviewUrl value for this BaseVideoCreative.
*
* @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 BaseVideoCreative.
*
* @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;
}
/**
* Gets the sslScanResult value for this BaseVideoCreative.
*
* @return sslScanResult * The SSL compatibility scan result of this creative.
*
*
This attribute is read-only and determined
* by Google.
*/
public com.google.api.ads.admanager.axis.v202402.SslScanResult getSslScanResult() {
return sslScanResult;
}
/**
* Sets the sslScanResult value for this BaseVideoCreative.
*
* @param sslScanResult * The SSL compatibility scan result of this creative.
*
*
This attribute is read-only and determined
* by Google.
*/
public void setSslScanResult(com.google.api.ads.admanager.axis.v202402.SslScanResult sslScanResult) {
this.sslScanResult = sslScanResult;
}
/**
* Gets the sslManualOverride value for this BaseVideoCreative.
*
* @return sslManualOverride * The manual override for the SSL compatibility of this creative.
*
*
This attribute is optional and defaults to
* {@link SslManualOverride#NO_OVERRIDE}.
*/
public com.google.api.ads.admanager.axis.v202402.SslManualOverride getSslManualOverride() {
return sslManualOverride;
}
/**
* Sets the sslManualOverride value for this BaseVideoCreative.
*
* @param sslManualOverride * The manual override for the SSL compatibility of this creative.
*
*
This attribute is optional and defaults to
* {@link SslManualOverride#NO_OVERRIDE}.
*/
public void setSslManualOverride(com.google.api.ads.admanager.axis.v202402.SslManualOverride sslManualOverride) {
this.sslManualOverride = sslManualOverride;
}
private java.lang.Object __equalsCalc = null;
public synchronized boolean equals(java.lang.Object obj) {
if (!(obj instanceof BaseVideoCreative)) return false;
BaseVideoCreative other = (BaseVideoCreative) 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.duration==null && other.getDuration()==null) ||
(this.duration!=null &&
this.duration.equals(other.getDuration()))) &&
((this.allowDurationOverride==null && other.getAllowDurationOverride()==null) ||
(this.allowDurationOverride!=null &&
this.allowDurationOverride.equals(other.getAllowDurationOverride()))) &&
((this.trackingUrls==null && other.getTrackingUrls()==null) ||
(this.trackingUrls!=null &&
java.util.Arrays.equals(this.trackingUrls, other.getTrackingUrls()))) &&
((this.companionCreativeIds==null && other.getCompanionCreativeIds()==null) ||
(this.companionCreativeIds!=null &&
java.util.Arrays.equals(this.companionCreativeIds, other.getCompanionCreativeIds()))) &&
((this.customParameters==null && other.getCustomParameters()==null) ||
(this.customParameters!=null &&
this.customParameters.equals(other.getCustomParameters()))) &&
((this.adId==null && other.getAdId()==null) ||
(this.adId!=null &&
this.adId.equals(other.getAdId()))) &&
((this.adIdType==null && other.getAdIdType()==null) ||
(this.adIdType!=null &&
this.adIdType.equals(other.getAdIdType()))) &&
((this.skippableAdType==null && other.getSkippableAdType()==null) ||
(this.skippableAdType!=null &&
this.skippableAdType.equals(other.getSkippableAdType()))) &&
((this.vastPreviewUrl==null && other.getVastPreviewUrl()==null) ||
(this.vastPreviewUrl!=null &&
this.vastPreviewUrl.equals(other.getVastPreviewUrl()))) &&
((this.sslScanResult==null && other.getSslScanResult()==null) ||
(this.sslScanResult!=null &&
this.sslScanResult.equals(other.getSslScanResult()))) &&
((this.sslManualOverride==null && other.getSslManualOverride()==null) ||
(this.sslManualOverride!=null &&
this.sslManualOverride.equals(other.getSslManualOverride())));
__equalsCalc = null;
return _equals;
}
private boolean __hashCodeCalc = false;
public synchronized int hashCode() {
if (__hashCodeCalc) {
return 0;
}
__hashCodeCalc = true;
int _hashCode = super.hashCode();
if (getDuration() != null) {
_hashCode += getDuration().hashCode();
}
if (getAllowDurationOverride() != null) {
_hashCode += getAllowDurationOverride().hashCode();
}
if (getTrackingUrls() != null) {
for (int i=0;
i