Annex: Mapping UI fields to API fields by creative type

The table below maps UI fields to corresponding API fields, separated by creative type. Note that some API fields require further specification through an assigned role or type for the resource provided.

Standard Image Creative

Creative Type: CREATIVE_TYPE_STANDARD
Hosting Source: HOSTING_SOURCE_HOSTED
Name
Required
API Field Name: displayName
Creative asset
Required
API Field Name: assets
Asset Role: ASSET_ROLE_MAIN
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Status
Required
API Field Name: entityStatus
Appended HTML tracking tag
Optional
API Field Name: appendedTag
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

HTML5 Creative

Creative Type: CREATIVE_TYPE_STANDARD
Hosting Source: HOSTING_SOURCE_HOSTED
Name
Required
API Field Name: displayName
Creative asset
Required
API Field Name: assets
Asset Role: ASSET_ROLE_MAIN
Status
Required
API Field Name: entityStatus
Backup images
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_BACKUP
Backup landing page URL
Optional
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_BACKUP
Backup exit reporting label
Optional
API Field Name: exitEvents[].reportingName
Exit Event Type: EXIT_EVENT_TYPE_BACKUP
Polite load images
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_POLITE_LOAD
Exits
Required
API Field Name: exitEvents[]
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Counters
Optional
API Field Name: counterEvents[]
Timers
Optional
API Field Name: timerEvents[]
Appended HTML tracking tag
Optional
API Field Name: appendedTag
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Optional
API Field Name: reviewStatus

Third Party Display Creative

Creative Type: CREATIVE_TYPE_STANDARD
Hosting Source: HOSTING_SOURCE_THIRD_PARTY
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
Dimensions
Required
API Field Name: dimensions
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Requires MRAID
Optional
API Field Name: requireMraid
Requires HTML5
Optional
API Field Name: requireHtml5
Third-party tag
Required
API Field Name: thirdPartyTag
Requires ping for attribution
Optional
API Field Name: requirePingForAttribution
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Third Party Expandable Creative

Creative Type: CREATIVE_TYPE_EXPANDABLE
Hosting Source: HOSTING_SOURCE_THIRD_PARTY
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
Dimensions
Required
API Field Name: dimensions
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Requires MRAID
Optional
API Field Name: requireMraid
Requires HTML5
Optional
API Field Name: requireHtml5
Expanding direction
Required
API Field Name: expandingDirection
Expand on hover
Optional
API Field Name: expandOnHover
Third-party
Required
API Field Name: thirdPartyTag
Requires ping for attribution
Optional
API Field Name: requirePingForAttribution
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Third Party Video Creative

Creative Type: CREATIVE_TYPE_VIDEO
Hosting Source: HOSTING_SOURCE_THIRD_PARTY
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
VAST Tag URL
Required
API Field Name: vastTagUrl
VPAID
Readonly
API Field Name: vpaid
HTML5 Video
Readonly
API Field Name: html5Video
Requires ping for attribution
Optional
API Field Name: requirePingForAttribution
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Third Party Audio Creative

Creative Type: CREATIVE_TYPE_AUDIO
Hosting Source: HOSTING_SOURCE_THIRD_PARTY
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
VAST Tag URL
Required
API Field Name: vastTagUrl
Requires ping for attribution
Optional
API Field Name: requirePingForAttribution
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Video Creative

Creative Type: CREATIVE_TYPE_VIDEO
Hosting Source: HOSTING_SOURCE_HOSTED
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
Source file
Required
API Field Name: assets
Asset Role: ASSET_ROLE_MAIN
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Include skip button
Optional
API Field Name: skippable
Skip offset
Optional
API Field Name: skipOffset
Progress offset
Optional
API Field Name: progressOffset
Universal Ad ID
Optional
API Field Name: universalAdId
OBA
Optional
API Field Name: obaIcon
Companion creatives
Optional
API Field Name: companionCreativeIds
Serving file
Readonly
API Field Name: transcodes
Third-party URLs
Optional
API Field Name: thirdPartyUrls
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Audio Creative

Creative Type: CREATIVE_TYPE_AUDIO
Hosting Source: HOSTING_SOURCE_HOSTED
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
Source file
Required
API Field Name: assets
Asset Role: ASSET_ROLE_MAIN
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Companion asset (Upload or Assign)
Required
API Field Name: companionCreativeIds
Serving file name
Readonly
API Field Name: transcodes[].name
Serving file type
Readonly
API Field Name: transcodes[].mimeType
Serving file audio bit rate
Readonly
API Field Name: transcodes[].audioBitRateKbps
Serving file audio sample rate
Readonly
API Field Name: transcodes[].audioSampleRateHz
Third-party URLs
Optional
API Field Name: thirdPartyUrls
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Native Display Creative

