REST Resource: networks.creatives

  • The Creative resource represents display creatives, and stores information such as creative ID, display name, and associated advertiser.

  • Creatives can optionally declare associated ad partners, specifying the type of declaration and the ad partners involved.

  • You can use the provided methods to get a specific creative or retrieve a list of creatives.

Resource: Creative

The Creative resource.

JSON representation 
{
  "name": string,
  "updateTime": string,
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ],
  "size": {
    object (Size)
  },
  "thirdPartyDataDeclaration": {
    object (ThirdPartyDataDeclaration)
  },
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "buyerPlacementConfig": {
    object (BuyerPlacementConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adExchangeCreative": {
    object (AdExchangeCreativeDetails)
  },
  "adSenseCreative": {
    object (AdSenseCreativeDetails)
  },
  "aspectRatioImageCreative": {
    object (AspectRatioImageCreativeDetails)
  },
  "audioCreative": {
    object (AudioCreativeDetails)
  },
  "audioRedirectCreative": {
    object (AudioRedirectCreativeDetails)
  },
  "clickTrackingCreative": {
    object (ClickTrackingCreativeDetails)
  },
  "customCreative": {
    object (CustomCreativeDetails)
  },
  "html5Creative": {
    object (Html5CreativeDetails)
  },
  "imageCreative": {
    object (ImageCreativeDetails)
  },
  "imageOverlayCreative": {
    object (ImageOverlayCreativeDetails)
  },
  "imageRedirectCreative": {
    object (ImageRedirectCreativeDetails)
  },
  "imageRedirectOverlayCreative": {
    object (ImageRedirectOverlayCreativeDetails)
  },
  "internalRedirectCreative": {
    object (InternalRedirectCreativeDetails)
  },
  "legacyDfpCreative": {
    object (LegacyDfpCreativeDetails)
  },
  "programmaticCreative": {
    object (ProgrammaticCreativeDetails)
  },
  "richMediaStudioCreative": {
    object (RichMediaStudioCreativeDetails)
  },
  "setTopBoxCreative": {
    object (SetTopBoxCreativeDetails)
  },
  "templateCreative": {
    object (TemplateCreativeDetails)
  },
  "thirdPartyCreative": {
    object (ThirdPartyCreativeDetails)
  },
  "vastRedirectCreative": {
    object (VastRedirectCreativeDetails)
  },
  "videoCreative": {
    object (VideoCreativeDetails)
  },
  "videoRedirectCreative": {
    object (VideoRedirectCreativeDetails)
  }
  // End of mutually exclusive fields.
  "displayName": string,
  "advertiser": string,
  "previewUrl": string,
  "thirdPartyDataDeclarationStatus": enum (CreativeThirdPartyDataDeclarationStatus),
  "selfDeclaredEuropeanUnionPoliticalContent": boolean,
  "adBadgingEnabled": boolean
}
Fields
name

string

Identifier. The resource name of the Creative. Format: networks/{networkCode}/creatives/{creativeId}
updateTime

string (Timestamp format)

Output only. The instant this Creative was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
customFieldValues[]

object (CustomFieldValue)

Optional. The values of the custom fields associated with this creative.
size

object (Size)

Required. Immutable. The Size of the creative.
thirdPartyDataDeclaration

object (ThirdPartyDataDeclaration)

Optional. The third party companies associated with this creative. This is distinct from any associated companies that Google may detect programmatically.
appliedLabels[]

object (AppliedLabel)

Optional. The set of labels applied directly to this creative.
buyerPlacementConfig

object (BuyerPlacementConfig)

Optional. The buyer placement configuration for this creative.
The details of the creative specific to its type. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
adExchangeCreative

object (AdExchangeCreativeDetails)

Optional. An Ad Exchange dynamic allocation creative.
adSenseCreative

object (AdSenseCreativeDetails)

Optional. An AdSense dynamic allocation creative.
aspectRatioImageCreative

object (AspectRatioImageCreativeDetails)

Optional. A Creative intended for mobile platforms that displays an image, whose size is defined as an aspect ratio. It can have multiple images whose dimensions conform to that aspect ratio.
audioCreative

object (AudioCreativeDetails)

Optional. A Creative that contains Ad Manager hosted audio ads and is served via VAST XML.
audioRedirectCreative

object (AudioRedirectCreativeDetails)

Optional. A Creative that contains externally hosted audio ads and is served via VAST XML.
clickTrackingCreative

object (ClickTrackingCreativeDetails)

Optional. A creative that is used for tracking clicks on ads that are served directly from the customers' web servers or media servers. NOTE: The size attribute is not used for click tracking creative and it will not be persisted upon save.
customCreative

object (CustomCreativeDetails)

Optional. A Creative that contains a custom HTML snippet and file assets.
html5Creative

object (Html5CreativeDetails)

Optional. A Creative that contains a zipped HTML5 bundle asset, a list of third party impression trackers, and a third party click tracker.
imageCreative

object (ImageCreativeDetails)

Optional. A Creative that displays an image.
imageOverlayCreative

