type Campaign (v201809)

Service

CampaignService

Dependencies

CampaignOperation CampaignPage CampaignReturnValue

▼

Campaign

Data representing an AdWords campaign.

---

Namespace

https://adwords.google.com/api/adwords/cm/v201809

Field
id	xsd:long 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.
campaignGroupId	xsd:long Id of the campaign group this campaign belongs to. This field can be selected using the value "CampaignGroupId". This field can be filtered on.
name	xsd:string 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 '[^\x00\x0A\x0D]*'. This string must not be empty.
status	CampaignStatus Status of this campaign. On add, defaults to ENABLED. Enumerations UNKNOWN ENABLED Campaign is currently serving ads depending on budget information. PAUSED Campaign has been paused by the user. REMOVED Campaign has been removed. This field can be selected using the value "Status". This field can be filtered on.
servingStatus	ServingStatus Serving status. Enumerations SERVING The campaign is currently serving ads. NONE This is the catch-all if none of the other statuses make sense. Such a campaign is not serving, but none of the other statuses are sensible options. ENDED The campaign end date has been past. PENDING The campaign start date has not yet been reached. SUSPENDED The campaign has been suspended probably from lack of allocated funds. 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.
startDate	xsd:string 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.
endDate	xsd:string 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.
budget	Budget 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.
conversionOptimizerEligibility	ConversionOptimizerEligibility This field is read only and will be ignored when sent to the API.
adServingOptimizationStatus	AdServingOptimizationStatus Ad serving optimization status. Enumerations OPTIMIZE Ad serving is optimized based on CTR for the campaign. CONVERSION_OPTIMIZE Ad serving is optimized based on CTR * Conversion for the campaign. If the campaign is not in the conversion optimizer bidding strategy, it will default to OPTIMIZED. ROTATE Ads are rotated evenly for 90 days, then optimized for clicks. ROTATE_INDEFINITELY Show lower performing ads more evenly with higher performing ads, and do not optimize. UNAVAILABLE Ad serving optimization status is not available. UNKNOWN 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.
frequencyCap	FrequencyCap Frequency cap for this campaign. This field may not be set for campaign channel subtypes: DISPLAY_SMART_CAMPAIGN, UNIVERSAL_APP_CAMPAIGN, SEARCH_MOBILE_APP.
settings	Setting[] DynamicSearchAdsSetting GeoTargetTypeSetting UniversalAppCampaignSetting RealTimeBiddingSetting ShoppingSetting TargetingSetting TrackingSetting List of settings for the campaign. This field can be selected using the value "Settings".
advertisingChannelType	AdvertisingChannelType 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 null when it is contained within Operators : ADD Enumerations UNKNOWN SEARCH Search Network. Includes display bundled, and Search+ campaigns. DISPLAY Google Display Network only. SHOPPING Shopping campaigns serve on the shopping property and on google.com search results. MULTI_CHANNEL Universal app campaigns that target multiple channels across search, display, youtube, etc. 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.
advertisingChannelSubType	AdvertisingChannelSubType 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. Enumerations UNKNOWN SEARCH_MOBILE_APP Mobile App Campaigns for Search DISPLAY_MOBILE_APP Mobile App Campaigns for Display SEARCH_EXPRESS AdWords Express campaigns for search. DISPLAY_EXPRESS AdWords Express campaigns for display. UNIVERSAL_APP_CAMPAIGN Campaigns specialized for advertising mobile app installations, that targets multiple advertising channels across search, display and youtube. Google manages the keywords and ads for these campaigns. DISPLAY_SMART_CAMPAIGN Smart display campaign SHOPPING_GOAL_OPTIMIZED_ADS Campaigns specialized for retail advertising, that target multiple advertising channels across Search, Google Display Network, and YouTube. These campaigns optimize automatically towards the retailer's business objectives. DISPLAY_GMAIL_AD Gmail Ad Campaigns 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.
networkSetting	NetworkSetting Network settings for the campaign indicating where the campaign will serve.
labels	Label[] TextLabel 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.
biddingStrategyConfiguration	BiddingStrategyConfiguration 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
campaignTrialType	CampaignTrialType Indicates if this campaign is a normal campaign, a draft campaign, or a trial campaign. Enumerations UNKNOWN Invalid type. Should not be used except for detecting values that are incorrect, or values that are not yet known to the user. BASE This is a regular campaign created by the advertiser. DRAFT This is a draft version of a campaign that is part of a CampaignDraft or a customer-level Draft. It has some modifications from a base campaign, but it does not serve or accrue stats. TRIAL This is a trial version of a campaign. It has some modifications from a base campaign. The type will continue to be TRIAL unless the trial is graduated. The TRIAL type will remain even on trial campaigns which are promoted back to the BASE campaigns. 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.
baseCampaignId	xsd:long 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.
forwardCompatibilityMap	String_StringMapEntry[] 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.
trackingUrlTemplate	xsd:string 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.
finalUrlSuffix	xsd:string 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.
urlCustomParameters	CustomParameters 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	VanityPharma Describes how unbranded pharma ads will be displayed. This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN.
universalAppCampaignInfo	UniversalAppCampaignInfo Stores information specific to Universal App Campaigns. This field may only be set for campaign channel type MULTI_CHANNEL.
selectiveOptimization	SelectiveOptimization 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".