campaign

campaign

Field descriptionThe campaign referenced in the query.
CategoryRESOURCE
Data Type MESSAGE
Type URLcom.google.ads.googleads.v1.resources.Campaign
FilterableFalse
SelectableFalse
SortableFalse
RepeatedFalse
Selectable With
Attribute Resources
Metrics
Segments

campaign.ad_serving_optimization_status

Field descriptionThe ad serving optimization status of the campaign.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.advertising_channel_sub_type

Field descriptionOptional 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.advertising_channel_type

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.app_campaign_setting.app_id

Field descriptionA string that uniquely identifies a mobile application.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.app_campaign_setting.app_store

Field descriptionThe application store that distributes this specific app.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AppCampaignAppStoreEnum.AppCampaignAppStore
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.app_campaign_setting.bidding_strategy_goal_type

Field descriptionRepresents the goal which the bidding strategy of this app campaign should optimize towards.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.base_campaign

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.bidding_strategy

Field descriptionPortfolio bidding strategy used by campaign.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

campaign.bidding_strategy_type

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.BiddingStrategyTypeEnum.BiddingStrategyType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.campaign_budget

Field descriptionThe budget of the campaign.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

campaign.commission.commission_rate_micros

Field descriptionCommission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%).
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.dynamic_search_ads_setting.domain_name

Field descriptionThe Internet domain name that this setting represents, e.g., "google.com" or "www.google.com".
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.dynamic_search_ads_setting.feeds

Field descriptionThe list of page feeds associated with the campaign.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

campaign.dynamic_search_ads_setting.language_code

Field descriptionThe language code specifying the language of the domain, e.g., "en".
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.dynamic_search_ads_setting.use_supplied_urls_only

Field descriptionWhether the campaign uses advertiser supplied URLs exclusively.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.end_date

Field descriptionThe date when campaign ended. This field must not be used in WHERE clauses.
CategoryATTRIBUTE
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableFalse
SelectableTrue
SortableTrue
RepeatedFalse

campaign.experiment_type

Field descriptionThe type of campaign: normal, draft, or experiment.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.CampaignExperimentTypeEnum.CampaignExperimentType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.final_url_suffix

Field descriptionSuffix used to append query parameters to landing pages that are served with parallel tracking.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.frequency_caps

Field descriptionA list that limits how often each user will see this campaign's ads.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.FrequencyCapEntry
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

campaign.geo_target_type_setting.negative_geo_target_type

Field descriptionThe setting used for negative geotargeting in this particular campaign.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.NegativeGeoTargetTypeEnum.NegativeGeoTargetType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.geo_target_type_setting.positive_geo_target_type

Field descriptionThe setting used for positive geotargeting in this particular campaign.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.PositiveGeoTargetTypeEnum.PositiveGeoTargetType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.hotel_setting.hotel_center_id

Field descriptionThe linked Hotel Center account.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.id

Field descriptionThe ID of the campaign.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.labels

Field descriptionThe resource names of labels attached to this campaign.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

campaign.manual_cpc.enhanced_cpc_enabled

Field descriptionWhether bids are to be enhanced based on conversion optimizer data.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.manual_cpm

Field descriptionStandard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.ManualCpm
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

campaign.manual_cpv

Field descriptionA bidding strategy that pays a configurable amount per video view.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.ManualCpv
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

campaign.maximize_conversion_value.target_roas

Field descriptionThe target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
CategoryATTRIBUTE
Data Type DOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.maximize_conversions

Field descriptionStandard Maximize Conversions bidding strategy that automatically maximizes number of conversions given a daily budget.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.MaximizeConversions
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

campaign.name

Field descriptionThe 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.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.network_settings.target_content_network

Field descriptionWhether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.network_settings.target_google_search

Field descriptionWhether ads will be served with google.com search results.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.network_settings.target_partner_search_network

Field descriptionWhether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.network_settings.target_search_network

Field descriptionWhether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.payment_mode

Field descriptionPayment mode for the campaign.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.PaymentModeEnum.PaymentMode
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.percent_cpc.cpc_bid_ceiling_micros

Field descriptionMaximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.percent_cpc.enhanced_cpc_enabled

Field descriptionAdjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.real_time_bidding_setting.opt_in

Field descriptionWhether the campaign is opted in to real-time bidding.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.resource_name

Field descriptionThe resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

campaign.selective_optimization.conversion_actions

Field descriptionThe selected set of conversion actions for optimizing this campaign.
CategoryATTRIBUTE
Data Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

campaign.serving_status

Field descriptionThe ad serving status of the campaign.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.CampaignServingStatusEnum.CampaignServingStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.shopping_setting.campaign_priority

Field descriptionPriority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.
CategoryATTRIBUTE
Data Type INT32
Type URLgoogle.protobuf.Int32Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.shopping_setting.enable_local

Field descriptionWhether to include local products.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.shopping_setting.merchant_id

Field descriptionID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.shopping_setting.sales_country

Field descriptionSales country of products to include in the campaign. This field is required for Shopping campaigns. This field is immutable. This field is optional for non-Shopping campaigns, but it must be equal to 'ZZ' if set.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.start_date

Field descriptionThe date when campaign started. This field must not be used in WHERE clauses.
CategoryATTRIBUTE
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableFalse
SelectableTrue
SortableTrue
RepeatedFalse

campaign.status

Field descriptionThe status of the campaign. When a new campaign is added, the status defaults to ENABLED.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.CampaignStatusEnum.CampaignStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_cpa.cpc_bid_ceiling_micros

Field descriptionMaximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_cpa.cpc_bid_floor_micros

Field descriptionMinimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_cpa.target_cpa_micros

Field descriptionAverage CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_cpm

Field descriptionA bidding strategy that automatically optimizes cost per thousand impressions.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.TargetCpm
FilterableFalse
SelectableTrue
SortableFalse
RepeatedFalse

campaign.target_impression_share.cpc_bid_ceiling_micros

Field descriptionThe highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_impression_share.location

Field descriptionThe targeted location on the search results page.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.TargetImpressionShareLocationEnum.TargetImpressionShareLocation
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_impression_share.location_fraction_micros

Field descriptionThe desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_roas.cpc_bid_ceiling_micros

Field descriptionMaximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_roas.cpc_bid_floor_micros

Field descriptionMinimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_roas.target_roas

Field descriptionRequired. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
CategoryATTRIBUTE
Data Type DOUBLE
Type URLgoogle.protobuf.DoubleValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_spend.cpc_bid_ceiling_micros

Field descriptionMaximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.target_spend.target_spend_micros

Field descriptionThe spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.targeting_setting.target_restrictions

Field descriptionThe per-targeting-dimension setting to restrict the reach of your campaign or ad group.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.TargetRestriction
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

campaign.tracking_setting.tracking_url

Field descriptionThe url used for dynamic tracking.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.tracking_url_template

Field descriptionThe URL template for constructing a tracking URL.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.url_custom_parameters

Field descriptionThe list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.CustomParameter
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

campaign.vanity_pharma.vanity_pharma_display_url_mode

Field descriptionThe display mode for vanity pharma URLs.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.vanity_pharma.vanity_pharma_text

Field descriptionThe text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.VanityPharmaTextEnum.VanityPharmaText
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

campaign.video_brand_safety_suitability

Field description3-Tier Brand Safety setting for the campaign.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

Send feedback about...

Google Ads API
Google Ads API
Need help? Visit our support page.