object (ImageOverlayCreativeDetails)

Optional. An overlay Creative that displays an image and is served via VAST 2.0 XML. Overlays cover part of the video content they are displayed on top of.
imageRedirectCreative

object (ImageRedirectCreativeDetails)

Optional. A Creative that loads an image asset from a specified URL.
imageRedirectOverlayCreative

object (ImageRedirectOverlayCreativeDetails)

Optional. An overlay Creative that loads an image asset from a specified URL and is served via VAST XML. Overlays cover part of the video content they are displayed on top of. This creative is read only.
internalRedirectCreative

object (InternalRedirectCreativeDetails)

Optional. A Creative hosted by Campaign Manager 360.

Similar to third-party creatives, a Campaign Manager 360 tag is used to retrieve a creative asset. However, Campaign Manager 360 tags are not sent to the user's browser. Instead, they are processed internally within the Google Marketing Platform system.
legacyDfpCreative

object (LegacyDfpCreativeDetails)

Optional. A Creative that isn't supported by Google DFP, but was migrated from DART. Creatives of this type cannot be created or modified.
programmaticCreative

object (ProgrammaticCreativeDetails)

Optional. A Creative used for programmatic trafficking. This creative will be auto-created with the right approval from the buyer. This creative cannot be created through the API. This creative can be updated.
richMediaStudioCreative

object (RichMediaStudioCreativeDetails)

Optional. A Creative that is created by a Rich Media Studio. You cannot create this creative, but you can update some fields of this creative.
setTopBoxCreative

object (SetTopBoxCreativeDetails)

Optional. 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.
templateCreative

object (TemplateCreativeDetails)

Optional. A Creative that is created by the specified creative template.
thirdPartyCreative

object (ThirdPartyCreativeDetails)

Optional. A Creative that is served by a 3rd-party vendor.
vastRedirectCreative

object (VastRedirectCreativeDetails)

Optional. A Creative that points to an externally hosted VAST ad and is served via VAST XML as a VAST Wrapper.
videoCreative

object (VideoCreativeDetails)

Optional. A Creative that contains Ad Manager hosted video ads and is served via VAST XML.
videoRedirectCreative

object (VideoRedirectCreativeDetails)

Optional. A Creative that contains externally hosted video ads and is served via VAST XML.
End of mutually exclusive fields.
displayName

string

Required. Display name of the Creative. This attribute has a maximum length of 255 characters.
advertiser

string

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this Creative belongs. Format: "networks/{networkCode}/companies/{companyId}"
previewUrl

string

Output only. The URL of the creative for previewing the media.
thirdPartyDataDeclarationStatus

enum (CreativeThirdPartyDataDeclarationStatus)

Output only. The status of the publisher's ThirdPartyDataDeclaration, when compared with the set of third party companies detected via automated scanning.

For example, if automated scanning detects more companies than have been declared, this status will be CreativeThirdPartyDataDeclarationStatus.INCOMPLETE.
selfDeclaredEuropeanUnionPoliticalContent

boolean

Optional. Whether this creative contains self-declared European Union political content.
adBadgingEnabled

boolean

Optional. Non-empty default. Whether the creative has ad badging enabled.

Defaults to false for VastRedirectCreative, ThirdPartyCreative, AudioRedirectCreative, ProgrammaticCreative, LegacyDfpMobileCreative, FlashOverlayCreative, GraphicalInterstitialCreative, LegacyDfpCreative, MobileAdNetworkCreative, MobileVideoInterstitialCreative, SdkMediationCreative, and FlashCreative types.

Defaults to true for all other creative types.

AdExchangeCreativeDetails

An Ad Exchange dynamic allocation creative.

JSON representation 
{
  "nativeEligible": boolean,
  "interstitial": boolean,
  "allowsAllRequestedSizes": boolean,
  "slotId": string,
  "backfillSnippet": string
}
Fields
nativeEligible

boolean

Optional. Whether this creative is eligible for native ad-serving. This value is optional and defaults to false.
interstitial

boolean

Optional. True if this creative is interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.
allowsAllRequestedSizes

boolean

Optional. True if this creative is eligible for all requested sizes.
slotId

string

Output only. The ID of ad slot (inventory) that an advertiser might want to target.
backfillSnippet

string

Optional. The code snippet (ad tag) from Ad Exchange or AdSense to traffic the dynamic allocation creative. Only valid Ad Exchange or AdSense parameters will be considered. Any extraneous HTML or JavaScript will be ignored.

AdSenseCreativeDetails

An AdSense dynamic allocation creative.

JSON representation 
{
  "slotId": string,
  "backfillSnippet": string
}
Fields
slotId

string

Output only. The ID of ad slot (inventory) that an advertiser might want to target.
backfillSnippet

string

Optional. The code snippet (ad tag) from Ad Exchange or AdSense to traffic the dynamic allocation creative. Only valid Ad Exchange or AdSense parameters will be considered. Any extraneous HTML or JavaScript will be ignored.

AspectRatioImageCreativeDetails

