Campaign

{
  "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)
  },
  "discoveryCampaignSettings": {
    object (DiscoveryCampaignSettings)
  },
  "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)
  },
  "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)
  }
  // End of list of possible types for union field campaign_bidding_strategy.
}

string

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

customers/{customerId}/campaigns/{campaignId}

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.

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.

enum (CampaignStatus)

The status of the campaign.

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

enum (CampaignServingStatus)

Output only. The ad serving status of the campaign.

enum (BiddingStrategySystemStatus)

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

enum (AdServingOptimizationStatus)

The ad serving optimization status of the campaign.

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.

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.

object (CustomParameter)

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

object (LocalServicesCampaignSettings)

The Local Services Campaign related settings.

object (TravelCampaignSettings)

Settings for Travel campaign.

object (DiscoveryCampaignSettings)

Settings for Discovery campaign.

object (RealTimeBiddingSetting)

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

object (NetworkSettings)

The network settings for the campaign.

object (HotelSettingInfo)

Immutable. The hotel setting for the campaign.

object (DynamicSearchAdsSetting)

The setting for controlling Dynamic Search Ads (DSA).

object (ShoppingSetting)

The setting for controlling Shopping campaigns.

object (TargetingSetting)

Setting for targeting related features.

object (GeoTargetTypeSetting)

The setting for ads geotargeting.

object (LocalCampaignSetting)

The setting for local campaign.

object (AppCampaignSetting)

The setting related to App Campaign.

string

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

enum (CampaignExperimentType)

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

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.

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.

object (FrequencyCapEntry)

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

enum (BrandSafetySuitability)

Output only. 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.

object (VanityPharma)

Describes how unbranded pharma ads will be displayed.

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.

object (OptimizationGoalSetting)

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

object (TrackingSetting)

Output only. Campaign-level settings for tracking information.

enum (PaymentMode)

Payment mode for the campaign.

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.

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.

object (PerformanceMaxUpgrade)

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

string (int64 format)

Output only. The ID of the campaign.

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.

string

The URL template for constructing a tracking URL.

object (AudienceSetting)

Immutable. Setting for audience related features.

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.

string

The budget of the campaign.

string

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

string

The campaign group this campaign belongs to.

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.

string

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

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.

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.

string

Immutable. The set of hotel properties for Performance Max for travel goals campaigns.

enum (ListingType)

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

string

Portfolio bidding strategy used by campaign.

object (Commission)

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

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.

object (ManualCpc)

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

object (ManualCpm)

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

object (ManualCpv)

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

object (MaximizeConversions)

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

object (MaximizeConversionValue)

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

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.

object (TargetImpressionShare)

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

object (TargetRoas)

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

object (TargetSpend)

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

object (PercentCpc)

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

object (TargetCpm)

A bidding strategy that automatically optimizes cost per thousand impressions.