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. This attribute is
- /// read-only and is populated by Google.
+ /// The values of the custom fields associated with this creative.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
- public Size size {
+ [System.Xml.Serialization.XmlElementAttribute("customFieldValues", Order = 9)]
+ public BaseCustomFieldValue[] customFieldValues {
get {
- return this.sizeField;
+ return this.customFieldValuesField;
}
set {
- this.sizeField = value;
+ this.customFieldValuesField = value;
}
}
+ }
- /// The click tags of the asset. This field is read-only.
- ///
- [System.Xml.Serialization.XmlElementAttribute("clickTags", Order = 6)]
- public ClickTag[] clickTags {
+
+ /// Represents the different types of policy violations that may be detected on a
+ /// given creative. For more information about the various types of policy
+ /// violations, see here.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum CreativePolicyViolation {
+ /// Malware was found in the creative. For more information see here.
+ ///
+ MALWARE_IN_CREATIVE = 0,
+ /// Malware was found in the landing page. For more information see here.
+ ///
+ MALWARE_IN_LANDING_PAGE = 1,
+ /// The redirect url contains legally objectionable content.
+ ///
+ LEGALLY_BLOCKED_REDIRECT_URL = 2,
+ /// The creative misrepresents the product or service being advertised. For more
+ /// information see
+ /// here.
+ ///
+ MISREPRESENTATION_OF_PRODUCT = 3,
+ /// The creative has been determined to be self clicking.
+ ///
+ SELF_CLICKING_CREATIVE = 4,
+ /// The creative has been determined as attempting to game the Google network.
+ /// For more information see
+ /// here.
+ ///
+ GAMING_GOOGLE_NETWORK = 5,
+ /// The landing page for the creative uses a dynamic DNS. For more information
+ /// see here.
+ ///
+ DYNAMIC_DNS = 6,
+ /// The creative has been determined as attempting to circumvent Google advertising
+ /// systems.
+ ///
+ CIRCUMVENTING_SYSTEMS = 13,
+ /// Phishing found in creative or landing page. For more information see here.
+ ///
+ PHISHING = 7,
+ /// The creative prompts the user to download a file. For more information see here
+ ///
+ DOWNLOAD_PROMPT_IN_CREATIVE = 9,
+ /// The creative sets an unauthorized cookie on a Google domain. For more
+ /// information see here
+ ///
+ UNAUTHORIZED_COOKIE_DETECTED = 10,
+ /// The creative has been temporarily paused while we investigate.
+ ///
+ TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION = 11,
+ /// The landing page contains an abusive experience. For more information see here.
+ ///
+ ABUSIVE_EXPERIENCE = 12,
+ /// The value returned if the actual value is not exposed by the requested API
+ /// version.
+ ///
+ UNKNOWN = 8,
+ }
+
+
+ /// A Creative that points to an externally hosted VAST ad and is
+ /// served via VAST XML as a VAST Wrapper.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class VastRedirectCreative : Creative {
+ private string vastXmlUrlField;
+
+ private VastRedirectType vastRedirectTypeField;
+
+ private bool vastRedirectTypeFieldSpecified;
+
+ private int durationField;
+
+ private bool durationFieldSpecified;
+
+ private long[] companionCreativeIdsField;
+
+ private ConversionEvent_TrackingUrlsMapEntry[] trackingUrlsField;
+
+ private string vastPreviewUrlField;
+
+ private SslScanResult sslScanResultField;
+
+ private bool sslScanResultFieldSpecified;
+
+ private SslManualOverride sslManualOverrideField;
+
+ private bool sslManualOverrideFieldSpecified;
+
+ /// The URL where the 3rd party VAST XML is hosted. This attribute is required.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public string vastXmlUrl {
get {
- return this.clickTagsField;
+ return this.vastXmlUrlField;
}
set {
- this.clickTagsField = value;
+ this.vastXmlUrlField = value;
}
}
- /// 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 is optional and
- /// defaults to ONE_TO_ONE.
+ /// The type of VAST ad that this redirects to. This attribute is required.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
- public ImageDensity imageDensity {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public VastRedirectType vastRedirectType {
get {
- return this.imageDensityField;
+ return this.vastRedirectTypeField;
}
set {
- this.imageDensityField = value;
- this.imageDensitySpecified = true;
+ this.vastRedirectTypeField = value;
+ this.vastRedirectTypeSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="vastRedirectType" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool imageDensitySpecified {
+ public bool vastRedirectTypeSpecified {
get {
- return this.imageDensityFieldSpecified;
+ return this.vastRedirectTypeFieldSpecified;
}
set {
- this.imageDensityFieldSpecified = value;
+ this.vastRedirectTypeFieldSpecified = value;
}
}
- }
-
-
- /// Represents the dimensions of an AdUnit, LineItem or Creative. For
- /// interstitial size (out-of-page), native, ignored and fluid size,
- /// Size must be 1x1.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class Size {
- private int widthField;
-
- private bool widthFieldSpecified;
-
- private int heightField;
-
- private bool heightFieldSpecified;
-
- private bool isAspectRatioField;
-
- private bool isAspectRatioFieldSpecified;
- /// The width of the AdUnit, LineItem or
- /// Creative.
+ /// The duration of the VAST ad in milliseconds. This attribute is required.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public int width {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
+ public int duration {
get {
- return this.widthField;
+ return this.durationField;
}
set {
- this.widthField = value;
- this.widthSpecified = true;
+ this.durationField = value;
+ this.durationSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool widthSpecified {
+ public bool durationSpecified {
get {
- return this.widthFieldSpecified;
+ return this.durationFieldSpecified;
}
set {
- this.widthFieldSpecified = value;
+ this.durationFieldSpecified = value;
}
}
- /// The height of the AdUnit, LineItem
- /// or Creative.
+ /// The IDs of the companion creatives that are associated with this creative. This
+ /// attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public int height {
+ [System.Xml.Serialization.XmlElementAttribute("companionCreativeIds", Order = 3)]
+ public long[] companionCreativeIds {
get {
- return this.heightField;
+ return this.companionCreativeIdsField;
}
set {
- this.heightField = value;
- this.heightSpecified = true;
+ this.companionCreativeIdsField = value;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool heightSpecified {
+ /// A map from ConversionEvent to a list of URLs that will be pinged
+ /// when the event happens. This attribute is optional.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute("trackingUrls", Order = 4)]
+ public ConversionEvent_TrackingUrlsMapEntry[] trackingUrls {
get {
- return this.heightFieldSpecified;
+ return this.trackingUrlsField;
}
set {
- this.heightFieldSpecified = value;
+ this.trackingUrlsField = value;
}
}
- /// True if this size represents an aspect ratio, false otherwise.
+ /// An ad tag URL that will return a preview of the VAST XML response specific to
+ /// this creative. This attribute is read-only.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public bool isAspectRatio {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
+ public string vastPreviewUrl {
get {
- return this.isAspectRatioField;
+ return this.vastPreviewUrlField;
}
set {
- this.isAspectRatioField = value;
- this.isAspectRatioSpecified = true;
+ this.vastPreviewUrlField = value;
+ }
+ }
+
+ /// The SSL compatibility scan result for this creative. This attribute is
+ /// read-only and determined by Google.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
+ public SslScanResult sslScanResult {
+ get {
+ return this.sslScanResultField;
+ }
+ set {
+ this.sslScanResultField = value;
+ this.sslScanResultSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="sslScanResult" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool isAspectRatioSpecified {
+ public bool sslScanResultSpecified {
get {
- return this.isAspectRatioFieldSpecified;
+ return this.sslScanResultFieldSpecified;
}
set {
- this.isAspectRatioFieldSpecified = value;
+ this.sslScanResultFieldSpecified = value;
}
}
- }
-
-
- /// 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.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class ClickTag {
- private string nameField;
-
- private string urlField;
- /// Name of the click tag, follows the regex "clickTag\\d*"
+ /// The manual override for the SSL compatibility of this creative. This
+ /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string name {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
+ public SslManualOverride sslManualOverride {
get {
- return this.nameField;
+ return this.sslManualOverrideField;
}
set {
- this.nameField = value;
+ this.sslManualOverrideField = value;
+ this.sslManualOverrideSpecified = true;
}
}
- /// URL of the click tag.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public string url {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool sslManualOverrideSpecified {
get {
- return this.urlField;
+ return this.sslManualOverrideFieldSpecified;
}
set {
- this.urlField = value;
+ this.sslManualOverrideFieldSpecified = value;
}
}
}
- /// Image densities.
+ /// The types of VAST ads that a VastRedirectCreative can point to.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum ImageDensity {
- /// 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.
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum VastRedirectType {
+ /// The VAST XML contains only linear ads.
///
- ONE_TO_ONE = 0,
- /// 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.
+ LINEAR = 0,
+ /// The VAST XML contains only nonlinear ads.
///
- THREE_TO_TWO = 1,
- /// 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.
+ NON_LINEAR = 1,
+ /// The VAST XML contains both linear and nonlinear ads.
///
- TWO_TO_ONE = 2,
+ LINEAR_AND_NON_LINEAR = 2,
+ }
+
+
+ /// Enum to store the creative SSL compatibility scan result.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum SslScanResult {
/// The value returned if the actual value is not exposed by the requested API
/// version.
///
- UNKNOWN = 3,
+ UNKNOWN = 0,
+ UNSCANNED = 1,
+ SCANNED_SSL = 2,
+ SCANNED_NON_SSL = 3,
}
- /// 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.
+ /// Enum to store the creative SSL compatibility manual override. Its three states
+ /// are similar to that of SslScanResult.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum SslManualOverride {
+ /// The value returned if the actual value is not exposed by the requested API
+ /// version.
+ ///
+ UNKNOWN = 0,
+ NO_OVERRIDE = 1,
+ SSL_COMPATIBLE = 2,
+ NOT_SSL_COMPATIBLE = 3,
+ }
+
+
+ /// A Creative that isn't supported by this version of the API. This
+ /// object is readonly and when encountered should be reported on the Ad Manager API
+ /// forum.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class CustomCreativeAsset {
- private string macroNameField;
-
- private CreativeAsset assetField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class UnsupportedCreative : Creative {
+ private string unsupportedCreativeTypeField;
- /// 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%%".
+ /// The creative type that is unsupported by this API version.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string macroName {
- get {
- return this.macroNameField;
- }
- set {
- this.macroNameField = value;
- }
- }
-
- /// The asset. This attribute is required. To view the asset, use CreativeAsset#assetUrl.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public CreativeAsset asset {
+ public string unsupportedCreativeType {
get {
- return this.assetField;
+ return this.unsupportedCreativeTypeField;
}
set {
- this.assetField = value;
+ this.unsupportedCreativeTypeField = value;
}
}
}
- /// Metadata for a video asset.
+ /// A Creative that is served by a 3rd-party vendor.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class VideoMetadata {
- private ScalableType scalableTypeField;
-
- private bool scalableTypeFieldSpecified;
-
- private int durationField;
-
- private bool durationFieldSpecified;
-
- private int bitRateField;
-
- private bool bitRateFieldSpecified;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class ThirdPartyCreative : Creative {
+ private string snippetField;
- private int minimumBitRateField;
+ private string expandedSnippetField;
- private bool minimumBitRateFieldSpecified;
+ private SslScanResult sslScanResultField;
- private int maximumBitRateField;
+ private bool sslScanResultFieldSpecified;
- private bool maximumBitRateFieldSpecified;
+ private SslManualOverride sslManualOverrideField;
- private Size sizeField;
+ private bool sslManualOverrideFieldSpecified;
- private MimeType mimeTypeField;
+ private LockedOrientation lockedOrientationField;
- private bool mimeTypeFieldSpecified;
+ private bool lockedOrientationFieldSpecified;
- private VideoDeliveryType deliveryTypeField;
+ private bool isSafeFrameCompatibleField;
- private bool deliveryTypeFieldSpecified;
+ private bool isSafeFrameCompatibleFieldSpecified;
- private string[] codecsField;
+ private string[] thirdPartyImpressionTrackingUrlsField;
- /// The scalable type of the asset. This attribute is required.
+ /// The HTML snippet that this creative delivers. This attribute is required.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public ScalableType scalableType {
+ public string snippet {
get {
- return this.scalableTypeField;
+ return this.snippetField;
}
set {
- this.scalableTypeField = value;
- this.scalableTypeSpecified = true;
+ this.snippetField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool scalableTypeSpecified {
+ /// The HTML snippet that this creative delivers with macros expanded. This
+ /// attribute is read-only and is set by Google.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public string expandedSnippet {
get {
- return this.scalableTypeFieldSpecified;
+ return this.expandedSnippetField;
}
set {
- this.scalableTypeFieldSpecified = value;
+ this.expandedSnippetField = value;
}
}
- /// The duration of the asset in milliseconds. This attribute is required.
+ /// The SSL compatibility scan result for this creative. This attribute is
+ /// read-only and determined by Google.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public int duration {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
+ public SslScanResult sslScanResult {
get {
- return this.durationField;
+ return this.sslScanResultField;
}
set {
- this.durationField = value;
- this.durationSpecified = true;
+ this.sslScanResultField = value;
+ this.sslScanResultSpecified = true;
}
}
- /// true, if a value is specified for , false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool durationSpecified {
+ public bool sslScanResultSpecified {
get {
- return this.durationFieldSpecified;
+ return this.sslScanResultFieldSpecified;
}
set {
- this.durationFieldSpecified = value;
+ this.sslScanResultFieldSpecified = value;
}
}
- /// The bit rate of the asset in kbps. If the asset can play at a range of bit rates
- /// (such as an Http Live Streaming video), then set the bit rate to zero and
- /// populate the minimum and maximum bit rate instead.
+ /// The manual override for the SSL compatibility of this creative. This
+ /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public int bitRate {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
+ public SslManualOverride sslManualOverride {
get {
- return this.bitRateField;
+ return this.sslManualOverrideField;
}
set {
- this.bitRateField = value;
- this.bitRateSpecified = true;
+ this.sslManualOverrideField = value;
+ this.sslManualOverrideSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool bitRateSpecified {
+ public bool sslManualOverrideSpecified {
get {
- return this.bitRateFieldSpecified;
+ return this.sslManualOverrideFieldSpecified;
}
set {
- this.bitRateFieldSpecified = value;
+ this.sslManualOverrideFieldSpecified = value;
}
}
- /// The minimum bitrate of the video in kbps. Only set this if the asset can play at
- /// a range of bit rates.
+ /// A locked orientation for this creative to be displayed in.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public int minimumBitRate {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
+ public LockedOrientation lockedOrientation {
get {
- return this.minimumBitRateField;
+ return this.lockedOrientationField;
}
set {
- this.minimumBitRateField = value;
- this.minimumBitRateSpecified = true;
+ this.lockedOrientationField = value;
+ this.lockedOrientationSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="lockedOrientation" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool minimumBitRateSpecified {
+ public bool lockedOrientationSpecified {
get {
- return this.minimumBitRateFieldSpecified;
+ return this.lockedOrientationFieldSpecified;
}
set {
- this.minimumBitRateFieldSpecified = value;
+ this.lockedOrientationFieldSpecified = value;
}
}
- /// The maximum bitrate of the video in kbps. Only set this if the asset can play at
- /// a range of bit rates.
+ /// Whether the Creative is compatible for SafeFrame
+ /// rendering. This attribute is optional and defaults to true.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
- public int maximumBitRate {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
+ public bool isSafeFrameCompatible {
get {
- return this.maximumBitRateField;
+ return this.isSafeFrameCompatibleField;
}
set {
- this.maximumBitRateField = value;
- this.maximumBitRateSpecified = true;
+ this.isSafeFrameCompatibleField = value;
+ this.isSafeFrameCompatibleSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="isSafeFrameCompatible" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool maximumBitRateSpecified {
+ public bool isSafeFrameCompatibleSpecified {
get {
- return this.maximumBitRateFieldSpecified;
+ return this.isSafeFrameCompatibleFieldSpecified;
}
set {
- this.maximumBitRateFieldSpecified = value;
+ this.isSafeFrameCompatibleFieldSpecified = value;
}
}
- /// The size (width and height) of the asset. This attribute is required.
+ /// A list of impression tracking URLs to ping when this creative is displayed. This
+ /// field is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
- public Size size {
+ [System.Xml.Serialization.XmlElementAttribute("thirdPartyImpressionTrackingUrls", Order = 6)]
+ public string[] thirdPartyImpressionTrackingUrls {
get {
- return this.sizeField;
+ return this.thirdPartyImpressionTrackingUrlsField;
}
set {
- this.sizeField = value;
+ this.thirdPartyImpressionTrackingUrlsField = value;
}
}
+ }
- /// The mime type of the asset. This attribute is required.
+
+ /// Describes the orientation that a creative should be served with.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum LockedOrientation {
+ /// The value returned if the actual value is not exposed by the requested API
+ /// version.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
- public MimeType mimeType {
+ UNKNOWN = 0,
+ FREE_ORIENTATION = 1,
+ PORTRAIT_ONLY = 2,
+ LANDSCAPE_ONLY = 3,
+ }
+
+
+ /// A Creative that is created by the specified creative template.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class TemplateCreative : Creative {
+ private long creativeTemplateIdField;
+
+ private bool creativeTemplateIdFieldSpecified;
+
+ private bool isInterstitialField;
+
+ private bool isInterstitialFieldSpecified;
+
+ private bool isNativeEligibleField;
+
+ private bool isNativeEligibleFieldSpecified;
+
+ private bool isSafeFrameCompatibleField;
+
+ private bool isSafeFrameCompatibleFieldSpecified;
+
+ private string destinationUrlField;
+
+ private BaseCreativeTemplateVariableValue[] creativeTemplateVariableValuesField;
+
+ private SslScanResult sslScanResultField;
+
+ private bool sslScanResultFieldSpecified;
+
+ private SslManualOverride sslManualOverrideField;
+
+ private bool sslManualOverrideFieldSpecified;
+
+ private LockedOrientation lockedOrientationField;
+
+ private bool lockedOrientationFieldSpecified;
+
+ /// Creative template ID that this creative is created from.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public long creativeTemplateId {
get {
- return this.mimeTypeField;
+ return this.creativeTemplateIdField;
}
set {
- this.mimeTypeField = value;
- this.mimeTypeSpecified = true;
+ this.creativeTemplateIdField = value;
+ this.creativeTemplateIdSpecified = true;
}
}
- /// true, if a value is specified for , false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool mimeTypeSpecified {
+ public bool creativeTemplateIdSpecified {
get {
- return this.mimeTypeFieldSpecified;
+ return this.creativeTemplateIdFieldSpecified;
}
set {
- this.mimeTypeFieldSpecified = value;
+ this.creativeTemplateIdFieldSpecified = value;
}
}
- /// The delivery type of the asset. This attribute is required.
+ /// true if this template instantiated creative is interstitial. This
+ /// attribute is read-only and is assigned by Google based on the creative template.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
- public VideoDeliveryType deliveryType {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public bool isInterstitial {
get {
- return this.deliveryTypeField;
+ return this.isInterstitialField;
}
set {
- this.deliveryTypeField = value;
- this.deliveryTypeSpecified = true;
+ this.isInterstitialField = value;
+ this.isInterstitialSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="isInterstitial" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool deliveryTypeSpecified {
+ public bool isInterstitialSpecified {
get {
- return this.deliveryTypeFieldSpecified;
+ return this.isInterstitialFieldSpecified;
}
set {
- this.deliveryTypeFieldSpecified = value;
+ this.isInterstitialFieldSpecified = value;
}
}
- /// The codecs of the asset. This attribute is optional and defaults to an empty
- /// list.
+ /// true if this template instantiated creative is eligible for native
+ /// adserving. This attribute is read-only and is assigned by Google based on the
+ /// creative template.
///
- [System.Xml.Serialization.XmlElementAttribute("codecs", Order = 8)]
- public string[] codecs {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
+ public bool isNativeEligible {
get {
- return this.codecsField;
+ return this.isNativeEligibleField;
}
set {
- this.codecsField = value;
+ this.isNativeEligibleField = value;
+ this.isNativeEligibleSpecified = true;
}
}
- }
-
-
- /// The different ways a video/flash can scale.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum ScalableType {
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
- ///
- UNKNOWN = 0,
- /// The creative should not be scaled.
- ///
- NOT_SCALABLE = 1,
- /// The creative can be scaled and its aspect-ratio must be maintained.
- ///
- RATIO_SCALABLE = 2,
- /// The creative can be scaled and its aspect-ratio can be distorted.
- ///
- STRETCH_SCALABLE = 3,
- }
-
-
- /// Enum of supported mime types
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum MimeType {
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
- ///
- UNKNOWN = 0,
- /// application/x-asp
- ///
- ASP = 1,
- /// audio/aiff
- ///
- AUDIO_AIFF = 2,
- /// audio/basic
- ///
- AUDIO_BASIC = 3,
- /// audio/flac
- ///
- AUDIO_FLAC = 4,
- /// audio/mid
- ///
- AUDIO_MID = 5,
- /// audio/mpeg
- ///
- AUDIO_MP3 = 6,
- /// audio/mp4
- ///
- AUDIO_MP4 = 7,
- /// audio/x-mpegurl
- ///
- AUDIO_MPEG_URL = 8,
- /// audio/x-ms-wma
- ///
- AUDIO_MS_WMA = 9,
- /// audio/ogg
- ///
- AUDIO_OGG = 10,
- /// audio/x-pn-realaudio-plugin
- ///
- AUDIO_REAL_AUDIO_PLUGIN = 11,
- /// audio/x-wav
- ///
- AUDIO_WAV = 12,
- /// application/binary
- ///
- BINARY = 13,
- /// application/dash+xml
- ///
- DASH = 62,
- /// application/x-director
- ///
- DIRECTOR = 14,
- /// application/x-shockwave-flash
- ///
- FLASH = 15,
- /// application/graphicconverter
- ///
- GRAPHIC_CONVERTER = 16,
- /// application/x-javascript
- ///
- JAVASCRIPT = 17,
- /// application/json
- ///
- JSON = 18,
- /// image/x-win-bitmap
- ///
- IMAGE_BITMAP = 19,
- /// image/bmp
- ///
- IMAGE_BMP = 20,
- /// image/gif
- ///
- IMAGE_GIF = 21,
- /// image/jpeg
- ///
- IMAGE_JPEG = 22,
- /// image/photoshop
- ///
- IMAGE_PHOTOSHOP = 23,
- /// image/png
- ///
- IMAGE_PNG = 24,
- /// image/tiff
- ///
- IMAGE_TIFF = 25,
- /// image/vnd.wap.wbmp
- ///
- IMAGE_WBMP = 26,
- /// application/x-mpegURL
- ///
- M3U8 = 27,
- /// application/mac-binhex40
- ///
- MAC_BIN_HEX_40 = 28,
- /// application/vnd.ms-excel
- ///
- MS_EXCEL = 29,
- /// application/ms-powerpoint
- ///
- MS_POWERPOINT = 30,
- /// application/msword
- ///
- MS_WORD = 31,
- /// application/octet-stream
- ///
- OCTET_STREAM = 32,
- /// application/pdf
- ///
- PDF = 33,
- /// application/postscript
- ///
- POSTSCRIPT = 34,
- /// application/vnd.rn-realmedia
- ///
- RN_REAL_MEDIA = 35,
- /// message/rfc822
- ///
- RFC_822 = 36,
- /// application/rtf
- ///
- RTF = 37,
- /// text/calendar
- ///
- TEXT_CALENDAR = 38,
- /// text/css
- ///
- TEXT_CSS = 39,
- /// text/csv
- ///
- TEXT_CSV = 40,
- /// text/html
- ///
- TEXT_HTML = 41,
- /// text/java
- ///
- TEXT_JAVA = 42,
- /// text/plain
- ///
- TEXT_PLAIN = 43,
- /// video/3gpp
- ///
- VIDEO_3GPP = 44,
- /// video/3gpp2
- ///
- VIDEO_3GPP2 = 45,
- /// video/avi
- ///
- VIDEO_AVI = 46,
- /// video/x-flv
- ///
- VIDEO_FLV = 47,
- /// video/mp4
- ///
- VIDEO_MP4 = 48,
- /// video/mp4v-es
- ///
- VIDEO_MP4V_ES = 49,
- /// video/mpeg
- ///
- VIDEO_MPEG = 50,
- /// video/x-ms-asf
- ///
- VIDEO_MS_ASF = 51,
- /// video/x-ms-wm
- ///
- VIDEO_MS_WM = 52,
- /// video/x-ms-wmv
- ///
- VIDEO_MS_WMV = 53,
- /// video/x-ms-wvx
- ///
- VIDEO_MS_WVX = 54,
- /// video/ogg
- ///
- VIDEO_OGG = 55,
- /// video/x-quicktime
- ///
- VIDEO_QUICKTIME = 56,
- /// video/webm
- ///
- VIDEO_WEBM = 57,
- /// application/xaml+xml
- ///
- XAML = 58,
- /// application/xhtml+xml
- ///
- XHTML = 59,
- /// application/xml
- ///
- XML = 60,
- /// application/zip
- ///
- ZIP = 61,
- }
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool isNativeEligibleSpecified {
+ get {
+ return this.isNativeEligibleFieldSpecified;
+ }
+ set {
+ this.isNativeEligibleFieldSpecified = value;
+ }
+ }
- /// The video delivery type.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum VideoDeliveryType {
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
- ///
- UNKNOWN = 0,
- /// Video will be served through a progressive download.
- ///
- PROGRESSIVE = 1,
- /// Video will be served via a streaming protocol like RTMP.
+ /// Whether the Creative is compatible for SafeFrame
+ /// rendering. This attribute is read-only and is assigned by Google based on the
+ /// CreativeTemplate.
///
- STREAMING = 2,
- }
-
-
- /// Base asset properties.
- ///
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(RedirectAsset))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoRedirectAsset))]
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public abstract partial class Asset {
- }
-
+ [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
+ public bool isSafeFrameCompatible {
+ get {
+ return this.isSafeFrameCompatibleField;
+ }
+ set {
+ this.isSafeFrameCompatibleField = value;
+ this.isSafeFrameCompatibleSpecified = true;
+ }
+ }
- /// An externally hosted asset.
- ///
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoRedirectAsset))]
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public abstract partial class RedirectAsset : Asset {
- private string redirectUrlField;
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool isSafeFrameCompatibleSpecified {
+ get {
+ return this.isSafeFrameCompatibleFieldSpecified;
+ }
+ set {
+ this.isSafeFrameCompatibleFieldSpecified = value;
+ }
+ }
- /// The URL where the asset is hosted.
+ /// The URL the user is directed to if they click on the creative. This attribute is
+ /// only required if the template snippet contains the %u or
+ /// %%DEST_URL%% macro. It has a maximum length of 1024 characters.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string redirectUrl {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
+ public string destinationUrl {
get {
- return this.redirectUrlField;
+ return this.destinationUrlField;
}
set {
- this.redirectUrlField = value;
+ this.destinationUrlField = value;
}
}
- }
-
-
- /// An externally-hosted video asset.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class VideoRedirectAsset : RedirectAsset {
- private VideoMetadata metadataField;
- /// Metadata related to the asset. This attribute is required.
+ /// Stores values of CreativeTemplateVariable
+ /// in the CreativeTemplate.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public VideoMetadata metadata {
+ [System.Xml.Serialization.XmlElementAttribute("creativeTemplateVariableValues", Order = 5)]
+ public BaseCreativeTemplateVariableValue[] creativeTemplateVariableValues {
get {
- return this.metadataField;
+ return this.creativeTemplateVariableValuesField;
}
set {
- this.metadataField = value;
+ this.creativeTemplateVariableValuesField = value;
}
}
- }
-
-
- /// This represents an entry in a map with a key of type ConversionEvent and value
- /// of type TrackingUrls.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class ConversionEvent_TrackingUrlsMapEntry {
- private ConversionEvent keyField;
-
- private bool keyFieldSpecified;
- private string[] valueField;
-
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public ConversionEvent key {
+ /// The SSL compatibility scan result for this creative. This attribute is
+ /// read-only and determined by Google.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
+ public SslScanResult sslScanResult {
get {
- return this.keyField;
+ return this.sslScanResultField;
}
set {
- this.keyField = value;
- this.keySpecified = true;
+ this.sslScanResultField = value;
+ this.sslScanResultSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool keySpecified {
+ public bool sslScanResultSpecified {
get {
- return this.keyFieldSpecified;
+ return this.sslScanResultFieldSpecified;
}
set {
- this.keyFieldSpecified = value;
+ this.sslScanResultFieldSpecified = value;
}
}
- [System.Xml.Serialization.XmlArrayAttribute(Order = 1)]
- [System.Xml.Serialization.XmlArrayItemAttribute("urls", IsNullable = false)]
- public string[] value {
+ /// The manual override for the SSL compatibility of this creative. This
+ /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
+ public SslManualOverride sslManualOverride {
get {
- return this.valueField;
+ return this.sslManualOverrideField;
}
set {
- this.valueField = value;
+ this.sslManualOverrideField = value;
+ this.sslManualOverrideSpecified = true;
}
}
- }
-
- /// All possible tracking event types. Not all events are supported by every kind of
- /// creative.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum ConversionEvent {
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
- ///
- UNKNOWN = 0,
- /// Corresponds to the creativeView tracking event.
- ///
- CREATIVE_VIEW = 1,
- /// Corresponds to the start tracking event.
- ///
- START = 2,
- /// 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.
- ///
- SKIP_SHOWN = 3,
- /// Corresponds to the firstQuartile tracking event.
- ///
- FIRST_QUARTILE = 4,
- /// Corresponds to the midpoint tracking event.
- ///
- MIDPOINT = 5,
- /// Corresponds to the thirdQuartile tracking event.
- ///
- THIRD_QUARTILE = 6,
- /// 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.
- ///
- ENGAGED_VIEW = 7,
- /// Corresponds to the complete tracking event.
- ///
- COMPLETE = 8,
- /// Corresponds to the mute tracking event.
- ///
- MUTE = 9,
- /// Corresponds to the unmute tracking event.
- ///
- UNMUTE = 10,
- /// Corresponds to the pause tracking event.
- ///
- PAUSE = 11,
- /// Corresponds to the rewind tracking event.
- ///
- REWIND = 12,
- /// Corresponds to the resume tracking event.
- ///
- RESUME = 13,
- /// 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.
- ///
- SKIPPED = 14,
- /// Corresponds to the fullscreen tracking event.
- ///
- FULLSCREEN = 15,
- /// Corresponds to the expand tracking event.
- ///
- EXPAND = 16,
- /// Corresponds to the collapse tracking event.
- ///
- COLLAPSE = 17,
- /// Corresponds to the acceptInvitation tracking event.
- ///
- ACCEPT_INVITATION = 18,
- /// Corresponds to the close tracking event.
- ///
- CLOSE = 19,
- /// Corresponds to the Linear.VideoClicks.ClickTracking node.
- ///
- CLICK_TRACKING = 20,
- /// Corresponds to the InLine.Survey node.
- ///
- SURVEY = 21,
- /// Corresponds to the Linear.VideoClicks.CustomClick node.
- ///
- CUSTOM_CLICK = 22,
- /// Corresponds to the measurableImpression tracking event.
- ///
- MEASURABLE_IMPRESSION = 23,
- /// Corresponds to the viewableImpression tracking event.
- ///
- VIEWABLE_IMPRESSION = 24,
- /// Corresponds to the abandon tracking event.
- ///
- VIDEO_ABANDON = 25,
- /// Corresponds to the true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool sslManualOverrideSpecified {
get {
- return this.assetField;
+ return this.sslManualOverrideFieldSpecified;
}
set {
- this.assetField = value;
+ this.sslManualOverrideFieldSpecified = value;
}
}
- /// A list of HTML5 features required to play this Swiffy
- /// fallback asset correctly.
+ /// A locked orientation for this creative to be displayed in.
///
- [System.Xml.Serialization.XmlElementAttribute("html5Features", Order = 1)]
- public Html5Feature[] html5Features {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 8)]
+ public LockedOrientation lockedOrientation {
get {
- return this.html5FeaturesField;
+ return this.lockedOrientationField;
}
set {
- this.html5FeaturesField = value;
+ this.lockedOrientationField = value;
+ this.lockedOrientationSpecified = true;
}
}
- /// A list of localized messages that give detailed information about the Swiffy
- /// conversion. Does not contain error or warning messages.
- ///
- [System.Xml.Serialization.XmlElementAttribute("localizedInfoMessages", Order = 2)]
- public string[] localizedInfoMessages {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool lockedOrientationSpecified {
get {
- return this.localizedInfoMessagesField;
+ return this.lockedOrientationFieldSpecified;
}
set {
- this.localizedInfoMessagesField = value;
+ this.lockedOrientationFieldSpecified = value;
}
}
}
- /// An HTML5 features required by HTML5 assets.
+ /// 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.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum Html5Feature {
- /// Requires a basic SVG animation.
- ///
- BASIC_SVG = 0,
- /// Requires support for SVG filter based animation.
- ///
- SVG_FILTERS = 1,
- /// The feature is not known or defined in newer versions.
- ///
- UNKNOWN = 2,
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class ProgrammaticCreative : Creative {
}
- /// Represents a child asset in RichMediaStudioCreative.
+ /// A Creative that isn't supported by Google DFP, but was migrated
+ /// from DART. Creatives of this type cannot be created or modified.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class RichMediaStudioChildAssetProperty {
- private string nameField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class LegacyDfpCreative : Creative {
+ }
- private RichMediaStudioChildAssetPropertyType typeField;
- private bool typeFieldSpecified;
+ /// A Creative hosted by Campaign Manager. Similar to third-party
+ /// creatives, a Campaign Manager tag is used to retrieve a creative asset. However,
+ /// Campaign Manager tags are not sent to the user's browser. Instead, they are
+ /// processed internally within the Google Marketing Platform system..
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class InternalRedirectCreative : Creative {
+ private LockedOrientation lockedOrientationField;
- private long totalFileSizeField;
+ private bool lockedOrientationFieldSpecified;
- private bool totalFileSizeFieldSpecified;
+ private Size assetSizeField;
- private int widthField;
+ private string internalRedirectUrlField;
- private bool widthFieldSpecified;
+ private bool overrideSizeField;
- private int heightField;
+ private bool overrideSizeFieldSpecified;
- private bool heightFieldSpecified;
+ private bool isInterstitialField;
- private string urlField;
+ private bool isInterstitialFieldSpecified;
- /// The name of the asset as known by Rich Media Studio. This attribute is readonly.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string name {
- get {
- return this.nameField;
- }
- set {
- this.nameField = value;
- }
- }
+ private SslScanResult sslScanResultField;
- /// Required file type of the asset. This attribute is readonly.
+ private bool sslScanResultFieldSpecified;
+
+ private SslManualOverride sslManualOverrideField;
+
+ private bool sslManualOverrideFieldSpecified;
+
+ private string[] thirdPartyImpressionTrackingUrlsField;
+
+ /// A locked orientation for this creative to be displayed in.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public RichMediaStudioChildAssetPropertyType type {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public LockedOrientation lockedOrientation {
get {
- return this.typeField;
+ return this.lockedOrientationField;
}
set {
- this.typeField = value;
- this.typeSpecified = true;
+ this.lockedOrientationField = value;
+ this.lockedOrientationSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool typeSpecified {
+ public bool lockedOrientationSpecified {
get {
- return this.typeFieldSpecified;
+ return this.lockedOrientationFieldSpecified;
}
set {
- this.typeFieldSpecified = value;
+ this.lockedOrientationFieldSpecified = value;
}
}
- /// The total size of the asset in bytes. This attribute is readonly.
+ /// The asset size of an internal redirect creative. Note that this may differ from
+ /// size if users set overrideSize to true. This attribute
+ /// is read-only and is populated by Google.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public long totalFileSize {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public Size assetSize {
get {
- return this.totalFileSizeField;
+ return this.assetSizeField;
}
set {
- this.totalFileSizeField = value;
- this.totalFileSizeSpecified = true;
+ this.assetSizeField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool totalFileSizeSpecified {
+ /// The internal redirect URL of the DFA or DART for Publishers hosted creative.
+ /// This attribute is required and has a maximum length of 1024 characters.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
+ public string internalRedirectUrl {
get {
- return this.totalFileSizeFieldSpecified;
+ return this.internalRedirectUrlField;
}
set {
- this.totalFileSizeFieldSpecified = value;
+ this.internalRedirectUrlField = value;
}
}
- /// Width of the widget in pixels. This attribute is readonly.
+ /// Allows the creative size to differ from the actual size specified in the
+ /// internal redirect's url. This attribute is optional.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public int width {
+ public bool overrideSize {
get {
- return this.widthField;
+ return this.overrideSizeField;
}
set {
- this.widthField = value;
- this.widthSpecified = true;
+ this.overrideSizeField = value;
+ this.overrideSizeSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool widthSpecified {
+ public bool overrideSizeSpecified {
get {
- return this.widthFieldSpecified;
+ return this.overrideSizeFieldSpecified;
}
set {
- this.widthFieldSpecified = value;
+ this.overrideSizeFieldSpecified = value;
}
}
- /// Height of the widget in pixels. This attribute is readonly.
+ /// true if this internal redirect creative is interstitial.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 4)]
- public int height {
+ public bool isInterstitial {
get {
- return this.heightField;
+ return this.isInterstitialField;
}
set {
- this.heightField = value;
- this.heightSpecified = true;
+ this.isInterstitialField = value;
+ this.isInterstitialSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool heightSpecified {
+ public bool isInterstitialSpecified {
get {
- return this.heightFieldSpecified;
+ return this.isInterstitialFieldSpecified;
}
set {
- this.heightFieldSpecified = value;
+ this.isInterstitialFieldSpecified = value;
}
}
- /// The URL of the asset. This attribute is readonly.
+ /// The SSL compatibility scan result for this creative. This attribute is
+ /// read-only and determined by Google.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 5)]
- public string url {
- get {
- return this.urlField;
- }
- set {
- this.urlField = value;
- }
- }
- }
-
-
- /// Type of RichMediaStudioChildAssetProperty
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(TypeName = "RichMediaStudioChildAssetProperty.Type", Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum RichMediaStudioChildAssetPropertyType {
- /// SWF files
- ///
- FLASH = 0,
- /// FLVS and any other video file types
- ///
- VIDEO = 1,
- /// Image files
- ///
- IMAGE = 2,
- /// The rest of the supported file types .txt, .xml, etc.
- ///
- DATA = 3,
- }
-
-
- /// The value of a CustomField for a particular entity.
- ///
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(DropDownCustomFieldValue))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(CustomFieldValue))]
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public abstract partial class BaseCustomFieldValue {
- private long customFieldIdField;
-
- private bool customFieldIdFieldSpecified;
-
- /// Id of the CustomField to which this value belongs. This attribute
- /// is required.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public long customFieldId {
+ public SslScanResult sslScanResult {
get {
- return this.customFieldIdField;
+ return this.sslScanResultField;
}
set {
- this.customFieldIdField = value;
- this.customFieldIdSpecified = true;
+ this.sslScanResultField = value;
+ this.sslScanResultSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="sslScanResult" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool customFieldIdSpecified {
+ public bool sslScanResultSpecified {
get {
- return this.customFieldIdFieldSpecified;
+ return this.sslScanResultFieldSpecified;
}
set {
- this.customFieldIdFieldSpecified = value;
+ this.sslScanResultFieldSpecified = value;
}
}
- }
-
-
- /// A CustomFieldValue for a CustomField that has a CustomField#dataType of CustomFieldDataType#DROP_DOWN
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class DropDownCustomFieldValue : BaseCustomFieldValue {
- private long customFieldOptionIdField;
-
- private bool customFieldOptionIdFieldSpecified;
- /// The ID of the CustomFieldOption for this value.
+ /// The manual override for the SSL compatibility of this creative. This
+ /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public long customFieldOptionId {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
+ public SslManualOverride sslManualOverride {
get {
- return this.customFieldOptionIdField;
+ return this.sslManualOverrideField;
}
set {
- this.customFieldOptionIdField = value;
- this.customFieldOptionIdSpecified = true;
+ this.sslManualOverrideField = value;
+ this.sslManualOverrideSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="sslManualOverride" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool customFieldOptionIdSpecified {
+ public bool sslManualOverrideSpecified {
get {
- return this.customFieldOptionIdFieldSpecified;
+ return this.sslManualOverrideFieldSpecified;
}
set {
- this.customFieldOptionIdFieldSpecified = value;
+ this.sslManualOverrideFieldSpecified = value;
}
}
- }
-
-
- /// The value of a CustomField that does not have a CustomField#dataType of CustomFieldDataType#DROP_DOWN.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class CustomFieldValue : BaseCustomFieldValue {
- private Value valueField;
- /// The value for this field. The appropriate type of Value is
- /// determined by the CustomField#dataType of the
- /// labelId as
- /// the inherited label's ID and isNegated set to true.
+ /// A Creative that contains a zipped HTML5 bundle asset, a list of
+ /// third party impression trackers, and a third party click tracker.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class AppliedLabel {
- private long labelIdField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class Html5Creative : Creative {
+ private bool overrideSizeField;
- private bool labelIdFieldSpecified;
+ private bool overrideSizeFieldSpecified;
- private bool isNegatedField;
+ private string[] thirdPartyImpressionTrackingUrlsField;
- private bool isNegatedFieldSpecified;
+ private string thirdPartyClickTrackingUrlField;
- /// The ID of a created Label.
+ private LockedOrientation lockedOrientationField;
+
+ private bool lockedOrientationFieldSpecified;
+
+ private SslScanResult sslScanResultField;
+
+ private bool sslScanResultFieldSpecified;
+
+ private SslManualOverride sslManualOverrideField;
+
+ private bool sslManualOverrideFieldSpecified;
+
+ private bool isSafeFrameCompatibleField;
+
+ private bool isSafeFrameCompatibleFieldSpecified;
+
+ private CreativeAsset html5AssetField;
+
+ /// Allows the creative size to differ from the actual HTML5 asset size. This
+ /// attribute is optional.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public long labelId {
+ public bool overrideSize {
get {
- return this.labelIdField;
+ return this.overrideSizeField;
}
set {
- this.labelIdField = value;
- this.labelIdSpecified = true;
+ this.overrideSizeField = value;
+ this.overrideSizeSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool labelIdSpecified {
+ public bool overrideSizeSpecified {
get {
- return this.labelIdFieldSpecified;
+ return this.overrideSizeFieldSpecified;
}
set {
- this.labelIdFieldSpecified = value;
+ this.overrideSizeFieldSpecified = value;
}
}
- /// isNegated should be set to true to negate the effects
- /// of labelId.
+ /// Impression tracking URLs to ping when this creative is displayed. This field is
+ /// optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public bool isNegated {
+ [System.Xml.Serialization.XmlElementAttribute("thirdPartyImpressionTrackingUrls", Order = 1)]
+ public string[] thirdPartyImpressionTrackingUrls {
get {
- return this.isNegatedField;
+ return this.thirdPartyImpressionTrackingUrlsField;
}
set {
- this.isNegatedField = value;
- this.isNegatedSpecified = true;
+ this.thirdPartyImpressionTrackingUrlsField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool isNegatedSpecified {
+ /// A click tracking URL to ping when this creative is clicked. This field is
+ /// optional.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
+ public string thirdPartyClickTrackingUrl {
get {
- return this.isNegatedFieldSpecified;
+ return this.thirdPartyClickTrackingUrlField;
}
set {
- this.isNegatedFieldSpecified = value;
+ this.thirdPartyClickTrackingUrlField = value;
}
}
- }
-
- /// A Creative represents the media for the ad being served. Read
- /// more about creatives on the Ad Manager Help
- /// Center.
- ///
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VastRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(UnsupportedCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ThirdPartyCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(TemplateCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ProgrammaticCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(LegacyDfpCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(InternalRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(Html5Creative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(HasDestinationUrlCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(CustomCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseVideoCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(SetTopBoxCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseImageRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseImageCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseFlashRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashRedirectOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseFlashCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(AspectRatioImageCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ClickTrackingCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseRichMediaStudioCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(RichMediaStudioCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseDynamicAllocationCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(HasHtmlSnippetDynamicAllocationCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(AdSenseCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(AdExchangeCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(AdMobBackfillCreative))]
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public abstract partial class Creative {
- private long advertiserIdField;
-
- private bool advertiserIdFieldSpecified;
-
- private long idField;
-
- private bool idFieldSpecified;
-
- private string nameField;
-
- private Size sizeField;
-
- private string previewUrlField;
-
- private CreativePolicyViolation[] policyViolationsField;
-
- private AppliedLabel[] appliedLabelsField;
-
- private DateTime lastModifiedDateTimeField;
-
- private BaseCustomFieldValue[] customFieldValuesField;
-
- /// The ID of the advertiser that owns the creative. This attribute is required.
+ /// A locked orientation for this creative to be displayed in.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public long advertiserId {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
+ public LockedOrientation lockedOrientation {
get {
- return this.advertiserIdField;
+ return this.lockedOrientationField;
}
set {
- this.advertiserIdField = value;
- this.advertiserIdSpecified = true;
+ this.lockedOrientationField = value;
+ this.lockedOrientationSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="lockedOrientation" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool advertiserIdSpecified {
+ public bool lockedOrientationSpecified {
get {
- return this.advertiserIdFieldSpecified;
+ return this.lockedOrientationFieldSpecified;
}
set {
- this.advertiserIdFieldSpecified = value;
+ this.lockedOrientationFieldSpecified = value;
}
}
- /// 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.
+ /// The SSL compatibility scan result of this creative. This attribute is
+ /// read-only and determined by Google.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public long id {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
+ public SslScanResult sslScanResult {
get {
- return this.idField;
+ return this.sslScanResultField;
}
set {
- this.idField = value;
- this.idSpecified = true;
+ this.sslScanResultField = value;
+ this.sslScanResultSpecified = true;
}
}
- /// true, if a value is specified for ,
- /// false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool idSpecified {
+ public bool sslScanResultSpecified {
get {
- return this.idFieldSpecified;
+ return this.sslScanResultFieldSpecified;
}
set {
- this.idFieldSpecified = value;
+ this.sslScanResultFieldSpecified = value;
}
}
- /// The name of the creative. This attribute is required and has a maximum length of
- /// 255 characters.
+ /// The manual override for the SSL compatibility of this creative. This
+ /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public string name {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
+ public SslManualOverride sslManualOverride {
get {
- return this.nameField;
+ return this.sslManualOverrideField;
}
set {
- this.nameField = value;
+ this.sslManualOverrideField = value;
+ this.sslManualOverrideSpecified = true;
}
}
- /// The Size of the creative. This attribute is required for
- /// creation and then is read-only.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public Size size {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool sslManualOverrideSpecified {
get {
- return this.sizeField;
+ return this.sslManualOverrideFieldSpecified;
}
set {
- this.sizeField = value;
+ this.sslManualOverrideFieldSpecified = value;
}
}
- /// The URL of the creative for previewing the media. This attribute is read-only
- /// and is assigned by Google when a creative is created.
+ /// Whether the Creative is compatible for SafeFrame
+ /// rendering. This attribute is optional and defaults to true.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
- public string previewUrl {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
+ public bool isSafeFrameCompatible {
get {
- return this.previewUrlField;
+ return this.isSafeFrameCompatibleField;
}
set {
- this.previewUrlField = value;
+ this.isSafeFrameCompatibleField = value;
+ this.isSafeFrameCompatibleSpecified = true;
}
}
- /// Set of policy violations detected for this creative. This attribute is
- /// read-only.
- ///
- [System.Xml.Serialization.XmlElementAttribute("policyViolations", Order = 5)]
- public CreativePolicyViolation[] policyViolations {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool isSafeFrameCompatibleSpecified {
get {
- return this.policyViolationsField;
+ return this.isSafeFrameCompatibleFieldSpecified;
}
set {
- this.policyViolationsField = value;
+ this.isSafeFrameCompatibleFieldSpecified = value;
}
}
- /// The set of labels applied to this creative.
+ /// The HTML5 asset. To preview the HTML5 asset, use the CreativeAsset#assetUrl. In this field, the CreativeAsset#assetByteArray must be a
+ /// zip bundle and the CreativeAsset#fileName
+ /// must have a zip extension. This attribute is required.
///
- [System.Xml.Serialization.XmlElementAttribute("appliedLabels", Order = 6)]
- public AppliedLabel[] appliedLabels {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
+ public CreativeAsset html5Asset {
get {
- return this.appliedLabelsField;
+ return this.html5AssetField;
}
set {
- this.appliedLabelsField = value;
+ this.html5AssetField = value;
}
}
+ }
- /// The date and time this creative was last modified.
+
+ /// A Creative that has a destination url
+ ///
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(CustomCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseVideoCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoRedirectCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(SetTopBoxCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseImageRedirectCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectOverlayCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseImageCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageOverlayCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(AspectRatioImageCreative))]
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public abstract partial class HasDestinationUrlCreative : Creative {
+ private string destinationUrlField;
+
+ private DestinationUrlType destinationUrlTypeField;
+
+ private bool destinationUrlTypeFieldSpecified;
+
+ /// 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.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
- public DateTime lastModifiedDateTime {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public string destinationUrl {
get {
- return this.lastModifiedDateTimeField;
+ return this.destinationUrlField;
}
set {
- this.lastModifiedDateTimeField = value;
+ this.destinationUrlField = value;
}
}
- /// The values of the custom fields associated with this creative.
+ /// The action that should be performed if the user clicks on the creative. This
+ /// attribute is optional and defaults to DestinationUrlType#CLICK_TO_WEB.
///
- [System.Xml.Serialization.XmlElementAttribute("customFieldValues", Order = 8)]
- public BaseCustomFieldValue[] customFieldValues {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public DestinationUrlType destinationUrlType {
get {
- return this.customFieldValuesField;
+ return this.destinationUrlTypeField;
}
set {
- this.customFieldValuesField = value;
+ this.destinationUrlTypeField = value;
+ this.destinationUrlTypeSpecified = true;
+ }
+ }
+
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool destinationUrlTypeSpecified {
+ get {
+ return this.destinationUrlTypeFieldSpecified;
+ }
+ set {
+ this.destinationUrlTypeFieldSpecified = value;
}
}
}
- /// Represents the different types of policy violations that may be detected on a
- /// given creative. For more information about the various types of policy
- /// violations, see here.
+ /// The valid actions that a destination URL may perform if the user clicks on the
+ /// ad.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum CreativePolicyViolation {
- /// Malware was found in the creative. For more information see here.
- ///
- MALWARE_IN_CREATIVE = 0,
- /// Malware was found in the landing page. For more information see here.
- ///
- MALWARE_IN_LANDING_PAGE = 1,
- /// The redirect url contains legally objectionable content.
- ///
- LEGALLY_BLOCKED_REDIRECT_URL = 2,
- /// The creative misrepresents the product or service being advertised. For more
- /// information see
- /// here.
- ///
- MISREPRESENTATION_OF_PRODUCT = 3,
- /// The creative has been determined to be self clicking.
- ///
- SELF_CLICKING_CREATIVE = 4,
- /// The creative has been determined as attempting to game the Google network.
- /// For more information see
- /// here.
- ///
- GAMING_GOOGLE_NETWORK = 5,
- /// The landing page for the creative uses a dynamic DNS. For more information
- /// see here.
- ///
- DYNAMIC_DNS = 6,
- /// Phishing found in creative or landing page. For more information see here.
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum DestinationUrlType {
+ /// The value returned if the actual value is not exposed by the requested API
+ /// version.
///
- PHISHING = 7,
- /// The creative prompts the user to download a file. For more information see here
+ UNKNOWN = 0,
+ /// Navigate to a web page. (a.k.a. "Click-through URL").
///
- DOWNLOAD_PROMPT_IN_CREATIVE = 9,
- /// The creative sets an unauthorized cookie on a Google domain. For more
- /// information see here
+ CLICK_TO_WEB = 1,
+ /// Start an application.
///
- UNAUTHORIZED_COOKIE_DETECTED = 10,
- /// The creative has been temporarily paused while we investigate.
+ CLICK_TO_APP = 2,
+ /// Make a phone call.
///
- TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION = 11,
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
+ CLICK_TO_CALL = 3,
+ /// Destination URL not present. Useful for video creatives where a landing page or
+ /// a product isn't necessarily applicable.
///
- UNKNOWN = 8,
+ NONE = 4,
}
- /// A Creative that points to an externally hosted VAST ad and is
- /// served via VAST XML as a VAST Wrapper.
+ /// A Creative that contains an arbitrary HTML snippet and file assets.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class VastRedirectCreative : Creative {
- private string vastXmlUrlField;
-
- private VastRedirectType vastRedirectTypeField;
-
- private bool vastRedirectTypeFieldSpecified;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class CustomCreative : HasDestinationUrlCreative {
+ private string htmlSnippetField;
- private int durationField;
+ private CustomCreativeAsset[] customCreativeAssetsField;
- private bool durationFieldSpecified;
+ private bool isInterstitialField;
- private long[] companionCreativeIdsField;
+ private bool isInterstitialFieldSpecified;
- private ConversionEvent_TrackingUrlsMapEntry[] trackingUrlsField;
+ private LockedOrientation lockedOrientationField;
- private string vastPreviewUrlField;
+ private bool lockedOrientationFieldSpecified;
private SslScanResult sslScanResultField;
@@ -7127,113 +6913,95 @@ public partial class VastRedirectCreative : Creative {
private bool sslManualOverrideFieldSpecified;
- /// The URL where the 3rd party VAST XML is hosted. This attribute is required.
+ private bool isSafeFrameCompatibleField;
+
+ private bool isSafeFrameCompatibleFieldSpecified;
+
+ private string[] thirdPartyImpressionTrackingUrlsField;
+
+ /// The HTML snippet that this creative delivers. This attribute is required.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string vastXmlUrl {
+ public string htmlSnippet {
get {
- return this.vastXmlUrlField;
+ return this.htmlSnippetField;
}
set {
- this.vastXmlUrlField = value;
+ this.htmlSnippetField = value;
}
}
- /// The type of VAST ad that this redirects to. This attribute is required.
+ /// A list of file assets that are associated with this creative, and can be
+ /// referenced in the snippet.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public VastRedirectType vastRedirectType {
- get {
- return this.vastRedirectTypeField;
- }
- set {
- this.vastRedirectTypeField = value;
- this.vastRedirectTypeSpecified = true;
- }
- }
-
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool vastRedirectTypeSpecified {
+ [System.Xml.Serialization.XmlElementAttribute("customCreativeAssets", Order = 1)]
+ public CustomCreativeAsset[] customCreativeAssets {
get {
- return this.vastRedirectTypeFieldSpecified;
+ return this.customCreativeAssetsField;
}
set {
- this.vastRedirectTypeFieldSpecified = value;
+ this.customCreativeAssetsField = value;
}
}
- /// The duration of the VAST ad in milliseconds. This attribute is required.
+ /// true if this custom creative is interstitial. An interstitial
+ /// creative will not consider an impression served until it is fully rendered in
+ /// the browser.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public int duration {
+ public bool isInterstitial {
get {
- return this.durationField;
+ return this.isInterstitialField;
}
set {
- this.durationField = value;
- this.durationSpecified = true;
+ this.isInterstitialField = value;
+ this.isInterstitialSpecified = true;
}
}
- /// true, if a value is specified for , false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool durationSpecified {
- get {
- return this.durationFieldSpecified;
- }
- set {
- this.durationFieldSpecified = value;
- }
- }
-
- /// The IDs of the companion creatives that are associated with this creative. This
- /// attribute is optional.
- ///
- [System.Xml.Serialization.XmlElementAttribute("companionCreativeIds", Order = 3)]
- public long[] companionCreativeIds {
+ public bool isInterstitialSpecified {
get {
- return this.companionCreativeIdsField;
+ return this.isInterstitialFieldSpecified;
}
set {
- this.companionCreativeIdsField = value;
+ this.isInterstitialFieldSpecified = value;
}
}
- /// A map from ConversionEvent to a list of URLs that will be pinged
- /// when the event happens. This attribute is optional.
+ /// A locked orientation for this creative to be displayed in.
///
- [System.Xml.Serialization.XmlElementAttribute("trackingUrls", Order = 4)]
- public ConversionEvent_TrackingUrlsMapEntry[] trackingUrls {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
+ public LockedOrientation lockedOrientation {
get {
- return this.trackingUrlsField;
+ return this.lockedOrientationField;
}
set {
- this.trackingUrlsField = value;
+ this.lockedOrientationField = value;
+ this.lockedOrientationSpecified = true;
}
}
- /// An ad tag URL that will return a preview of the VAST XML response specific to
- /// this creative. This attribute is read-only.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
- public string vastPreviewUrl {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool lockedOrientationSpecified {
get {
- return this.vastPreviewUrlField;
+ return this.lockedOrientationFieldSpecified;
}
set {
- this.vastPreviewUrlField = value;
+ this.lockedOrientationFieldSpecified = value;
}
}
- /// The SSL compatibility scan result for this creative. This attribute is
+ /// The SSL compatibility scan result of this creative. This attribute is
/// read-only and determined by Google.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
+ [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
public SslScanResult sslScanResult {
get {
return this.sslScanResultField;
@@ -7261,7 +7029,7 @@ public bool sslScanResultSpecified {
/// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
+ [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
public SslManualOverride sslManualOverride {
get {
return this.sslManualOverrideField;
@@ -7284,635 +7052,734 @@ public bool sslManualOverrideSpecified {
this.sslManualOverrideFieldSpecified = value;
}
}
- }
-
-
- /// The types of VAST ads that a VastRedirectCreative can point to.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum VastRedirectType {
- /// The VAST XML contains only linear ads.
- ///
- LINEAR = 0,
- /// The VAST XML contains only nonlinear ads.
- ///
- NON_LINEAR = 1,
- /// The VAST XML contains both linear and nonlinear ads.
- ///
- LINEAR_AND_NON_LINEAR = 2,
- }
-
- /// Enum to store the creative SSL compatibility scan result.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum SslScanResult {
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
+ /// Whether the Creative is compatible for SafeFrame
+ /// rendering. This attribute is optional and defaults to true.
///
- UNKNOWN = 0,
- UNSCANNED = 1,
- SCANNED_SSL = 2,
- SCANNED_NON_SSL = 3,
- }
+ [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
+ public bool isSafeFrameCompatible {
+ get {
+ return this.isSafeFrameCompatibleField;
+ }
+ set {
+ this.isSafeFrameCompatibleField = value;
+ this.isSafeFrameCompatibleSpecified = true;
+ }
+ }
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool isSafeFrameCompatibleSpecified {
+ get {
+ return this.isSafeFrameCompatibleFieldSpecified;
+ }
+ set {
+ this.isSafeFrameCompatibleFieldSpecified = value;
+ }
+ }
- /// Enum to store the creative SSL compatibility manual override. Its three states
- /// are similar to that of SslScanResult.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum SslManualOverride {
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
+ /// A list of impression tracking URLs to ping when this creative is displayed. This
+ /// field is optional.
///
- UNKNOWN = 0,
- NO_OVERRIDE = 1,
- SSL_COMPATIBLE = 2,
- NOT_SSL_COMPATIBLE = 3,
+ [System.Xml.Serialization.XmlElementAttribute("thirdPartyImpressionTrackingUrls", Order = 7)]
+ public string[] thirdPartyImpressionTrackingUrls {
+ get {
+ return this.thirdPartyImpressionTrackingUrlsField;
+ }
+ set {
+ this.thirdPartyImpressionTrackingUrlsField = value;
+ }
+ }
}
- /// A Creative that isn't supported by this version of the API. This
- /// object is readonly and when encountered should be reported on the Ad Manager API
- /// forum.
+ /// A base type for video creatives.
///
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoRedirectCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(SetTopBoxCreative))]
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class UnsupportedCreative : Creative {
- private string unsupportedCreativeTypeField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public abstract partial class BaseVideoCreative : HasDestinationUrlCreative {
+ private int durationField;
- /// The creative type that is unsupported by this API version.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string unsupportedCreativeType {
- get {
- return this.unsupportedCreativeTypeField;
- }
- set {
- this.unsupportedCreativeTypeField = value;
- }
- }
- }
+ private bool durationFieldSpecified;
+ private bool allowDurationOverrideField;
- /// A Creative that is served by a 3rd-party vendor.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class ThirdPartyCreative : Creative {
- private string snippetField;
+ private bool allowDurationOverrideFieldSpecified;
- private string expandedSnippetField;
+ private ConversionEvent_TrackingUrlsMapEntry[] trackingUrlsField;
- private SslScanResult sslScanResultField;
+ private long[] companionCreativeIdsField;
- private bool sslScanResultFieldSpecified;
+ private string customParametersField;
- private SslManualOverride sslManualOverrideField;
+ private SkippableAdType skippableAdTypeField;
- private bool sslManualOverrideFieldSpecified;
+ private bool skippableAdTypeFieldSpecified;
- private LockedOrientation lockedOrientationField;
+ private string vastPreviewUrlField;
- private bool lockedOrientationFieldSpecified;
+ private SslScanResult sslScanResultField;
- private bool isSafeFrameCompatibleField;
+ private bool sslScanResultFieldSpecified;
- private bool isSafeFrameCompatibleFieldSpecified;
+ private SslManualOverride sslManualOverrideField;
- private string[] thirdPartyImpressionTrackingUrlsField;
+ private bool sslManualOverrideFieldSpecified;
- /// The HTML snippet that this creative delivers. This attribute is required.
+ /// The expected duration of this creative in milliseconds.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string snippet {
+ public int duration {
get {
- return this.snippetField;
+ return this.durationField;
}
set {
- this.snippetField = value;
+ this.durationField = value;
+ this.durationSpecified = true;
}
}
- /// The HTML snippet that this creative delivers with macros expanded. This
- /// attribute is read-only and is set by Google.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public string expandedSnippet {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool durationSpecified {
get {
- return this.expandedSnippetField;
+ return this.durationFieldSpecified;
}
set {
- this.expandedSnippetField = value;
+ this.durationFieldSpecified = value;
}
}
- /// The SSL compatibility scan result for this creative. This attribute is
- /// read-only and determined by Google.
+ /// Allows the creative duration to differ from the actual asset durations. This
+ /// attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public SslScanResult sslScanResult {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public bool allowDurationOverride {
get {
- return this.sslScanResultField;
+ return this.allowDurationOverrideField;
}
set {
- this.sslScanResultField = value;
- this.sslScanResultSpecified = true;
+ this.allowDurationOverrideField = value;
+ this.allowDurationOverrideSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="allowDurationOverride" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslScanResultSpecified {
+ public bool allowDurationOverrideSpecified {
get {
- return this.sslScanResultFieldSpecified;
+ return this.allowDurationOverrideFieldSpecified;
}
set {
- this.sslScanResultFieldSpecified = value;
+ this.allowDurationOverrideFieldSpecified = value;
}
}
- /// The manual override for the SSL compatibility of this creative. This
- /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
+ /// A map from ConversionEvent to a list of URLs that will be pinged
+ /// when the event happens. This attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public SslManualOverride sslManualOverride {
+ [System.Xml.Serialization.XmlElementAttribute("trackingUrls", Order = 2)]
+ public ConversionEvent_TrackingUrlsMapEntry[] trackingUrls {
get {
- return this.sslManualOverrideField;
+ return this.trackingUrlsField;
}
set {
- this.sslManualOverrideField = value;
- this.sslManualOverrideSpecified = true;
+ this.trackingUrlsField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslManualOverrideSpecified {
+ /// The IDs of the companion creatives that are associated with this creative. This
+ /// attribute is optional.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute("companionCreativeIds", Order = 3)]
+ public long[] companionCreativeIds {
get {
- return this.sslManualOverrideFieldSpecified;
+ return this.companionCreativeIdsField;
}
set {
- this.sslManualOverrideFieldSpecified = value;
+ this.companionCreativeIdsField = value;
}
}
- /// A locked orientation for this creative to be displayed in.
+ /// A comma separated key=value list of parameters that will be supplied to the
+ /// creative, written into the VAST true, if a value is specified for , false otherwise.
+ /// cref="skippableAdType" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool lockedOrientationSpecified {
+ public bool skippableAdTypeSpecified {
get {
- return this.lockedOrientationFieldSpecified;
+ return this.skippableAdTypeFieldSpecified;
}
set {
- this.lockedOrientationFieldSpecified = value;
+ this.skippableAdTypeFieldSpecified = value;
}
}
- /// Whether the Creative is compatible for SafeFrame
- /// rendering. This attribute is optional and defaults to true.
+ /// An ad tag URL that will return a preview of the VAST XML response specific to
+ /// this creative. This attribute is read-only.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
- public bool isSafeFrameCompatible {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
+ public string vastPreviewUrl {
get {
- return this.isSafeFrameCompatibleField;
+ return this.vastPreviewUrlField;
}
set {
- this.isSafeFrameCompatibleField = value;
- this.isSafeFrameCompatibleSpecified = true;
+ this.vastPreviewUrlField = value;
+ }
+ }
+
+ /// The SSL compatibility scan result of this creative. This attribute is
+ /// read-only and determined by Google.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
+ public SslScanResult sslScanResult {
+ get {
+ return this.sslScanResultField;
+ }
+ set {
+ this.sslScanResultField = value;
+ this.sslScanResultSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="sslScanResult" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool isSafeFrameCompatibleSpecified {
+ public bool sslScanResultSpecified {
get {
- return this.isSafeFrameCompatibleFieldSpecified;
+ return this.sslScanResultFieldSpecified;
}
set {
- this.isSafeFrameCompatibleFieldSpecified = value;
+ this.sslScanResultFieldSpecified = value;
}
}
- /// A list of impression tracking URLs to ping when this creative is displayed. This
- /// field is optional.
+ /// The manual override for the SSL compatibility of this creative. This
+ /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
///
- [System.Xml.Serialization.XmlElementAttribute("thirdPartyImpressionTrackingUrls", Order = 6)]
- public string[] thirdPartyImpressionTrackingUrls {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 8)]
+ public SslManualOverride sslManualOverride {
get {
- return this.thirdPartyImpressionTrackingUrlsField;
+ return this.sslManualOverrideField;
}
set {
- this.thirdPartyImpressionTrackingUrlsField = value;
+ this.sslManualOverrideField = value;
+ this.sslManualOverrideSpecified = true;
+ }
+ }
+
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool sslManualOverrideSpecified {
+ get {
+ return this.sslManualOverrideFieldSpecified;
+ }
+ set {
+ this.sslManualOverrideFieldSpecified = value;
}
}
}
- /// Describes the orientation that a creative should be served with.
+ /// The different types of skippable ads.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum LockedOrientation {
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum SkippableAdType {
/// The value returned if the actual value is not exposed by the requested API
/// version.
///
UNKNOWN = 0,
- FREE_ORIENTATION = 1,
- PORTRAIT_ONLY = 2,
- LANDSCAPE_ONLY = 3,
+ /// Skippable ad type is disabled.
+ ///
+ DISABLED = 1,
+ /// Skippable ad type is enabled.
+ ///
+ ENABLED = 2,
+ /// Skippable in-stream ad type.
+ ///
+ INSTREAM_SELECT = 3,
}
- /// A Creative that is created by the specified creative template.
+ /// A Creative that contains externally hosted video ads and is served
+ /// via VAST XML.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class TemplateCreative : Creative {
- private long creativeTemplateIdField;
-
- private bool creativeTemplateIdFieldSpecified;
-
- private bool isInterstitialField;
-
- private bool isInterstitialFieldSpecified;
-
- private bool isNativeEligibleField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class VideoRedirectCreative : BaseVideoCreative {
+ private VideoRedirectAsset[] videoAssetsField;
- private bool isNativeEligibleFieldSpecified;
+ private VideoRedirectAsset mezzanineFileField;
- private bool isSafeFrameCompatibleField;
+ /// The video creative assets.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute("videoAssets", Order = 0)]
+ public VideoRedirectAsset[] videoAssets {
+ get {
+ return this.videoAssetsField;
+ }
+ set {
+ this.videoAssetsField = value;
+ }
+ }
- private bool isSafeFrameCompatibleFieldSpecified;
+ /// The high quality mezzanine video asset.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public VideoRedirectAsset mezzanineFile {
+ get {
+ return this.mezzanineFileField;
+ }
+ set {
+ this.mezzanineFileField = value;
+ }
+ }
+ }
- private string destinationUrlField;
- private BaseCreativeTemplateVariableValue[] creativeTemplateVariableValuesField;
+ /// A Creative that contains Ad Manager hosted video ads and is served
+ /// via VAST XML. This creative is read-only.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class VideoCreative : BaseVideoCreative {
+ }
- private SslScanResult sslScanResultField;
- private bool sslScanResultFieldSpecified;
+ /// 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.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class SetTopBoxCreative : BaseVideoCreative {
+ private string externalAssetIdField;
- private SslManualOverride sslManualOverrideField;
+ private string providerIdField;
- private bool sslManualOverrideFieldSpecified;
+ private string[] availabilityRegionIdsField;
- private LockedOrientation lockedOrientationField;
+ private DateTime licenseWindowStartDateTimeField;
- private bool lockedOrientationFieldSpecified;
+ private DateTime licenseWindowEndDateTimeField;
- /// Creative template ID that this creative is created from.
+ /// An external asset identifier that is used in the cable system. This attribute is
+ /// read-only after creation.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public long creativeTemplateId {
+ public string externalAssetId {
get {
- return this.creativeTemplateIdField;
+ return this.externalAssetIdField;
}
set {
- this.creativeTemplateIdField = value;
- this.creativeTemplateIdSpecified = true;
+ this.externalAssetIdField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool creativeTemplateIdSpecified {
+ /// An identifier for the provider in the cable system. This attribute is read-only
+ /// after creation.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public string providerId {
get {
- return this.creativeTemplateIdFieldSpecified;
+ return this.providerIdField;
}
set {
- this.creativeTemplateIdFieldSpecified = value;
+ this.providerIdField = value;
}
}
- /// true if this template instantiated creative is interstitial. This
- /// attribute is read-only and is assigned by Google based on the creative template.
+ /// IDs of regions where the creative is available to serve from a local cable
+ /// video-on-demand server. This attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public bool isInterstitial {
+ [System.Xml.Serialization.XmlElementAttribute("availabilityRegionIds", Order = 2)]
+ public string[] availabilityRegionIds {
get {
- return this.isInterstitialField;
+ return this.availabilityRegionIdsField;
}
set {
- this.isInterstitialField = value;
- this.isInterstitialSpecified = true;
+ this.availabilityRegionIdsField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool isInterstitialSpecified {
+ /// The date and time that this creative can begin serving from a local cable
+ /// video-on-demand server. This attribute is optional.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
+ public DateTime licenseWindowStartDateTime {
get {
- return this.isInterstitialFieldSpecified;
+ return this.licenseWindowStartDateTimeField;
}
set {
- this.isInterstitialFieldSpecified = value;
+ this.licenseWindowStartDateTimeField = value;
}
}
- /// true if this template instantiated creative is eligible for native
- /// adserving. This attribute is read-only and is assigned by Google based on the
- /// creative template.
+ /// The date and time that this creative can no longer be served from a local cable
+ /// video-on-demand server. This attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public bool isNativeEligible {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
+ public DateTime licenseWindowEndDateTime {
get {
- return this.isNativeEligibleField;
+ return this.licenseWindowEndDateTimeField;
}
set {
- this.isNativeEligibleField = value;
- this.isNativeEligibleSpecified = true;
+ this.licenseWindowEndDateTimeField = value;
}
}
+ }
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool isNativeEligibleSpecified {
+
+ /// The base type for creatives that load an image asset from a specified URL.
+ ///
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectOverlayCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectCreative))]
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public abstract partial class BaseImageRedirectCreative : HasDestinationUrlCreative {
+ private string imageUrlField;
+
+ /// The URL where the actual asset resides. This attribute is required and has a
+ /// maximum length of 1024 characters.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public string imageUrl {
get {
- return this.isNativeEligibleFieldSpecified;
+ return this.imageUrlField;
}
set {
- this.isNativeEligibleFieldSpecified = value;
+ this.imageUrlField = value;
}
}
+ }
- /// Whether the Creative is compatible for SafeFrame
- /// rendering. This attribute is read-only and is assigned by Google based on the
- /// CreativeTemplate.
+
+ /// 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.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class ImageRedirectOverlayCreative : BaseImageRedirectCreative {
+ private Size assetSizeField;
+
+ private int durationField;
+
+ private bool durationFieldSpecified;
+
+ private long[] companionCreativeIdsField;
+
+ private ConversionEvent_TrackingUrlsMapEntry[] trackingUrlsField;
+
+ private string customParametersField;
+
+ private string vastPreviewUrlField;
+
+ /// The size of the image asset. Note that this may differ from #size if the asset is not expected to fill the entire video
+ /// player. This attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public bool isSafeFrameCompatible {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public Size assetSize {
get {
- return this.isSafeFrameCompatibleField;
+ return this.assetSizeField;
}
set {
- this.isSafeFrameCompatibleField = value;
- this.isSafeFrameCompatibleSpecified = true;
+ this.assetSizeField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool isSafeFrameCompatibleSpecified {
+ /// Minimum suggested duration in milliseconds. This attribute is optional.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public int duration {
get {
- return this.isSafeFrameCompatibleFieldSpecified;
+ return this.durationField;
}
set {
- this.isSafeFrameCompatibleFieldSpecified = value;
+ this.durationField = value;
+ this.durationSpecified = true;
}
}
- /// The URL the user is directed to if they click on the creative. This attribute is
- /// only required if the template snippet contains the %u or
- /// %%DEST_URL%% macro. It has a maximum length of 1024 characters.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
- public string destinationUrl {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool durationSpecified {
get {
- return this.destinationUrlField;
+ return this.durationFieldSpecified;
}
set {
- this.destinationUrlField = value;
+ this.durationFieldSpecified = value;
}
}
- /// Stores values of CreativeTemplateVariable
- /// in the CreativeTemplate.
+ /// The IDs of the companion creatives that are associated with this creative. This
+ /// attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute("creativeTemplateVariableValues", Order = 5)]
- public BaseCreativeTemplateVariableValue[] creativeTemplateVariableValues {
+ [System.Xml.Serialization.XmlElementAttribute("companionCreativeIds", Order = 2)]
+ public long[] companionCreativeIds {
get {
- return this.creativeTemplateVariableValuesField;
+ return this.companionCreativeIdsField;
}
set {
- this.creativeTemplateVariableValuesField = value;
+ this.companionCreativeIdsField = value;
}
}
- /// The SSL compatibility scan result for this creative. This attribute is
- /// read-only and determined by Google.
+ /// A map from ConversionEvent to a list of URLs that will be pinged
+ /// when the event happens. This attribute is optional.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
- public SslScanResult sslScanResult {
+ [System.Xml.Serialization.XmlElementAttribute("trackingUrls", Order = 3)]
+ public ConversionEvent_TrackingUrlsMapEntry[] trackingUrls {
get {
- return this.sslScanResultField;
+ return this.trackingUrlsField;
}
set {
- this.sslScanResultField = value;
- this.sslScanResultSpecified = true;
+ this.trackingUrlsField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslScanResultSpecified {
+ /// A comma separated key=value list of parameters that will be supplied to the
+ /// creative, written into the VAST This
- /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
+ /// An ad tag URL that will return a preview of the VAST XML response specific to
+ /// this creative. This attribute is read-only.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
- public SslManualOverride sslManualOverride {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
+ public string vastPreviewUrl {
get {
- return this.sslManualOverrideField;
+ return this.vastPreviewUrlField;
}
set {
- this.sslManualOverrideField = value;
- this.sslManualOverrideSpecified = true;
+ this.vastPreviewUrlField = value;
}
}
+ }
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslManualOverrideSpecified {
- get {
- return this.sslManualOverrideFieldSpecified;
- }
- set {
- this.sslManualOverrideFieldSpecified = value;
- }
- }
- /// A locked orientation for this creative to be displayed in.
+ /// A Creative that loads an image asset from a specified URL.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class ImageRedirectCreative : BaseImageRedirectCreative {
+ private string altTextField;
+
+ private string thirdPartyImpressionUrlField;
+
+ /// Alternative text to be rendered along with the creative used mainly for
+ /// accessibility. This field is optional and has a maximum length of 500
+ /// characters.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 8)]
- public LockedOrientation lockedOrientation {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public string altText {
get {
- return this.lockedOrientationField;
+ return this.altTextField;
}
set {
- this.lockedOrientationField = value;
- this.lockedOrientationSpecified = true;
+ this.altTextField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool lockedOrientationSpecified {
+ /// An impression tracking URL to ping when this creative is displayed. This field
+ /// is optional has a maximum length of 1024 characters.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public string thirdPartyImpressionUrl {
get {
- return this.lockedOrientationFieldSpecified;
+ return this.thirdPartyImpressionUrlField;
}
set {
- this.lockedOrientationFieldSpecified = value;
+ this.thirdPartyImpressionUrlField = value;
}
}
}
- /// 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.
+ /// The base type for creatives that display an image.
///
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageOverlayCreative))]
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageCreative))]
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class ProgrammaticCreative : Creative {
- private bool isSafeFrameCompatibleField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public abstract partial class BaseImageCreative : HasDestinationUrlCreative {
+ private bool overrideSizeField;
- private bool isSafeFrameCompatibleFieldSpecified;
+ private bool overrideSizeFieldSpecified;
+
+ private CreativeAsset primaryImageAssetField;
- /// true if this Creative is served in a
- /// SafeFrame. This field is deprecated and will be removed in a future API version.
+ /// Allows the creative size to differ from the actual image asset size. This
+ /// attribute is optional.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public bool isSafeFrameCompatible {
+ public bool overrideSize {
get {
- return this.isSafeFrameCompatibleField;
+ return this.overrideSizeField;
}
set {
- this.isSafeFrameCompatibleField = value;
- this.isSafeFrameCompatibleSpecified = true;
+ this.overrideSizeField = value;
+ this.overrideSizeSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="overrideSize" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool isSafeFrameCompatibleSpecified {
+ public bool overrideSizeSpecified {
get {
- return this.isSafeFrameCompatibleFieldSpecified;
+ return this.overrideSizeFieldSpecified;
}
set {
- this.isSafeFrameCompatibleFieldSpecified = value;
+ this.overrideSizeFieldSpecified = value;
+ }
+ }
+
+ /// The primary image asset associated with this creative. This attribute is
+ /// required.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public CreativeAsset primaryImageAsset {
+ get {
+ return this.primaryImageAssetField;
+ }
+ set {
+ this.primaryImageAssetField = value;
}
}
}
- /// A Creative that isn't supported by Google DFP, but was migrated
- /// from DART. Creatives of this type cannot be created or modified.
+ /// 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.
+ /// This creative is read only prior to v201705.
///
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class LegacyDfpCreative : Creative {
- }
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class ImageOverlayCreative : BaseImageCreative {
+ private long[] companionCreativeIdsField;
+ private ConversionEvent_TrackingUrlsMapEntry[] trackingUrlsField;
- /// A Creative hosted by Campaign Manager. Similar to third-party
- /// creatives, a Campaign Manager tag is used to retrieve a creative asset. However,
- /// Campaign Manager tags are not sent to the user's browser. Instead, they are
- /// processed internally within the Google Marketing Platform system..
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class InternalRedirectCreative : Creative {
private LockedOrientation lockedOrientationField;
private bool lockedOrientationFieldSpecified;
- private Size assetSizeField;
-
- private string internalRedirectUrlField;
-
- private bool overrideSizeField;
-
- private bool overrideSizeFieldSpecified;
-
- private bool isInterstitialField;
-
- private bool isInterstitialFieldSpecified;
+ private string customParametersField;
- private SslScanResult sslScanResultField;
+ private int durationField;
- private bool sslScanResultFieldSpecified;
+ private bool durationFieldSpecified;
- private SslManualOverride sslManualOverrideField;
+ private string vastPreviewUrlField;
- private bool sslManualOverrideFieldSpecified;
+ /// The IDs of the companion creatives that are associated with this creative. This
+ /// attribute is optional. This attribute is read-only.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute("companionCreativeIds", Order = 0)]
+ public long[] companionCreativeIds {
+ get {
+ return this.companionCreativeIdsField;
+ }
+ set {
+ this.companionCreativeIdsField = value;
+ }
+ }
- private string[] thirdPartyImpressionTrackingUrlsField;
+ /// A map from ConversionEvent to a list of URLs that will be pinged
+ /// when the event happens. This attribute is optional.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute("trackingUrls", Order = 1)]
+ public ConversionEvent_TrackingUrlsMapEntry[] trackingUrls {
+ get {
+ return this.trackingUrlsField;
+ }
+ set {
+ this.trackingUrlsField = value;
+ }
+ }
/// A locked orientation for this creative to be displayed in.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
public LockedOrientation lockedOrientation {
get {
return this.lockedOrientationField;
@@ -7936,176 +7803,287 @@ public bool lockedOrientationSpecified {
}
}
- /// The asset size of an internal redirect creative. Note that this may differ from
- /// size if users set overrideSize to true. This attribute
- /// is read-only and is populated by Google.
+ /// A comma separated key=value list of parameters that will be supplied to the
+ /// creative, written into the VAST true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool durationSpecified {
+ get {
+ return this.durationFieldSpecified;
+ }
+ set {
+ this.durationFieldSpecified = value;
+ }
+ }
+
+ /// An ad tag URL that will return a preview of the VAST XML response specific to
+ /// this creative. This attribute is read-only.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public bool overrideSize {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
+ public string vastPreviewUrl {
get {
- return this.overrideSizeField;
+ return this.vastPreviewUrlField;
}
set {
- this.overrideSizeField = value;
- this.overrideSizeSpecified = true;
+ this.vastPreviewUrlField = value;
}
}
+ }
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool overrideSizeSpecified {
+
+ /// A Creative that displays an image.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class ImageCreative : BaseImageCreative {
+ private string altTextField;
+
+ private string thirdPartyImpressionUrlField;
+
+ private CreativeAsset[] secondaryImageAssetsField;
+
+ /// Alternative text to be rendered along with the creative used mainly for
+ /// accessibility. This field is optional and has a maximum length of 500
+ /// characters.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public string altText {
get {
- return this.overrideSizeFieldSpecified;
+ return this.altTextField;
}
set {
- this.overrideSizeFieldSpecified = value;
+ this.altTextField = value;
}
}
- /// true if this internal redirect creative is interstitial.
+ /// An impression tracking URL to ping when this creative is displayed. This field
+ /// is optional has a maximum length of 1024 characters.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
- public bool isInterstitial {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public string thirdPartyImpressionUrl {
get {
- return this.isInterstitialField;
+ return this.thirdPartyImpressionUrlField;
}
set {
- this.isInterstitialField = value;
- this.isInterstitialSpecified = true;
+ this.thirdPartyImpressionUrlField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool isInterstitialSpecified {
+ /// The list of 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.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute("secondaryImageAssets", Order = 2)]
+ public CreativeAsset[] secondaryImageAssets {
get {
- return this.isInterstitialFieldSpecified;
+ return this.secondaryImageAssetsField;
}
set {
- this.isInterstitialFieldSpecified = value;
+ this.secondaryImageAssetsField = value;
}
}
+ }
- /// The SSL compatibility scan result for this creative. This attribute is
- /// read-only and determined by Google.
+
+ /// A Creative intended for mobile platforms that displays an image,
+ /// whose size is defined as an aspect ratio, i.e. Size#isAspectRatio. It can have multiple images
+ /// whose dimensions conform to that aspect ratio.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class AspectRatioImageCreative : HasDestinationUrlCreative {
+ private CreativeAsset[] imageAssetsField;
+
+ private string altTextField;
+
+ private string thirdPartyImpressionUrlField;
+
+ private bool overrideSizeField;
+
+ private bool overrideSizeFieldSpecified;
+
+ /// 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.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
- public SslScanResult sslScanResult {
+ [System.Xml.Serialization.XmlElementAttribute("imageAssets", Order = 0)]
+ public CreativeAsset[] imageAssets {
get {
- return this.sslScanResultField;
+ return this.imageAssetsField;
}
set {
- this.sslScanResultField = value;
- this.sslScanResultSpecified = true;
+ this.imageAssetsField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslScanResultSpecified {
+ /// 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.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public string altText {
get {
- return this.sslScanResultFieldSpecified;
+ return this.altTextField;
}
set {
- this.sslScanResultFieldSpecified = value;
+ this.altTextField = value;
}
}
- /// The manual override for the SSL compatibility of this creative. This
- /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
+ /// An impression tracking URL to ping when this creative is displayed. This field
+ /// is optional has a maximum length of 1024 characters.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
- public SslManualOverride sslManualOverride {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
+ public string thirdPartyImpressionUrl {
get {
- return this.sslManualOverrideField;
+ return this.thirdPartyImpressionUrlField;
}
set {
- this.sslManualOverrideField = value;
- this.sslManualOverrideSpecified = true;
+ this.thirdPartyImpressionUrlField = value;
+ }
+ }
+
+ /// Allows the actual image asset sizes to differ from the creative size. This
+ /// attribute is optional.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
+ public bool overrideSize {
+ get {
+ return this.overrideSizeField;
+ }
+ set {
+ this.overrideSizeField = value;
+ this.overrideSizeSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="overrideSize" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslManualOverrideSpecified {
+ public bool overrideSizeSpecified {
get {
- return this.sslManualOverrideFieldSpecified;
+ return this.overrideSizeFieldSpecified;
}
set {
- this.sslManualOverrideFieldSpecified = value;
+ this.overrideSizeFieldSpecified = value;
}
}
+ }
- /// A list of impression tracking URLs to ping when this creative is displayed. This
- /// field is 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.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class ClickTrackingCreative : Creative {
+ private string clickTrackingUrlField;
+
+ /// The click tracking URL. This attribute is required.
///
- [System.Xml.Serialization.XmlElementAttribute("thirdPartyImpressionTrackingUrls", Order = 7)]
- public string[] thirdPartyImpressionTrackingUrls {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
+ public string clickTrackingUrl {
get {
- return this.thirdPartyImpressionTrackingUrlsField;
+ return this.clickTrackingUrlField;
}
set {
- this.thirdPartyImpressionTrackingUrlsField = value;
+ this.clickTrackingUrlField = value;
}
}
}
- /// A Creative that contains a zipped HTML5 bundle asset, a list of
- /// third party impression trackers, and a third party click tracker.
+ /// A Creative that is created by a Rich Media Studio.
///
+ [System.Xml.Serialization.XmlIncludeAttribute(typeof(RichMediaStudioCreative))]
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class Html5Creative : Creative {
- private bool overrideSizeField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public abstract partial class BaseRichMediaStudioCreative : Creative {
+ private long studioCreativeIdField;
- private bool overrideSizeFieldSpecified;
+ private bool studioCreativeIdFieldSpecified;
- private string[] thirdPartyImpressionTrackingUrlsField;
+ private RichMediaStudioCreativeFormat creativeFormatField;
- private string thirdPartyClickTrackingUrlField;
+ private bool creativeFormatFieldSpecified;
- private LockedOrientation lockedOrientationField;
+ private RichMediaStudioCreativeArtworkType artworkTypeField;
- private bool lockedOrientationFieldSpecified;
+ private bool artworkTypeFieldSpecified;
+
+ private long totalFileSizeField;
+
+ private bool totalFileSizeFieldSpecified;
+
+ private string[] adTagKeysField;
+
+ private string[] customKeyValuesField;
+
+ private string surveyUrlField;
+
+ private string allImpressionsUrlField;
+
+ private string richMediaImpressionsUrlField;
+
+ private string backupImageImpressionsUrlField;
+
+ private string overrideCssField;
+
+ private string requiredFlashPluginVersionField;
+
+ private int durationField;
+
+ private bool durationFieldSpecified;
+
+ private RichMediaStudioCreativeBillingAttribute billingAttributeField;
+
+ private bool billingAttributeFieldSpecified;
+
+ private RichMediaStudioChildAssetProperty[] richMediaStudioChildAssetPropertiesField;
private SslScanResult sslScanResultField;
@@ -8115,413 +8093,289 @@ public partial class Html5Creative : Creative {
private bool sslManualOverrideFieldSpecified;
- private bool isSafeFrameCompatibleField;
-
- private bool isSafeFrameCompatibleFieldSpecified;
-
- private CreativeAsset html5AssetField;
-
- /// Allows the creative size to differ from the actual HTML5 asset size. This
- /// attribute is optional.
+ /// The creative ID as known by Rich Media Studio creative. This attribute is
+ /// readonly.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public bool overrideSize {
+ public long studioCreativeId {
get {
- return this.overrideSizeField;
+ return this.studioCreativeIdField;
}
set {
- this.overrideSizeField = value;
- this.overrideSizeSpecified = true;
+ this.studioCreativeIdField = value;
+ this.studioCreativeIdSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="studioCreativeId" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool overrideSizeSpecified {
+ public bool studioCreativeIdSpecified {
get {
- return this.overrideSizeFieldSpecified;
+ return this.studioCreativeIdFieldSpecified;
}
set {
- this.overrideSizeFieldSpecified = value;
+ this.studioCreativeIdFieldSpecified = value;
}
}
- /// Impression tracking URLs to ping when this creative is displayed. This field is
- /// optional.
+ /// The creative format of the Rich Media Studio creative. This attribute is
+ /// readonly.
///
- [System.Xml.Serialization.XmlElementAttribute("thirdPartyImpressionTrackingUrls", Order = 1)]
- public string[] thirdPartyImpressionTrackingUrls {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
+ public RichMediaStudioCreativeFormat creativeFormat {
get {
- return this.thirdPartyImpressionTrackingUrlsField;
+ return this.creativeFormatField;
}
set {
- this.thirdPartyImpressionTrackingUrlsField = value;
+ this.creativeFormatField = value;
+ this.creativeFormatSpecified = true;
}
}
- /// A click tracking URL to ping when this creative is clicked. This field is
- /// optional.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public string thirdPartyClickTrackingUrl {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool creativeFormatSpecified {
get {
- return this.thirdPartyClickTrackingUrlField;
+ return this.creativeFormatFieldSpecified;
}
set {
- this.thirdPartyClickTrackingUrlField = value;
+ this.creativeFormatFieldSpecified = value;
}
}
- /// A locked orientation for this creative to be displayed in.
+ /// The type of artwork used in this creative. This attribute is readonly.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public LockedOrientation lockedOrientation {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
+ public RichMediaStudioCreativeArtworkType artworkType {
get {
- return this.lockedOrientationField;
+ return this.artworkTypeField;
}
set {
- this.lockedOrientationField = value;
- this.lockedOrientationSpecified = true;
+ this.artworkTypeField = value;
+ this.artworkTypeSpecified = true;
}
}
- /// true, if a value is specified for , false otherwise.
+ /// true, if a value is specified for , false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool lockedOrientationSpecified {
+ public bool artworkTypeSpecified {
get {
- return this.lockedOrientationFieldSpecified;
+ return this.artworkTypeFieldSpecified;
}
set {
- this.lockedOrientationFieldSpecified = value;
+ this.artworkTypeFieldSpecified = value;
}
}
- /// The SSL compatibility scan result of this creative. This attribute is
- /// read-only and determined by Google.
+ /// The total size of all assets in bytes. This attribute is readonly.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
- public SslScanResult sslScanResult {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
+ public long totalFileSize {
get {
- return this.sslScanResultField;
+ return this.totalFileSizeField;
}
set {
- this.sslScanResultField = value;
- this.sslScanResultSpecified = true;
+ this.totalFileSizeField = value;
+ this.totalFileSizeSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="totalFileSize" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslScanResultSpecified {
+ public bool totalFileSizeSpecified {
get {
- return this.sslScanResultFieldSpecified;
+ return this.totalFileSizeFieldSpecified;
}
set {
- this.sslScanResultFieldSpecified = value;
+ this.totalFileSizeFieldSpecified = value;
}
}
- /// The manual override for the SSL compatibility of this creative. This
- /// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
+ /// Ad tag keys. This attribute is optional and updatable.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
- public SslManualOverride sslManualOverride {
+ [System.Xml.Serialization.XmlElementAttribute("adTagKeys", Order = 4)]
+ public string[] adTagKeys {
get {
- return this.sslManualOverrideField;
+ return this.adTagKeysField;
}
set {
- this.sslManualOverrideField = value;
- this.sslManualOverrideSpecified = true;
+ this.adTagKeysField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool sslManualOverrideSpecified {
+ /// Custom key values. This attribute is optional and updatable.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute("customKeyValues", Order = 5)]
+ public string[] customKeyValues {
get {
- return this.sslManualOverrideFieldSpecified;
+ return this.customKeyValuesField;
}
set {
- this.sslManualOverrideFieldSpecified = value;
+ this.customKeyValuesField = value;
}
}
- /// Whether the Creative is compatible for SafeFrame
- /// rendering. This attribute is optional and defaults to true.
+ /// The survey URL for this creative. This attribute is optional and updatable.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 6)]
- public bool isSafeFrameCompatible {
+ public string surveyUrl {
get {
- return this.isSafeFrameCompatibleField;
+ return this.surveyUrlField;
}
set {
- this.isSafeFrameCompatibleField = value;
- this.isSafeFrameCompatibleSpecified = true;
+ this.surveyUrlField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool isSafeFrameCompatibleSpecified {
+ /// 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://.
+ /// This attribute is optional and updatable.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 7)]
- public CreativeAsset html5Asset {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 8)]
+ public string richMediaImpressionsUrl {
get {
- return this.html5AssetField;
+ return this.richMediaImpressionsUrlField;
}
set {
- this.html5AssetField = value;
+ this.richMediaImpressionsUrlField = value;
}
}
- }
-
-
- /// A Creative that has a destination url
- ///
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(CustomCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseVideoCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(SetTopBoxCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseImageRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseImageCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(ImageCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseFlashRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashRedirectOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(BaseFlashCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashOverlayCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(FlashCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(AspectRatioImageCreative))]
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public abstract partial class HasDestinationUrlCreative : Creative {
- private string destinationUrlField;
-
- private DestinationUrlType destinationUrlTypeField;
- private bool destinationUrlTypeFieldSpecified;
-
- /// 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.
+ /// The tracking URL to be triggered when the Rich Media backup image is served.
+ /// This attribute is optional and updatable.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string destinationUrl {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 9)]
+ public string backupImageImpressionsUrl {
get {
- return this.destinationUrlField;
+ return this.backupImageImpressionsUrlField;
}
set {
- this.destinationUrlField = value;
+ this.backupImageImpressionsUrlField = value;
}
}
- /// The action that should be performed if the user clicks on the creative. This
- /// attribute is optional and defaults to DestinationUrlType#CLICK_TO_WEB.
+ /// The override CSS. You can put custom CSS code here to repair creative styling;
+ /// e.g. tr td { background-color:#FBB; }. This attribute is optional
+ /// and updatable.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 1)]
- public DestinationUrlType destinationUrlType {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 10)]
+ public string overrideCss {
get {
- return this.destinationUrlTypeField;
+ return this.overrideCssField;
}
set {
- this.destinationUrlTypeField = value;
- this.destinationUrlTypeSpecified = true;
+ this.overrideCssField = value;
}
}
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool destinationUrlTypeSpecified {
+ /// The Flash plugin version required to view this creative; e.g. Flash
+ /// 10.2/AS 3. This attribute is read only.
+ ///
+ [System.Xml.Serialization.XmlElementAttribute(Order = 11)]
+ public string requiredFlashPluginVersion {
get {
- return this.destinationUrlTypeFieldSpecified;
+ return this.requiredFlashPluginVersionField;
}
set {
- this.destinationUrlTypeFieldSpecified = value;
+ this.requiredFlashPluginVersionField = value;
}
}
- }
-
-
- /// The valid actions that a destination URL may perform if the user clicks on the
- /// ad.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public enum DestinationUrlType {
- /// The value returned if the actual value is not exposed by the requested API
- /// version.
- ///
- UNKNOWN = 0,
- /// Navigate to a web page. (a.k.a. "Click-through URL").
- ///
- CLICK_TO_WEB = 1,
- /// Start an application.
- ///
- CLICK_TO_APP = 2,
- /// Make a phone call.
- ///
- CLICK_TO_CALL = 3,
- /// Destination URL not present. Useful for video creatives where a landing page or
- /// a product isn't necessarily applicable.
- ///
- NONE = 4,
- }
-
-
- /// A Creative that contains an arbitrary HTML snippet and file assets.
- ///
- [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
- [System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public partial class CustomCreative : HasDestinationUrlCreative {
- private string htmlSnippetField;
-
- private CustomCreativeAsset[] customCreativeAssetsField;
-
- private bool isInterstitialField;
-
- private bool isInterstitialFieldSpecified;
-
- private LockedOrientation lockedOrientationField;
-
- private bool lockedOrientationFieldSpecified;
-
- private SslScanResult sslScanResultField;
-
- private bool sslScanResultFieldSpecified;
-
- private SslManualOverride sslManualOverrideField;
-
- private bool sslManualOverrideFieldSpecified;
-
- private bool isSafeFrameCompatibleField;
-
- private bool isSafeFrameCompatibleFieldSpecified;
-
- private string[] thirdPartyImpressionTrackingUrlsField;
- /// The HTML snippet that this creative delivers. This attribute is required.
+ /// The duration of the creative in milliseconds. This attribute is optional and
+ /// updatable.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public string htmlSnippet {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 12)]
+ public int duration {
get {
- return this.htmlSnippetField;
+ return this.durationField;
}
set {
- this.htmlSnippetField = value;
+ this.durationField = value;
+ this.durationSpecified = true;
}
}
- /// A list of file assets that are associated with this creative, and can be
- /// referenced in the snippet.
- ///
- [System.Xml.Serialization.XmlElementAttribute("customCreativeAssets", Order = 1)]
- public CustomCreativeAsset[] customCreativeAssets {
+ /// true, if a value is specified for , false otherwise.
+ [System.Xml.Serialization.XmlIgnoreAttribute()]
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool durationSpecified {
get {
- return this.customCreativeAssetsField;
+ return this.durationFieldSpecified;
}
set {
- this.customCreativeAssetsField = value;
+ this.durationFieldSpecified = value;
}
}
- /// true if this custom creative is interstitial. An interstitial
- /// creative will not consider an impression served until it is fully rendered in
- /// the browser.
+ /// The billing attribute associated with this creative. This attribute is read
+ /// only.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 2)]
- public bool isInterstitial {
+ [System.Xml.Serialization.XmlElementAttribute(Order = 13)]
+ public RichMediaStudioCreativeBillingAttribute billingAttribute {
get {
- return this.isInterstitialField;
+ return this.billingAttributeField;
}
set {
- this.isInterstitialField = value;
- this.isInterstitialSpecified = true;
+ this.billingAttributeField = value;
+ this.billingAttributeSpecified = true;
}
}
/// true, if a value is specified for , false otherwise.
+ /// cref="billingAttribute" />, false otherwise.
[System.Xml.Serialization.XmlIgnoreAttribute()]
[EditorBrowsable(EditorBrowsableState.Never)]
- public bool isInterstitialSpecified {
+ public bool billingAttributeSpecified {
get {
- return this.isInterstitialFieldSpecified;
+ return this.billingAttributeFieldSpecified;
}
set {
- this.isInterstitialFieldSpecified = value;
+ this.billingAttributeFieldSpecified = value;
}
}
- /// A locked orientation for this creative to be displayed in.
+ /// The list of child assets associated with this creative. This attribute is read
+ /// only.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 3)]
- public LockedOrientation lockedOrientation {
- get {
- return this.lockedOrientationField;
- }
- set {
- this.lockedOrientationField = value;
- this.lockedOrientationSpecified = true;
- }
- }
-
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool lockedOrientationSpecified {
+ [System.Xml.Serialization.XmlElementAttribute("richMediaStudioChildAssetProperties", Order = 14)]
+ public RichMediaStudioChildAssetProperty[] richMediaStudioChildAssetProperties {
get {
- return this.lockedOrientationFieldSpecified;
+ return this.richMediaStudioChildAssetPropertiesField;
}
set {
- this.lockedOrientationFieldSpecified = value;
+ this.richMediaStudioChildAssetPropertiesField = value;
}
}
/// The SSL compatibility scan result of this creative. This attribute is
/// read-only and determined by Google.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 4)]
+ [System.Xml.Serialization.XmlElementAttribute(Order = 15)]
public SslScanResult sslScanResult {
get {
return this.sslScanResultField;
@@ -8549,7 +8403,7 @@ public bool sslScanResultSpecified {
/// attribute is optional and defaults to SslManualOverride#NO_OVERRIDE.
///
- [System.Xml.Serialization.XmlElementAttribute(Order = 5)]
+ [System.Xml.Serialization.XmlElementAttribute(Order = 16)]
public SslManualOverride sslManualOverride {
get {
return this.sslManualOverrideField;
@@ -8572,3125 +8426,3662 @@ public bool sslManualOverrideSpecified {
this.sslManualOverrideFieldSpecified = value;
}
}
+ }
- /// Whether the Creative is compatible for SafeFrame
- /// rendering. This attribute is optional and defaults to true.
- ///
- [System.Xml.Serialization.XmlElementAttribute(Order = 6)]
- public bool isSafeFrameCompatible {
- get {
- return this.isSafeFrameCompatibleField;
- }
- set {
- this.isSafeFrameCompatibleField = value;
- this.isSafeFrameCompatibleSpecified = true;
- }
- }
-
- /// true, if a value is specified for , false otherwise.
- [System.Xml.Serialization.XmlIgnoreAttribute()]
- [EditorBrowsable(EditorBrowsableState.Never)]
- public bool isSafeFrameCompatibleSpecified {
- get {
- return this.isSafeFrameCompatibleFieldSpecified;
- }
- set {
- this.isSafeFrameCompatibleFieldSpecified = value;
- }
- }
- /// A list of impression tracking URLs to ping when this creative is displayed. This
- /// field is optional.
+ /// Different creative format supported by Rich Media Studio creative.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum RichMediaStudioCreativeFormat {
+ /// 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.
///
- [System.Xml.Serialization.XmlElementAttribute("thirdPartyImpressionTrackingUrls", Order = 7)]
- public string[] thirdPartyImpressionTrackingUrls {
- get {
- return this.thirdPartyImpressionTrackingUrlsField;
- }
- set {
- this.thirdPartyImpressionTrackingUrlsField = value;
- }
- }
+ IN_PAGE = 0,
+ /// Expanding creatives expand/collapse on user interaction such as mouse over. It
+ /// consists of an initial, or collapsed and an expanded creative area.
+ ///
+ EXPANDING = 1,
+ /// 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.
+ ///
+ IM_EXPANDING = 2,
+ /// Floating creatives float on top of publishers page and can be closed with a
+ /// close button.
+ ///
+ FLOATING = 3,
+ /// 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.
+ ///
+ PEEL_DOWN = 4,
+ /// 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.
+ ///
+ IN_PAGE_WITH_FLOATING = 5,
+ /// 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 = 6,
+ /// 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.
+ ///
+ FLASH_IN_FLASH_EXPANDING = 7,
+ /// 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_APP = 8,
+ /// The creative format is unknown or not supported in the API version in use.
+ ///
+ UNKNOWN = 9,
}
- /// A base type for video creatives.
+ /// Rich Media Studio creative artwork types.
///
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoRedirectCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(VideoCreative))]
- [System.Xml.Serialization.XmlIncludeAttribute(typeof(SetTopBoxCreative))]
[System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
[System.SerializableAttribute()]
- [System.Diagnostics.DebuggerStepThroughAttribute()]
- [System.ComponentModel.DesignerCategoryAttribute("code")]
- [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201808")]
- public abstract partial class BaseVideoCreative : HasDestinationUrlCreative {
- private int durationField;
-
- private bool durationFieldSpecified;
-
- private bool allowDurationOverrideField;
-
- private bool allowDurationOverrideFieldSpecified;
-
- private ConversionEvent_TrackingUrlsMapEntry[] trackingUrlsField;
-
- private long[] companionCreativeIdsField;
-
- private string customParametersField;
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum RichMediaStudioCreativeArtworkType {
+ /// The creative is a Flash creative.
+ ///
+ FLASH = 0,
+ /// The creative is HTML5.
+ ///
+ HTML5 = 1,
+ /// The creative is Flash if available, and HTML5 otherwise.
+ ///
+ MIXED = 2,
+ }
- private SkippableAdType skippableAdTypeField;
- private bool skippableAdTypeFieldSpecified;
+ /// 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.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public enum RichMediaStudioCreativeBillingAttribute {
+ /// Applies to any RichMediaStudioCreativeFormat#IN_PAGE,
+ /// without Video.
+ ///
+ IN_PAGE = 0,
+ /// Applies to any of these following RichMediaStudioCreativeFormat, without
+ /// Video: RichMediaStudioCreativeFormat#EXPANDING,
+ /// RichMediaStudioCreativeFormat#IM_EXPANDING,
+ /// RichMediaStudioCreativeFormat#FLOATING,
+ /// RichMediaStudioCreativeFormat#PEEL_DOWN,
+ /// RichMediaStudioCreativeFormat#IN_PAGE_WITH_FLOATING
+ ///
+ FLOATING_EXPANDING = 1,
+ /// Applies to any creatives that includes a video.
+ ///
+ VIDEO = 2,
+ /// Applies to any RichMediaStudioCreativeFormat#FLASH_IN_FLASH,
+ /// without Video.
+ ///
+ FLASH_IN_FLASH = 3,
+ }
- private string vastPreviewUrlField;
- private SslScanResult sslScanResultField;
+ /// A Creative that is created by a Rich Media Studio. You cannot
+ /// create this creative, but you can update some fields of this creative.
+ ///
+ [System.CodeDom.Compiler.GeneratedCodeAttribute("svcutil", "4.6.1055.0")]
+ [System.SerializableAttribute()]
+ [System.Diagnostics.DebuggerStepThroughAttribute()]
+ [System.ComponentModel.DesignerCategoryAttribute("code")]
+ [System.Xml.Serialization.XmlTypeAttribute(Namespace = "https://www.google.com/apis/ads/publisher/v201908")]
+ public partial class RichMediaStudioCreative : BaseRichMediaStudioCreative {
+ private LockedOrientation lockedOrientationField;
- private bool sslScanResultFieldSpecified;
+ private bool lockedOrientationFieldSpecified;
- private SslManualOverride sslManualOverrideField;
+ private bool isInterstitialField;
- private bool sslManualOverrideFieldSpecified;
+ private bool isInterstitialFieldSpecified;
- /// The expected duration of this creative in milliseconds.
+ /// A locked orientation for this creative to be displayed in.
///
[System.Xml.Serialization.XmlElementAttribute(Order = 0)]
- public int duration {
+ public LockedOrientation lockedOrientation {
get {
- return this.durationField;
+ return this.lockedOrientationField;
}
set {
- this.durationField = value;
- this.durationSpecified = true;
+ this.lockedOrientationField = value;
+ this.lockedOrientationSpecified = true;
}
}
- ///