<?php
/*
 * Copyright 2014 Google Inc.
 *
 * 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.
 */

namespace Google\Service\DisplayVideo;

class DemandGenVideoAd extends \Google\Collection
{
  /**
   * Not specified or unknown.
   */
  public const CALL_TO_ACTION_CALL_TO_ACTION_UNSPECIFIED = 'CALL_TO_ACTION_UNSPECIFIED';
  /**
   * Automated.
   */
  public const CALL_TO_ACTION_AUTOMATED = 'AUTOMATED';
  /**
   * Learn more.
   */
  public const CALL_TO_ACTION_LEARN_MORE = 'LEARN_MORE';
  /**
   * Get quote.
   */
  public const CALL_TO_ACTION_GET_QUOTE = 'GET_QUOTE';
  /**
   * Apply now.
   */
  public const CALL_TO_ACTION_APPLY_NOW = 'APPLY_NOW';
  /**
   * Sign up.
   */
  public const CALL_TO_ACTION_SIGN_UP = 'SIGN_UP';
  /**
   * Contact us.
   */
  public const CALL_TO_ACTION_CONTACT_US = 'CONTACT_US';
  /**
   * Subscribe.
   */
  public const CALL_TO_ACTION_SUBSCRIBE = 'SUBSCRIBE';
  /**
   * Download.
   */
  public const CALL_TO_ACTION_DOWNLOAD = 'DOWNLOAD';
  /**
   * Book now.
   */
  public const CALL_TO_ACTION_BOOK_NOW = 'BOOK_NOW';
  /**
   * Shop now.
   */
  public const CALL_TO_ACTION_SHOP_NOW = 'SHOP_NOW';
  /**
   * Buy now.
   */
  public const CALL_TO_ACTION_BUY_NOW = 'BUY_NOW';
  /**
   * Donate now.
   */
  public const CALL_TO_ACTION_DONATE_NOW = 'DONATE_NOW';
  /**
   * Order now.
   */
  public const CALL_TO_ACTION_ORDER_NOW = 'ORDER_NOW';
  /**
   * Play now.
   */
  public const CALL_TO_ACTION_PLAY_NOW = 'PLAY_NOW';
  /**
   * See more.
   */
  public const CALL_TO_ACTION_SEE_MORE = 'SEE_MORE';
  /**
   * Start now.
   */
  public const CALL_TO_ACTION_START_NOW = 'START_NOW';
  /**
   * Visit site.
   */
  public const CALL_TO_ACTION_VISIT_SITE = 'VISIT_SITE';
  /**
   * Watch now.
   */
  public const CALL_TO_ACTION_WATCH_NOW = 'WATCH_NOW';
  protected $collection_key = 'videos';
  /**
   * Required. The business name shown on the ad.
   *
   * @var string
   */
  public $businessName;
  /**
   * Required. The call-to-action button shown on the ad. The supported values
   * are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` *
   * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` *
   * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` *
   * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
   *
   * @var string
   */
  public $callToAction;
  protected $companionBannerType = ImageAsset::class;
  protected $companionBannerDataType = '';
  /**
   * Optional. The custom parameters to pass custom values to tracking URL
   * template.
   *
   * @var string[]
   */
  public $customParameters;
  /**
   * Required. The list of descriptions shown on the ad.
   *
   * @var string[]
   */
  public $descriptions;
  /**
   * Optional. The first piece after the domain in the display URL.
   *
   * @var string
   */
  public $displayUrlBreadcrumb1;
  /**
   * Optional. The second piece after the domain in the display URL.
   *
   * @var string
   */
  public $displayUrlBreadcrumb2;
  /**
   * Optional. The URL address of the webpage that people reach after they click
   * the ad on a mobile device.
   *
   * @var string
   */
  public $finalMobileUrl;
  /**
   * Required. The URL address of the webpage that people reach after they click
   * the ad.
   *
   * @var string
   */
  public $finalUrl;
  /**
   * Optional. The suffix to append to landing page URLs.
   *
   * @var string
   */
  public $finalUrlSuffix;
  /**
   * Required. The list of headlines shown on the ad.
   *
   * @var string[]
   */
  public $headlines;
  protected $logoType = ImageAsset::class;
  protected $logoDataType = '';
  /**
   * Required. The list of lone headlines shown on the ad.
   *
   * @var string[]
   */
  public $longHeadlines;
  /**
   * Output only. The URL address loaded in the background for tracking
   * purposes.
   *
   * @var string
   */
  public $trackingUrl;
  /**
   * Optional. The tracking URL specified by the user manually.
   *
   * @var string
   */
  public $userSpecifiedTrackingUrl;
  protected $videosType = YoutubeVideoDetails::class;
  protected $videosDataType = 'array';