A Creative intended for mobile platforms that displays an image, whose size is defined as an aspect ratio. It can have multiple images whose dimensions conform to that aspect ratio.

JSON representation 
{
  "imageAssets": [
    {
      object (CreativeAsset)
    }
  ],
  "thirdPartyImpressionTrackingUrls": [
    string
  ],
  "altText": string,
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType)
}
Fields
imageAssets[]

object (CreativeAsset)

Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.
thirdPartyImpressionTrackingUrls[]

string

Optional. Third party impression tracking URLs to ping when this creative is displayed.
altText

string

Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

CreativeDestinationUrlType

The valid actions that a destination URL may perform if the user clicks on the ad.

Enums
CREATIVE_DESTINATION_URL_TYPE_UNSPECIFIED Default value. This value is unused.
CLICK_TO_APP Start an application.
CLICK_TO_CALL Make a phone call.
CLICK_TO_WEB Navigate to a web page. (a.k.a. "Click-through URL").
NONE Destination URL not present. Useful for video creatives where a landing page or a product isn't necessarily applicable.

CreativeAsset

A CreativeAsset is an asset that can be used in creatives.

JSON representation 
{
  "size": {
    object (Size)
  },
  "clickTags": [
    {
      object (ClickTag)
    }
  ],
  "asset": string,
  "assetByteArray": string,
  "fileName": string,
  "fileSize": string,
  "assetUrl": string,
  "imageDensity": enum (AssetImageDensity)
}
Fields
size

object (Size)

Output only. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.
clickTags[]

object (ClickTag)

Output only. The click tags of the asset.
asset

string

Required. The resource name of the asset. This attribute is generated by Google upon creation. Format: networks/{networkCode}/assets/{asset}
assetByteArray

string (bytes format)

Input only. The content of the asset as a byte array. This attribute is required when creating the creative that contains this asset if asset is not provided.

When updating the content, pass a new byte array, and set asset to null. Otherwise, this field can be null.

The assetByteArray will be null when the creative is retrieved.

A base64-encoded string.
fileName

string

Optional. The file name of the asset. This attribute is required when creating a new asset (e.g. when assetByteArray is not null).
fileSize

string (int64 format)

Output only. The file size of the asset in bytes.
assetUrl

string

Output only. A URL where the asset can be previewed.
imageDensity

enum (AssetImageDensity)

Non-empty default. The display density of the image. This is the ratio between a dimension in pixels of the image and the dimension in pixels that it should occupy in device-independent pixels when displayed. This attribute defaults to ONE_TO_ONE.

ClickTag

Click tags define click-through URLs for each exit on an HTML5 creative. An exit is any area that can be clicked that directs the browser to a landing page. Each click tag defines the click-through URL for a different exit. In Ad Manager, tracking pixels are attached to the click tags if URLs are valid.

JSON representation 
{
  "displayName": string,
  "url": string
}
Fields
displayName

string

Optional. Name of the click tag. Must match the regular expression clickTag\d*.
url

string

Optional. URL of the click tag.

AssetImageDensity

Image densities.

Enums
ASSET_IMAGE_DENSITY_UNSPECIFIED Default value. This value is unused.
ONE_TO_ONE Indicates that there is a 1:1 ratio between the dimensions of the raw image and the dimensions that it should be displayed at in device-independent pixels.
THREE_TO_TWO Indicates that there is a 3:2 ratio between the dimensions of the raw image and the dimensions that it should be displayed at in device-independent pixels.
TWO_TO_ONE Indicates that there is a 2:1 ratio between the dimensions of the raw image and the dimensions that it should be displayed at in device-independent pixels.

AudioCreativeDetails

A Creative that contains Ad Manager hosted audio ads and is served via VAST XML.

JSON representation 
{
  "vastInfo": {
    object (VastInfo)
  }
}
Fields
vastInfo

object (VastInfo)

Optional. Fields common to Video Ad Serving Template (VAST) creatives

VastInfo

Fields common to Video Ad Serving Template (VAST) creatives.

JSON representation 
{
  "duration": string,
  "trackingUrls": [
    {
      object (VideoTrackingUrl)
    }
  ],
  "companionCreatives": [
    string
  ],
  "allowDurationOverride": boolean,
  "customParameters": string,
  "adId": string,
  "adIdType": enum (VastAdIdType),
  "skippableAdType": enum (SkippableAdType),
  "vastPreviewUrl": string,
  "creativeSetDisplayName": string,
  "creativeSet": string,
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType)
}
Fields
duration

string (Duration format)

Optional. The expected duration of this creative.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
trackingUrls[]

object (VideoTrackingUrl)

Optional. URLs that will be pinged when conversion events happen.
companionCreatives[]

string

Optional. The companion creatives that are associated with this creative. Format: "networks/{networkCode}/creatives/{creativeId}"
allowDurationOverride

boolean

Optional. Allows the creative duration to differ from the actual asset durations.
customParameters

string

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.
adId

string

Optional. The ad id associated with the video as defined by the adIdType registry. This field is required if adIdType is not NONE.
adIdType

