Campaign

A campaign.

JSON representation 
{
  "resourceName": string,
  "primaryStatus": enum (CampaignPrimaryStatus),
  "primaryStatusReasons": [
    enum (CampaignPrimaryStatusReason)
  ],
  "status": enum (CampaignStatus),
  "servingStatus": enum (CampaignServingStatus),
  "biddingStrategySystemStatus": enum (BiddingStrategySystemStatus),
  "adServingOptimizationStatus": enum (AdServingOptimizationStatus),
  "advertisingChannelType": enum (AdvertisingChannelType),
  "advertisingChannelSubType": enum (AdvertisingChannelSubType),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "localServicesCampaignSettings": {
    object (LocalServicesCampaignSettings)
  },
  "travelCampaignSettings": {
    object (TravelCampaignSettings)
  },
  "demandGenCampaignSettings": {
    object (DemandGenCampaignSettings)
  },
  "videoCampaignSettings": {
    object (VideoCampaignSettings)
  },
  "realTimeBiddingSetting": {
    object (RealTimeBiddingSetting)
  },
  "networkSettings": {
    object (NetworkSettings)
  },
  "hotelSetting": {
    object (HotelSettingInfo)
  },
  "dynamicSearchAdsSetting": {
    object (DynamicSearchAdsSetting)
  },
  "shoppingSetting": {
    object (ShoppingSetting)
  },
  "targetingSetting": {
    object (TargetingSetting)
  },
  "geoTargetTypeSetting": {
    object (GeoTargetTypeSetting)
  },
  "localCampaignSetting": {
    object (LocalCampaignSetting)
  },
  "appCampaignSetting": {
    object (AppCampaignSetting)
  },
  "labels": [
    string
  ],
  "experimentType": enum (CampaignExperimentType),
  "biddingStrategyType": enum (BiddingStrategyType),
  "accessibleBiddingStrategy": string,
  "frequencyCaps": [
    {
      object (FrequencyCapEntry)
    }
  ],
  "videoBrandSafetySuitability": enum (BrandSafetySuitability),
  "vanityPharma": {
    object (VanityPharma)
  },
  "selectiveOptimization": {
    object (SelectiveOptimization)
  },
  "optimizationGoalSetting": {
    object (OptimizationGoalSetting)
  },
  "trackingSetting": {
    object (TrackingSetting)
  },
  "paymentMode": enum (PaymentMode),
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "excludedParentAssetSetTypes": [
    enum (AssetSetType)
  ],
  "performanceMaxUpgrade": {
    object (PerformanceMaxUpgrade)
  },
  "assetAutomationSettings": [
    {
      object (AssetAutomationSetting)
    }
  ],
  "keywordMatchType": enum (CampaignKeywordMatchType),
  "id": string,
  "name": string,
  "trackingUrlTemplate": string,
  "audienceSetting": {
    object (AudienceSetting)
  },
  "baseCampaign": string,
  "campaignBudget": string,
  "startDate": string,
  "campaignGroup": string,
  "endDate": string,
  "finalUrlSuffix": string,
  "optimizationScore": number,
  "urlExpansionOptOut": boolean,
  "hotelPropertyAssetSet": string,
  "listingType": enum (ListingType),

  // Union field campaign_bidding_strategy can be only one of the following:
  "biddingStrategy": string,
  "commission": {
    object (Commission)
  },
  "manualCpa": {
    object (ManualCpa)
  },
  "manualCpc": {
    object (ManualCpc)
  },
  "manualCpm": {
    object (ManualCpm)
  },
  "manualCpv": {
    object (ManualCpv)
  },
  "maximizeConversions": {
    object (MaximizeConversions)
  },
  "maximizeConversionValue": {
    object (MaximizeConversionValue)
  },
  "targetCpa": {
    object (TargetCpa)
  },
  "targetImpressionShare": {
    object (TargetImpressionShare)
  },
  "targetRoas": {
    object (TargetRoas)
  },
  "targetSpend": {
    object (TargetSpend)
  },
  "percentCpc": {
    object (PercentCpc)
  },
  "targetCpm": {
    object (TargetCpm)
  },
  "fixedCpm": {
    object (FixedCpm)
  },
  "targetCpv": {
    object (TargetCpv)
  }
  // End of list of possible types for union field campaign_bidding_strategy.
}
Fields
resourceName

string

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

customers/{customerId}/campaigns/{campaignId}
primaryStatus

enum (CampaignPrimaryStatus)

Output only. The primary status of the campaign.

Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.
primaryStatusReasons[]

enum (CampaignPrimaryStatusReason)

Output only. The primary status reasons of the campaign.

Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus.
status

enum (CampaignStatus)

The status of the campaign.

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

enum (CampaignServingStatus)

Output only. The ad serving status of the campaign.
biddingStrategySystemStatus

