Class Campaign

Contains properties of a Campaign Manager campaign.

Inheritance

System.Object

Campaign

Implements

IDirectResponseSchema

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 Campaign : IDirectResponseSchema

Properties

AccountId

Account ID of this campaign. 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>

AdBlockingConfiguration

Ad blocking settings for this campaign.

Declaration

[JsonProperty("adBlockingConfiguration")]
public virtual AdBlockingConfiguration AdBlockingConfiguration { get; set; }

Property Value

Type	Description
AdBlockingConfiguration

AdditionalCreativeOptimizationConfigurations

Additional creative optimization configurations for the campaign.

Declaration

[JsonProperty("additionalCreativeOptimizationConfigurations")]
public virtual IList<CreativeOptimizationConfiguration> AdditionalCreativeOptimizationConfigurations { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<CreativeOptimizationConfiguration>

AdvertiserGroupId

Advertiser group ID of the associated advertiser.

Declaration

[JsonProperty("advertiserGroupId")]
public virtual long? AdvertiserGroupId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

AdvertiserId

Advertiser ID of this campaign. This is a required field.

Declaration

[JsonProperty("advertiserId")]
public virtual long? AdvertiserId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

AdvertiserIdDimensionValue

Dimension value for the advertiser ID of this campaign. 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 campaign has been archived.

Declaration

[JsonProperty("archived")]
public virtual bool? Archived { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AudienceSegmentGroups

Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.

Declaration

[JsonProperty("audienceSegmentGroups")]
public virtual IList<AudienceSegmentGroup> AudienceSegmentGroups { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<AudienceSegmentGroup>

BillingInvoiceCode

Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.

Declaration

[JsonProperty("billingInvoiceCode")]
public virtual string BillingInvoiceCode { get; set; }

Property Value

Type	Description
System.String

ClickThroughUrlSuffixProperties

Click-through URL suffix override properties for this campaign.

Declaration

[JsonProperty("clickThroughUrlSuffixProperties")]
public virtual ClickThroughUrlSuffixProperties ClickThroughUrlSuffixProperties { get; set; }

Property Value

Type	Description
ClickThroughUrlSuffixProperties

Comment

Arbitrary comments about this campaign. Must be less than 256 characters long.

Declaration

[JsonProperty("comment")]
public virtual string Comment { get; set; }

Property Value

Type	Description
System.String

CreateInfo

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

Declaration

[JsonProperty("createInfo")]
public virtual LastModifiedInfo CreateInfo { get; set; }

Property Value

Type	Description
LastModifiedInfo

CreativeGroupIds

List of creative group IDs that are assigned to the campaign.

Declaration

[JsonProperty("creativeGroupIds")]
public virtual IList<long? > CreativeGroupIds { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.Nullable<System.Int64>>

CreativeOptimizationConfiguration

Creative optimization configuration for the campaign.

Declaration

[JsonProperty("creativeOptimizationConfiguration")]
public virtual CreativeOptimizationConfiguration CreativeOptimizationConfiguration { get; set; }

Property Value

Type	Description
CreativeOptimizationConfiguration

DefaultClickThroughEventTagProperties

Click-through event tag ID override properties for this campaign.

Declaration

[JsonProperty("defaultClickThroughEventTagProperties")]
public virtual DefaultClickThroughEventTagProperties DefaultClickThroughEventTagProperties { get; set; }

Property Value

Type	Description
DefaultClickThroughEventTagProperties

DefaultLandingPageId

The default landing page ID for this campaign.

Declaration

[JsonProperty("defaultLandingPageId")]
public virtual long? DefaultLandingPageId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

EndDate

Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.

Declaration

[JsonProperty("endDate")]
public virtual string EndDate { 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

Overrides that can be used to activate or deactivate advertiser event tags.

Declaration

[JsonProperty("eventTagOverrides")]
public virtual IList<EventTagOverride> EventTagOverrides { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<EventTagOverride>

ExternalId

External ID for this campaign.

Declaration

[JsonProperty("externalId")]
public virtual string ExternalId { get; set; }

Property Value

Type	Description
System.String

Id

ID of this campaign. 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 campaign. This is a read-only, auto-generated field.

Declaration

[JsonProperty("idDimensionValue")]
public virtual DimensionValue IdDimensionValue { get; set; }

Property Value

Type	Description
DimensionValue

Kind

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

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
System.String

LastModifiedInfo

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

Declaration

[JsonProperty("lastModifiedInfo")]
public virtual LastModifiedInfo LastModifiedInfo { get; set; }

Property Value

Type	Description
LastModifiedInfo

LookbackConfiguration

Lookback window settings for the campaign.

Declaration

[JsonProperty("lookbackConfiguration")]
public virtual LookbackConfiguration LookbackConfiguration { get; set; }

Property Value

Type	Description
LookbackConfiguration

Name

Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
System.String

NielsenOcrEnabled

Whether Nielsen reports are enabled for this campaign.

Declaration

[JsonProperty("nielsenOcrEnabled")]
public virtual bool? NielsenOcrEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

StartDate

Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.

Declaration

[JsonProperty("startDate")]
public virtual string StartDate { get; set; }

Property Value

Type	Description
System.String

SubaccountId

Subaccount ID of this campaign. 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>

TraffickerEmails

Campaign trafficker contact emails.

Declaration

[JsonProperty("traffickerEmails")]
public virtual IList<string> TraffickerEmails { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Implements

IDirectResponseSchema