Class Creative

A single Creative.

Inheritance
object
Creative
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DisplayVideo.v1.Data
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class Creative : IDirectResponseSchema

Properties

AdditionalDimensions

Additional dimensions. Applicable when creative_type is one of: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_TEMPLATED_APP_INSTALL * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_LIGHTBOX * CREATIVE_TYPE_NATIVE_APP_INSTALL * CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE * CREATIVE_TYPE_PUBLISHER_HOSTED If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.

Declaration
[JsonProperty("additionalDimensions")]
public virtual IList<Dimensions> AdditionalDimensions { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><Dimensions>

AdvertiserId

Output only. The unique ID of the advertiser the creative belongs to.

Declaration
[JsonProperty("advertiserId")]
public virtual long? AdvertiserId { get; set; }
Property Value
Type Description
long?

AppendedTag

Third-party HTML tracking tag to be appended to the creative tag.

Declaration
[JsonProperty("appendedTag")]
public virtual string AppendedTag { get; set; }
Property Value
Type Description
string

Assets

Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * ASSET_ROLE_UNSPECIFIED * ASSET_ROLE_MAIN * ASSET_ROLE_BACKUP * ASSET_ROLE_POLITE_LOAD

Declaration
[JsonProperty("assets")]
public virtual IList<AssetAssociation> Assets { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><AssetAssociation>

CmPlacementId

Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.

Declaration
[JsonProperty("cmPlacementId")]
public virtual long? CmPlacementId { get; set; }
Property Value
Type Description
long?

CmTrackingAd

The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_APP_INSTALL * CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE Output only for other cases.

Declaration
[JsonProperty("cmTrackingAd")]
public virtual CmTrackingAd CmTrackingAd { get; set; }
Property Value
Type Description
CmTrackingAd

CompanionCreativeIds

The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("companionCreativeIds")]
public virtual IList<long?> CompanionCreativeIds { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><long?>

CounterEvents

Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.

Declaration
[JsonProperty("counterEvents")]
public virtual IList<CounterEvent> CounterEvents { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><CounterEvent>

CreateTime

Output only. The timestamp when the creative was created. Assigned by the system.

Declaration
[JsonProperty("createTime")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreativeAttributes

Output only. A list of attributes of the creative that is generated by the system.

Declaration
[JsonProperty("creativeAttributes")]
public virtual IList<string> CreativeAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><string>

CreativeId

Output only. The unique ID of the creative. Assigned by the system.

Declaration
[JsonProperty("creativeId")]
public virtual long? CreativeId { get; set; }
Property Value
Type Description
long?

CreativeType

Required. Immutable. The type of the creative.

Declaration
[JsonProperty("creativeType")]
public virtual string CreativeType { get; set; }
Property Value
Type Description
string

Dimensions

Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to 0 when creative_type is one of: * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_NATIVE_VIDEO * CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO

Declaration
[JsonProperty("dimensions")]
public virtual Dimensions Dimensions { get; set; }
Property Value
Type Description
Dimensions

DisplayName

Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

Dynamic

Output only. Indicates whether the creative is dynamic.

Declaration
[JsonProperty("dynamic")]
public virtual bool? Dynamic { get; set; }
Property Value
Type Description
bool?

EntityStatus

Required. Controls whether or not the creative can serve. Accepted values are: * ENTITY_STATUS_ACTIVE * ENTITY_STATUS_ARCHIVED * ENTITY_STATUS_PAUSED

Declaration
[JsonProperty("entityStatus")]
public virtual string EntityStatus { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExitEvents

Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

Declaration
[JsonProperty("exitEvents")]
public virtual IList<ExitEvent> ExitEvents { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><ExitEvent>

ExpandingDirection

Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_EXPANDABLE

Declaration
[JsonProperty("expandingDirection")]
public virtual string ExpandingDirection { get; set; }
Property Value
Type Description
string

ExpandOnHover

Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_EXPANDABLE

Declaration
[JsonProperty("expandOnHover")]
public virtual bool? ExpandOnHover { get; set; }
Property Value
Type Description
bool?

HostingSource

Required. Indicates where the creative is hosted.

Declaration
[JsonProperty("hostingSource")]
public virtual string HostingSource { get; set; }
Property Value
Type Description
string

Html5Video

Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("html5Video")]
public virtual bool? Html5Video { get; set; }
Property Value
Type Description
bool?

IasCampaignMonitoring

Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.

Declaration
[JsonProperty("iasCampaignMonitoring")]
public virtual bool? IasCampaignMonitoring { get; set; }
Property Value
Type Description
bool?

IntegrationCode

ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.

Declaration
[JsonProperty("integrationCode")]
public virtual string IntegrationCode { get; set; }
Property Value
Type Description
string

JsTrackerUrl

JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only supported in following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_APP_INSTALL * CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO

Declaration
[JsonProperty("jsTrackerUrl")]
public virtual string JsTrackerUrl { get; set; }
Property Value
Type Description
string

LineItemIds

Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.

Declaration
[JsonProperty("lineItemIds")]
public virtual IList<long?> LineItemIds { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><long?>

MediaDuration

Output only. Media duration of the creative. Applicable when creative_type is one of: * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_NATIVE_VIDEO * CREATIVE_TYPE_PUBLISHER_HOSTED

Declaration
[JsonProperty("mediaDuration")]
public virtual object MediaDuration { get; set; }
Property Value
Type Description
object

Mp3Audio

Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO

Declaration
[JsonProperty("mp3Audio")]
public virtual bool? Mp3Audio { get; set; }
Property Value
Type Description
bool?

Name

Output only. The resource name of the creative.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Notes

User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.

Declaration
[JsonProperty("notes")]
public virtual string Notes { get; set; }
Property Value
Type Description
string

ObaIcon

Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("obaIcon")]
public virtual ObaIcon ObaIcon { get; set; }
Property Value
Type Description
ObaIcon

OggAudio

Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO

Declaration
[JsonProperty("oggAudio")]
public virtual bool? OggAudio { get; set; }
Property Value
Type Description
bool?

ProgressOffset

Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("progressOffset")]
public virtual AudioVideoOffset ProgressOffset { get; set; }
Property Value
Type Description
AudioVideoOffset

RequireHtml5

Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE

Declaration
[JsonProperty("requireHtml5")]
public virtual bool? RequireHtml5 { get; set; }
Property Value
Type Description
bool?

RequireMraid

Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE

Declaration
[JsonProperty("requireMraid")]
public virtual bool? RequireMraid { get; set; }
Property Value
Type Description
bool?

RequirePingForAttribution

Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("requirePingForAttribution")]
public virtual bool? RequirePingForAttribution { get; set; }
Property Value
Type Description
bool?

ReviewStatus

Output only. The current status of the creative review process.

Declaration
[JsonProperty("reviewStatus")]
public virtual ReviewStatusInfo ReviewStatus { get; set; }
Property Value
Type Description
ReviewStatusInfo

SkipOffset

Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("skipOffset")]
public virtual AudioVideoOffset SkipOffset { get; set; }
Property Value
Type Description
AudioVideoOffset

Skippable

Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("skippable")]
public virtual bool? Skippable { get; set; }
Property Value
Type Description
bool?

ThirdPartyTag

Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE

Declaration
[JsonProperty("thirdPartyTag")]
public virtual string ThirdPartyTag { get; set; }
Property Value
Type Description
string

ThirdPartyUrls

Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_NATIVE_VIDEO

Declaration
[JsonProperty("thirdPartyUrls")]
public virtual IList<ThirdPartyUrl> ThirdPartyUrls { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><ThirdPartyUrl>

TimerEvents

Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.

Declaration
[JsonProperty("timerEvents")]
public virtual IList<TimerEvent> TimerEvents { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><TimerEvent>

TrackerUrls

Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display &amp; Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only supported in following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_APP_INSTALL * CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO

Declaration
[JsonProperty("trackerUrls")]
public virtual IList<string> TrackerUrls { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><string>

Transcodes

Output only. Audio/Video transcodes. Display &amp; Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_NATIVE_VIDEO * CREATIVE_TYPE_AUDIO

Declaration
[JsonProperty("transcodes")]
public virtual IList<Transcode> Transcodes { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><Transcode>

UniversalAdId

Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("universalAdId")]
public virtual UniversalAdId UniversalAdId { get; set; }
Property Value
Type Description
UniversalAdId

UpdateTime

Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.

Declaration
[JsonProperty("updateTime")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

VastTagUrl

Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source:

  • HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO
Declaration
[JsonProperty("vastTagUrl")]
public virtual string VastTagUrl { get; set; }
Property Value
Type Description
string

Vpaid

Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_VIDEO

Declaration
[JsonProperty("vpaid")]
public virtual bool? Vpaid { get; set; }
Property Value
Type Description
bool?

Implements