enum (BiddingStrategySystemStatus)

Output only. The system status of the campaign's bidding strategy.
adServingOptimizationStatus

enum (AdServingOptimizationStatus)

The ad serving optimization status of the campaign.
advertisingChannelType

enum (AdvertisingChannelType)

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

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.
advertisingChannelSubType

enum (AdvertisingChannelSubType)

Immutable. Optional refinement to advertisingChannelType. 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.
urlCustomParameters[]

object (CustomParameter)

The list of mappings used to substitute custom parameter tags in a trackingUrlTemplate, finalUrls, or mobile_final_urls.
localServicesCampaignSettings

object (LocalServicesCampaignSettings)

The Local Services Campaign related settings.
travelCampaignSettings

object (TravelCampaignSettings)

Settings for Travel campaign.
demandGenCampaignSettings

object (DemandGenCampaignSettings)

Settings for Demand Gen campaign.
videoCampaignSettings

object (VideoCampaignSettings)

Settings for Video campaign.
realTimeBiddingSetting

object (RealTimeBiddingSetting)

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

object (NetworkSettings)

The network settings for the campaign.
hotelSetting

object (HotelSettingInfo)

Immutable. The hotel setting for the campaign.
dynamicSearchAdsSetting

object (DynamicSearchAdsSetting)

The setting for controlling Dynamic Search Ads (DSA).
shoppingSetting

object (ShoppingSetting)

The setting for controlling Shopping campaigns.
targetingSetting

object (TargetingSetting)

Setting for targeting related features.
geoTargetTypeSetting

object (GeoTargetTypeSetting)

The setting for ads geotargeting.
localCampaignSetting

object (LocalCampaignSetting)

The setting for local campaign.
appCampaignSetting

object (AppCampaignSetting)

The setting related to App Campaign.
labels[]

string

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

enum (CampaignExperimentType)

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

