com.google.api.services.displayvideo.v2.model

Class MastheadAd

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.displayvideo.v2.model.MastheadAd

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MastheadAd
extends com.google.api.client.json.GenericJson

Details for a Masthead Ad.

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: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MastheadAd()

Method Summary

Modifier and Type	Method and Description
MastheadAd	clone()
String	getAutoplayVideoDuration() The duration of time the video will autoplay.
Long	getAutoplayVideoStartMillisecond() The amount of time in milliseconds after which the video will start to play.
String	getCallToActionButtonLabel() The text on the call-to-action button.
String	getCallToActionFinalUrl() The destination URL for the call-to-action button.
String	getCallToActionTrackingUrl() The tracking URL for the call-to-action button.
List<YoutubeVideoDetails>	getCompanionYoutubeVideos() The videos that appear next to the Masthead Ad on desktop.
String	getDescription() The description of the ad.
String	getHeadline() The headline of the ad.
Boolean	getShowChannelArt() Whether to show a background or banner that appears at the top of a YouTube page.
YoutubeVideoDetails	getVideo() The YouTube video used by the ad.
String	getVideoAspectRatio() The aspect ratio of the autoplaying YouTube video on the Masthead.
MastheadAd	set(String fieldName, Object value)
MastheadAd	setAutoplayVideoDuration(String autoplayVideoDuration) The duration of time the video will autoplay.
MastheadAd	setAutoplayVideoStartMillisecond(Long autoplayVideoStartMillisecond) The amount of time in milliseconds after which the video will start to play.
MastheadAd	setCallToActionButtonLabel(String callToActionButtonLabel) The text on the call-to-action button.
MastheadAd	setCallToActionFinalUrl(String callToActionFinalUrl) The destination URL for the call-to-action button.
MastheadAd	setCallToActionTrackingUrl(String callToActionTrackingUrl) The tracking URL for the call-to-action button.
MastheadAd	setCompanionYoutubeVideos(List<YoutubeVideoDetails> companionYoutubeVideos) The videos that appear next to the Masthead Ad on desktop.
MastheadAd	setDescription(String description) The description of the ad.
MastheadAd	setHeadline(String headline) The headline of the ad.
MastheadAd	setShowChannelArt(Boolean showChannelArt) Whether to show a background or banner that appears at the top of a YouTube page.
MastheadAd	setVideo(YoutubeVideoDetails video) The YouTube video used by the ad.
MastheadAd	setVideoAspectRatio(String videoAspectRatio) The aspect ratio of the autoplaying YouTube video on the Masthead.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

MastheadAd

public MastheadAd()

Method Detail

getAutoplayVideoDuration

public String getAutoplayVideoDuration()

The duration of time the video will autoplay.

Returns:

value or null for none

setAutoplayVideoDuration

public MastheadAd setAutoplayVideoDuration(String autoplayVideoDuration)

The duration of time the video will autoplay.

Parameters:

autoplayVideoDuration - autoplayVideoDuration or null for none

getAutoplayVideoStartMillisecond

public Long getAutoplayVideoStartMillisecond()

The amount of time in milliseconds after which the video will start to play.

Returns:

value or null for none

setAutoplayVideoStartMillisecond

public MastheadAd setAutoplayVideoStartMillisecond(Long autoplayVideoStartMillisecond)

The amount of time in milliseconds after which the video will start to play.

Parameters:

autoplayVideoStartMillisecond - autoplayVideoStartMillisecond or null for none

getCallToActionButtonLabel

public String getCallToActionButtonLabel()

The text on the call-to-action button.

Returns:

value or null for none

setCallToActionButtonLabel

public MastheadAd setCallToActionButtonLabel(String callToActionButtonLabel)

The text on the call-to-action button.

Parameters:

callToActionButtonLabel - callToActionButtonLabel or null for none

getCallToActionFinalUrl

public String getCallToActionFinalUrl()

The destination URL for the call-to-action button.

Returns:

value or null for none

setCallToActionFinalUrl

public MastheadAd setCallToActionFinalUrl(String callToActionFinalUrl)

The destination URL for the call-to-action button.

Parameters:

callToActionFinalUrl - callToActionFinalUrl or null for none

getCallToActionTrackingUrl

public String getCallToActionTrackingUrl()

The tracking URL for the call-to-action button.

Returns:

value or null for none

setCallToActionTrackingUrl

public MastheadAd setCallToActionTrackingUrl(String callToActionTrackingUrl)

The tracking URL for the call-to-action button.

Parameters:

callToActionTrackingUrl - callToActionTrackingUrl or null for none

getCompanionYoutubeVideos

public List<YoutubeVideoDetails> getCompanionYoutubeVideos()

The videos that appear next to the Masthead Ad on desktop. Can be no more than two.

Returns:

value or null for none

setCompanionYoutubeVideos

public MastheadAd setCompanionYoutubeVideos(List<YoutubeVideoDetails> companionYoutubeVideos)

The videos that appear next to the Masthead Ad on desktop. Can be no more than two.

Parameters:

companionYoutubeVideos - companionYoutubeVideos or null for none

getDescription

public String getDescription()

The description of the ad.

Returns:

value or null for none

setDescription

public MastheadAd setDescription(String description)

The description of the ad.

Parameters:

description - description or null for none

getHeadline

public String getHeadline()

The headline of the ad.

Returns:

value or null for none

setHeadline

public MastheadAd setHeadline(String headline)

The headline of the ad.

Parameters:

headline - headline or null for none

getShowChannelArt

public Boolean getShowChannelArt()

Whether to show a background or banner that appears at the top of a YouTube page.

Returns:

value or null for none

setShowChannelArt

public MastheadAd setShowChannelArt(Boolean showChannelArt)

Whether to show a background or banner that appears at the top of a YouTube page.

Parameters:

showChannelArt - showChannelArt or null for none

getVideo

public YoutubeVideoDetails getVideo()

The YouTube video used by the ad.

Returns:

value or null for none

setVideo

public MastheadAd setVideo(YoutubeVideoDetails video)

The YouTube video used by the ad.

Parameters:

video - video or null for none

getVideoAspectRatio

public String getVideoAspectRatio()

The aspect ratio of the autoplaying YouTube video on the Masthead.

Returns:

value or null for none

setVideoAspectRatio

public MastheadAd setVideoAspectRatio(String videoAspectRatio)

The aspect ratio of the autoplaying YouTube video on the Masthead.

Parameters:

videoAspectRatio - videoAspectRatio or null for none

set

public MastheadAd set(String fieldName,
                      Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public MastheadAd clone()

Overrides:

clone in class com.google.api.client.json.GenericJson