AdWords API

Feedback on this document

type Campaign (v201209)

Service

CampaignService MutateJobService

Dependencies

CampaignOperation Operand

▼

Campaign

Data representing an AdWords campaign.

Namespace

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

Fields

id
name
status
servingStatus
startDate
endDate
budget
biddingStrategy
conversionOptimizerEligibility
campaignStats
adServingOptimizationStatus
frequencyCap
settings
networkSetting
forwardCompatibilityMap

Field	Type	Description
id Filterable ReadOnly Required 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 should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored. This field is required and should not be `null` when it is contained within Operators : SET.
name Filterable Selectable StringLength	`xsd:string`	Name of this campaign. On add, defaults to `Campaign #N`. This field can be selected using the value "Name". This field can be filtered on. This string must not be empty.
status Filterable Selectable	`CampaignStatus`	Status of this campaign. On add, defaults to `ACTIVE`. This field can be selected using the value "Status". This field can be filtered on. Enumerations `ACTIVE` Campaign is currently serving ads depending on budget information. `DELETED` Campaign has been deleted. `PAUSED` Campaign has been paused by the user.
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 should not be set. If this field is sent to the API, it will be ignored. 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 `20371231`, 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 active.
biddingStrategy Required	`BiddingStrategy` `BudgetOptimizer` `ConversionOptimizer` `ManualCPC` `ManualCPM` `PercentCPA` `UnknownBiddingStrategy`	Bidding strategy for this campaign. This field is required when adding a new campaign. To change an existing campaign's bidding strategy, use CampaignOperation.biddingTransition. Note that campaigns must meet specific eligibility requirements before they can use the `ConversionOptimizer` bidding strategy. This field is required and should not be `null` when it is contained within Operators : ADD.
conversionOptimizerEligibility ReadOnly	`ConversionOptimizerEligibility`	This field is read only and should not be set. If this field is sent to the API, it will be ignored.
campaignStats ReadOnly	`CampaignStats`	Statistics for this campaign, returned by get() only if requested in the selector. This field is read only and should not be set. If this field is sent to the API, it will be ignored.
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	`FrequencyCap`	Frequency cap for this campaign.
settings Selectable	`Setting[]` `GeoTargetTypeSetting` `KeywordMatchSetting` `RealTimeBiddingSetting` `TargetRestrictSetting` `TargetingSetting` `TrackingSetting`	List of settings for the campaign. This field can be selected using the value "Settings".
networkSetting	`NetworkSetting`	Network settings for the campaign indicating where the campaign will serve.
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.

Last updated October 4, 2012.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.