enum (VastAdIdType)

Optional. The registry which the ad id of this creative belongs to. This field defaults to NONE.
skippableAdType

enum (SkippableAdType)

Optional. The type of skippable ad.
vastPreviewUrl

string

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
creativeSetDisplayName

string

Output only. The display name of the creative set.
creativeSet

string

Output only. The resource name of the creative set. Format: "networks/{networkCode}/creativeSets/{creativeSetId}"
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

VastAdIdType

The registry that an ad ID belongs to.

Enums
VAST_AD_ID_TYPE_UNSPECIFIED Default value. This value is unused.
AD_ID Ad ID.
ARPP The ad ID is registered with ARPP Pub-ID.
CLEARCAST The ad ID is registered with clearcast.co.uk.
CUSV The ad ID is registered with Auditel Spot ID.
NONE None.

AudioRedirectCreativeDetails

A Creative that contains externally hosted audio ads and is served via VAST XML.

JSON representation 
{
  "vastInfo": {
    object (VastInfo)
  }
}
Fields
vastInfo

object (VastInfo)

Optional. Fields common to Video Ad Serving Template (VAST) creatives

ClickTrackingCreativeDetails

A creative that is used for tracking clicks on ads that are served directly from the customers' web servers or media servers. NOTE: The size attribute is not used for click tracking creative and it will not be persisted upon save.

JSON representation 
{
  "clickTrackingUrl": string
}
Fields
clickTrackingUrl

string

Optional. The click tracking URL.

CustomCreativeDetails

A Creative that contains a custom HTML snippet and file assets.

JSON representation 
{
  "thirdPartyImpressionTrackingUrls": [
    string
  ],
  "customCreativeAssets": [
    {
      object (CustomCreativeAsset)
    }
  ],
  "htmlSnippet": string,
  "ampHtmlSnippet": string,
  "interstitial": boolean,
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType),
  "safeFrameCompatible": boolean,
  "effectiveSafeFrameCompatible": boolean,
  "lockedOrientation": enum (CreativeLockedOrientation)
}
Fields
thirdPartyImpressionTrackingUrls[]

string

Optional. Impression tracking URLs to ping when this creative is displayed.
customCreativeAssets[]

object (CustomCreativeAsset)

Optional. File assets that are associated with this creative, and can be referenced in the snippet.
htmlSnippet

string

Required. The HTML snippet that this creative delivers.
ampHtmlSnippet

string

The AMP HTML snippet that this creative delivers.
interstitial

boolean

Whether this custom creative is an interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.
safeFrameCompatible

boolean

Input only. Whether the creative is compatible for SafeFrame rendering.
effectiveSafeFrameCompatible

boolean

Output only. The effective value of whether the creative is compatible for SafeFrame rendering, as decided by the service.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.

CreativeLockedOrientation

Describes the orientation that a creative should be served with.

Enums
CREATIVE_LOCKED_ORIENTATION_UNSPECIFIED Default value. This value is unused.
LANDSCAPE Landscape orientation.
PORTRAIT Portrait orientation.
FREE Free orientation.

CustomCreativeAsset

A CustomCreativeAsset is an association between a CustomCreative and an asset. Any assets that are associated with a creative can be inserted into its HTML snippet.

JSON representation 
{
  "asset": {
    object (CreativeAsset)
  },
  "macroName": string
}
Fields
asset

object (CreativeAsset)

Required. The asset. To view the asset, use CreativeAsset.asset_url.
macroName

string

Optional. The name by which the associated asset will be referenced. For example, if the value is "foo", then the asset can be inserted into an HTML snippet using the macro: "%%FILE:foo%%".

Html5CreativeDetails

A Creative that contains a zipped HTML5 bundle asset, a list of third party impression trackers, and a third party click tracker.

JSON representation 
{
  "thirdPartyImpressionTrackingUrls": [
    string
  ],
  "lockedOrientation": enum (CreativeLockedOrientation),
  "overrideSize": boolean,
  "thirdPartyClickTrackingUrl": string,
  "safeFrameCompatible": boolean,
  "html5Asset": {
    object (CreativeAsset)
  }
}
Fields
thirdPartyImpressionTrackingUrls[]

string

Optional. Impression tracking URLs to ping when this creative is displayed.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.
overrideSize

boolean

Optional. Allows the creative size to differ from the actual HTML5 asset size.
thirdPartyClickTrackingUrl

string

Optional. A click tracking URL to ping when this creative is clicked.
safeFrameCompatible

boolean

Optional. Whether the creative is compatible for SafeFrame rendering.
html5Asset

object (CreativeAsset)

Required. The HTML5 asset. To preview the HTML5 asset, use the CreativeAsset.asset_url. In this field, the CreativeAsset.asset_byte_array must be a zip bundle and the CreativeAsset.file_name must have a zip extension.

ImageCreativeDetails

A Creative that displays an image.

