Enables Brand Guidelines for Performance Max campaigns. List of thrown errors: [AuthenticationError]() [AssetError]() [AssetLinkError]() [AuthorizationError]() [BrandGuidelinesMigrationError]() [CampaignError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

Creates, updates, or removes campaigns. Operation statuses are returned. List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]() [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

Method Details

close()

Close httplib2 connections.

enablePMaxBrandGuidelines(customerId, body=None, x__xgafv=None)

Enables Brand Guidelines for Performance Max campaigns. List of thrown errors: [AuthenticationError]() [AssetError]() [AssetLinkError]() [AuthorizationError]() [BrandGuidelinesMigrationError]() [CampaignError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

Args:
  customerId: string, Required. The ID of the customer whose campaigns are being enabled. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request to enable Brand Guidelines for a Performance Max campaign.
  "operations": [ # Required. The list of individual campaign operations. A maximum of 10 enable operations can be executed in a request.
    { # A single enable operation of a campaign.
      "accentColor": "A String", # Optional. Hex code representation of the accent brand color, for example #00ff00. accent_color is required when main_color is specified.
      "autoPopulateBrandAssets": True or False, # Required. The switch to automatically populate top-performing brand assets. This field is required. If true, top-performing brand assets will be automatically populated. If false, the brand_assets field is required.
      "brandAssets": { # Assets linked at the campaign level. A business_name and at least one logo_asset are required. # Optional. The brand assets linked to the campaign. This field is required when the value of auto_populate_brand_assets is false.
        "businessNameAsset": "A String", # Required. The resource name of the business name text asset.
        "landscapeLogoAsset": [ # Optional. The resource name of landscape logo assets.
          "A String",
        ],
        "logoAsset": [ # Required. The resource name of square logo assets.
          "A String",
        ],
      },
      "campaign": "A String", # Required. The resource name of the campaign to enable.
      "finalUriDomain": "A String", # Optional. The domain of the final uri.
      "fontFamily": "A String", # Optional. The font family is specified as a string, and must be one of the following: "Open Sans", "Roboto", "Roboto Slab", "Montserrat", "Poppins", "Lato", "Oswald", or "Playfair Display".
      "mainColor": "A String", # Optional. Hex code representation of the main brand color, for example #00ff00. main_color is required when accent color is specified.
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Brand Guidelines campaign enablement response.
  "results": [ # Campaign enablement results per campaign.
    { # A single enablement result of a campaign.
      "campaign": "A String", # This indicates the campaign for which enablement was tried, regardless of the outcome.
      "enablementError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Details of the error when enablement fails.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
    },
  ],
}

mutate(customerId, body=None, x__xgafv=None)

Args:
customerId: string, Required. The ID of the customer whose campaigns are being modified. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for CampaignService.MutateCampaigns.
"operations": [ # Required. The list of operations to perform on individual campaigns.
{ # A single operation (create, update, remove) on a campaign.
"create": { # A campaign. # Create operation: No resource name is expected for the new campaign.
"accessibleBiddingStrategy": "A String", # Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. 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.
"adServingOptimizationStatus": "A String", # The ad serving optimization status of the campaign.
"advertisingChannelSubType": "A String", # Immutable. Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
"advertisingChannelType": "A String", # Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
"aiMaxSetting": { # Settings for AI Max in search campaigns. # Settings for AI Max in search campaigns.
"bundlingRequired": "A String", # Output only. Indicates whether a search campaign has adopted AI Max before, and is required to have AI Max enabled to adopt campaign-level text asset automation and brand list targeting in all API versions.
"enableAiMax": True or False, # Controls whether or not AI Max features are served for this campaign. Individual AI Max features are enabled or disabled by their respective settings. But if enable_ai_max is set to false or cleared, then no AI Max features will serve for this campaign, regardless of the other settings. Search Term Matching is enabled by default when AI Max is enabled, and can be disabled at the ad group level.
},
"appCampaignSetting": { # Campaign-level settings for App Campaigns. # The setting related to App Campaign.
"appId": "A String", # Immutable. A string that uniquely identifies a mobile application.
"appStore": "A String", # Immutable. The application store that distributes this specific app.
"biddingStrategyGoalType": "A String", # Represents the goal which the bidding strategy of this app campaign should optimize towards.
},
"assetAutomationSettings": [ # Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
{ # Asset automation setting contains pair of AssetAutomationType and the asset automation opt-in/out status
"assetAutomationStatus": "A String", # The opt-in/out status of asset automation type.
"assetAutomationType": "A String", # The asset automation type advertiser would like to opt-in/out.
},
],
"audienceSetting": { # Settings for the audience targeting. # Immutable. Setting for audience related features.
"useAudienceGrouped": True or False, # Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
},
"baseCampaign": "A String", # Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to `resource_name`. This field is read-only.
"biddingStrategy": "A String", # The resource name of the portfolio bidding strategy used by the campaign.
"biddingStrategySystemStatus": "A String", # Output only. The system status of the campaign's bidding strategy.
"biddingStrategyType": "A String", # 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 `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
"brandGuidelines": { # Settings that control the visual appearance of your brand in a campaign's automatically generated assets and formats. Only applicable to Performance Max campaigns.
"accentColor": "A String", # The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.
"mainColor": "A String", # The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.
"predefinedFontFamily": "A String", # The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.
},
"brandGuidelinesEnabled": True or False, # Immutable. Whether Brand Guidelines are enabled for this Campaign. Only applicable to Performance Max campaigns. If enabled, business name and logo assets must be linked as CampaignAssets instead of AssetGroupAssets.
"campaignBudget": "A String", # The resource name of the campaign budget of the campaign.
"campaignGroup": "A String", # The resource name of the campaign group that this campaign belongs to.
"commission": { # Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value. # Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
"commissionRateMicros": "A String", # 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%).
},
"containsEuPoliticalAdvertising": "A String", # The advertiser should self-declare whether this campaign contains political advertising content targeted towards the European Union.
"demandGenCampaignSettings": { # Settings for Demand Gen campaign. # Settings for Demand Gen campaign.
"upgradedTargeting": True or False, # 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.
},
"dynamicSearchAdsSetting": { # The setting for controlling Dynamic Search Ads (DSA). # The setting for controlling Dynamic Search Ads (DSA).
"domainName": "A String", # Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
"languageCode": "A String", # Required. The language code specifying the language of the domain, for example, "en".
"useSuppliedUrlsOnly": True or False, # Whether the campaign uses advertiser supplied URLs exclusively.
},
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.
"A String",
],
"endDateTime": "A String", # The last day and time of the campaign in serving customer's timezone in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily granularity, time granularity is only supported for some campaign types. On create, defaults to running indefinitely. To set an existing campaign to run indefinitely, clear this field.
"engineId": "A String", # Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.
"excludedParentAssetFieldTypes": [ # 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.
"A String",
],
"excludedParentAssetSetTypes": [ # 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.
"A String",
],
"experimentType": "A String", # Output only. The type of campaign: normal, draft, or experiment.
"feedTypes": [ # Output only. Types of feeds that are attached directly to this campaign.
"A String",
],
"finalUrlSuffix": "A String", # Suffix used to append query parameters to landing pages that are served with parallel tracking.
"frequencyCaps": [ # A list that limits how often each user will see this campaign's ads.
{ # 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.
"cap": 42, # Maximum number of events allowed during the time range by this cap.
"key": { # A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key. # The key of a particular frequency cap. There can be no more than one frequency cap with the same key.
"eventType": "A String", # The type of event that the cap applies to (for example, impression).
"level": "A String", # 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.
"timeLength": 42, # Number of time units the cap lasts.
"timeUnit": "A String", # Unit of time the cap is defined at (for example, day, week).
},
},
],
"geoTargetTypeSetting": { # Represents a collection of settings related to ads geotargeting. # The setting for ads geotargeting.
"negativeGeoTargetType": "A String", # The setting used for negative geotargeting in this particular campaign.
"positiveGeoTargetType": "A String", # The setting used for positive geotargeting in this particular campaign.
},
"hotelPropertyAssetSet": "A String", # Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
"hotelSetting": { # Campaign-level settings for hotel ads. # Output only. The hotel setting for the campaign.
"hotelCenterId": "A String", # Output only. The linked Hotel Center account.
},
"id": "A String", # Output only. The ID of the campaign.
"keywordMatchType": "A String", # Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
"labels": [ # Output only. The resource names of labels attached to this campaign.
"A String",
],
"lastModifiedTime": "A String", # Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"listingType": "A String", # Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.
"localCampaignSetting": { # Campaign setting for local campaigns. # The setting for local campaign.
"locationSourceType": "A String", # The location source type for this local campaign.
},
"localServicesCampaignSettings": { # Settings for LocalServicesCampaign subresource. # The Local Services Campaign related settings.
"categoryBids": [ # Categorical level bids associated with MANUAL_CPA bidding strategy.
{ # Category bids in LocalServicesReportingCampaignSettings.
"categoryId": "A String", # Category for which the bid will be associated with. For example, xcat:service_area_business_plumber.
"manualCpaBidMicros": "A String", # 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.
"targetCpaBidMicros": "A String", # Target CPA bid for the category. Value is in micros and in the advertiser's currency.
},
],
},
"manualCpa": { # Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. # 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": { # Manual click-based bidding where user pays per click. # Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
"enhancedCpcEnabled": True or False, # Whether bids are to be enhanced based on conversion optimizer data.
},
"manualCpm": { # Manual impression-based bidding where user pays per thousand impressions. # Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
},
"manualCpv": { # View based bidding where user pays per video view. # A bidding strategy that pays a configurable amount per video view.
},
"maximizeConversionValue": { # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. # Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"targetRoas": 3.14, # The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
"targetRoasTolerancePercentMillis": "A String", # The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS.
},
"maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"targetCpaMicros": "A String", # The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
},
"missingEuPoliticalAdvertisingDeclaration": True or False, # Output only. Indicates whether this campaign is missing a declaration about whether it contains political advertising targeted towards the EU and is ineligible for any exemptions. If this field is true, use the contains_eu_political_advertising field to add the required declaration. This field is read-only.
"name": "A 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.
"networkSettings": { # The network settings for the campaign. # The network settings for the campaign.
"targetContentNetwork": True or False, # Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
"targetGoogleSearch": True or False, # Whether ads will be served with google.com search results.
"targetGoogleTvNetwork": True or False, # Whether ads will be served on the Google TV network.
"targetPartnerSearchNetwork": True or False, # Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead.
"targetSearchNetwork": True or False, # Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`).
"targetYoutube": True or False, # Whether ads will be served on YouTube.
},
"optimizationGoalSetting": { # Optimization goal setting for this campaign, which includes a set of optimization goal types. # Optimization goal setting for this campaign, which includes a set of optimization goal types.
"optimizationGoalTypes": [ # The list of optimization goal types.
"A String",
],
},
"optimizationScore": 3.14, # 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.
"paymentMode": "A String", # Payment mode for the campaign.
"percentCpc": { # A bidding strategy where bids are a fraction of the advertised price for some good or service. # Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
"cpcBidCeilingMicros": "A String", # 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": True or False, # Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
},
"performanceMaxUpgrade": { # Information about a campaign being upgraded to Performance Max. # Output only. Information about campaigns being upgraded to Performance Max.
"performanceMaxCampaign": "A String", # Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
"preUpgradeCampaign": "A String", # Output only. The resource name of the legacy campaign upgraded to Performance Max.
"status": "A String", # Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.
},
"pmaxCampaignSettings": { # Settings for Performance Max campaigns. # Settings for Performance Max campaign.
"brandTargetingOverrides": { # Overrides of brand targeting for various ad types. # Overrides of brand targeting for various ad types.
"ignoreExclusionsForShoppingAds": True or False, # If true, brand exclusions are ignored for Shopping ads.
},
},
"primaryStatus": "A String", # 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": [ # 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.
"A String",
],
"realTimeBiddingSetting": { # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network. # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
"optIn": True or False, # Whether the campaign is opted in to real-time bidding.
},
"resourceName": "A String", # Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
"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. # 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.
"conversionActions": [ # The selected set of resource names for conversion actions for optimizing this campaign.
"A String",
],
},
"selectiveOptimizationMode": "A String", # Selective optimization mode for this campaign.
"servingStatus": "A String", # Output only. The ad serving status of the campaign.
"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. # The setting for controlling Shopping campaigns.
"advertisingPartnerIds": [ # The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link. This feature is currently supported only for Performance Max, Shopping, Search and Demand Gen campaign types.
"A String",
],
"campaignPriority": 42, # 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.
"disableProductFeed": True or False, # 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.
"enableLocal": True or False, # Whether to include local products.
"feedLabel": "A String", # Feed label of products to include in the campaign. Valid feed labels may contain a maximum of 20 characters including uppercase letters, numbers, hyphens, and underscores. If you previously used the deprecated `sales_country` in the two-letter country code (`XX`) format, the `feed_label` field should be used instead. For more information see the [feed label](//support.google.com/merchants/answer/12453549) support article.
"merchantId": "A String", # ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
"useVehicleInventory": True or False, # Immutable. Whether to target Vehicle Listing inventory.
},
"startDateTime": "A String", # The date and time when campaign started in serving. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 00:00:00 for daily granularity, time granularity is only supported for some campaign types.
"status": "A String", # The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
"targetCpa": { # An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. # 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.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"targetCpaMicros": "A String", # Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
},
"targetCpc": { # An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set. # An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set.
"targetCpcMicros": "A String", # Average CPC target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
},
"targetCpm": { # Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set. # A bidding strategy that automatically optimizes cost per thousand impressions.
},
"targetImpressionShare": { # An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location). # Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
"cpcBidCeilingMicros": "A String", # The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
"location": "A String", # The targeted location on the search results page.
"locationFractionMicros": "A String", # The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
},
"targetRoas": { # An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). # Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"targetRoas": 3.14, # Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
"targetRoasTolerancePercentMillis": "A String", # The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS. This field is only mutable for portfolio bidding strategies.
},
"targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
"targetSpendMicros": "A String", # Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
},
"targetingSetting": { # Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594 # Setting for targeting related features.
"targetRestrictionOperations": [ # The list of operations changing the target restrictions. Adding a target restriction with a targeting dimension that already exists causes the existing target restriction to be replaced with the new value.
{ # Operation to be performed on a target restriction list in a mutate.
"operator": "A String", # Type of list operation to perform.
"value": { # The list of per-targeting-dimension targeting settings. # The target restriction being added to or removed from the list.
"bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
"targetingDimension": "A String", # The targeting dimension that these settings apply to.
},
},
],
"targetRestrictions": [ # The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
{ # The list of per-targeting-dimension targeting settings.
"bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
"targetingDimension": "A String", # The targeting dimension that these settings apply to.
},
],
},
"thirdPartyIntegrationPartners": { # Container for Campaign level third party integration partners. # Third-Party integration partners.
"brandLiftIntegrationPartners": [ # Third party integration partners for Brand Lift verification for this Campaign.
{ # Container for third party Brand Lift integration data for Campaign.
"brandLiftIntegrationPartner": "A String", # Allowed third party integration partners for Brand Lift verification.
"brandLiftIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube Brand Lift verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
},
],
"brandSafetyIntegrationPartners": [ # Third party integration partners for brand safety verification for this Campaign.
{ # Container for third party brand safety integration data for Campaign.
"brandSafetyIntegrationPartner": "A String", # Allowed third party integration partners for brand safety verification.
"brandSafetyIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube brand safety verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
},
],
"reachIntegrationPartners": [ # Third party integration partners for reach verification for this Campaign.
{ # Container for third party reach integration data for Campaign.
"reachIntegrationPartner": "A String", # Allowed third party integration partners for reach verification.
"reachIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube Reach verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
},
],
"viewabilityIntegrationPartners": [ # Third party integration partners for YouTube viewability verification for this Campaign.
{ # Container for third party viewability integration data for Campaign.
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
"viewabilityIntegrationPartner": "A String", # Allowed third party integration partners for YouTube viewability verification.
"viewabilityIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube viewability verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
},
],
},
"trackingSetting": { # Campaign-level settings for tracking information. # Output only. Campaign-level settings for tracking information.
"trackingUrl": "A String", # Output only. The url used for dynamic tracking.
},
"trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
"travelCampaignSettings": { # Settings for Travel campaign. # Settings for Travel campaign.
"travelAccountId": "A String", # Immutable. The Travel account ID associated with the Travel campaign.
},
"urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
{ # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
"key": "A String", # The key matching the parameter tag name.
"value": "A String", # The value to be substituted.
},
],
"vanityPharma": { # Describes how unbranded pharma ads will be displayed. # Describes how unbranded pharma ads will be displayed.
"vanityPharmaDisplayUrlMode": "A String", # The display mode for vanity pharma URLs.
"vanityPharmaText": "A String", # 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.
},
"videoBrandSafetySuitability": "A String", # 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.
},
"remove": "A String", # Remove operation: A resource name for the removed campaign is expected, in this format: `customers/{customer_id}/campaigns/{campaign_id}`
"update": { # A campaign. # Update operation: The campaign is expected to have a valid resource name.
"accessibleBiddingStrategy": "A String", # Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. 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.
"adServingOptimizationStatus": "A String", # The ad serving optimization status of the campaign.
"advertisingChannelSubType": "A String", # Immutable. Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
"advertisingChannelType": "A String", # Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
"aiMaxSetting": { # Settings for AI Max in search campaigns. # Settings for AI Max in search campaigns.
"bundlingRequired": "A String", # Output only. Indicates whether a search campaign has adopted AI Max before, and is required to have AI Max enabled to adopt campaign-level text asset automation and brand list targeting in all API versions.
"enableAiMax": True or False, # Controls whether or not AI Max features are served for this campaign. Individual AI Max features are enabled or disabled by their respective settings. But if enable_ai_max is set to false or cleared, then no AI Max features will serve for this campaign, regardless of the other settings. Search Term Matching is enabled by default when AI Max is enabled, and can be disabled at the ad group level.
},
"appCampaignSetting": { # Campaign-level settings for App Campaigns. # The setting related to App Campaign.
"appId": "A String", # Immutable. A string that uniquely identifies a mobile application.
"appStore": "A String", # Immutable. The application store that distributes this specific app.
"biddingStrategyGoalType": "A String", # Represents the goal which the bidding strategy of this app campaign should optimize towards.
},
"assetAutomationSettings": [ # Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
{ # Asset automation setting contains pair of AssetAutomationType and the asset automation opt-in/out status
"assetAutomationStatus": "A String", # The opt-in/out status of asset automation type.
"assetAutomationType": "A String", # The asset automation type advertiser would like to opt-in/out.
},
],
"audienceSetting": { # Settings for the audience targeting. # Immutable. Setting for audience related features.
"useAudienceGrouped": True or False, # Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
},
"baseCampaign": "A String", # Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to `resource_name`. This field is read-only.
"biddingStrategy": "A String", # The resource name of the portfolio bidding strategy used by the campaign.
"biddingStrategySystemStatus": "A String", # Output only. The system status of the campaign's bidding strategy.
"biddingStrategyType": "A String", # 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 `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
"brandGuidelines": { # Settings that control the visual appearance of your brand in a campaign's automatically generated assets and formats. Only applicable to Performance Max campaigns.
"accentColor": "A String", # The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.
"mainColor": "A String", # The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.
"predefinedFontFamily": "A String", # The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.
},
"brandGuidelinesEnabled": True or False, # Immutable. Whether Brand Guidelines are enabled for this Campaign. Only applicable to Performance Max campaigns. If enabled, business name and logo assets must be linked as CampaignAssets instead of AssetGroupAssets.
"campaignBudget": "A String", # The resource name of the campaign budget of the campaign.
"campaignGroup": "A String", # The resource name of the campaign group that this campaign belongs to.
"commission": { # Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value. # Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
"commissionRateMicros": "A String", # 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%).
},
"containsEuPoliticalAdvertising": "A String", # The advertiser should self-declare whether this campaign contains political advertising content targeted towards the European Union.
"demandGenCampaignSettings": { # Settings for Demand Gen campaign. # Settings for Demand Gen campaign.
"upgradedTargeting": True or False, # 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.
},
"dynamicSearchAdsSetting": { # The setting for controlling Dynamic Search Ads (DSA). # The setting for controlling Dynamic Search Ads (DSA).
"domainName": "A String", # Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
"languageCode": "A String", # Required. The language code specifying the language of the domain, for example, "en".
"useSuppliedUrlsOnly": True or False, # Whether the campaign uses advertiser supplied URLs exclusively.
},
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.
"A String",
],
"endDateTime": "A String", # The last day and time of the campaign in serving customer's timezone in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily granularity, time granularity is only supported for some campaign types. On create, defaults to running indefinitely. To set an existing campaign to run indefinitely, clear this field.
"engineId": "A String", # Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.
"excludedParentAssetFieldTypes": [ # 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.
"A String",
],
"excludedParentAssetSetTypes": [ # 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.
"A String",
],
"experimentType": "A String", # Output only. The type of campaign: normal, draft, or experiment.
"feedTypes": [ # Output only. Types of feeds that are attached directly to this campaign.
"A String",
],
"finalUrlSuffix": "A String", # Suffix used to append query parameters to landing pages that are served with parallel tracking.
"frequencyCaps": [ # A list that limits how often each user will see this campaign's ads.
{ # 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.
"cap": 42, # Maximum number of events allowed during the time range by this cap.
"key": { # A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key. # The key of a particular frequency cap. There can be no more than one frequency cap with the same key.
"eventType": "A String", # The type of event that the cap applies to (for example, impression).
"level": "A String", # 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.
"timeLength": 42, # Number of time units the cap lasts.
"timeUnit": "A String", # Unit of time the cap is defined at (for example, day, week).
},
},
],
"geoTargetTypeSetting": { # Represents a collection of settings related to ads geotargeting. # The setting for ads geotargeting.
"negativeGeoTargetType": "A String", # The setting used for negative geotargeting in this particular campaign.
"positiveGeoTargetType": "A String", # The setting used for positive geotargeting in this particular campaign.
},
"hotelPropertyAssetSet": "A String", # Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
"hotelSetting": { # Campaign-level settings for hotel ads. # Output only. The hotel setting for the campaign.
"hotelCenterId": "A String", # Output only. The linked Hotel Center account.
},
"id": "A String", # Output only. The ID of the campaign.
"keywordMatchType": "A String", # Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
"labels": [ # Output only. The resource names of labels attached to this campaign.
"A String",
],
"lastModifiedTime": "A String", # Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"listingType": "A String", # Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.
"localCampaignSetting": { # Campaign setting for local campaigns. # The setting for local campaign.
"locationSourceType": "A String", # The location source type for this local campaign.
},
"localServicesCampaignSettings": { # Settings for LocalServicesCampaign subresource. # The Local Services Campaign related settings.
"categoryBids": [ # Categorical level bids associated with MANUAL_CPA bidding strategy.
{ # Category bids in LocalServicesReportingCampaignSettings.
"categoryId": "A String", # Category for which the bid will be associated with. For example, xcat:service_area_business_plumber.
"manualCpaBidMicros": "A String", # 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.
"targetCpaBidMicros": "A String", # Target CPA bid for the category. Value is in micros and in the advertiser's currency.
},
],
},
"manualCpa": { # Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. # 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": { # Manual click-based bidding where user pays per click. # Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
"enhancedCpcEnabled": True or False, # Whether bids are to be enhanced based on conversion optimizer data.
},
"manualCpm": { # Manual impression-based bidding where user pays per thousand impressions. # Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
},
"manualCpv": { # View based bidding where user pays per video view. # A bidding strategy that pays a configurable amount per video view.
},
"maximizeConversionValue": { # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. # Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"targetRoas": 3.14, # The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
"targetRoasTolerancePercentMillis": "A String", # The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS.
},
"maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"targetCpaMicros": "A String", # The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
},
"missingEuPoliticalAdvertisingDeclaration": True or False, # Output only. Indicates whether this campaign is missing a declaration about whether it contains political advertising targeted towards the EU and is ineligible for any exemptions. If this field is true, use the contains_eu_political_advertising field to add the required declaration. This field is read-only.
"name": "A 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.
"networkSettings": { # The network settings for the campaign. # The network settings for the campaign.
"targetContentNetwork": True or False, # Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
"targetGoogleSearch": True or False, # Whether ads will be served with google.com search results.
"targetGoogleTvNetwork": True or False, # Whether ads will be served on the Google TV network.
"targetPartnerSearchNetwork": True or False, # Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead.
"targetSearchNetwork": True or False, # Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`).
"targetYoutube": True or False, # Whether ads will be served on YouTube.
},
"optimizationGoalSetting": { # Optimization goal setting for this campaign, which includes a set of optimization goal types. # Optimization goal setting for this campaign, which includes a set of optimization goal types.
"optimizationGoalTypes": [ # The list of optimization goal types.
"A String",
],
},
"optimizationScore": 3.14, # 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.
"paymentMode": "A String", # Payment mode for the campaign.
"percentCpc": { # A bidding strategy where bids are a fraction of the advertised price for some good or service. # Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
"cpcBidCeilingMicros": "A String", # 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": True or False, # Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
},
"performanceMaxUpgrade": { # Information about a campaign being upgraded to Performance Max. # Output only. Information about campaigns being upgraded to Performance Max.
"performanceMaxCampaign": "A String", # Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
"preUpgradeCampaign": "A String", # Output only. The resource name of the legacy campaign upgraded to Performance Max.
"status": "A String", # Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.
},
"pmaxCampaignSettings": { # Settings for Performance Max campaigns. # Settings for Performance Max campaign.
"brandTargetingOverrides": { # Overrides of brand targeting for various ad types. # Overrides of brand targeting for various ad types.
"ignoreExclusionsForShoppingAds": True or False, # If true, brand exclusions are ignored for Shopping ads.
},
},
"primaryStatus": "A String", # 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": [ # 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.
"A String",
],
"realTimeBiddingSetting": { # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network. # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
"optIn": True or False, # Whether the campaign is opted in to real-time bidding.
},
"resourceName": "A String", # Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
"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. # 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.
"conversionActions": [ # The selected set of resource names for conversion actions for optimizing this campaign.
"A String",
],
},
"selectiveOptimizationMode": "A String", # Selective optimization mode for this campaign.
"servingStatus": "A String", # Output only. The ad serving status of the campaign.
"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. # The setting for controlling Shopping campaigns.
"advertisingPartnerIds": [ # The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link. This feature is currently supported only for Performance Max, Shopping, Search and Demand Gen campaign types.
"A String",
],
"campaignPriority": 42, # 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.
"disableProductFeed": True or False, # 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.
"enableLocal": True or False, # Whether to include local products.
"feedLabel": "A String", # Feed label of products to include in the campaign. Valid feed labels may contain a maximum of 20 characters including uppercase letters, numbers, hyphens, and underscores. If you previously used the deprecated `sales_country` in the two-letter country code (`XX`) format, the `feed_label` field should be used instead. For more information see the [feed label](//support.google.com/merchants/answer/12453549) support article.
"merchantId": "A String", # ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
"useVehicleInventory": True or False, # Immutable. Whether to target Vehicle Listing inventory.
},
"startDateTime": "A String", # The date and time when campaign started in serving. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 00:00:00 for daily granularity, time granularity is only supported for some campaign types.
"status": "A String", # The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
"targetCpa": { # An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. # 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.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"targetCpaMicros": "A String", # Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
},
"targetCpc": { # An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set. # An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set.
"targetCpcMicros": "A String", # Average CPC target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
},
"targetCpm": { # Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set. # A bidding strategy that automatically optimizes cost per thousand impressions.
},
"targetImpressionShare": { # An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location). # Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
"cpcBidCeilingMicros": "A String", # The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
"location": "A String", # The targeted location on the search results page.
"locationFractionMicros": "A String", # The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
},
"targetRoas": { # An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). # Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"targetRoas": 3.14, # Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
"targetRoasTolerancePercentMillis": "A String", # The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS. This field is only mutable for portfolio bidding strategies.
},
"targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
"targetSpendMicros": "A String", # Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
},
"targetingSetting": { # Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594 # Setting for targeting related features.
"targetRestrictionOperations": [ # The list of operations changing the target restrictions. Adding a target restriction with a targeting dimension that already exists causes the existing target restriction to be replaced with the new value.
{ # Operation to be performed on a target restriction list in a mutate.
"operator": "A String", # Type of list operation to perform.
"value": { # The list of per-targeting-dimension targeting settings. # The target restriction being added to or removed from the list.
"bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
"targetingDimension": "A String", # The targeting dimension that these settings apply to.
},
},
],
"targetRestrictions": [ # The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
{ # The list of per-targeting-dimension targeting settings.
"bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
"targetingDimension": "A String", # The targeting dimension that these settings apply to.
},
],
},
"thirdPartyIntegrationPartners": { # Container for Campaign level third party integration partners. # Third-Party integration partners.
"brandLiftIntegrationPartners": [ # Third party integration partners for Brand Lift verification for this Campaign.
{ # Container for third party Brand Lift integration data for Campaign.
"brandLiftIntegrationPartner": "A String", # Allowed third party integration partners for Brand Lift verification.
"brandLiftIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube Brand Lift verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
},
],
"brandSafetyIntegrationPartners": [ # Third party integration partners for brand safety verification for this Campaign.
{ # Container for third party brand safety integration data for Campaign.
"brandSafetyIntegrationPartner": "A String", # Allowed third party integration partners for brand safety verification.
"brandSafetyIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube brand safety verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
},
],
"reachIntegrationPartners": [ # Third party integration partners for reach verification for this Campaign.
{ # Container for third party reach integration data for Campaign.
"reachIntegrationPartner": "A String", # Allowed third party integration partners for reach verification.
"reachIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube Reach verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
},
],
"viewabilityIntegrationPartners": [ # Third party integration partners for YouTube viewability verification for this Campaign.
{ # Container for third party viewability integration data for Campaign.
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
"viewabilityIntegrationPartner": "A String", # Allowed third party integration partners for YouTube viewability verification.
"viewabilityIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube viewability verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
},
],
},
"trackingSetting": { # Campaign-level settings for tracking information. # Output only. Campaign-level settings for tracking information.
"trackingUrl": "A String", # Output only. The url used for dynamic tracking.
},
"trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
"travelCampaignSettings": { # Settings for Travel campaign. # Settings for Travel campaign.
"travelAccountId": "A String", # Immutable. The Travel account ID associated with the Travel campaign.
},
"urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
{ # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
"key": "A String", # The key matching the parameter tag name.
"value": "A String", # The value to be substituted.
},
],
"vanityPharma": { # Describes how unbranded pharma ads will be displayed. # Describes how unbranded pharma ads will be displayed.
"vanityPharmaDisplayUrlMode": "A String", # The display mode for vanity pharma URLs.
"vanityPharmaText": "A String", # 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.
},
"videoBrandSafetySuitability": "A String", # 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.
},
"updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
},
],
"partialFailure": True or False, # If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false.
"responseContentType": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
"validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for campaign mutate.
"partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"results": [ # All results for the mutate.
{ # The result for the campaign mutate.
"campaign": { # A campaign. # The mutated campaign with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"accessibleBiddingStrategy": "A String", # Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. 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.
"adServingOptimizationStatus": "A String", # The ad serving optimization status of the campaign.
"advertisingChannelSubType": "A String", # Immutable. Optional refinement to `advertising_channel_type`. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.
"advertisingChannelType": "A String", # Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in `network_settings`. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.
"aiMaxSetting": { # Settings for AI Max in search campaigns. # Settings for AI Max in search campaigns.
"bundlingRequired": "A String", # Output only. Indicates whether a search campaign has adopted AI Max before, and is required to have AI Max enabled to adopt campaign-level text asset automation and brand list targeting in all API versions.
"enableAiMax": True or False, # Controls whether or not AI Max features are served for this campaign. Individual AI Max features are enabled or disabled by their respective settings. But if enable_ai_max is set to false or cleared, then no AI Max features will serve for this campaign, regardless of the other settings. Search Term Matching is enabled by default when AI Max is enabled, and can be disabled at the ad group level.
},
"appCampaignSetting": { # Campaign-level settings for App Campaigns. # The setting related to App Campaign.
"appId": "A String", # Immutable. A string that uniquely identifies a mobile application.
"appStore": "A String", # Immutable. The application store that distributes this specific app.
"biddingStrategyGoalType": "A String", # Represents the goal which the bidding strategy of this app campaign should optimize towards.
},
"assetAutomationSettings": [ # Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.
{ # Asset automation setting contains pair of AssetAutomationType and the asset automation opt-in/out status
"assetAutomationStatus": "A String", # The opt-in/out status of asset automation type.
"assetAutomationType": "A String", # The asset automation type advertiser would like to opt-in/out.
},
],
"audienceSetting": { # Settings for the audience targeting. # Immutable. Setting for audience related features.
"useAudienceGrouped": True or False, # Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.
},
"baseCampaign": "A String", # Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to `resource_name`. This field is read-only.
"biddingStrategy": "A String", # The resource name of the portfolio bidding strategy used by the campaign.
"biddingStrategySystemStatus": "A String", # Output only. The system status of the campaign's bidding strategy.
"biddingStrategyType": "A String", # 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 `bidding_strategy` field to create a portfolio bidding strategy. This field is read-only.
"brandGuidelines": { # Settings that control the visual appearance of your brand in a campaign's automatically generated assets and formats. Only applicable to Performance Max campaigns.
"accentColor": "A String", # The accent brand color, entered as a hex code (e.g., #00ff00). You must provide the accent_color if you provide a main_color.
"mainColor": "A String", # The main brand color, entered as a hex code (e.g., #00ff00). You must provide the main_color if you provide an accent_color.
"predefinedFontFamily": "A String", # The brand's font family. Must be one of the following Google Fonts (case sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald, Playfair Display, Roboto Slab.
},
"brandGuidelinesEnabled": True or False, # Immutable. Whether Brand Guidelines are enabled for this Campaign. Only applicable to Performance Max campaigns. If enabled, business name and logo assets must be linked as CampaignAssets instead of AssetGroupAssets.
"campaignBudget": "A String", # The resource name of the campaign budget of the campaign.
"campaignGroup": "A String", # The resource name of the campaign group that this campaign belongs to.
"commission": { # Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value. # Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value.
"commissionRateMicros": "A String", # 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%).
},
"containsEuPoliticalAdvertising": "A String", # The advertiser should self-declare whether this campaign contains political advertising content targeted towards the European Union.
"demandGenCampaignSettings": { # Settings for Demand Gen campaign. # Settings for Demand Gen campaign.
"upgradedTargeting": True or False, # 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.
},
"dynamicSearchAdsSetting": { # The setting for controlling Dynamic Search Ads (DSA). # The setting for controlling Dynamic Search Ads (DSA).
"domainName": "A String", # Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
"languageCode": "A String", # Required. The language code specifying the language of the domain, for example, "en".
"useSuppliedUrlsOnly": True or False, # Whether the campaign uses advertiser supplied URLs exclusively.
},
"effectiveLabels": [ # Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.
"A String",
],
"endDateTime": "A String", # The last day and time of the campaign in serving customer's timezone in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily granularity, time granularity is only supported for some campaign types. On create, defaults to running indefinitely. To set an existing campaign to run indefinitely, clear this field.
"engineId": "A String", # Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.
"excludedParentAssetFieldTypes": [ # 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.
"A String",
],
"excludedParentAssetSetTypes": [ # 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.
"A String",
],
"experimentType": "A String", # Output only. The type of campaign: normal, draft, or experiment.
"feedTypes": [ # Output only. Types of feeds that are attached directly to this campaign.
"A String",
],
"finalUrlSuffix": "A String", # Suffix used to append query parameters to landing pages that are served with parallel tracking.
"frequencyCaps": [ # A list that limits how often each user will see this campaign's ads.
{ # 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.
"cap": 42, # Maximum number of events allowed during the time range by this cap.
"key": { # A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key. # The key of a particular frequency cap. There can be no more than one frequency cap with the same key.
"eventType": "A String", # The type of event that the cap applies to (for example, impression).
"level": "A String", # 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.
"timeLength": 42, # Number of time units the cap lasts.
"timeUnit": "A String", # Unit of time the cap is defined at (for example, day, week).
},
},
],
"geoTargetTypeSetting": { # Represents a collection of settings related to ads geotargeting. # The setting for ads geotargeting.
"negativeGeoTargetType": "A String", # The setting used for negative geotargeting in this particular campaign.
"positiveGeoTargetType": "A String", # The setting used for positive geotargeting in this particular campaign.
},
"hotelPropertyAssetSet": "A String", # Immutable. The resource name for a set of hotel properties for Performance Max for travel goals campaigns.
"hotelSetting": { # Campaign-level settings for hotel ads. # Output only. The hotel setting for the campaign.
"hotelCenterId": "A String", # Output only. The linked Hotel Center account.
},
"id": "A String", # Output only. The ID of the campaign.
"keywordMatchType": "A String", # Keyword match type of Campaign. Set to BROAD to set broad matching for all keywords in a campaign.
"labels": [ # Output only. The resource names of labels attached to this campaign.
"A String",
],
"lastModifiedTime": "A String", # Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
"listingType": "A String", # Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.
"localCampaignSetting": { # Campaign setting for local campaigns. # The setting for local campaign.
"locationSourceType": "A String", # The location source type for this local campaign.
},
"localServicesCampaignSettings": { # Settings for LocalServicesCampaign subresource. # The Local Services Campaign related settings.
"categoryBids": [ # Categorical level bids associated with MANUAL_CPA bidding strategy.
{ # Category bids in LocalServicesReportingCampaignSettings.
"categoryId": "A String", # Category for which the bid will be associated with. For example, xcat:service_area_business_plumber.
"manualCpaBidMicros": "A String", # 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.
"targetCpaBidMicros": "A String", # Target CPA bid for the category. Value is in micros and in the advertiser's currency.
},
],
},
"manualCpa": { # Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. # 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": { # Manual click-based bidding where user pays per click. # Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.
"enhancedCpcEnabled": True or False, # Whether bids are to be enhanced based on conversion optimizer data.
},
"manualCpm": { # Manual impression-based bidding where user pays per thousand impressions. # Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.
},
"manualCpv": { # View based bidding where user pays per video view. # A bidding strategy that pays a configurable amount per video view.
},
"maximizeConversionValue": { # An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. # Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"targetRoas": 3.14, # The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
"targetRoasTolerancePercentMillis": "A String", # The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS.
},
"maximizeConversions": { # An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. # Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
"targetCpaMicros": "A String", # The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
},
"missingEuPoliticalAdvertisingDeclaration": True or False, # Output only. Indicates whether this campaign is missing a declaration about whether it contains political advertising targeted towards the EU and is ineligible for any exemptions. If this field is true, use the contains_eu_political_advertising field to add the required declaration. This field is read-only.
"name": "A 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.
"networkSettings": { # The network settings for the campaign. # The network settings for the campaign.
"targetContentNetwork": True or False, # Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
"targetGoogleSearch": True or False, # Whether ads will be served with google.com search results.
"targetGoogleTvNetwork": True or False, # Whether ads will be served on the Google TV network.
"targetPartnerSearchNetwork": True or False, # Whether ads will be served on the partner network. This is available only to some select partner accounts. Unless you have been instructed to use this field, it likely does not apply to your account. This does not control whether ads will be served on Google Search Partners Network; use `target_search_network` for that instead.
"targetSearchNetwork": True or False, # Whether ads will be served on sites in the Google Search Partners Network (requires `target_google_search` to also be `true`).
"targetYoutube": True or False, # Whether ads will be served on YouTube.
},
"optimizationGoalSetting": { # Optimization goal setting for this campaign, which includes a set of optimization goal types. # Optimization goal setting for this campaign, which includes a set of optimization goal types.
"optimizationGoalTypes": [ # The list of optimization goal types.
"A String",
],
},
"optimizationScore": 3.14, # 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.
"paymentMode": "A String", # Payment mode for the campaign.
"percentCpc": { # A bidding strategy where bids are a fraction of the advertised price for some good or service. # Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.
"cpcBidCeilingMicros": "A String", # 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": True or False, # Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
},
"performanceMaxUpgrade": { # Information about a campaign being upgraded to Performance Max. # Output only. Information about campaigns being upgraded to Performance Max.
"performanceMaxCampaign": "A String", # Output only. The resource name of the Performance Max campaign the campaign is upgraded to.
"preUpgradeCampaign": "A String", # Output only. The resource name of the legacy campaign upgraded to Performance Max.
"status": "A String", # Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.
},
"pmaxCampaignSettings": { # Settings for Performance Max campaigns. # Settings for Performance Max campaign.
"brandTargetingOverrides": { # Overrides of brand targeting for various ad types. # Overrides of brand targeting for various ad types.
"ignoreExclusionsForShoppingAds": True or False, # If true, brand exclusions are ignored for Shopping ads.
},
},
"primaryStatus": "A String", # 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": [ # 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.
"A String",
],
"realTimeBiddingSetting": { # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network. # Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
"optIn": True or False, # Whether the campaign is opted in to real-time bidding.
},
"resourceName": "A String", # Immutable. The resource name of the campaign. Campaign resource names have the form: `customers/{customer_id}/campaigns/{campaign_id}`
"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. # 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.
"conversionActions": [ # The selected set of resource names for conversion actions for optimizing this campaign.
"A String",
],
},
"selectiveOptimizationMode": "A String", # Selective optimization mode for this campaign.
"servingStatus": "A String", # Output only. The ad serving status of the campaign.
"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. # The setting for controlling Shopping campaigns.
"advertisingPartnerIds": [ # The list of Google Ads accounts IDs of advertising partners cooperating within the campaign. This feature is currently available only for accounts having an advertising partner link. This feature is currently supported only for Performance Max, Shopping, Search and Demand Gen campaign types.
"A String",
],
"campaignPriority": 42, # 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.
"disableProductFeed": True or False, # 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.
"enableLocal": True or False, # Whether to include local products.
"feedLabel": "A String", # Feed label of products to include in the campaign. Valid feed labels may contain a maximum of 20 characters including uppercase letters, numbers, hyphens, and underscores. If you previously used the deprecated `sales_country` in the two-letter country code (`XX`) format, the `feed_label` field should be used instead. For more information see the [feed label](//support.google.com/merchants/answer/12453549) support article.
"merchantId": "A String", # ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.
"useVehicleInventory": True or False, # Immutable. Whether to target Vehicle Listing inventory.
},
"startDateTime": "A String", # The date and time when campaign started in serving. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time component to 00:00:00 for daily granularity, time granularity is only supported for some campaign types.
"status": "A String", # The status of the campaign. When a new campaign is added, the status defaults to ENABLED.
"targetCpa": { # An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. # 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.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"targetCpaMicros": "A String", # Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
},
"targetCpc": { # An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set. # An automated bidding strategy that sets bids to help get as many clicks as possible at the target cost-per-click (CPC) you set.
"targetCpcMicros": "A String", # Average CPC target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
},
"targetCpm": { # Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set. # A bidding strategy that automatically optimizes cost per thousand impressions.
},
"targetImpressionShare": { # An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location). # Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.
"cpcBidCeilingMicros": "A String", # The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
"location": "A String", # The targeted location on the search results page.
"locationFractionMicros": "A String", # The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
},
"targetRoas": { # An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). # Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"cpcBidFloorMicros": "A String", # Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
"targetRoas": 3.14, # Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
"targetRoasTolerancePercentMillis": "A String", # The percent of ROAS(return on advertising spend) degradation tolerance allowed to increase traffic diversity and conversion volume, specified in millis (for example, 10,000 = 10%). A value of 10,000 means that the advertiser can expect ROAS degradation of up to 10% of the specified target ROAS. This field is only mutable for portfolio bidding strategies.
},
"targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.
"cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
"targetSpendMicros": "A String", # Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
},
"targetingSetting": { # Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594 # Setting for targeting related features.
"targetRestrictionOperations": [ # The list of operations changing the target restrictions. Adding a target restriction with a targeting dimension that already exists causes the existing target restriction to be replaced with the new value.
{ # Operation to be performed on a target restriction list in a mutate.
"operator": "A String", # Type of list operation to perform.
"value": { # The list of per-targeting-dimension targeting settings. # The target restriction being added to or removed from the list.
"bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
"targetingDimension": "A String", # The targeting dimension that these settings apply to.
},
},
],
"targetRestrictions": [ # The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
{ # The list of per-targeting-dimension targeting settings.
"bidOnly": True or False, # Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
"targetingDimension": "A String", # The targeting dimension that these settings apply to.
},
],
},
"thirdPartyIntegrationPartners": { # Container for Campaign level third party integration partners. # Third-Party integration partners.
"brandLiftIntegrationPartners": [ # Third party integration partners for Brand Lift verification for this Campaign.
{ # Container for third party Brand Lift integration data for Campaign.
"brandLiftIntegrationPartner": "A String", # Allowed third party integration partners for Brand Lift verification.
"brandLiftIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube Brand Lift verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
},
],
"brandSafetyIntegrationPartners": [ # Third party integration partners for brand safety verification for this Campaign.
{ # Container for third party brand safety integration data for Campaign.
"brandSafetyIntegrationPartner": "A String", # Allowed third party integration partners for brand safety verification.
"brandSafetyIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube brand safety verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
},
],
"reachIntegrationPartners": [ # Third party integration partners for reach verification for this Campaign.
{ # Container for third party reach integration data for Campaign.
"reachIntegrationPartner": "A String", # Allowed third party integration partners for reach verification.
"reachIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube Reach verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
},
],
"viewabilityIntegrationPartners": [ # Third party integration partners for YouTube viewability verification for this Campaign.
{ # Container for third party viewability integration data for Campaign.
"shareCost": True or False, # If true, then cost data will be shared with this vendor.
"viewabilityIntegrationPartner": "A String", # Allowed third party integration partners for YouTube viewability verification.
"viewabilityIntegrationPartnerData": { # Contains third party measurement partner related data for video campaigns. # Third party partner data for YouTube viewability verification. This is optional metadata for partners to join or attach data to Ads campaigns.
"clientId": "A String", # The client ID that allows the measurement partner to join multiple campaigns for a particular advertiser.
"thirdPartyPlacementId": "A String", # The third party placement ID that maps the measurement partner data with a campaign (or a group of related campaigns) specific data.
},
},
],
},
"trackingSetting": { # Campaign-level settings for tracking information. # Output only. Campaign-level settings for tracking information.
"trackingUrl": "A String", # Output only. The url used for dynamic tracking.
},
"trackingUrlTemplate": "A String", # The URL template for constructing a tracking URL.
"travelCampaignSettings": { # Settings for Travel campaign. # Settings for Travel campaign.
"travelAccountId": "A String", # Immutable. The Travel account ID associated with the Travel campaign.
},
"urlCustomParameters": [ # The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
{ # A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
"key": "A String", # The key matching the parameter tag name.
"value": "A String", # The value to be substituted.
},
],
"vanityPharma": { # Describes how unbranded pharma ads will be displayed. # Describes how unbranded pharma ads will be displayed.
"vanityPharmaDisplayUrlMode": "A String", # The display mode for vanity pharma URLs.
"vanityPharmaText": "A String", # 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.
},
"videoBrandSafetySuitability": "A String", # 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.
},
"resourceName": "A String", # Returned for successful operations.
},
],
}

Search Ads 360 Reporting API . customers . campaigns

Instance Methods

Method Details