REST Resource: networks.creativeWrappers

Resource: 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 label and applied to ad units by AdUnit.appliedLabels.

JSON representation 
{
  "name": string,
  "label": string,
  "videoTrackingUrls": [
    {
      object (VideoTrackingUrl)
    }
  ],
  "creativeWrapperType": enum (CreativeWrapperType),
  "headerCreative": string,
  "footerCreative": string,
  "htmlHeader": string,
  "htmlFooter": string,
  "ampHeader": string,
  "ampFooter": string,
  "thirdPartyDataDeclaration": {
    object (ThirdPartyDataDeclaration)
  },
  "ordering": enum (CreativeWrapperOrdering),
  "status": enum (CreativeWrapperStatus)
}
Fields
name

string

Identifier. The resource name of the CreativeWrapper. Format: networks/{networkCode}/creativeWrappers/{creativeWrapperId}
label

string

Required. Immutable. The resource name of the Label. Format:networks/{networkCode}/label/{labelId}
videoTrackingUrls[]

object (VideoTrackingUrl)

Optional. The video tracking URLs that this CreativeWrapper delivers. This field is required if the creativeWrapperType is CreativeWrapperType.VIDEO_TRACKING_URL and ignored otherwise.
creativeWrapperType

enum (CreativeWrapperType)

Required. The creativeWrapperType. If the creativeWrapperType is CreativeWrapperType.VIDEO_TRACKING_URL, the videoTrackingUrls field must be set. If the creativeWrapperType is CreativeWrapperType.HTML, either the header or footer field must be set.
headerCreative

string

Output only. The resource name of the Creative. Format: networks/{networkCode}/creative/{creativeId}
footerCreative

string

Output only. The resource name of the Creative. Format: networks/{networkCode}/creative/{creativeId}
htmlHeader

string

Optional. The header HTML snippet that this CreativeWrapper delivers.
ampHeader

string

Optional. The header AMP snippet that this CreativeWrapper delivers.
thirdPartyDataDeclaration

object (ThirdPartyDataDeclaration)

Optional. The ThirdPartyDataDeclaration for this creative wrapper.

The third party companies that are associated with this CreativeWrapper and are present in the htmlHeader or htmlFooter. This field is only applicable when the creativeWrapperType is CreativeWrapperType.HTML.
ordering

enum (CreativeWrapperOrdering)

Optional. If there are multiple wrappers for a Creative, then ordering defines the order in which the HTML snippets are rendered.
status

enum (CreativeWrapperStatus)

Output only. The status of the CreativeWrapper.

CreativeWrapperType

The type of a CreativeWrapper which is specified on the CreativeWrapper.

Enums
CREATIVE_WRAPPER_TYPE_UNSPECIFIED Default value. This value is unused.
HTML HTML CreativeWrappers that include header/footer HTML snippets.
VIDEO_TRACKING_URL Video Tracking URL CreativeWrappers that include tracking URIs.

CreativeWrapperOrdering

Defines the order in which the header and footer HTML snippets will be wrapped around the served creative. INNER snippets will be wrapped first, followed by NO_PREFERENCE and finally OUTER. If the creative needs to be wrapped with more than one snippet with the same CreativeWrapperOrdering, then the order is unspecified.

Enums
CREATIVE_WRAPPER_ORDERING_UNSPECIFIED Default value. This value is unused.
INNER Wrapping occurs as early as possible.
NO_PREFERENCE Wrapping occurs after INNER but before OUTER
OUTER Wrapping occurs after both NO_PREFERENCE and INNER

CreativeWrapperStatus

Indicates whether the CreativeWrapper is active. HTML snippets are served to Creatives only when the CreativeWrapper is active.

Enums
CREATIVE_WRAPPER_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE The CreativeWrapper will be applied to served creatives.
INACTIVE The CreativeWrapper will not be applied to served creatives.

Methods

batchActivate

 Batch activates CreativeWrapper objects.

batchCreate

 Creates CreativeWrapper objects.

batchDeactivate

 Deactivates a list of CreativeWrapper objects.

batchUpdate

 Batch updates CreativeWrapper objects.

create

 Creates a CreativeWrapper object.

get

 Retrieves a CreativeWrapper object.

list

 Lists CreativeWrapper objects.

patch

 Updates a CreativeWrapper object.