enum (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 biddingStrategy field to create a portfolio bidding strategy.

This field is read-only.
accessibleBiddingStrategy

string

Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'biddingStrategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.
frequencyCaps[]

object (FrequencyCapEntry)

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

enum (BrandSafetySuitability)

Brand Safety setting at the individual campaign level. Allows for selecting an inventory type to show your ads on content that is the right fit for your brand. See https://support.google.com/google-ads/answer/7515513.
vanityPharma

object (VanityPharma)

Describes how unbranded pharma ads will be displayed.
selectiveOptimization

object (SelectiveOptimization)

Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.
optimizationGoalSetting

object (OptimizationGoalSetting)

Optimization goal setting for this campaign, which includes a set of optimization goal types.
trackingSetting

object (TrackingSetting)

Output only. Campaign-level settings for tracking information.
paymentMode

enum (PaymentMode)

Payment mode for the campaign.
excludedParentAssetFieldTypes[]

enum (AssetFieldType)

The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.
excludedParentAssetSetTypes[]

enum (AssetSetType)

The asset set types that should be excluded from this campaign. Asset set links with these types will not be inherited by this campaign from the upper level. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this campaign, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this campaign. Only LOCATION_SYNC is currently supported.
performanceMaxUpgrade

object (PerformanceMaxUpgrade)

Output only. Information about campaigns being upgraded to Performance Max.
assetAutomationSettings[]

object (AssetAutomationSetting)

Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
keywordMatchType

enum (CampaignKeywordMatchType)

Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
id

string (int64 format)

Output only. The ID of the campaign.
name

string

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.
trackingUrlTemplate

string

The URL template for constructing a tracking URL.
audienceSetting

object (AudienceSetting)

Immutable. Setting for audience related features.
baseCampaign

string

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

This field is read-only.
campaignBudget

string

The resource name of the campaign budget of the campaign.
startDate

string

The date when campaign started in serving customer's timezone in YYYY-MM-DD format.
campaignGroup

string

The resource name of the campaign group that this campaign belongs to.
endDate

string

The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.
finalUrlSuffix

string

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

number

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. This field is null for unscored campaigns.

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

This field is read-only.
urlExpansionOptOut

boolean

Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.
hotelPropertyAssetSet

string

Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
listingType

enum (ListingType)

Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.

Union field campaign_bidding_strategy. The bidding strategy for the campaign.

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

string

The resource name of the portfolio bidding strategy used by the campaign.
commission

object (Commission)

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

object (ManualCpa)

Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.
manualCpc

object (ManualCpc)

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

object (ManualCpm)

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

object (ManualCpv)

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

object (MaximizeConversions)

Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
maximizeConversionValue

object (MaximizeConversionValue)

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

object (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.
targetImpressionShare

object (TargetImpressionShare)

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

object (TargetRoas)

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

object (TargetSpend)

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

object (PercentCpc)

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

object (TargetCpm)

A bidding strategy that automatically optimizes cost per thousand impressions.
fixedCpm

object (FixedCpm)

A manual bidding strategy with a fixed CPM.
targetCpv

object (TargetCpv)

An automated bidding strategy that sets bids to optimize performance given the target CPV you set.

CampaignPrimaryStatus

Enum describing the possible campaign primary status. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ELIGIBLE The campaign is eligible to serve.
PAUSED The user-specified campaign status is paused.
REMOVED The user-specified campaign status is removed.
ENDED The user-specified time for this campaign to end has passed.
PENDING The campaign may serve in the future.
MISCONFIGURED The campaign or its associated entities have incorrect user-specified settings.
LIMITED The campaign or its associated entities are limited by user-specified settings.
LEARNING The automated bidding system is adjusting to user-specified changes to the campaign or associated entities.
NOT_ELIGIBLE The campaign is not eligible to serve.

CampaignPrimaryStatusReason

Enum describing the possible campaign primary status reasons. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall campaign primary status.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CAMPAIGN_REMOVED The user-specified campaign status is removed.
CAMPAIGN_PAUSED The user-specified campaign status is paused.
CAMPAIGN_PENDING The user-specified time for this campaign to start is in the future.
CAMPAIGN_ENDED The user-specified time for this campaign to end has passed.
CAMPAIGN_DRAFT The campaign is a draft.
BIDDING_STRATEGY_MISCONFIGURED The bidding strategy has incorrect user-specified settings.
BIDDING_STRATEGY_LIMITED The bidding strategy is limited by user-specified settings such as lack of data or similar.
BIDDING_STRATEGY_LEARNING The automated bidding system is adjusting to user-specified changes to the bidding strategy.
BIDDING_STRATEGY_CONSTRAINED Campaign could capture more conversion value by adjusting CPA/ROAS targets.
BUDGET_CONSTRAINED The budget is limiting the campaign's ability to serve.
BUDGET_MISCONFIGURED The budget has incorrect user-specified settings.
SEARCH_VOLUME_LIMITED Campaign is not targeting all relevant queries.
AD_GROUPS_PAUSED The user-specified ad group statuses are all paused.
NO_AD_GROUPS No eligible ad groups exist in this campaign.
KEYWORDS_PAUSED The user-specified keyword statuses are all paused.
NO_KEYWORDS No eligible keywords exist in this campaign.
AD_GROUP_ADS_PAUSED The user-specified ad group ad statuses are all paused.
NO_AD_GROUP_ADS No eligible ad group ads exist in this campaign.
HAS_ADS_LIMITED_BY_POLICY At least one ad in this campaign is limited by policy.
HAS_ADS_DISAPPROVED At least one ad in this campaign is disapproved.
MOST_ADS_UNDER_REVIEW Most ads in this campaign are pending review.
MISSING_LEAD_FORM_EXTENSION The campaign has a lead form goal, and the lead form extension is missing.
MISSING_CALL_EXTENSION The campaign has a call goal, and the call extension is missing.
LEAD_FORM_EXTENSION_UNDER_REVIEW The lead form extension is under review.
LEAD_FORM_EXTENSION_DISAPPROVED The lead extension is disapproved.
CALL_EXTENSION_UNDER_REVIEW The call extension is under review.
CALL_EXTENSION_DISAPPROVED The call extension is disapproved.
NO_MOBILE_APPLICATION_AD_GROUP_CRITERIA No eligible mobile application ad group criteria exist in this campaign.
CAMPAIGN_GROUP_PAUSED The user-specified campaign group status is paused.
CAMPAIGN_GROUP_ALL_GROUP_BUDGETS_ENDED The user-specified times of all group budgets associated with the parent campaign group has passed.
APP_NOT_RELEASED The app associated with this ACi campaign is not released in the target countries of the campaign.
APP_PARTIALLY_RELEASED The app associated with this ACi campaign is partially released in the target countries of the campaign.
HAS_ASSET_GROUPS_DISAPPROVED At least one asset group in this campaign is disapproved.
HAS_ASSET_GROUPS_LIMITED_BY_POLICY At least one asset group in this campaign is limited by policy.
MOST_ASSET_GROUPS_UNDER_REVIEW Most asset groups in this campaign are pending review.
NO_ASSET_GROUPS No eligible asset groups exist in this campaign.
ASSET_GROUPS_PAUSED All asset groups in this campaign are paused.

CampaignStatus

Possible statuses of a campaign.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Campaign is active and can show ads.
PAUSED Campaign has been paused by the user.
REMOVED Campaign has been removed.

CampaignServingStatus

Possible serving statuses of a campaign.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
SERVING Serving.
NONE None.
ENDED Ended.
PENDING Pending.
SUSPENDED Suspended.

BiddingStrategySystemStatus

The possible system statuses of a BiddingStrategy.

Enums
UNSPECIFIED Signals that an unexpected error occurred, for example, no bidding strategy type was found, or no status information was found.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The bid strategy is active, and AdWords cannot find any specific issues with the strategy.
LEARNING_NEW The bid strategy is learning because it has been recently created or recently reactivated.
LEARNING_SETTING_CHANGE The bid strategy is learning because of a recent setting change.
LEARNING_BUDGET_CHANGE The bid strategy is learning because of a recent budget change.
LEARNING_COMPOSITION_CHANGE The bid strategy is learning because of recent change in number of campaigns, ad groups or keywords attached to it.
LEARNING_CONVERSION_TYPE_CHANGE The bid strategy depends on conversion reporting and the customer recently modified conversion types that were relevant to the bid strategy.
LEARNING_CONVERSION_SETTING_CHANGE The bid strategy depends on conversion reporting and the customer recently changed their conversion settings.
LIMITED_BY_CPC_BID_CEILING The bid strategy is limited by its bid ceiling.
LIMITED_BY_CPC_BID_FLOOR The bid strategy is limited by its bid floor.
LIMITED_BY_DATA The bid strategy is limited because there was not enough conversion traffic over the past weeks.
LIMITED_BY_BUDGET A significant fraction of keywords in this bid strategy are limited by budget.
LIMITED_BY_LOW_PRIORITY_SPEND The bid strategy cannot reach its target spend because its spend has been de-prioritized.
LIMITED_BY_LOW_QUALITY A significant fraction of keywords in this bid strategy have a low Quality Score.
LIMITED_BY_INVENTORY The bid strategy cannot fully spend its budget because of narrow targeting.
MISCONFIGURED_ZERO_ELIGIBILITY Missing conversion tracking (no pings present) and/or remarketing lists for SSC.
MISCONFIGURED_CONVERSION_TYPES The bid strategy depends on conversion reporting and the customer is lacking conversion types that might be reported against this strategy.
MISCONFIGURED_CONVERSION_SETTINGS The bid strategy depends on conversion reporting and the customer's conversion settings are misconfigured.
MISCONFIGURED_SHARED_BUDGET There are campaigns outside the bid strategy that share budgets with campaigns included in the strategy.
MISCONFIGURED_STRATEGY_TYPE The campaign has an invalid strategy type and is not serving.
PAUSED The bid strategy is not active. Either there are no active campaigns, ad groups or keywords attached to the bid strategy. Or there are no active budgets connected to the bid strategy.
UNAVAILABLE This bid strategy currently does not support status reporting.
MULTIPLE_LEARNING There were multiple LEARNING_* system statuses for this bid strategy during the time in question.
MULTIPLE_LIMITED There were multiple LIMITED_* system statuses for this bid strategy during the time in question.
MULTIPLE_MISCONFIGURED There were multiple MISCONFIGURED_* system statuses for this bid strategy during the time in question.
MULTIPLE There were multiple system statuses for this bid strategy during the time in question.

AdServingOptimizationStatus

Enum describing possible serving statuses.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
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.

LocalServicesCampaignSettings

Settings for LocalServicesCampaign subresource.

JSON representation 
{
  "categoryBids": [
    {
      object (CategoryBid)
    }
  ]
}
Fields
categoryBids[]

object (CategoryBid)

Categorical level bids associated with MANUAL_CPA bidding strategy.

CategoryBid

Category bids in LocalServicesReportingCampaignSettings.

JSON representation 
{
  "categoryId": string,
  "manualCpaBidMicros": string
}
Fields
categoryId

string

Category for which the bid will be associated with. For example, xcat:service_area_business_plumber.
manualCpaBidMicros

string (int64 format)

Manual CPA bid for the category. Bid must be greater than the reserve price associated for that category. Value is in micros and in the advertiser's currency.

TravelCampaignSettings

Settings for Travel campaign.

JSON representation 
{
  "travelAccountId": string
}
Fields
travelAccountId

string (int64 format)

Immutable. The Travel account ID associated with the Travel campaign.

DemandGenCampaignSettings

Settings for Demand Gen campaign.

JSON representation 
{
  "upgradedTargeting": boolean
}
Fields
upgradedTargeting

boolean

Immutable. Specifies whether this campaign uses upgraded targeting options. When this field is set to true, you can use location and language targeting at the ad group level as opposed to the standard campaign-level targeting. This field defaults to false, and can only be set when creating a campaign.

VideoCampaignSettings

Settings for Video campaign.

JSON representation 
{
  "videoAdInventoryControl": {
    object (VideoAdInventoryControl)
  }
}
Fields
videoAdInventoryControl

object (VideoAdInventoryControl)

Inventory control for responsive ad containers in reach campaigns.

VideoAdInventoryControl

For campaigns using responsive ad containers inventory controls determine on which inventories the ads can be shown. This only applies for campaigns with the bidding strategies TARGET_CPM and FIXED_CPM.

JSON representation 
{
  "allowInStream": boolean,
  "allowInFeed": boolean,
  "allowShorts": boolean
}
Fields
allowInStream

boolean

Determine if VideoResponsiveAds can be used for in-stream video ads.
allowInFeed

boolean

Determine if VideoResponsiveAds can be used for in-feed video ads.
allowShorts

boolean

Determine if VideoResponsiveAds can be used as shorts format.

RealTimeBiddingSetting

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

JSON representation 
{
  "optIn": boolean
}
Fields
optIn

boolean

Whether the campaign is opted in to real-time bidding.

NetworkSettings

The network settings for the campaign.

JSON representation 
{
  "targetGoogleSearch": boolean,
  "targetSearchNetwork": boolean,
  "targetContentNetwork": boolean,
  "targetPartnerSearchNetwork": boolean,
  "targetYoutube": boolean,
  "targetGoogleTvNetwork": boolean
}
Fields
targetSearchNetwork

boolean

Whether ads will be served on partner sites in the Google Search Network (requires targetGoogleSearch to also be true).
targetContentNetwork

boolean

Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
targetPartnerSearchNetwork

boolean

Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
targetYoutube

boolean

Whether ads will be served on YouTube.
targetGoogleTvNetwork

boolean

Whether ads will be served on the Google TV network.

HotelSettingInfo

Campaign-level settings for hotel ads.

JSON representation 
{
  "hotelCenterId": string
}
Fields
hotelCenterId

string (int64 format)

Immutable. The linked Hotel Center account.

DynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA).

JSON representation 
{
  "domainName": string,
  "languageCode": string,
  "feeds": [
    string
  ],
  "useSuppliedUrlsOnly": boolean
}
Fields
domainName

string

Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
languageCode

string

Required. The language code specifying the language of the domain, for example, "en".
feeds[]

string

The list of resource names of page feed assets associated with the campaign.
useSuppliedUrlsOnly

boolean

Whether the campaign uses advertiser supplied URLs exclusively.

ShoppingSetting

The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns.

JSON representation 
{
  "feedLabel": string,
  "useVehicleInventory": boolean,
  "advertisingPartnerIds": [
    string
  ],
  "merchantId": string,
  "campaignPriority": integer,
  "enableLocal": boolean,
  "disableProductFeed": boolean
}
Fields
feedLabel

string

Feed label of products to include in the campaign. Only one of feedLabel or sales_country can be set. If used instead of sales_country, the feedLabel field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.
useVehicleInventory

boolean

Immutable. Whether to target Vehicle Listing inventory. This field is supported only in Smart Shopping Campaigns. For setting Vehicle Listing inventory in Performance Max campaigns, use listingType instead.
advertisingPartnerIds[]

string (int64 format)

Immutable. The ads account IDs of advertising partners cooperating within the campaign.
merchantId

string (int64 format)

ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
campaignPriority

integer

Priority 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.
enableLocal

boolean

Whether to include local products.
disableProductFeed

boolean

Disable the optional product feed. This field is currently supported only for Demand Gen campaigns. See https://support.google.com/google-ads/answer/13721750 to learn more about this feature.

AudienceSetting

Settings for the audience targeting.

JSON representation 
{
  "useAudienceGrouped": boolean
}
Fields
useAudienceGrouped

boolean

Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.

GeoTargetTypeSetting

Represents a collection of settings related to ads geotargeting.

JSON representation 
{
  "positiveGeoTargetType": enum (PositiveGeoTargetType),
  "negativeGeoTargetType": enum (NegativeGeoTargetType)
}
Fields
positiveGeoTargetType

enum (PositiveGeoTargetType)

The setting used for positive geotargeting in this particular campaign.
negativeGeoTargetType

enum (NegativeGeoTargetType)

The setting used for negative geotargeting in this particular campaign.

PositiveGeoTargetType

The possible positive geo target types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
PRESENCE_OR_INTEREST Specifies that an ad is triggered if the user is in, or shows interest in, advertiser's targeted locations.
SEARCH_INTEREST Specifies that an ad is triggered if the user searches for advertiser's targeted locations. This can only be used with Search and standard Shopping campaigns.
PRESENCE Specifies that an ad is triggered if the user is in or regularly in advertiser's targeted locations.

NegativeGeoTargetType

The possible negative geo target types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
PRESENCE_OR_INTEREST Specifies that a user is excluded from seeing the ad if they are in, or show interest in, advertiser's excluded locations.
PRESENCE Specifies that a user is excluded from seeing the ad if they are in advertiser's excluded locations.

LocalCampaignSetting

Campaign setting for local campaigns.

JSON representation 
{
  "locationSourceType": enum (LocationSourceType)
}
Fields
locationSourceType

enum (LocationSourceType)

The location source type for this local campaign.

LocationSourceType

The possible types of a location source.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
GOOGLE_MY_BUSINESS Locations associated with the customer's linked Business Profile.
AFFILIATE Affiliate (chain) store locations. For example, Best Buy store locations.

AppCampaignSetting

Campaign-level settings for App Campaigns.

JSON representation 
{
  "biddingStrategyGoalType": enum (AppCampaignBiddingStrategyGoalType),
  "appStore": enum (AppCampaignAppStore),
  "appId": string
}
Fields
biddingStrategyGoalType

enum (AppCampaignBiddingStrategyGoalType)

Represents the goal which the bidding strategy of this app campaign should optimize towards.
appStore

enum (AppCampaignAppStore)

Immutable. The application store that distributes this specific app.
appId

string

Immutable. A string that uniquely identifies a mobile application.

AppCampaignBiddingStrategyGoalType

Goal type of App campaign BiddingStrategy.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
OPTIMIZE_INSTALLS_TARGET_INSTALL_COST Aim to maximize the number of app installs. The cpa bid is the target cost per install.
OPTIMIZE_IN_APP_CONVERSIONS_TARGET_INSTALL_COST Aim to maximize the long term number of selected in-app conversions from app installs. The cpa bid is the target cost per install.
OPTIMIZE_IN_APP_CONVERSIONS_TARGET_CONVERSION_COST Aim to maximize the long term number of selected in-app conversions from app installs. The cpa bid is the target cost per in-app conversion. Note that the actual cpa may seem higher than the target cpa at first, since the long term conversions haven't happened yet.
OPTIMIZE_RETURN_ON_ADVERTISING_SPEND Aim to maximize all conversions' value, for example, install + selected in-app conversions while achieving or exceeding target return on advertising spend.
OPTIMIZE_PRE_REGISTRATION_CONVERSION_VOLUME Aim to maximize the pre-registration of the app.
OPTIMIZE_INSTALLS_WITHOUT_TARGET_INSTALL_COST Aim to maximize installation of the app without target cost-per-install.

AppCampaignAppStore

Enum describing app campaign app store.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
APPLE_APP_STORE Apple app store.
GOOGLE_APP_STORE Google play.

CampaignExperimentType

Indicates if this campaign is a normal campaign, a draft campaign, or an experiment campaign.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BASE This is a regular campaign.
DRAFT This is a draft version of a campaign. It has some modifications from a base campaign, but it does not serve or accrue metrics.
EXPERIMENT This is an experiment version of a campaign. It has some modifications from a base campaign, and a percentage of traffic is being diverted from the BASE campaign to this experiment campaign.

FrequencyCapEntry

A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.

JSON representation 
{
  "key": {
    object (FrequencyCapKey)
  },
  "cap": integer
}
Fields
key

object (FrequencyCapKey)

The key of a particular frequency cap. There can be no more than one frequency cap with the same key.
cap

integer

Maximum number of events allowed during the time range by this cap.

FrequencyCapKey

A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key.

JSON representation 
{
  "level": enum (FrequencyCapLevel),
  "eventType": enum (FrequencyCapEventType),
  "timeUnit": enum (FrequencyCapTimeUnit),
  "timeLength": integer
}
Fields
level

enum (FrequencyCapLevel)

The level on which the cap is to be applied (for example, ad group ad, ad group). The cap is applied to all the entities of this level.
eventType

enum (FrequencyCapEventType)

The type of event that the cap applies to (for example, impression).
timeUnit

enum (FrequencyCapTimeUnit)

Unit of time the cap is defined at (for example, day, week).
timeLength

integer

Number of time units the cap lasts.

FrequencyCapLevel

The level on which the cap is to be applied (e.g ad group ad, ad group). Cap is applied to all the resources of this level.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AD_GROUP_AD The cap is applied at the ad group ad level.
AD_GROUP The cap is applied at the ad group level.
CAMPAIGN The cap is applied at the campaign level.

FrequencyCapEventType

The type of event that the cap applies to (for example, impression).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
IMPRESSION The cap applies on ad impressions.
VIDEO_VIEW The cap applies on video ad views.

VanityPharma

Describes how unbranded pharma ads will be displayed.

JSON representation 
{
  "vanityPharmaDisplayUrlMode": enum (VanityPharmaDisplayUrlMode),
  "vanityPharmaText": enum (VanityPharmaText)
}
Fields
vanityPharmaDisplayUrlMode

enum (VanityPharmaDisplayUrlMode)

The display mode for vanity pharma URLs.
vanityPharmaText

enum (VanityPharmaText)

The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.

VanityPharmaDisplayUrlMode

Enum describing possible display modes for vanity pharma URLs.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MANUFACTURER_WEBSITE_URL Replace vanity pharma URL with manufacturer website url.
WEBSITE_DESCRIPTION Replace vanity pharma URL with description of the website.

VanityPharmaText

Enum describing possible text.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PRESCRIPTION_TREATMENT_WEBSITE_EN Prescription treatment website with website content in English.
PRESCRIPTION_TREATMENT_WEBSITE_ES Prescription treatment website with website content in Spanish (Sitio de tratamientos con receta).
PRESCRIPTION_DEVICE_WEBSITE_EN Prescription device website with website content in English.
PRESCRIPTION_DEVICE_WEBSITE_ES Prescription device website with website content in Spanish (Sitio de dispositivos con receta).
MEDICAL_DEVICE_WEBSITE_EN Medical device website with website content in English.
MEDICAL_DEVICE_WEBSITE_ES Medical device website with website content in Spanish (Sitio de dispositivos médicos).
PREVENTATIVE_TREATMENT_WEBSITE_EN Preventative treatment website with website content in English.
PREVENTATIVE_TREATMENT_WEBSITE_ES Preventative treatment website with website content in Spanish (Sitio de tratamientos preventivos).
PRESCRIPTION_CONTRACEPTION_WEBSITE_EN Prescription contraception website with website content in English.
PRESCRIPTION_CONTRACEPTION_WEBSITE_ES Prescription contraception website with website content in Spanish (Sitio de anticonceptivos con receta).
PRESCRIPTION_VACCINE_WEBSITE_EN Prescription vaccine website with website content in English.
PRESCRIPTION_VACCINE_WEBSITE_ES Prescription vaccine website with website content in Spanish (Sitio de vacunas con receta).

SelectiveOptimization

Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.

JSON representation 
{
  "conversionActions": [
    string
  ]
}
Fields
conversionActions[]

string

The selected set of resource names for conversion actions for optimizing this campaign.

OptimizationGoalSetting

Optimization goal setting for this campaign, which includes a set of optimization goal types.

JSON representation 
{
  "optimizationGoalTypes": [
    enum (OptimizationGoalType)
  ]
}
Fields
optimizationGoalTypes[]

enum (OptimizationGoalType)

The list of optimization goal types.

OptimizationGoalType

The type of optimization goal

Enums
UNSPECIFIED Not specified.
UNKNOWN Used as a return value only. Represents value unknown in this version.
CALL_CLICKS Optimize for call clicks. Call click conversions are times people selected 'Call' to contact a store after viewing an ad.
DRIVING_DIRECTIONS Optimize for driving directions. Driving directions conversions are times people selected 'Get directions' to navigate to a store after viewing an ad.
APP_PRE_REGISTRATION Optimize for pre-registration. Pre-registration conversions are the number of pre-registration signups to receive a notification when the app is released.

TrackingSetting

Campaign-level settings for tracking information.

JSON representation 
{
  "trackingUrl": string
}
Fields
trackingUrl

string

Output only. The url used for dynamic tracking.

PaymentMode

Enum describing possible payment modes.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CLICKS Pay per interaction.
CONVERSION_VALUE Pay per conversion value. This mode is only supported by campaigns with AdvertisingChannelType.HOTEL, BiddingStrategyType.COMMISSION, and BudgetType.STANDARD.
CONVERSIONS Pay per conversion. This mode is only supported by campaigns with AdvertisingChannelType.DISPLAY (excluding AdvertisingChannelSubType.DISPLAY_GMAIL), BiddingStrategyType.TARGET_CPA, and BudgetType.FIXED_CPA. The customer must also be eligible for this mode. See Customer.eligibility_failure_reasons for details.
GUEST_STAY Pay per guest stay value. This mode is only supported by campaigns with AdvertisingChannelType.HOTEL, BiddingStrategyType.COMMISSION, and BudgetType.STANDARD.

PerformanceMaxUpgrade

Information about a campaign being upgraded to Performance Max.

JSON representation 
{
  "performanceMaxCampaign": string,
  "preUpgradeCampaign": string,
  "status": enum (PerformanceMaxUpgradeStatus)
}
Fields
performanceMaxCampaign

string

Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
preUpgradeCampaign

string

Output only. The resource name of the legacy campaign upgraded to Performance Max.
status

enum (PerformanceMaxUpgradeStatus)

Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.

PerformanceMaxUpgradeStatus

Performance Max Upgrade status enum for campaign.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
UPGRADE_IN_PROGRESS The upgrade to a Performance Max campaign is in progress.
UPGRADE_COMPLETE The upgrade to a Performance Max campaign is complete.
UPGRADE_FAILED The upgrade to a Performance Max campaign failed. The campaign will still serve as it was before upgrade was attempted.
UPGRADE_ELIGIBLE The campaign is eligible for upgrade to a Performance Max campaign.

ListingType

Possible listing types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
VEHICLES This campaign serves vehicle ads.

AssetAutomationSetting

Asset automation setting contains pair of AssetAutomationType and the asset automation opt-in/out status

JSON representation 
{
  "assetAutomationType": enum (AssetAutomationType),
  "assetAutomationStatus": enum (AssetAutomationStatus)
}
Fields
assetAutomationType

enum (AssetAutomationType)

The asset automation type advertiser would like to opt-in/out.
assetAutomationStatus

enum (AssetAutomationStatus)

The opt-in/out status of asset automation type.

AssetAutomationType

The type of asset automation.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used as a return value only. Represents value unknown in this version.
TEXT_ASSET_AUTOMATION Text asset automation includes headlines and descriptions. By default, advertisers are opted-in for Performance Max and opted-out for Search.

AssetAutomationStatus

The status of asset automation.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used as a return value only. Represents value unknown in this version.
OPTED_IN Opted-in will enable generating and serving an asset automation type.
OPTED_OUT Opted-out will stop generating and serving an asset automation type.

CampaignKeywordMatchType

Enum describing keyword match type of Campaign.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BROAD Campaign level broad match.

Commission

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

JSON representation 
{
  "commissionRateMicros": string
}
Fields
commissionRateMicros

string (int64 format)

Commission 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%).