Creative Type: CREATIVE_TYPE_NATIVE, CREATIVE_TYPE_NATIVE_SITE_SQUARE
Hosting Source: HOSTING_SOURCE_HOSTED
Name
Required
API Field Name: displayName
status
Required
API Field Name: entityStatus
Logo
Required
API Field Name: assets
Asset Role: ASSET_ROLE_ICON
Image / Square image
Required
API Field Name: assets
Asset Role: ASSET_ROLE_MAIN
Headline
Required
API Field Name: assets
Asset Role: ASSET_ROLE_HEADLINE
Long headline
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_LONG_HEADLINE
Body text
Required
API Field Name: assets
Asset Role: ASSET_ROLE_BODY
Long body text
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_LONG_BODY
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Caption URL
Required
API Field Name: assets
Asset Role: ASSET_ROLE_CAPTION_URL
Call to action
Required
API Field Name: assets
Asset Role: ASSET_ROLE_CALL_TO_ACTION
Campaign Manager 360 tracking ad
Optional
API Field Name: cmTrackingAd
Impression tracking URL 1
Optional
API Field Name: trackingUrls[]
Impression tracking URL 2
Optional
API Field Name: trackingUrls[]
JavaScript tracking URL
Optional
API Field Name: jsTrackerUrl
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Native App Install Creative

Creative Type: CREATIVE_TYPE_NATIVE_APP_INSTALL, CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE
Hosting Source: HOSTING_SOURCE_HOSTED
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
Mobil app
Required
API Field Name: assets
Asset Role: ASSET_ROLE_ANDROID_APP_ID, ASSET_ROLE_IOS_APP_ID
Logo
Required
API Field Name: assets
Asset Role: ASSET_ROLE_ICON
Advertiser name
Required
API Field Name: assets
Asset Role: ASSET_ROLE_ADVERTISER_NAME
Price
Required
API Field Name: assets
Asset Role: ASSET_ROLE_PRICE
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Image / Square image
Required
API Field Name: assets
Asset Role: ASSET_ROLE_MAIN
Headline
Required
API Field Name: assets
Asset Role: ASSET_ROLE_HEADLINE
Long headline
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_LONG_HEADLINE
Body text
Required
API Field Name: assets
Asset Role: ASSET_ROLE_BODY
Long body text
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_LONG_BODY
Call to action
Required
API Field Name: assets
Asset Role: ASSET_ROLE_CALL_TO_ACTION
Campaign Manager 360 tracking ad
Optional
API Field Name: cmTrackingAd
Impression tracking URL 1
Optional
API Field Name: trackingUrls[]
Impression tracking URL 2
Optional
API Field Name: trackingUrls[]
JavaScript tracking URL
Optional
API Field Name: jsTrackerUrl
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus

Native Video Creative

Creative Type: CREATIVE_TYPE_NATIVE_VIDEO
Hosting Source: HOSTING_SOURCE_HOSTED
Name
Required
API Field Name: displayName
Status
Required
API Field Name: entityStatus
Logo
Required
API Field Name: assets
Asset Role: ASSET_ROLE_ICON
Video
Required
API Field Name: assets
Asset Role: ASSET_ROLE_MAIN
Cover image
Required
API Field Name: assets
Asset Role: ASSET_ROLE_COVER_IMAGE
Advertiser name
Required
API Field Name: assets
Asset Role: ASSET_ROLE_ADVERTISER_NAME
Headline
Required
API Field Name: assets
Asset Role: ASSET_ROLE_HEADLINE
Long headline
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_LONG_HEADLINE
Body text
Required
API Field Name: assets
Asset Role: ASSET_ROLE_BODY
Long body text
Optional
API Field Name: assets
Asset Role: ASSET_ROLE_LONG_BODY
Landing page URL
Required
API Field Name: exitEvents[].url
Exit Event Type: EXIT_EVENT_TYPE_DEFAULT
Caption URL
Required
API Field Name: assets
Asset Role: ASSET_ROLE_CAPTION_URL
Call to action
Required
API Field Name: assets
Asset Role: ASSET_ROLE_CALL_TO_ACTION
Impression tracking URL 1
Optional
API Field Name: trackingUrls[]
Impression tracking URL 2
Optional
API Field Name: trackingUrls[]
JavaScript tracking URL
Optional
API Field Name: jsTrackerUrl
Integration code
Optional
API Field Name: integrationCode
Notes
Optional
API Field Name: notes
Audit status
Readonly
API Field Name: reviewStatus