type CreativeWrapper (v202405)

Service

CreativeWrapperService

Dependencies

CreativeWrapperPage createCreativeWrappers() updateCreativeWrappers()

▼

CreativeWrapper

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

Creative wrappers must be associated with a LabelType.CREATIVE_WRAPPER label and applied to ad units by AdUnit.appliedLabels.

---

Namespace

https://www.google.com/apis/ads/publisher/v202405

Field
id	xsd:long The unique ID of the CreativeWrapper. This value is readonly and is assigned by Google.
labelId	xsd:long The ID of the Label which will be used to label ad units. The labelId on a creative wrapper cannot be changed once it is created.
creativeWrapperType	CreativeWrapperType The creative wrapper type. If the creative wrapper type is CreativeWrapperType.VIDEO_TRACKING_URL, the videoTrackingUrls field must be set. If the creative wrapper type is CreativeWrapperType.HTML, either the header or footer field must be set. This field is required. Enumerations HTML HTML creative wrappers that include header/footer HTML snippets. VIDEO_TRACKING_URL Video Tracking URL creative wrappers that include tracking URIs. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
htmlHeader	xsd:string The header HTML snippet that this creative wrapper delivers.
htmlFooter	xsd:string The footer HTML snippet that this creative wrapper delivers.
ampHead	xsd:string The header AMP snippet that this creative wrapper delivers.
ampBody	xsd:string The footer AMP snippet that this creative wrapper delivers.
videoTrackingUrls	ConversionEvent_TrackingUrl...[] The video tracking URLs that this creative wrapper delivers. This field is required if the creativeWrapperType is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.
thirdPartyDataDeclaration	ThirdPartyDataDeclaration The ThirdPartyDataDeclaration for this creative wrapper. It is copied to one of the underlying creatives. If the header creative is active then it is persisted there. Otherwise it is stored on the footer creative.
ordering	CreativeWrapperOrdering If there are multiple wrappers for a creative, then ordering defines the order in which the HTML snippets are rendered. Enumerations NO_PREFERENCE Wrapping occurs after INNER but before OUTER INNER Wrapping occurs as early as possible. OUTER Wrapping occurs after both NO_PREFERENCE and INNER
status	CreativeWrapperStatus The status of the CreativeWrapper. This attribute is readonly. Enumerations ACTIVE INACTIVE