Class CreativeWrapper

A CreativeWrapper allows the wrapping of HTML snippets to be served along with Creative objects.

CreativeWrapper must be associated with a [LabelType.CREATIVE_WRAPPER][google.ads.admanager.v1.LabelTypeEnum.LabelType.CREATIVE_WRAPPER] label and applied to ad units by [AdUnit.appliedLabels][google.ads.admanager.v1.AdUnit.applied_labels].

Inheritance

object

CreativeWrapper

Implements

IMessage<CreativeWrapper>

IEquatable<CreativeWrapper>

IDeepCloneable<CreativeWrapper>

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 CreativeWrapper : IMessage<CreativeWrapper>, IEquatable<CreativeWrapper>, IDeepCloneable<CreativeWrapper>, IBufferMessage, IMessage

Constructors

CreativeWrapper()

Declaration

public CreativeWrapper()

CreativeWrapper(CreativeWrapper)

Declaration

public CreativeWrapper(CreativeWrapper other)

Parameters

Type	Name	Description
CreativeWrapper	other

Properties

AmpFooter

Optional. The footer AMP snippet that this CreativeWrapper delivers.

Declaration

public string AmpFooter { get; set; }

Property Value

Type	Description
string

AmpHeader

Optional. The header AMP snippet that this CreativeWrapper delivers.

Declaration

public string AmpHeader { get; set; }

Property Value

Type	Description
string

CreativeWrapperName

CreativeWrapperName-typed view over the Name resource name property.

Declaration

public CreativeWrapperName CreativeWrapperName { get; set; }

Property Value

Type	Description
CreativeWrapperName

CreativeWrapperType

Required. The creative_wrapper_type. If the creative_wrapper_type is [CreativeWrapperType.VIDEO_TRACKING_URL][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.VIDEO_TRACKING_URL], the video_tracking_urls field must be set. If the creative_wrapper_type is [CreativeWrapperType.HTML][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.HTML], either the header or footer field must be set.

Declaration

public CreativeWrapperTypeEnum.Types.CreativeWrapperType CreativeWrapperType { get; set; }

Property Value

Type	Description
CreativeWrapperTypeEnum.Types.CreativeWrapperType

FooterCreative

Output only. The resource name of the [Creative][google.ads.admanager.v1.Creative]. Format: networks/{network_code}/creative/{creative_id}

Declaration

public string FooterCreative { get; set; }

Property Value

Type	Description
string

FooterCreativeAsCreativeName

CreativeName-typed view over the FooterCreative resource name property.

Declaration

public CreativeName FooterCreativeAsCreativeName { get; set; }

Property Value

Type	Description
CreativeName

HasAmpFooter

Gets whether the "amp_footer" field is set

Declaration

public bool HasAmpFooter { get; }

Property Value

Type	Description
bool

HasAmpHeader

Gets whether the "amp_header" field is set

Declaration

public bool HasAmpHeader { get; }

Property Value

Type	Description
bool

HasCreativeWrapperType

Gets whether the "creative_wrapper_type" field is set

Declaration

public bool HasCreativeWrapperType { get; }

Property Value

Type	Description
bool

HasFooterCreative

Gets whether the "footer_creative" field is set

Declaration

public bool HasFooterCreative { get; }

Property Value

Type	Description
bool

HasHeaderCreative

Gets whether the "header_creative" field is set

Declaration

public bool HasHeaderCreative { get; }

Property Value

Type	Description
bool

HasHtmlFooter

Gets whether the "html_footer" field is set

Declaration

public bool HasHtmlFooter { get; }

Property Value

Type	Description
bool

HasHtmlHeader

Gets whether the "html_header" field is set

Declaration

public bool HasHtmlHeader { get; }

Property Value

Type	Description
bool

HasOrdering

Gets whether the "ordering" field is set

Declaration

public bool HasOrdering { get; }

Property Value

Type	Description
bool

HasStatus

Gets whether the "status" field is set

Declaration

public bool HasStatus { get; }

Property Value

Type	Description
bool

HeaderCreative

Output only. The resource name of the [Creative][google.ads.admanager.v1.Creative]. Format: networks/{network_code}/creative/{creative_id}

Declaration

public string HeaderCreative { get; set; }

Property Value

Type	Description
string

HeaderCreativeAsCreativeName

CreativeName-typed view over the HeaderCreative resource name property.

Declaration

public CreativeName HeaderCreativeAsCreativeName { get; set; }

Property Value

Type	Description
CreativeName

HtmlFooter

Optional. The footer HTML snippet that this CreativeWrapper delivers.

Declaration

public string HtmlFooter { get; set; }

Property Value

Type	Description
string

HtmlHeader

Optional. The header HTML snippet that this CreativeWrapper delivers.

Declaration

public string HtmlHeader { get; set; }

Property Value

Type	Description
string

Label

Required. Immutable. The resource name of the [Label][google.ads.admanager.v1.Label]. Format:networks/{network_code}/label/{label_id}

Declaration

public string Label { get; set; }

Property Value

Type	Description
string

LabelAsLabelName

LabelName-typed view over the Label resource name property.

Declaration

public LabelName LabelAsLabelName { get; set; }

Property Value

Type	Description
LabelName

Name

Identifier. The resource name of the CreativeWrapper. Format: networks/{network_code}/creativeWrappers/{creative_wrapper_id}

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Ordering

Optional. If there are multiple wrappers for a [Creative][google.ads.admanager.v1.Creative], then ordering defines the order in which the HTML snippets are rendered.

Declaration

public CreativeWrapperOrderingEnum.Types.CreativeWrapperOrdering Ordering { get; set; }

Property Value

Type	Description
CreativeWrapperOrderingEnum.Types.CreativeWrapperOrdering

Status

Output only. The status of the CreativeWrapper.

Declaration

public CreativeWrapperStatusEnum.Types.CreativeWrapperStatus Status { get; set; }

Property Value

Type	Description
CreativeWrapperStatusEnum.Types.CreativeWrapperStatus

ThirdPartyDataDeclaration

Optional. The ThirdPartyDataDeclaration for this creative wrapper.

The third party companies that are associated with this CreativeWrapper and are present in the html_header or html_footer. This field is only applicable when the creative_wrapper_type is [CreativeWrapperType.HTML][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.HTML].

Declaration

public ThirdPartyDataDeclaration ThirdPartyDataDeclaration { get; set; }

Property Value

Type	Description
ThirdPartyDataDeclaration

VideoTrackingUrls

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creative_wrapper_type is [CreativeWrapperType.VIDEO_TRACKING_URL][google.ads.admanager.v1.CreativeWrapperTypeEnum.CreativeWrapperType.VIDEO_TRACKING_URL] and ignored otherwise.

Declaration

public RepeatedField<VideoTrackingUrl> VideoTrackingUrls { get; }

Property Value

Type	Description
RepeatedField<VideoTrackingUrl>