JSON representation 
{
  "thirdPartyImpressionTrackingUrls": [
    string
  ],
  "primaryImageAsset": {
    object (CreativeAsset)
  },
  "secondaryImageAssets": [
    {
      object (CreativeAsset)
    }
  ],
  "altText": string,
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType),
  "ampDestinationUrl": string,
  "lockedOrientation": enum (CreativeLockedOrientation),
  "overrideSize": boolean
}
Fields
thirdPartyImpressionTrackingUrls[]

string

Optional. Impression tracking URLs to ping when this creative is displayed.
primaryImageAsset

object (CreativeAsset)

The primary image asset associated with this creative. This attribute is required.
secondaryImageAssets[]

object (CreativeAsset)

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.
altText

string

Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.
ampDestinationUrl

string

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.
overrideSize

boolean

Optional. Allows the creative size to differ from the actual image asset size.

ImageOverlayCreativeDetails

An overlay Creative that displays an image and is served via VAST 2.0 XML. Overlays cover part of the video content they are displayed on top of.

JSON representation 
{
  "primaryImageAsset": {
    object (CreativeAsset)
  },
  "companionCreatives": [
    string
  ],
  "trackingUrls": [
    {
      object (VideoTrackingUrl)
    }
  ],
  "duration": string,
  "expectedCompanions": [
    {
      object (CreativePlaceholder)
    }
  ],
  "lockedOrientation": enum (CreativeLockedOrientation),
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType),
  "overrideSize": boolean,
  "creativeSetDisplayName": string,
  "creativeSet": string,
  "customParameters": string,
  "expectedCompanionDeliveryOption": enum (CompanionDeliveryOption),
  "vastPreviewUrl": string
}
Fields
primaryImageAsset

object (CreativeAsset)

Required. The primary image asset associated with this creative.
companionCreatives[]

string

Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{networkCode}/creatives/{creativeId}"
trackingUrls[]

object (VideoTrackingUrl)

Optional. URLs that will be pinged when conversion events happen.
duration

string (Duration format)

Optional. Minimum suggested duration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
expectedCompanions[]

object (CreativePlaceholder)

Optional. CreativePlaceholder objects a creative set should fulfill.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.
overrideSize

boolean

Optional. Allows the creative size to differ from the actual image asset size.
creativeSetDisplayName

string

Output only. The display name of the creative set.
creativeSet

string

Output only. The resource name of the creative set. Format: "networks/{networkCode}/creativeSets/{creativeSetId}"
customParameters

string

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.
expectedCompanionDeliveryOption

enum (CompanionDeliveryOption)

Output only. The companion delivery option this set will be served with.
vastPreviewUrl

string

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.

ImageRedirectCreativeDetails

A Creative that loads an image asset from a specified URL.

JSON representation 
{
  "thirdPartyImpressionTrackingUrls": [
    string
  ],
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType),
  "altText": string,
  "imageUrl": string
}
Fields
thirdPartyImpressionTrackingUrls[]

string

Optional. Impression tracking URLs to ping when this creative is displayed. Each string has a maximum length of 1024 characters.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.
altText

string

Optional. Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.
imageUrl

string

Required. The URL where the actual asset resides. This field has a maximum length of 1024 characters.

ImageRedirectOverlayCreativeDetails

An overlay Creative that loads an image asset from a specified URL and is served via VAST XML. Overlays cover part of the video content they are displayed on top of. This creative is read only.

JSON representation 
{
  "trackingUrls": [
    {
      object (VideoTrackingUrl)
    }
  ],
  "expectedCompanions": [
    {
      object (CreativePlaceholder)
    }
  ],
  "companionCreatives": [
    string
  ],
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType),
  "imageUrl": string,
  "assetSize": {
    object (Size)
  },
  "duration": string,
  "customParameters": string,
  "expectedCompanionDeliveryOption": enum (CompanionDeliveryOption),
  "vastPreviewUrl": string,
  "creativeSetDisplayName": string,
  "creativeSet": string
}
Fields
trackingUrls[]

object (VideoTrackingUrl)

Optional. URLs that will be pinged when conversion events happen.
expectedCompanions[]

object (CreativePlaceholder)

Optional. CreativePlaceholder objects a creative set should fulfill.
companionCreatives[]

string

Optional. The companion creatives that are associated with this creative. Format: "networks/{networkCode}/creatives/{creativeId}"
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.
imageUrl

string

Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
assetSize

object (Size)

Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
duration

string (Duration format)

Optional. Minimum suggested duration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
customParameters

string

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.
expectedCompanionDeliveryOption

enum (CompanionDeliveryOption)

Output only. The companion delivery option this set will be served with.
vastPreviewUrl

string

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
creativeSetDisplayName

string

Output only. The display name of the creative set.
creativeSet

string

Output only. The resource name of the creative set. Format: "networks/{networkCode}/creativeSets/{creativeSetId}"

InternalRedirectCreativeDetails

A Creative hosted by Campaign Manager 360.

Similar to third-party creatives, a Campaign Manager 360 tag is used to retrieve a creative asset. However, Campaign Manager 360 tags are not sent to the user's browser. Instead, they are processed internally within the Google Marketing Platform system.

