Class Ad

Contains properties of a Campaign Manager ad.

Inheritance
System.Object
Ad
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Dfareporting.v3_2.Data
Assembly: Google.Apis.Dfareporting.v3_2.dll
Syntax
public class Ad : IDirectResponseSchema

Properties

AccountId

Account ID of this ad. This is a read-only field that can be left blank.

Declaration
[JsonProperty("accountId")]
public virtual long? AccountId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

Active

Whether this ad is active. When true, archived must be false.

Declaration
[JsonProperty("active")]
public virtual bool? Active { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

AdvertiserId

Advertiser ID of this ad. This is a required field on insertion.

Declaration
[JsonProperty("advertiserId")]
public virtual long? AdvertiserId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

AdvertiserIdDimensionValue

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

Declaration
[JsonProperty("advertiserIdDimensionValue")]
public virtual DimensionValue AdvertiserIdDimensionValue { get; set; }
Property Value
Type Description
DimensionValue

Archived

Whether this ad is archived. When true, active must be false.

Declaration
[JsonProperty("archived")]
public virtual bool? Archived { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

AudienceSegmentId

Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.

Declaration
[JsonProperty("audienceSegmentId")]
public virtual long? AudienceSegmentId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

CampaignId

Campaign ID of this ad. This is a required field on insertion.

Declaration
[JsonProperty("campaignId")]
public virtual long? CampaignId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

CampaignIdDimensionValue

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

Declaration
[JsonProperty("campaignIdDimensionValue")]
public virtual DimensionValue CampaignIdDimensionValue { get; set; }
Property Value
Type Description
DimensionValue

ClickThroughUrl

Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.

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

ClickThroughUrlSuffixProperties

Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.

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

Comments

Comments for this ad.

Declaration
[JsonProperty("comments")]
public virtual string Comments { get; set; }
Property Value
Type Description
System.String

Compatibility

Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.

Declaration
[JsonProperty("compatibility")]
public virtual string Compatibility { get; set; }
Property Value
Type Description
System.String

CreateInfo

Information about the creation of this ad. This is a read-only field.

Declaration
[JsonProperty("createInfo")]
public virtual LastModifiedInfo CreateInfo { get; set; }
Property Value
Type Description
LastModifiedInfo

CreativeGroupAssignments

Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.

Declaration
[JsonProperty("creativeGroupAssignments")]
public virtual IList<CreativeGroupAssignment> CreativeGroupAssignments { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<CreativeGroupAssignment>

CreativeRotation

Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.

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

DayPartTargeting

Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

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

DefaultClickThroughEventTagProperties

Default click-through event tag properties for this ad.

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

DeliverySchedule

Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.

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

DynamicClickTracker

Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.

Declaration
[JsonProperty("dynamicClickTracker")]
public virtual bool? DynamicClickTracker { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

EndTime

System.DateTime representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTime? EndTime { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

EndTimeRaw

Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
System.String

ETag

The ETag of the item.

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

EventTagOverrides

Event tag overrides for this ad.

Declaration
[JsonProperty("eventTagOverrides")]
public virtual IList<EventTagOverride> EventTagOverrides { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<EventTagOverride>

GeoTargeting

Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

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

Id

ID of this ad. This is a read-only, auto-generated field.

Declaration
[JsonProperty("id")]
public virtual long? Id { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

IdDimensionValue

Dimension value for the ID of this ad. This is a read-only, auto-generated field.

Declaration
[JsonProperty("idDimensionValue")]
public virtual DimensionValue IdDimensionValue { get; set; }
Property Value
Type Description
DimensionValue

KeyValueTargetingExpression

Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

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

Kind

Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
System.String

LanguageTargeting

Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

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

LastModifiedInfo

Information about the most recent modification of this ad. This is a read-only field.

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

Name

Name of this ad. This is a required field and must be less than 256 characters long.

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

PlacementAssignments

Placement assignments for this ad.

Declaration
[JsonProperty("placementAssignments")]
public virtual IList<PlacementAssignment> PlacementAssignments { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<PlacementAssignment>

RemarketingListExpression

Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

Declaration
[JsonProperty("remarketingListExpression")]
public virtual ListTargetingExpression RemarketingListExpression { get; set; }
Property Value
Type Description
ListTargetingExpression

Size

Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.

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

SslCompliant

Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.

Declaration
[JsonProperty("sslCompliant")]
public virtual bool? SslCompliant { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

SslRequired

Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.

Declaration
[JsonProperty("sslRequired")]
public virtual bool? SslRequired { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

StartTime

System.DateTime representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTime? StartTime { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

StartTimeRaw

Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
System.String

SubaccountId

Subaccount ID of this ad. This is a read-only field that can be left blank.

Declaration
[JsonProperty("subaccountId")]
public virtual long? SubaccountId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

TargetingTemplateId

Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.

Declaration
[JsonProperty("targetingTemplateId")]
public virtual long? TargetingTemplateId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

TechnologyTargeting

Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.

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

Type

Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
System.String

Implements