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.

REST Resource: customers.campaigns

Resource: Campaign

A campaign.

JSON representation
{
  "resourceName": string,
  "status": enum (CampaignStatus),
  "servingStatus": enum (CampaignServingStatus),
  "adServingOptimizationStatus": enum (AdServingOptimizationStatus),
  "advertisingChannelType": enum (AdvertisingChannelType),
  "advertisingChannelSubType": enum (AdvertisingChannelSubType),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "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),
  "frequencyCaps": [
    {
      object (FrequencyCapEntry)
    }
  ],
  "videoBrandSafetySuitability": enum (BrandSafetySuitability),
  "vanityPharma": {
    object (VanityPharma)
  },
  "selectiveOptimization": {
    object (SelectiveOptimization)
  },
  "optimizationGoalSetting": {
    object (OptimizationGoalSetting)
  },
  "trackingSetting": {
    object (TrackingSetting)
  },
  "paymentMode": enum (PaymentMode),
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "id": string,
  "name": string,
  "trackingUrlTemplate": string,
  "baseCampaign": string,
  "campaignBudget": string,
  "startDate": string,
  "endDate": string,
  "finalUrlSuffix": string,
  "optimizationScore": number,

  // Union field campaign_bidding_strategy can be only one of the following:
  "biddingStrategy": string,
  "commission": {
    object (Commission)
  },
  "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.

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.

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.

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.

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 budget of the campaign.

startDate

string

The date when campaign started.

endDate

string

The last day of the campaign.

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.

Union field 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:

biddingStrategy

string

Portfolio bidding strategy used by campaign.

commission

object (Commission)

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

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)

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

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 currently serving ads depending on budget information.
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.

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.

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
}
Fields
targetSearchNetwork

boolean

Whether ads will be served on partner sites in the Google googleAds.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.

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 googleAds.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, e.g., "google.com" or "www.google.com".

languageCode

string

Required. The language code specifying the language of the domain, e.g., "en".

feeds[]

string

The list of page feeds 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
{
  "merchantId": string,
  "salesCountry": string,
  "campaignPriority": integer,
  "enableLocal": boolean
}
Fields
merchantId

string (int64 format)

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

salesCountry

string

Immutable. Sales 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.

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.

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 googleAds.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 Google My Business account.
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, i.e. install + selected in-app conversions while achieving or exceeding target return on advertising spend.

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 (e.g. 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 (e.g. impression).

timeUnit

enum (FrequencyCapTimeUnit)

Unit of time the cap is defined at (e.g. 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 (e.g. 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.

FrequencyCapTimeUnit

Unit of time the cap is defined at (e.g. day, week).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DAY The cap would define limit per one day.
WEEK The cap would define limit per one week.
MONTH The cap would define limit per one month.

BrandSafetySuitability

3-Tier brand safety suitability control.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
EXPANDED_INVENTORY This option lets you show ads across all inventory on YouTube and video partners that meet our standards for monetization. This option may be an appropriate choice for brands that want maximum access to the full breadth of videos eligible for ads, including, for example, videos that have strong profanity in the context of comedy or a documentary, or excessive violence as featured in video games.
STANDARD_INVENTORY This option lets you show ads across a wide range of content that's appropriate for most brands, such as popular music videos, documentaries, and movie trailers. The content you can show ads on is based on YouTube's advertiser-friendly content guidelines that take into account, for example, the strength or frequency of profanity, or the appropriateness of subject matter like sensitive events. Ads won't show, for example, on content with repeated strong profanity, strong sexual content, or graphic violence.
LIMITED_INVENTORY This option lets you show ads on a reduced range of content that's appropriate for brands with particularly strict guidelines around inappropriate language and sexual suggestiveness; above and beyond what YouTube's advertiser-friendly content guidelines address. The videos accessible in this sensitive category meet heightened requirements, especially for inappropriate language and sexual suggestiveness. For example, your ads will be excluded from showing on some of YouTube's most popular music videos and other pop culture content across YouTube and Google video partners.

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.

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

string

The selected set of 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.

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 click.
CONVERSION_VALUE Pay per conversion value. This mode is only supported by campaigns with AdvertisingChannelType.HOTEL, BiddingStrategyType.COMMISSION, and BudgetType.HOTEL_ADS_COMMISSION.
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.

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

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

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

ManualCpv

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.

Methods

get

Returns the requested campaign in full detail.

mutate

Creates, updates, or removes campaigns.