JSON representation 
{
  "thirdPartyImpressionTrackingUrls": [
    string
  ],
  "lockedOrientation": enum (CreativeLockedOrientation),
  "assetSize": {
    object (Size)
  },
  "internalRedirectUrl": string,
  "overrideSize": boolean,
  "interstitial": boolean,
  "sslScanResult": enum (CreativeSslScanResult),
  "sslManualOverride": enum (CreativeSslOverride)
}
Fields
thirdPartyImpressionTrackingUrls[]

string

Optional. Impression tracking URLs to ping when this creative is displayed.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.
assetSize

object (Size)

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set overrideSize to true.
internalRedirectUrl

string

Required. The internal redirect URL of the Campaign Manager 360 hosted creative. This attribute has a maximum length of 1024 characters.
overrideSize

boolean

Optional. Allows the creative size to differ from the actual size specified in the internal redirect's url.
interstitial

boolean

Optional. Whether this creative is interstitial.
sslScanResult

enum (CreativeSslScanResult)

Output only. The SSL compatibility scan result of this creative.
sslManualOverride

enum (CreativeSslOverride)

Optional. The manual override for the SSL compatibility of this creative.

CreativeSslScanResult

Enum to store the creative SSL compatibility scan result.

Enums
CREATIVE_SSL_SCAN_RESULT_UNSPECIFIED Default value. This value is unused.
SCANNED_NON_SSL The creative was scanned and found to be SSL-incompatible.
SCANNED_SSL The creative was scanned and found to be SSL-compatible.
UNSCANNED The creative has not been scanned for SSL compatibility.

CreativeSslOverride

Enum to store the creative SSL compatibility manual override. Its three states are similar to that of SslScanResult.

Enums
CREATIVE_SSL_OVERRIDE_UNSPECIFIED Default value. This value is unused.
NOT_SSL_COMPATIBLE The creative is manually overridden to be SSL-incompatible.
NO_OVERRIDE The creative's SSL compatibility is determined by the scan result.
SSL_COMPATIBLE The creative is manually overridden to be SSL-compatible.

LegacyDfpCreativeDetails

This type has no fields.

A Creative that isn't supported by Google DFP, but was migrated from DART. Creatives of this type cannot be created or modified.

ProgrammaticCreativeDetails

This type has no fields.

A Creative used for programmatic trafficking. This creative will be auto-created with the right approval from the buyer. This creative cannot be created through the API. This creative can be updated.

RichMediaStudioCreativeDetails

A Creative that is created by a Rich Media Studio. You cannot create this creative, but you can update some fields of this creative.

JSON representation 
{
  "adTagKeys": [
    string
  ],
  "customKeyValues": [
    string
  ],
  "richMediaStudioChildAssetProperties": [
    {
      object (RichMediaStudioChildAssetProperty)
    }
  ],
  "lockedOrientation": enum (CreativeLockedOrientation),
  "studioCreativeId": string,
  "creativeFormat": enum (RichMediaStudioCreativeFormat),
  "totalFileSize": string,
  "surveyUrl": string,
  "allImpressionsUrl": string,
  "richMediaImpressionsUrl": string,
  "backupImageImpressionsUrl": string,
  "overrideCss": string,
  "requiredFlashPluginVersion": string,
  "duration": string,
  "billingAttribute": enum (RichMediaStudioCreativeBillingAttribute),
  "sslScanResult": enum (CreativeSslScanResult),
  "sslManualOverride": enum (CreativeSslOverride)
}
Fields
adTagKeys[]

string

Optional. Ad tag keys.
customKeyValues[]

string

Optional. Custom key values.
richMediaStudioChildAssetProperties[]

object (RichMediaStudioChildAssetProperty)

Output only. Child assets associated with this creative.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.
studioCreativeId

string (int64 format)

Output only. The creative ID as known by Rich Media Studio creative.
creativeFormat

enum (RichMediaStudioCreativeFormat)

Optional. The creative format of the Rich Media Studio creative.
totalFileSize

string (int64 format)

Output only. The total size of all assets in bytes.
surveyUrl

string

Optional. The survey URL for this creative.
allImpressionsUrl

string

Optional. The tracking URL to be triggered when an ad starts to play, whether Rich Media or backup content is displayed. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://.
richMediaImpressionsUrl

string

Optional. The tracking URL to be triggered when any rich media artwork is displayed in an ad. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://.
backupImageImpressionsUrl

string

Optional. The tracking URL to be triggered when the Rich Media backup image is served.
overrideCss

string