  /**
   * Required. The business name shown on the ad.
   *
   * @param string $businessName
   */
  public function setBusinessName($businessName)
  {
    $this->businessName = $businessName;
  }
  /**
   * @return string
   */
  public function getBusinessName()
  {
    return $this->businessName;
  }
  /**
   * Required. The call-to-action button shown on the ad. The supported values
   * are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` *
   * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` *
   * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` *
   * `START_NOW` * `VISIT_SITE` * `WATCH_NOW`
   *
   * Accepted values: CALL_TO_ACTION_UNSPECIFIED, AUTOMATED, LEARN_MORE,
   * GET_QUOTE, APPLY_NOW, SIGN_UP, CONTACT_US, SUBSCRIBE, DOWNLOAD, BOOK_NOW,
   * SHOP_NOW, BUY_NOW, DONATE_NOW, ORDER_NOW, PLAY_NOW, SEE_MORE, START_NOW,
   * VISIT_SITE, WATCH_NOW
   *
   * @param self::CALL_TO_ACTION_* $callToAction
   */
  public function setCallToAction($callToAction)
  {
    $this->callToAction = $callToAction;
  }
  /**
   * @return self::CALL_TO_ACTION_*
   */
  public function getCallToAction()
  {
    return $this->callToAction;
  }
  /**
   * Optional. The companion banner used by this ad.
   *
   * @param ImageAsset $companionBanner
   */
  public function setCompanionBanner(ImageAsset $companionBanner)
  {
    $this->companionBanner = $companionBanner;
  }
  /**
   * @return ImageAsset
   */
  public function getCompanionBanner()
  {
    return $this->companionBanner;
  }
  /**
   * Optional. The custom parameters to pass custom values to tracking URL
   * template.
   *
   * @param string[] $customParameters
   */
  public function setCustomParameters($customParameters)
  {
    $this->customParameters = $customParameters;
  }
  /**
   * @return string[]
   */
  public function getCustomParameters()
  {
    return $this->customParameters;
  }
  /**
   * Required. The list of descriptions shown on the ad.
   *
   * @param string[] $descriptions
   */
  public function setDescriptions($descriptions)
  {
    $this->descriptions = $descriptions;
  }
  /**
   * @return string[]
   */
  public function getDescriptions()
  {
    return $this->descriptions;
  }
  /**
   * Optional. The first piece after the domain in the display URL.
   *
   * @param string $displayUrlBreadcrumb1
   */
  public function setDisplayUrlBreadcrumb1($displayUrlBreadcrumb1)
  {
    $this->displayUrlBreadcrumb1 = $displayUrlBreadcrumb1;
  }
  /**
   * @return string
   */
  public function getDisplayUrlBreadcrumb1()
  {
    return $this->displayUrlBreadcrumb1;
  }
  /**
   * Optional. The second piece after the domain in the display URL.
   *
   * @param string $displayUrlBreadcrumb2
   */
  public function setDisplayUrlBreadcrumb2($displayUrlBreadcrumb2)
  {
    $this->displayUrlBreadcrumb2 = $displayUrlBreadcrumb2;
  }
  /**
   * @return string
   */
  public function getDisplayUrlBreadcrumb2()
  {
    return $this->displayUrlBreadcrumb2;
  }
  /**
   * Optional. The URL address of the webpage that people reach after they click
   * the ad on a mobile device.
   *
   * @param string $finalMobileUrl
   */
  public function setFinalMobileUrl($finalMobileUrl)
  {
    $this->finalMobileUrl = $finalMobileUrl;
  }
  /**
   * @return string
   */
  public function getFinalMobileUrl()
  {
    return $this->finalMobileUrl;
  }
  /**
   * Required. The URL address of the webpage that people reach after they click
   * the ad.
   *
   * @param string $finalUrl
   */
  public function setFinalUrl($finalUrl)
  {
    $this->finalUrl = $finalUrl;
  }
  /**
   * @return string
   */
  public function getFinalUrl()
  {
    return $this->finalUrl;
  }
  /**
   * Optional. The suffix to append to landing page URLs.
   *
   * @param string $finalUrlSuffix
   */
  public function setFinalUrlSuffix($finalUrlSuffix)
  {
    $this->finalUrlSuffix = $finalUrlSuffix;
  }
  /**
   * @return string
   */
  public function getFinalUrlSuffix()
  {
    return $this->finalUrlSuffix;
  }
  /**
   * Required. The list of headlines shown on the ad.
   *
   * @param string[] $headlines
   */
  public function setHeadlines($headlines)
  {
    $this->headlines = $headlines;
  }
  /**
   * @return string[]
   */
  public function getHeadlines()
  {
    return $this->headlines;
  }
  /**
   * Required. The logo image used by this ad.
   *
   * @param ImageAsset $logo
   */
  public function setLogo(ImageAsset $logo)
  {
    $this->logo = $logo;
  }
  /**
   * @return ImageAsset
   */
  public function getLogo()
  {
    return $this->logo;
  }
  /**
   * Required. The list of lone headlines shown on the ad.
   *
   * @param string[] $longHeadlines
   */
  public function setLongHeadlines($longHeadlines)
  {
    $this->longHeadlines = $longHeadlines;
  }
  /**
   * @return string[]
   */
  public function getLongHeadlines()
  {
    return $this->longHeadlines;
  }
  /**
   * Output only. The URL address loaded in the background for tracking
   * purposes.
   *
   * @param string $trackingUrl
   */
  public function setTrackingUrl($trackingUrl)
  {
    $this->trackingUrl = $trackingUrl;
  }
  /**
   * @return string
   */
  public function getTrackingUrl()
  {
    return $this->trackingUrl;
  }
  /**
   * Optional. The tracking URL specified by the user manually.
   *
   * @param string $userSpecifiedTrackingUrl
   */
  public function setUserSpecifiedTrackingUrl($userSpecifiedTrackingUrl)
  {
    $this->userSpecifiedTrackingUrl = $userSpecifiedTrackingUrl;
  }
  /**
   * @return string
   */
  public function getUserSpecifiedTrackingUrl()
  {
    return $this->userSpecifiedTrackingUrl;
  }
  /**
   * Required. The list of YouTube video assets used by this ad.
   *
   * @param YoutubeVideoDetails[] $videos
   */
  public function setVideos($videos)
  {
    $this->videos = $videos;
  }
  /**
   * @return YoutubeVideoDetails[]
   */
  public function getVideos()
  {
    return $this->videos;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DemandGenVideoAd::class, 'Google_Service_DisplayVideo_DemandGenVideoAd');