Campaign

A campaign.

Fields

resource_name

string

Immutable. The resource name of the campaign. Campaign resource names have the form:

customers/{customer_id}/campaigns/{campaign_id}

id

Int64Value

Output only. The ID of the campaign.

name

StringValue

The name of the campaign.

This field is required and should not be empty when creating new campaigns.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

status

CampaignStatus

The status of the campaign.

When a new campaign is added, the status defaults to ENABLED.

serving_status

CampaignServingStatus

Output only. The ad serving status of the campaign.

ad_serving_optimization_status

AdServingOptimizationStatus

The ad serving optimization status of the campaign.

advertising_channel_type

AdvertisingChannelType

Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings.

This field is required and should not be empty when creating new campaigns.

Can be set only when creating campaigns. After the campaign is created, the field can not be changed.

advertising_channel_sub_type

AdvertisingChannelSubType

Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type.

Can be set only when creating campaigns. After campaign is created, the field can not be changed.

tracking_url_template

StringValue

The URL template for constructing a tracking URL.

url_custom_parameters[]

CustomParameter

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

real_time_bidding_setting

RealTimeBiddingSetting

Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.

network_settings

NetworkSettings

The network settings for the campaign.

hotel_setting

HotelSettingInfo

Immutable. The hotel setting for the campaign.

dynamic_search_ads_setting

DynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA).

shopping_setting

ShoppingSetting

The setting for controlling Shopping campaigns.

targeting_setting

TargetingSetting

Setting for targeting related features.

geo_target_type_setting

GeoTargetTypeSetting

The setting for ads geotargeting.

app_campaign_setting

AppCampaignSetting

The setting related to App Campaign.

labels[]

StringValue

Output only. The resource names of labels attached to this campaign.

experiment_type

CampaignExperimentType

Output only. The type of campaign: normal, draft, or experiment.

base_campaign

StringValue

Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name.

This field is read-only.

campaign_budget

StringValue

The budget of the campaign.

bidding_strategy_type

BiddingStrategyType

Output only. The type of bidding strategy.

A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy.

This field is read-only.

start_date

StringValue

The date when campaign started.

This field must not be used in WHERE clauses.

end_date

StringValue

The date when campaign ended.

This field must not be used in WHERE clauses.

final_url_suffix

StringValue

Suffix used to append query parameters to landing pages that are served with parallel tracking.

frequency_caps[]

FrequencyCapEntry

A list that limits how often each user will see this campaign's ads.

video_brand_safety_suitability

BrandSafetySuitability

Output only. 3-Tier Brand Safety setting for the campaign.

vanity_pharma

VanityPharma

Describes how unbranded pharma ads will be displayed.

selective_optimization

SelectiveOptimization

Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.

tracking_setting

TrackingSetting

Output only. Campaign-level settings for tracking information.

payment_mode

PaymentMode

Payment mode for the campaign.

optimization_score

DoubleValue

Output only. Optimization score of the campaign.

Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential.

See "About optimization score" at https://support.google.com/google-ads/answer/9061546.

This field is read-only.

campaign_bidding_strategy

Union field campaign_bidding_strategy. The bidding strategy for the campaign.

campaign_bidding_strategy. The bidding strategy for the campaign.

Must be either portfolio (created via BiddingStrategy service) or standard, that is embedded into the campaign. campaign_bidding_strategy can be only one of the following:

campaign_bidding_strategy can be only one of the following:

bidding_strategy

StringValue

Portfolio bidding strategy used by campaign.

commission

Commission

Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.

manual_cpc

ManualCpc

Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.

manual_cpm

ManualCpm

Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.

manual_cpv

ManualCpv

Output only. A bidding strategy that pays a configurable amount per video view.

maximize_conversions

MaximizeConversions

Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions given a daily budget.

maximize_conversion_value

MaximizeConversionValue

Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.

target_cpa

TargetCpa

Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

target_impression_share

TargetImpressionShare

Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a desired percentage of impressions.

target_roas

TargetRoas

Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).

target_spend

TargetSpend

Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.

percent_cpc

PercentCpc

Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.

target_cpm

TargetCpm

A bidding strategy that automatically optimizes cost per thousand impressions.