Optional. The override CSS. You can put custom CSS code here to repair creative styling; e.g. tr td { background-color:#FBB; }.
requiredFlashPluginVersion

string

Output only. The Flash plugin version required to view this creative; e.g. Flash 10.2/AS 3.
duration

string (Duration format)

Optional. The duration of the creative.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
billingAttribute

enum (RichMediaStudioCreativeBillingAttribute)

Optional. The billing attribute associated with this creative.
sslScanResult

enum (CreativeSslScanResult)

Output only. The SSL compatibility scan result of this creative.
sslManualOverride

enum (CreativeSslOverride)

Optional. The manual override for the SSL compatibility of this creative.

RichMediaStudioCreativeFormat

Different creative format supported by Rich Media Studio creative.

Enums
RICH_MEDIA_STUDIO_CREATIVE_FORMAT_UNSPECIFIED Default value. This value is unused.
EXPANDING Expanding creatives expand/collapse on user interaction such as mouse over. It consists of an initial, or collapsed and an expanded creative area.
FLASH_IN_FLASH A Flash ad that renders in a Flash environment. The adserver will serve this using VAST, but it is not a proper VAST XML ad. It's an amalgamation of the proprietary InStream protocol, rendered inside VAST so that we can capture some standard behavior such as companions.
FLASH_IN_FLASH_EXPANDING An expanding flash ad that renders in a Flash environment. The adserver will serve this using VAST, but it is not a proper VAST XML ad. It's an amalgamation of the proprietary InStream protocol, rendered inside VAST so that we can capture some standard behavior such as companions.
FLOATING Floating creatives float on top of publishers page and can be closed with a close button.
IM_EXPANDING Creatives that are served in an instant messenger application such as AOL Instant Messanger or Yahoo! Messenger. This can also be used in desktop applications such as weatherbug.
IN_APP In-app creatives are served into an ad slot within a publisher's app. In-app implies that they maintain a static size, e.g., 468x60 and do not break out of these dimensions.
IN_PAGE In-page creatives are served into an ad slot on publishers page. In-page implies that they maintain a static size, e.g., 468x60 and do not break out of these dimensions.
IN_PAGE_WITH_FLOATING An In-Page with Floating creative is a dual-asset creative consisting of an in-page asset and a floating asset. This creative type lets you deliver a static primary ad to a webpage, while inviting a user to find out more through a floating asset delivered when the user interacts with the creative.
PEEL_DOWN Peel-down creatives show a glimpse of your ad in the corner of a web page. When the user interacts, the rest of the ad peels down to reveal the full message.
VPAID_LINEAR A creative format that follows the VPAID 2.0 protocol. The ad appears in the publisher's video player, and allows user interactivity with the video ad. The linear format runs pre-roll, post-roll, or interrupts the publisher's video content.
VPAID_NON_LINEAR A creative format that follows the VPAID 2.0 protocol. The ad appears in the publisher's video player, and allows user interactivity with the video ad. The non-linear format runs parallel to the publisher's video content.

RichMediaStudioCreativeBillingAttribute

Rich Media Studio creative supported billing attributes.

This is determined by Rich Media Studio based on the content of the creative and is not updateable.

Enums
RICH_MEDIA_STUDIO_CREATIVE_BILLING_ATTRIBUTE_UNSPECIFIED Default value. This value is unused.
FLASH_IN_FLASH Applies to any RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat.FLASH_IN_FLASH, without Video.
FLOATING_EXPANDING

Applies to any of the following RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat values, without Video:
IN_PAGE Applies to any RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat.IN_PAGE, without Video.
VIDEO Applies to any creatives that includes a video.

RichMediaStudioChildAssetProperty

Represents a child asset in RichMediaStudioCreative.

JSON representation 
{
  "displayName": string,
  "type": enum (RichMediaStudioChildAssetType),
  "totalFileSize": string,
  "width": integer,
  "height": integer,
  "url": string
}
Fields
displayName

string

Output only. The name of the asset as known by Rich Media Studio.
type

enum (RichMediaStudioChildAssetType)

Output only. Required file type of the asset.
totalFileSize

string (int64 format)

Output only. The total size of the asset in bytes.
width

integer

Output only. Width of the widget in pixels.
height

integer

Output only. Height of the widget in pixels.
url

string

Output only. The URL of the asset.

RichMediaStudioChildAssetType

Type of RichMediaStudioChildAssetProperty

Enums
RICH_MEDIA_STUDIO_CHILD_ASSET_TYPE_UNSPECIFIED Default value. This value is unused.
DATA The rest of the supported file types .txt, .xml, etc.
FLASH SWF files
IMAGE Image files
VIDEO FLVS and any other video file types

SetTopBoxCreativeDetails

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.

JSON representation 
{
  "vastInfo": {
    object (VastInfo)
  }
}
Fields
vastInfo

object (VastInfo)

Optional. Fields common to Video Ad Serving Template (VAST) creatives

TemplateCreativeDetails

A Creative that is created by the specified creative template.

JSON representation 
{
  "ampDestinationUrl": string,
  "lockedOrientation": enum (CreativeLockedOrientation),
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType)
}
Fields
ampDestinationUrl

string

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

ThirdPartyCreativeDetails

A Creative that is served by a 3rd-party vendor.