ManualCpa

This type has no fields.

Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action.

ManualCpc

Manual click-based bidding where user pays per click.

JSON representation 
{
  "enhancedCpcEnabled": boolean
}
Fields
enhancedCpcEnabled

boolean

Whether bids are to be enhanced based on conversion optimizer data.

ManualCpm

This type has no fields.

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

ManualCpv

This type has no fields.

View based bidding where user pays per video view.

PercentCpc

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

JSON representation 
{
  "cpcBidCeilingMicros": string,
  "enhancedCpcEnabled": boolean
}
Fields
cpcBidCeilingMicros

string (int64 format)

Maximum 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.
enhancedCpcEnabled

boolean

Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpcBidCeilingMicros, but the average bid amount for a campaign should not.

TargetCpm

Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set.

JSON representation 
{

  // Union field goal can be only one of the following:
  "targetFrequencyGoal": {
    object (TargetCpmTargetFrequencyGoal)
  }
  // End of list of possible types for union field goal.
}
Fields
Union field goal. Additional information related to bidding goal. goal can be only one of the following:
targetFrequencyGoal

object (TargetCpmTargetFrequencyGoal)

Target Frequency bidding goal details.

TargetCpmTargetFrequencyGoal

Target Frequency bidding goal details.

JSON representation 
{
  "targetCount": string,
  "timeUnit": enum (TargetFrequencyTimeUnit)
}
Fields
targetCount

