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.

VideoTrackingUrl

Represents a ConversionEventEnum to URL pair that will be pinged when the event happens.

JSON representation 
{
  "conversionEvent": enum (ConversionEvent),
  "url": string
}
Fields
conversionEvent

enum (ConversionEvent)

Required. All possible tracking event types.
url

string

Optional. A URL that should be pinged for the conversion event.

ConversionEvent

All possible tracking event types. Not all events are supported by every kind of creative.

Enums
CONVERSION_EVENT_UNSPECIFIED Default value. This value is unused.
ACCEPT_INVITATION Corresponds to the acceptInvitation tracking event.
CLICK_TRACKING Corresponds to the Linear.VideoClicks.ClickTracking node.
CLOSE Corresponds to the close tracking event.
COLLAPSE Corresponds to the collapse tracking event.
COMPLETE Corresponds to the complete tracking event.
CREATIVE_VIEW Corresponds to the creativeView tracking event.
CUSTOM_CLICK Corresponds to the Linear.VideoClicks.CustomClick node.
ENGAGED_VIEW An event that is fired after 30 seconds of viewing the video or when the video finished (if the video duration is less than 30 seconds). This event does not correspond to any VAST element and is implemented using an extension.
EXPAND Corresponds to the expand tracking event.
FIRST_QUARTILE Corresponds to the firstQuartile tracking event.
FULLSCREEN Corresponds to the fullscreen tracking event.
FULLY_VIEWABLE_AUDIBLE_HALF_DURATION_IMPRESSION Corresponds to the fullyViewableAudibleHalfDurationImpression tracking event.
MEASURABLE_IMPRESSION Corresponds to the measurableImpression tracking event.
MIDPOINT Corresponds to the midpoint tracking event.
MUTE Corresponds to the mute tracking event.
PAUSE Corresponds to the pause tracking event.
RESUME Corresponds to the resume tracking event.
REWIND Corresponds to the rewind tracking event.
SKIPPED An event that is fired when a video was skipped. This event does not correspond to any VAST element and is implemented using an extension.
SKIP_SHOWN An event that is fired when a video skip button is shown, usually after 5 seconds of viewing the video. This event does not correspond to any VAST element and is implemented using an extension.
START Corresponds to the start tracking event.
SURVEY Corresponds to the InLine.Survey node.
THIRD_QUARTILE Corresponds to the thirdQuartile tracking event.
UNMUTE Corresponds to the unmute tracking event.
VIDEO_ABANDON Corresponds to the abandon tracking event.
VIEWABLE_IMPRESSION Corresponds to the viewableImpression tracking event.

ThirdPartyDataDeclaration

Represents a set of declarations about what (if any) third party companies are associated with a given creative. This can also be set on the Network to serve as a default for those creatives that don't have such field set.

JSON representation 
{
  "declarationType": enum (ThirdPartyDataDeclarationType),
  "thirdPartyCompanies": [
    string
  ]
}
Fields
declarationType

enum (ThirdPartyDataDeclarationType)

Optional. The declaration about third party data usage on the associated entity.
thirdPartyCompanies[]

string

Optional. A list of ThirdPartyCompanies associated with this entity. Format: "networks/{networkCode}/thirdPartyCompanies/{thirdPartyCompany}"

ThirdPartyDataDeclarationType

The declaration about third party data usage on the associated entity.

Enums
THIRD_PARTY_DATA_DECLARATION_TYPE_UNSPECIFIED Default value. This value is unused.
DECLARED There is a set of ThirdPartyCompanies associated with this entity.
NONE There are no companies associated. Functionally the same as DECLARED, combined with an empty company list.

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.