Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.Campaign Class Reference

Data representing an AdWords campaign. More...

Classes

class  Fields
 List of all supported fields for the Campaign class. More...
 
class  FilterableFields
 List of all supported filterable fields for the Campaign class. More...
 
class  SelectableFields
 List of all supported selectable fields for the Campaign class. More...
 

Properties

long id [get, set]
 ID of this campaign. This field can be selected using the value "Id".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD. More...
 
bool idSpecified [get, set]
 
long campaignGroupId [get, set]
 Id of the campaign group this campaign belongs to. This field can be selected using the value "CampaignGroupId".This field can be filtered on. More...
 
bool campaignGroupIdSpecified [get, set]
 
string name [get, set]
 Name of this campaign. This field is required and should not be More...
 
CampaignStatus status [get, set]
 Status of this campaign. On add, defaults to More...
 
bool statusSpecified [get, set]
 
ServingStatus servingStatus [get, set]
 Serving status. This field can be selected using the value "ServingStatus".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool servingStatusSpecified [get, set]
 
string startDate [get, set]
 Date the campaign begins. On add, defaults to the current day in the parent account's local timezone. The date's format should be YYYYMMDD. This field can be selected using the value "StartDate".This field can be filtered on. More...
 
string endDate [get, set]
 Date the campaign ends. On add, defaults to More...
 
Budget budget [get, set]
 Current base budget of campaign; default if no custom budgets are enabled. This field is readonly for draft campaigns and will be ignored when sent to the API. More...
 
ConversionOptimizerEligibility conversionOptimizerEligibility [get, set]
 This field is read only and will be ignored when sent to the API. More...
 
AdServingOptimizationStatus adServingOptimizationStatus [get, set]
 Ad serving optimization status. This field can be selected using the value "AdServingOptimizationStatus". This field may only be set to CONVERSION_OPTIMIZE for campaign channel subtype UNIVERSAL_APP_CAMPAIGN. This field may only be set to CONVERSION_OPTIMIZE for campaign channel type DISPLAY with campaign channel subtype DISPLAY_SMART_CAMPAIGN. More...
 
bool adServingOptimizationStatusSpecified [get, set]
 
FrequencyCap frequencyCap [get, set]
 Frequency cap for this campaign. This field may not be set for campaign channel subtypes: DISPLAY_SMART_CAMPAIGN, UNIVERSAL_APP_CAMPAIGN, SEARCH_MOBILE_APP. More...
 
Setting[] settings [get, set]
 List of settings for the campaign. This field can be selected using the value "Settings". More...
 
AdvertisingChannelType advertisingChannelType [get, set]
 The primary serving target for ads within this campaign. The targeting options can be refined in NetworkSetting. May only be set for new campaigns. This field is required and should not be More...
 
bool advertisingChannelTypeSpecified [get, set]
 
AdvertisingChannelSubType advertisingChannelSubType [get, set]
 Optional refinement of advertisingChannelType. Must be a valid sub-type of the parent channel type. May only be set for new campaigns and cannot be changed once set. This field can be selected using the value "AdvertisingChannelSubType".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET. More...
 
bool advertisingChannelSubTypeSpecified [get, set]
 
NetworkSetting networkSetting [get, set]
 Network settings for the campaign indicating where the campaign will serve. More...
 
Label[] labels [get, set]
 Labels that are attached to the campaign. To associate an existing Label to an existing Campaign, use CampaignService::mutateLabel with the ADD operator. To remove an associated Label from the Campaign, use CampaignService::mutateLabel with the REMOVE operator. To filter on Labels, use one of Predicate.Operator::CONTAINS_ALL, Predicate.Operator::CONTAINS_ANY, Predicate.Operator::CONTAINS_NONE operators with a list of Label ids. This field can be selected using the value "Labels".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET. More...
 
BiddingStrategyConfiguration biddingStrategyConfiguration [get, set]
 Bidding configuration for this campaign. To change an existing campaign's bidding strategy, set the BiddingStrategyConfiguration::biddingStrategyType or BiddingStrategyConfiguration::biddingScheme. This field is required and should not be More...
 
CampaignTrialType campaignTrialType [get, set]
 Indicates if this campaign is a normal campaign, a draft campaign, or a trial campaign. This field can be selected using the value "CampaignTrialType".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool campaignTrialTypeSpecified [get, set]
 
long baseCampaignId [get, set]
 ID of the base campaign of the draft or trial campaign. For base campaigns, this is equal to the campaign ID. This field is only returned on get requests. This field can be selected using the value "BaseCampaignId".This field can be filtered on. This field is read only and will be ignored when sent to the API. More...
 
bool baseCampaignIdSpecified [get, set]
 
