My favorites | English | Sign in

Documentation for the requested version is not available.Documentation for the requested diff is not available.

Campaign

Link to this version

Data structure that represents an AdWords campaign. For more information on how Campaign objects are used, see the CampaignService overview.

Fields

budgetAmount long
Amount of the budget in micros. Use budgetPeriod to set the duration over which to spend this amount.
budgetOptimizerSettings BudgetOptimizerSettings
Budget Optimizer settings for this campaign.
budgetPeriod BudgetPeriod
Duration over which to spend the budgetAmount. For most developers, «Daily» is the only allowable option.

Values are:

  • Daily - Indicates a daily base budget.
  • Monthly - Indicates a monthly base budget (available only to a limited set of developers).

contentTargeting ContentTargeting
If this campaign targets the Content Network, this field controls how ads are considered for display on the content network.

Values are:

  • AllPlacements - Indicates that keyword criteria will be used to target all relevant content network placements in addition to those specified. This is the default value for campaigns started with Keyword criteria.
  • SelectedPlacements - Indicates that only placements specified in the Campaign will be considered when serving ads on the content network. This is the default value for campaigns started with Website criteria.

conversionOptimizerSettings ConversionOptimizerSettings
Conversion Optimizer settings for this campaign.
enableSeparateContentBids boolean
Enables ad groups to have a separate CPC bid for contextually-targeted content network ads.
endDay date
Last day the campaign will run (xsd:date). This field is mutable. New values must be one of the following:
  • In the future and no later than 2036-12-31
  • 2037-12-30 (a special date that indicates the campaign will not end).

If endDay is omitted when creating a campaign, CampaignService sets this field to 2037-12-30.

geoTargeting GeoTarget
Geographic targeting rules for this campaign.
id int
Numeric identifier of this campaign. This is globally unique and not mutable once assigned.
languageTargeting LanguageTarget
Languages targeted by this campaign.
name string
Human-readable name of this campaign. All AdWords campaigns associated with the same customer will have different names.
networkTargeting NetworkTarget
Advertising networks targeted by this campaign.

Note: If this campaign targets the Search Network or Google Search, it must use CPC (cost per click) bidding.

schedule AdSchedule
Ad scheduling settings for this campaign.
startDay date
Day the campaign begins.

When creating a campaign, if startDay is omitted, CampaignService sets this field to the current day in the parent account's local timezone.

status CampaignStatus
Status of this campaign. Values are:
  • Active - The campaign is currently running.
  • Pending - The campaign's start date has not yet been reached.
  • Ended - The campaign's end date has been reached.
  • Paused - The customer has paused the campaign.
  • Deleted - The customer has deleted the campaign.
  • Suspended - Google has temporarily suspended the campaign.

Campaigns can be created in the «Active» or «Paused» state, and can later be switched to either of these states. You can recover a deleted campaign by setting its status to «Active» or «Paused».

Note: The values «Pending», «Ended», and «Suspended» can only be set by Google. If a campaign is in one of these states, you cannot change the status.

Note: Deleted or paused campaigns do not count towards the cap on maximum campaigns per account.