type SetTopBoxCreative (v201808)

A Creative that will be served into cable set-top boxes. There are no assets for this creative type, as they are hosted by external cable systems.


Namespace
https://www.google.com/apis/ads/publisher/v201808

Field

Creative (inherited)

advertiserId

xsd:long

The ID of the advertiser that owns the creative. This attribute is required.

id

xsd:long

Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.

name

xsd:string

The name of the creative. This attribute is required and has a maximum length of 255 characters.

size

Size

The Size of the creative. This attribute is required for creation and then is read-only.

previewUrl

xsd:string

The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.

policyViolations

CreativePolicyViolation[]

Set of policy violations detected for this creative. This attribute is read-only.


Enumerations
MALWARE_IN_CREATIVE
Malware was found in the creative.

For more information see here.

MALWARE_IN_LANDING_PAGE
Malware was found in the landing page.

For more information see here.

LEGALLY_BLOCKED_REDIRECT_URL
The redirect url contains legally objectionable content.
MISREPRESENTATION_OF_PRODUCT
The creative misrepresents the product or service being advertised.

For more information see here.

SELF_CLICKING_CREATIVE
The creative has been determined to be self clicking.
GAMING_GOOGLE_NETWORK
The creative has been determined as attempting to game the Google network.

For more information see here.

DYNAMIC_DNS
The landing page for the creative uses a dynamic DNS.

For more information see here.

PHISHING
Phishing found in creative or landing page.

For more information see here.

DOWNLOAD_PROMPT_IN_CREATIVE
The creative prompts the user to download a file.

For more information see here

UNAUTHORIZED_COOKIE_DETECTED
The creative sets an unauthorized cookie on a Google domain.

For more information see here

TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION
The creative has been temporarily paused while we investigate.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

appliedLabels

AppliedLabel[]

The set of labels applied to this creative.

lastModifiedDateTime

DateTime

The date and time this creative was last modified.

customFieldValues

  1. BaseCustomFieldValue[]
    1. CustomFieldValue
    2. DropDownCustomFieldValue

The values of the custom fields associated with this creative.

HasDestinationUrlCreative (inherited)

destinationUrl

xsd:string

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

destinationUrlType

DestinationUrlType

The action that should be performed if the user clicks on the creative. This attribute is optional and defaults to DestinationUrlType.CLICK_TO_WEB.


Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CLICK_TO_WEB
Navigate to a web page. (a.k.a. "Click-through URL").
CLICK_TO_APP
Start an application.
CLICK_TO_CALL
Make a phone call.
NONE
Destination URL not present. Useful for video creatives where a landing page or a product isn't necessarily applicable.

BaseVideoCreative (inherited)

duration

xsd:int

The expected duration of this creative in milliseconds.

allowDurationOverride

xsd:boolean

Allows the creative duration to differ from the actual asset durations. This attribute is optional.

trackingUrls

ConversionEvent_TrackingUrl...[]

A map from ConversionEvent to a list of URLs that will be pinged when the event happens. This attribute is optional.

companionCreativeIds

xsd:long[]

The IDs of the companion creatives that are associated with this creative. This attribute is optional.

customParameters

xsd:string

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

skippableAdType

SkippableAdType

The type of skippable ad.


Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
DISABLED
Skippable ad type is disabled.
ENABLED
Skippable ad type is enabled.
INSTREAM_SELECT
Skippable in-stream ad type.

vastPreviewUrl

xsd:string

An ad tag URL that will return a preview of the VAST XML response specific to this creative. This attribute is read-only.

sslScanResult

SslScanResult

The SSL compatibility scan result of this creative.

This attribute is read-only and determined by Google.


Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
UNSCANNED
SCANNED_SSL
SCANNED_NON_SSL

sslManualOverride

SslManualOverride

The manual override for the SSL compatibility of this creative.

This attribute is optional and defaults to SslManualOverride.NO_OVERRIDE.


Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
NO_OVERRIDE
SSL_COMPATIBLE
NOT_SSL_COMPATIBLE

SetTopBoxCreative

externalAssetId

xsd:string

An external asset identifier that is used in the cable system. This attribute is read-only after creation.

providerId

xsd:string

An identifier for the provider in the cable system. This attribute is read-only after creation.

availabilityRegionIds

xsd:string[]

IDs of regions where the creative is available to serve from a local cable video-on-demand server. This attribute is optional.

licenseWindowStartDateTime

DateTime

The date and time that this creative can begin serving from a local cable video-on-demand server. This attribute is optional.

licenseWindowEndDateTime

DateTime

The date and time that this creative can no longer be served from a local cable video-on-demand server. This attribute is optional.

Send feedback about...

Ad Manager API
Ad Manager API
Need help? Visit our support page.