JSON representation 
{
  "thirdPartyImpressionTrackingUrls": [
    string
  ],
  "snippet": string,
  "expandedSnippet": string,
  "lockedOrientation": enum (CreativeLockedOrientation),
  "sslScanResult": enum (CreativeSslScanResult),
  "sslManualOverride": enum (CreativeSslOverride),
  "safeFrameCompatible": boolean,
  "ampRedirectUrl": string,
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType)
}
Fields
thirdPartyImpressionTrackingUrls[]

string

Optional. A list of impression tracking URLs to ping when this creative is displayed.
snippet

string

The HTML snippet that this creative delivers.
expandedSnippet

string

Output only. The HTML snippet that this creative delivers with macros expanded.
lockedOrientation

enum (CreativeLockedOrientation)

Optional. A locked orientation for this creative to be displayed in.
sslScanResult

enum (CreativeSslScanResult)

Output only. The SSL compatibility scan result of this creative.
sslManualOverride

enum (CreativeSslOverride)

Optional. The manual override for the SSL compatibility of this creative.
safeFrameCompatible

boolean

Optional. Whether the Creative is compatible for SafeFrame rendering.
ampRedirectUrl

string

Optional. The URL of the AMP creative.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

VastRedirectCreativeDetails

A Creative that points to an externally hosted VAST ad and is served via VAST XML as a VAST Wrapper.

JSON representation 
{
  "duration": string,
  "trackingUrls": [
    {
      object (VideoTrackingUrl)
    }
  ],
  "vastXmlUrl": string,
  "vastRedirectType": enum (VastRedirectType),
  "vastPricingEnabled": boolean,
  "programmaticDemandSource": boolean,
  "serverSideUnwrappingDisabled": boolean,
  "vastPreviewUrl": string,
  "audio": boolean,
  "destinationUrl": string,
  "destinationUrlType": enum (CreativeDestinationUrlType)
}
Fields
duration

string (Duration format)

Required. The duration of the VAST ad.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
trackingUrls[]

object (VideoTrackingUrl)

Optional. URLs that will be pinged when conversion events happen.
vastXmlUrl

string

Required. The URL where the 3rd party VAST XML is hosted.
vastRedirectType

enum (VastRedirectType)

Required. The type of VAST ad that this redirects to.
vastPricingEnabled

boolean

Optional. Whether pricing information from the VAST response will be used during ad selection.
programmaticDemandSource

boolean

Optional. Whether this is a redirect to a programmatic demand source.
serverSideUnwrappingDisabled

boolean

Optional. Whether server-side unwrapping is disabled.
vastPreviewUrl

string

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
audio

boolean

Optional. Whether the 3rd party VAST XML points to an audio ad. When true, size will always be 1x1.
destinationUrl

string

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

enum (CreativeDestinationUrlType)

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

VastRedirectType

The types of VAST ads that a VastRedirectCreative can point to.

Enums
VAST_REDIRECT_TYPE_UNSPECIFIED Default value. This value is unused.
LINEAR The VAST XML contains only linear ads.
LINEAR_AND_NON_LINEAR The VAST XML contains both linear and nonlinear ads.
NON_LINEAR The VAST XML contains only nonlinear ads.

VideoCreativeDetails

A Creative that contains Ad Manager hosted video ads and is served via VAST XML.

JSON representation 
{
  "vastInfo": {
    object (VastInfo)
  }
}
Fields
vastInfo

object (VastInfo)

Optional. Fields common to Video Ad Serving Template (VAST) creatives

VideoRedirectCreativeDetails

A Creative that contains externally hosted video ads and is served via VAST XML.

JSON representation 
{
  "vastInfo": {
    object (VastInfo)
  }
}
Fields
vastInfo

object (VastInfo)

Optional. Fields common to Video Ad Serving Template (VAST) creatives

CreativeThirdPartyDataDeclarationStatus

The "status" of the ThirdPartyDataDeclaration associated with a given creative.

This is calculated by comparing the companies detected by automated scanning/parsing, with the companies the publisher has declared in the ThirdPartyDataDeclaration.

Enums
CREATIVE_THIRD_PARTY_DATA_DECLARATION_STATUS_UNSPECIFIED Default value. This value is unused.
COMPLETE

All companies detected in scanning exist in the associated ThirdPartyDataDeclaration.

This could be because there were no detected companies, or all the detected companies exist in the associated declaration.
INCOMPLETE

There are companies detected in scanning that do not exist in the associated ThirdPartyDataDeclaration.

This could be because there is no declaration, at either the creative level or network level, or the declaration is missing companies.
UNSCANNED

This entity has not been recently scanned.

This can happen either because there is no scanning data for this creative, or the scanning data is stale (because the creative is not associated with any active line items / eligible to serve).

BuyerPlacementConfig

Represents the buyer placement configuration for a creative.

JSON representation 
{
  "placementId": string,
  "placementDisplayName": string
}
Fields
placementId

string

Optional. The ID of the buyer placement.
placementDisplayName

string

Optional. The name of the buyer placement.

Methods

batchActivate

 Batch activates Creative objects.

batchDeactivate

 Deactivates a list of Creative objects.

get

 Retrieves a Creative object.

list

 Lists Creative objects.