type Campaign (v201506)

Service

CampaignService MutateJobService

Dependencies

CampaignOperation CampaignPage CampaignReturnValue

▼

Campaign

Data representing an AdWords campaign.

Namespace

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

Fields

id
name
status
servingStatus
startDate
endDate
budget
conversionOptimizerEligibility
adServingOptimizationStatus
frequencyCap
settings
advertisingChannelType
advertisingChannelSubType
networkSetting
labels
biddingStrategyConfiguration
forwardCompatibilityMap
trackingUrlTemplate
urlCustomParameters

Field	Type	Description
id Filterable ReadOnly Selectable	`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.
name Filterable MatchesRegex Selectable StringLength	`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 Filterable Selectable	`CampaignStatus`	Status of this campaign. On add, defaults to `ENABLED`. This field can be selected using the value "Status". This field can be filtered on. Enumerations `UNKNOWN` Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version. `ENABLED` Campaign is currently serving ads depending on budget information. `PAUSED` Campaign has been paused by the user. `REMOVED` Campaign has been removed.
servingStatus Filterable ReadOnly Selectable	`ServingStatus`	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. 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.
startDate Filterable Selectable	`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 Filterable Selectable	`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.
conversionOptimizerEligibility ReadOnly	`ConversionOptimizerEligibility`	This field is read only and will be ignored when sent to the API.
adServingOptimizationStatus Selectable	`AdServingOptimizationStatus`	Ad serving optimization status. This field can be selected using the value "AdServingOptimizationStatus". 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.
frequencyCap CampaignType	`FrequencyCap`	Frequency cap for this campaign. This field may not be set for campaign channel subtype SEARCH_MOBILE_APP.
settings Selectable	`Setting[]` `DynamicSearchAdsSetting` `GeoTargetTypeSetting` `RealTimeBiddingSetting` `ShoppingSetting` `TrackingSetting`	List of settings for the campaign. This field can be selected using the value "Settings".
advertisingChannelType Filterable ReadOnly Selectable	`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 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. Enumerations `UNKNOWN` Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version. `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.
advertisingChannelSubType Filterable ReadOnly Selectable	`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. 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. Enumerations `UNKNOWN` Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version. `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.
networkSetting	`NetworkSetting`	Network settings for the campaign indicating where the campaign will serve.
labels Filterable ReadOnly Selectable	`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
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 Filterable Selectable	`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.
urlCustomParameters Selectable	`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".

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated July 24, 2015.

Send feedback about...

This page

Documentation feedback

AdWords API

Product feedback