String_StringMapEntry[] forwardCompatibilityMap [get, set]
 This Map provides a place to put new features and settings in older versions of the AdWords API in the rare instance we need to introduce a new feature in an older version. It is presently unused. Do not set a value. More...
 
string trackingUrlTemplate [get, set]
 URL template for constructing a tracking URL. More...
 
string finalUrlSuffix [get, set]
 URL template for appending params to Final URL. More...
 
CustomParameters urlCustomParameters [get, set]
 A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. This field can be selected using the value "UrlCustomParameters". This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN. More...
 
VanityPharma vanityPharma [get, set]
 Describes how unbranded pharma ads will be displayed. This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN. More...
 
UniversalAppCampaignInfo universalAppCampaignInfo [get, set]
 Stores information specific to Universal App Campaigns. This field may only be set for campaign channel type MULTI_CHANNEL. This field may not be set. More...
 
SelectiveOptimization selectiveOptimization [get, set]
 Selective optimization setting for this campaign, which includes a set of conversion types to optimize this campaign towards. This field can be selected using the value "SelectiveOptimization". More...
 

Detailed Description

Data representing an AdWords campaign.

Property Documentation

AdServingOptimizationStatus Google.Api.Ads.AdWords.v201809.Campaign.adServingOptimizationStatus
getset

Ad serving optimization status. This field can be selected using the value "AdServingOptimizationStatus". This field may only be set to CONVERSION_OPTIMIZE for campaign channel subtype UNIVERSAL_APP_CAMPAIGN. This field may only be set to CONVERSION_OPTIMIZE for campaign channel type DISPLAY with campaign channel subtype DISPLAY_SMART_CAMPAIGN.

bool Google.Api.Ads.AdWords.v201809.Campaign.adServingOptimizationStatusSpecified
getset

true, if a value is specified for adServingOptimizationStatus, false otherwise.

AdvertisingChannelSubType Google.Api.Ads.AdWords.v201809.Campaign.advertisingChannelSubType
getset

Optional refinement of advertisingChannelType. Must be a valid sub-type of the parent channel type. May only be set for new campaigns and cannot be changed once set. This field can be selected using the value "AdvertisingChannelSubType".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET.

bool Google.Api.Ads.AdWords.v201809.Campaign.advertisingChannelSubTypeSpecified
getset

true, if a value is specified for advertisingChannelSubType, false otherwise.

AdvertisingChannelType Google.Api.Ads.AdWords.v201809.Campaign.advertisingChannelType
getset

The primary serving target for ads within this campaign. The targeting options can be refined in NetworkSetting. May only be set for new campaigns. This field is required and should not be

when it is contained within Operators : ADD This field can be selected using the value "AdvertisingChannelType".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET.

bool Google.Api.Ads.AdWords.v201809.Campaign.advertisingChannelTypeSpecified
getset

true, if a value is specified for advertisingChannelType, false otherwise.

long Google.Api.Ads.AdWords.v201809.Campaign.baseCampaignId
getset

ID of the base campaign of the draft or trial campaign. For base campaigns, this is equal to the campaign ID. This field is only returned on get requests. This field can be selected using the value "BaseCampaignId".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.Campaign.baseCampaignIdSpecified
getset

true, if a value is specified for baseCampaignId, false otherwise.

BiddingStrategyConfiguration Google.Api.Ads.AdWords.v201809.Campaign.biddingStrategyConfiguration
getset

Bidding configuration for this campaign. To change an existing campaign's bidding strategy, set the BiddingStrategyConfiguration::biddingStrategyType or BiddingStrategyConfiguration::biddingScheme. This field is required and should not be

null when it is contained within Operators : ADD

Budget Google.Api.Ads.AdWords.v201809.Campaign.budget
getset

Current base budget of campaign; default if no custom budgets are enabled. This field is readonly for draft campaigns and will be ignored when sent to the API.

long Google.Api.Ads.AdWords.v201809.Campaign.campaignGroupId
getset

Id of the campaign group this campaign belongs to. This field can be selected using the value "CampaignGroupId".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.Campaign.campaignGroupIdSpecified
getset

true, if a value is specified for campaignGroupId, false otherwise.

CampaignTrialType Google.Api.Ads.AdWords.v201809.Campaign.campaignTrialType
getset

Indicates if this campaign is a normal campaign, a draft campaign, or a trial campaign. This field can be selected using the value "CampaignTrialType".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.Campaign.campaignTrialTypeSpecified
getset

true, if a value is specified for campaignTrialType, false otherwise.

ConversionOptimizerEligibility Google.Api.Ads.AdWords.v201809.Campaign.conversionOptimizerEligibility
getset

This field is read only and will be ignored when sent to the API.

string Google.Api.Ads.AdWords.v201809.Campaign.endDate
getset

Date the campaign ends. On add, defaults to

