/*
 * 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.displayvideo.v2.model;

/**
 * Details for a Masthead Ad.
 *
 * <p> 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 Display & Video 360 API. For a detailed explanation
 * see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class MastheadAd extends com.google.api.client.json.GenericJson {

  /**
   * The duration of time the video will autoplay.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String autoplayVideoDuration;

  /**
   * The amount of time in milliseconds after which the video will start to play.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long autoplayVideoStartMillisecond;

  /**
   * The text on the call-to-action button.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String callToActionButtonLabel;

  /**
   * The destination URL for the call-to-action button.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String callToActionFinalUrl;

  /**
   * The tracking URL for the call-to-action button.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String callToActionTrackingUrl;

  /**
   * The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<YoutubeVideoDetails> companionYoutubeVideos;

  /**
   * The description of the ad.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * The headline of the ad.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String headline;

  /**
   * Whether to show a background or banner that appears at the top of a YouTube page.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean showChannelArt;

  /**
   * The YouTube video used by the ad.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private YoutubeVideoDetails video;

  /**
   * The aspect ratio of the autoplaying YouTube video on the Masthead.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String videoAspectRatio;

  /**
   * The duration of time the video will autoplay.
   * @return value or {@code null} for none
   */
  public String getAutoplayVideoDuration() {
    return autoplayVideoDuration;
  }

  /**
   * The duration of time the video will autoplay.
   * @param autoplayVideoDuration autoplayVideoDuration or {@code null} for none
   */
  public MastheadAd setAutoplayVideoDuration(String autoplayVideoDuration) {
    this.autoplayVideoDuration = autoplayVideoDuration;
    return this;
  }

  /**
   * The amount of time in milliseconds after which the video will start to play.
   * @return value or {@code null} for none
   */
  public java.lang.Long getAutoplayVideoStartMillisecond() {
    return autoplayVideoStartMillisecond;
  }

  /**
   * The amount of time in milliseconds after which the video will start to play.
   * @param autoplayVideoStartMillisecond autoplayVideoStartMillisecond or {@code null} for none
   */
  public MastheadAd setAutoplayVideoStartMillisecond(java.lang.Long autoplayVideoStartMillisecond) {
    this.autoplayVideoStartMillisecond = autoplayVideoStartMillisecond;
    return this;
  }

  /**
   * The text on the call-to-action button.
   * @return value or {@code null} for none
   */
  public java.lang.String getCallToActionButtonLabel() {
    return callToActionButtonLabel;
  }

  /**
   * The text on the call-to-action button.
   * @param callToActionButtonLabel callToActionButtonLabel or {@code null} for none
   */
  public MastheadAd setCallToActionButtonLabel(java.lang.String callToActionButtonLabel) {
    this.callToActionButtonLabel = callToActionButtonLabel;
    return this;
  }

  /**
   * The destination URL for the call-to-action button.
   * @return value or {@code null} for none
   */
  public java.lang.String getCallToActionFinalUrl() {
    return callToActionFinalUrl;
  }

  /**
   * The destination URL for the call-to-action button.
   * @param callToActionFinalUrl callToActionFinalUrl or {@code null} for none
   */
  public MastheadAd setCallToActionFinalUrl(java.lang.String callToActionFinalUrl) {
    this.callToActionFinalUrl = callToActionFinalUrl;
    return this;
  }

  /**
   * The tracking URL for the call-to-action button.
   * @return value or {@code null} for none
   */
  public java.lang.String getCallToActionTrackingUrl() {
    return callToActionTrackingUrl;
  }

  /**
   * The tracking URL for the call-to-action button.
   * @param callToActionTrackingUrl callToActionTrackingUrl or {@code null} for none
   */
  public MastheadAd setCallToActionTrackingUrl(java.lang.String callToActionTrackingUrl) {
    this.callToActionTrackingUrl = callToActionTrackingUrl;
    return this;
  }

  /**
   * The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
   * @return value or {@code null} for none
   */
  public java.util.List<YoutubeVideoDetails> getCompanionYoutubeVideos() {
    return companionYoutubeVideos;
  }

  /**
   * The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
   * @param companionYoutubeVideos companionYoutubeVideos or {@code null} for none
   */
  public MastheadAd setCompanionYoutubeVideos(java.util.List<YoutubeVideoDetails> companionYoutubeVideos) {
    this.companionYoutubeVideos = companionYoutubeVideos;
    return this;
  }

  /**
   * The description of the ad.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * The description of the ad.
   * @param description description or {@code null} for none
   */
  public MastheadAd setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * The headline of the ad.
   * @return value or {@code null} for none
   */
  public java.lang.String getHeadline() {
    return headline;
  }

  /**
   * The headline of the ad.
   * @param headline headline or {@code null} for none
   */
  public MastheadAd setHeadline(java.lang.String headline) {
    this.headline = headline;
    return this;
  }

  /**
   * Whether to show a background or banner that appears at the top of a YouTube page.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getShowChannelArt() {
    return showChannelArt;
  }

  /**
   * Whether to show a background or banner that appears at the top of a YouTube page.
   * @param showChannelArt showChannelArt or {@code null} for none
   */
  public MastheadAd setShowChannelArt(java.lang.Boolean showChannelArt) {
    this.showChannelArt = showChannelArt;
    return this;
  }

  /**
   * The YouTube video used by the ad.
   * @return value or {@code null} for none
   */
  public YoutubeVideoDetails getVideo() {
    return video;
  }

  /**
   * The YouTube video used by the ad.
   * @param video video or {@code null} for none
   */
  public MastheadAd setVideo(YoutubeVideoDetails video) {
    this.video = video;
    return this;
  }

  /**
   * The aspect ratio of the autoplaying YouTube video on the Masthead.
   * @return value or {@code null} for none
   */
  public java.lang.String getVideoAspectRatio() {
    return videoAspectRatio;
  }

  /**
   * The aspect ratio of the autoplaying YouTube video on the Masthead.
   * @param videoAspectRatio videoAspectRatio or {@code null} for none
   */
  public MastheadAd setVideoAspectRatio(java.lang.String videoAspectRatio) {
    this.videoAspectRatio = videoAspectRatio;
    return this;
  }

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

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

}
