com.google.api.services.realtimebidding.v1.model.VideoMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-realtimebidding Show documentation
There is a newer version: v1-rev20240930-2.0.0
Show newest version
/*
 * 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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.realtimebidding.v1.model;

/**
 * Video metadata for a creative.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Real-time Bidding API. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class VideoMetadata extends com.google.api.client.json.GenericJson {

  /**
   * The duration of the ad. Can be used to filter the response of the creatives.list method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String duration;

  /**
   * Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isValidVast;

  /**
   * Is this a VPAID ad? Can be used to filter the response of the creatives.list method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isVpaid;

  /**
   * The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper
   * chain, this includes the media files from the deepest one in the chain.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List mediaFiles;

  static {
    // hack to force ProGuard to consider MediaFile used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(MediaFile.class);
  }

  /**
   * The minimum duration that the user has to watch before being able to skip this ad. If the field
   * is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to
   * filter the response of the creatives.list method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String skipOffset;

  /**
   * The maximum VAST version across all wrapped VAST documents. Can be used to filter the response
   * of the creatives.list method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String vastVersion;

  /**
   * The duration of the ad. Can be used to filter the response of the creatives.list method.
   * @return value or {@code null} for none
   */
  public String getDuration() {
    return duration;
  }

  /**
   * The duration of the ad. Can be used to filter the response of the creatives.list method.
   * @param duration duration or {@code null} for none
   */
  public VideoMetadata setDuration(String duration) {
    this.duration = duration;
    return this;
  }

  /**
   * Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsValidVast() {
    return isValidVast;
  }

  /**
   * Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.
   * @param isValidVast isValidVast or {@code null} for none
   */
  public VideoMetadata setIsValidVast(java.lang.Boolean isValidVast) {
    this.isValidVast = isValidVast;
    return this;
  }

  /**
   * Is this a VPAID ad? Can be used to filter the response of the creatives.list method.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsVpaid() {
    return isVpaid;
  }

  /**
   * Is this a VPAID ad? Can be used to filter the response of the creatives.list method.
   * @param isVpaid isVpaid or {@code null} for none
   */
  public VideoMetadata setIsVpaid(java.lang.Boolean isVpaid) {
    this.isVpaid = isVpaid;
    return this;
  }

  /**
   * The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper
   * chain, this includes the media files from the deepest one in the chain.
   * @return value or {@code null} for none
   */
  public java.util.List getMediaFiles() {
    return mediaFiles;
  }

  /**
   * The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper
   * chain, this includes the media files from the deepest one in the chain.
   * @param mediaFiles mediaFiles or {@code null} for none
   */
  public VideoMetadata setMediaFiles(java.util.List mediaFiles) {
    this.mediaFiles = mediaFiles;
    return this;
  }

  /**
   * The minimum duration that the user has to watch before being able to skip this ad. If the field
   * is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to
   * filter the response of the creatives.list method.
   * @return value or {@code null} for none
   */
  public String getSkipOffset() {
    return skipOffset;
  }

  /**
   * The minimum duration that the user has to watch before being able to skip this ad. If the field
   * is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to
   * filter the response of the creatives.list method.
   * @param skipOffset skipOffset or {@code null} for none
   */
  public VideoMetadata setSkipOffset(String skipOffset) {
    this.skipOffset = skipOffset;
    return this;
  }

  /**
   * The maximum VAST version across all wrapped VAST documents. Can be used to filter the response
   * of the creatives.list method.
   * @return value or {@code null} for none
   */
  public java.lang.String getVastVersion() {
    return vastVersion;
  }

  /**
   * The maximum VAST version across all wrapped VAST documents. Can be used to filter the response
   * of the creatives.list method.
   * @param vastVersion vastVersion or {@code null} for none
   */
  public VideoMetadata setVastVersion(java.lang.String vastVersion) {
    this.vastVersion = vastVersion;
    return this;
  }

  @Override
  public VideoMetadata set(String fieldName, Object value) {
    return (VideoMetadata) super.set(fieldName, value);
  }

  @Override
  public VideoMetadata clone() {
    return (VideoMetadata) super.clone();
  }

}