20371230, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 20371230. The date's format should be YYYYMMDD. This field can be selected using the value "EndDate".This field can be filtered on.

string Google.Api.Ads.AdWords.v201809.Campaign.finalUrlSuffix
getset

URL template for appending params to Final URL.

On update, empty string ("") indicates to clear the field. This field can be selected using the value "FinalUrlSuffix".This field can be filtered on. This field may not be set for campaign channel type MULTI_CHANNEL.

String_StringMapEntry [] Google.Api.Ads.AdWords.v201809.Campaign.forwardCompatibilityMap
getset

This Map provides a place to put new features and settings in older versions of the AdWords API in the rare instance we need to introduce a new feature in an older version. It is presently unused. Do not set a value.

FrequencyCap Google.Api.Ads.AdWords.v201809.Campaign.frequencyCap
getset

Frequency cap for this campaign. This field may not be set for campaign channel subtypes: DISPLAY_SMART_CAMPAIGN, UNIVERSAL_APP_CAMPAIGN, SEARCH_MOBILE_APP.

long Google.Api.Ads.AdWords.v201809.Campaign.id
getset
bool Google.Api.Ads.AdWords.v201809.Campaign.idSpecified
getset

true, if a value is specified for id, false otherwise.

Label [] Google.Api.Ads.AdWords.v201809.Campaign.labels
getset

Labels that are attached to the campaign. To associate an existing Label to an existing Campaign, use CampaignService::mutateLabel with the ADD operator. To remove an associated Label from the Campaign, use CampaignService::mutateLabel with the REMOVE operator. To filter on Labels, use one of Predicate.Operator::CONTAINS_ALL, Predicate.Operator::CONTAINS_ANY, Predicate.Operator::CONTAINS_NONE operators with a list of Label ids. This field can be selected using the value "Labels".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET.

Referenced by Google.Api.Ads.AdWords.Examples.CSharp.v201809.GetCampaignsByLabel.Run().

string Google.Api.Ads.AdWords.v201809.Campaign.name
getset

Name of this campaign. This field is required and should not be

null for ADD operations. For SET and REMOVE operations, this can be used to address the campaign by name when the campaign is ENABLED or PAUSED. Removed campaigns cannot be addressed by name. If you wish to rename a campaign, you must provide the ID. This field can be selected using the value "Name".This field can be filtered on. Campaign names must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters. This is checked by the regular expression '[^]*'. This string must not be empty.

NetworkSetting Google.Api.Ads.AdWords.v201809.Campaign.networkSetting
getset

Network settings for the campaign indicating where the campaign will serve.

SelectiveOptimization Google.Api.Ads.AdWords.v201809.Campaign.selectiveOptimization
getset

Selective optimization setting for this campaign, which includes a set of conversion types to optimize this campaign towards. This field can be selected using the value "SelectiveOptimization".

ServingStatus Google.Api.Ads.AdWords.v201809.Campaign.servingStatus
getset

Serving status. This field can be selected using the value "ServingStatus".This field can be filtered on. This field is read only and will be ignored when sent to the API.

bool Google.Api.Ads.AdWords.v201809.Campaign.servingStatusSpecified
getset

true, if a value is specified for servingStatus, false otherwise.

Setting [] Google.Api.Ads.AdWords.v201809.Campaign.settings
getset

List of settings for the campaign. This field can be selected using the value "Settings".

string Google.Api.Ads.AdWords.v201809.Campaign.startDate
getset

Date the campaign begins. On add, defaults to the current day in the parent account's local timezone. The date's format should be YYYYMMDD. This field can be selected using the value "StartDate".This field can be filtered on.

CampaignStatus Google.Api.Ads.AdWords.v201809.Campaign.status
getset

Status of this campaign. On add, defaults to

ENABLED. This field can be selected using the value "Status".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.Campaign.statusSpecified
getset

true, if a value is specified for status, false otherwise.

string Google.Api.Ads.AdWords.v201809.Campaign.trackingUrlTemplate
getset

URL template for constructing a tracking URL.

On update, empty string ("") indicates to clear the field. This field can be selected using the value "TrackingUrlTemplate".This field can be filtered on. This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN.

UniversalAppCampaignInfo Google.Api.Ads.AdWords.v201809.Campaign.universalAppCampaignInfo
getset

Stores information specific to Universal App Campaigns. This field may only be set for campaign channel type MULTI_CHANNEL. This field may not be set.

CustomParameters Google.Api.Ads.AdWords.v201809.Campaign.urlCustomParameters
getset

A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. This field can be selected using the value "UrlCustomParameters". This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN.

VanityPharma Google.Api.Ads.AdWords.v201809.Campaign.vanityPharma
getset

Describes how unbranded pharma ads will be displayed. This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN.


The documentation for this class was generated from the following file: