Class ImageOverlayCreativeDetails

An overlay Creative that displays an image and is served via VAST 2.0 XML. Overlays cover part of the video content they are displayed on top of.

Inheritance

object

ImageOverlayCreativeDetails

Implements

IMessage<ImageOverlayCreativeDetails>

IEquatable<ImageOverlayCreativeDetails>

IDeepCloneable<ImageOverlayCreativeDetails>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class ImageOverlayCreativeDetails : IMessage<ImageOverlayCreativeDetails>, IEquatable<ImageOverlayCreativeDetails>, IDeepCloneable<ImageOverlayCreativeDetails>, IBufferMessage, IMessage

Constructors

ImageOverlayCreativeDetails()

Declaration

public ImageOverlayCreativeDetails()

ImageOverlayCreativeDetails(ImageOverlayCreativeDetails)

Declaration

public ImageOverlayCreativeDetails(ImageOverlayCreativeDetails other)

Parameters

Type	Name	Description
ImageOverlayCreativeDetails	other

Properties

CompanionCreatives

Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"

Declaration

public RepeatedField<string> CompanionCreatives { get; }

Property Value

Type	Description
RepeatedField<string>

CompanionCreativesAsCreativeNames

CreativeName-typed view over the CompanionCreatives resource name property.

Declaration

public ResourceNameList<CreativeName> CompanionCreativesAsCreativeNames { get; }

Property Value

Type	Description
ResourceNameList<CreativeName>

CreativeSet

Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"

Declaration

public string CreativeSet { get; set; }

Property Value

Type	Description
string

CreativeSetAsCreativeSetName

CreativeSetName-typed view over the CreativeSet resource name property.

Declaration

public CreativeSetName CreativeSetAsCreativeSetName { get; set; }

Property Value

Type	Description
CreativeSetName

CreativeSetDisplayName

Output only. The display name of the creative set.

Declaration

public string CreativeSetDisplayName { get; set; }

Property Value

Type	Description
string

CustomParameters

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.

Declaration

public string CustomParameters { get; set; }

Property Value

Type	Description
string

DestinationUrl

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

Declaration

public string DestinationUrl { get; set; }

Property Value

Type	Description
string

DestinationUrlType

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

Declaration

public CreativeDestinationUrlTypeEnum.Types.CreativeDestinationUrlType DestinationUrlType { get; set; }

Property Value

Type	Description
CreativeDestinationUrlTypeEnum.Types.CreativeDestinationUrlType

Duration

Optional. Minimum suggested duration.

Declaration

public Duration Duration { get; set; }

Property Value

Type	Description
Duration

ExpectedCompanionDeliveryOption

Output only. The companion delivery option this set will be served with.

Declaration

public CompanionDeliveryOptionEnum.Types.CompanionDeliveryOption ExpectedCompanionDeliveryOption { get; set; }

Property Value

Type	Description
CompanionDeliveryOptionEnum.Types.CompanionDeliveryOption

ExpectedCompanions

Optional. CreativePlaceholder objects a creative set should fulfill.

Declaration

public RepeatedField<CreativePlaceholder> ExpectedCompanions { get; }

Property Value

Type	Description
RepeatedField<CreativePlaceholder>

HasCreativeSet

Gets whether the "creative_set" field is set

Declaration

public bool HasCreativeSet { get; }

Property Value

Type	Description
bool

HasCreativeSetDisplayName

Gets whether the "creative_set_display_name" field is set

Declaration

public bool HasCreativeSetDisplayName { get; }

Property Value

Type	Description
bool

HasCustomParameters

Gets whether the "custom_parameters" field is set

Declaration

public bool HasCustomParameters { get; }

Property Value

Type	Description
bool

HasDestinationUrl

Gets whether the "destination_url" field is set

Declaration

public bool HasDestinationUrl { get; }

Property Value

Type	Description
bool

HasDestinationUrlType

Gets whether the "destination_url_type" field is set

Declaration

public bool HasDestinationUrlType { get; }

Property Value

Type	Description
bool

HasExpectedCompanionDeliveryOption

Gets whether the "expected_companion_delivery_option" field is set

Declaration

public bool HasExpectedCompanionDeliveryOption { get; }

Property Value

Type	Description
bool

HasLockedOrientation

Gets whether the "locked_orientation" field is set

Declaration

public bool HasLockedOrientation { get; }

Property Value

Type	Description
bool

HasOverrideSize

Gets whether the "override_size" field is set

Declaration

public bool HasOverrideSize { get; }

Property Value

Type	Description
bool

HasVastPreviewUrl

Gets whether the "vast_preview_url" field is set

Declaration

public bool HasVastPreviewUrl { get; }

Property Value

Type	Description
bool

LockedOrientation

Optional. A locked orientation for this creative to be displayed in.

Declaration

public CreativeLockedOrientationEnum.Types.CreativeLockedOrientation LockedOrientation { get; set; }

Property Value

Type	Description
CreativeLockedOrientationEnum.Types.CreativeLockedOrientation

OverrideSize

Optional. Allows the creative size to differ from the actual image asset size.

Declaration

public bool OverrideSize { get; set; }

Property Value

Type	Description
bool

PrimaryImageAsset

Required. The primary image asset associated with this creative.

Declaration

public CreativeAsset PrimaryImageAsset { get; set; }

Property Value

Type	Description
CreativeAsset

TrackingUrls

Optional. URLs that will be pinged when conversion events happen.

Declaration

public RepeatedField<VideoTrackingUrl> TrackingUrls { get; }

Property Value

Type	Description
RepeatedField<VideoTrackingUrl>

VastPreviewUrl

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.

Declaration

public string VastPreviewUrl { get; set; }

Property Value

Type	Description
string