Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Campaign

Stay organized with collections Save and categorize content based on your preferences.

A campaign.

JSON representation
{
  "resourceName": string,
  "status": enum (CampaignStatus),
  "servingStatus": enum (CampaignServingStatus),
  "adServingOptimizationStatus": enum (AdServingOptimizationStatus),
  "advertisingChannelType": enum (AdvertisingChannelType),
  "advertisingChannelSubType": enum (AdvertisingChannelSubType),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "localServicesCampaignSettings": {
    object (LocalServicesCampaignSettings)
  },
  "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)
  ],
  "performanceMaxUpgrade": {
    object (PerformanceMaxUpgrade)
  },
  "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,

  // 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)
  }
  // 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}

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.

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.

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 googleAds.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)

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

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.

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.

performanceMaxUpgrade

object (PerformanceMaxUpgrade)

Output only. Information about campaigns being upgraded to Performance Max.

id