string (int64 format)

Target Frequency count representing how many times you want to reach a single user.
timeUnit

enum (TargetFrequencyTimeUnit)

Time window expressing the period over which you want to reach the specified targetCount.

FixedCpm

Fixed CPM (cost per thousand impression) bidding strategy. A manual bidding strategy with a fixed CPM.

JSON representation 
{
  "goal": enum (FixedCpmGoal),

  // Union field goal_info can be only one of the following:
  "targetFrequencyInfo": {
    object (FixedCpmTargetFrequencyGoalInfo)
  }
  // End of list of possible types for union field goal_info.
}
Fields
goal

enum (FixedCpmGoal)

Fixed CPM bidding goal. Determines the exact bidding optimization parameters.
Union field goal_info. Additional information related to bidding goal. goal_info can be only one of the following:
targetFrequencyInfo

object (FixedCpmTargetFrequencyGoalInfo)

Target frequency bidding goal details.

FixedCpmGoal

Enum describing the goal of the Fixed CPM bidding strategy.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
REACH Maximize reach, that is the number of users who saw the ads in this campaign.
TARGET_FREQUENCY Target Frequency CPM bidder. Optimize bidding to reach a single user with the requested frequency.

FixedCpmTargetFrequencyGoalInfo

Target frequency bidding goal details for Fixed CPM bidding strategy. Only relevant if the goal of the bidding strategy is TARGET_FREQUENCY.

JSON representation 
{
  "targetCount": string,
  "timeUnit": enum (FixedCpmTargetFrequencyTimeUnit)
}
Fields
targetCount

string (int64 format)

Target frequency count represents the number of times an advertiser wants to show the ad to target a single user.
timeUnit

enum (FixedCpmTargetFrequencyTimeUnit)

Time window expressing the period over which you want to reach the specified targetCount.

FixedCpmTargetFrequencyTimeUnit

An enum describing the time window over which the bidding is optimized to meet the target frequency when using Fixed CPM bidding strategy.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MONTHLY Optimize bidding to reach target frequency in 30 days.

TargetCpv

This type has no fields.

Target CPV (cost per view) bidding strategy. An automated bidding strategy that sets bids to optimize performance given the target CPV you set.