---
title: "PATCH /v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}"
method: PATCH
path: "/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}"
tags: ["advertisers"]
---

# PATCH /v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}

`PATCH /v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}`

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.

## Path parameters

- `advertiserId` string, required
- `adGroupId` string, required

## Query parameters

- `updateMask` string

## Request body

- AdGroup — A single ad group associated with a line item.
  - `adGroupId` string, int64 — Output only. The unique ID of the ad group. Assigned by the system.
  - `entityStatus` 'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION' — Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
  - `productFeedData` ProductFeedData — The details of product feed.
    - `isFeedDisabled` boolean — Whether the product feed has opted-out of showing products.
    - `productMatchType` 'PRODUCT_MATCH_TYPE_UNSPECIFIED' | 'PRODUCT_MATCH_TYPE_ALL_PRODUCTS' | 'PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS' | 'PRODUCT_MATCH_TYPE_CUSTOM_LABEL' — How products are selected by the product feed.
    - `productMatchDimensions` ProductMatchDimension[] — A list of dimensions used to match products.
      - `productOfferId` string — The ID of the product offer to match with a product with the same offer ID.
      - `customLabel` CustomLabel — The key and value of a custom label.
        - `key` 'CUSTOM_LABEL_KEY_UNSPECIFIED' | 'CUSTOM_LABEL_KEY_0' | 'CUSTOM_LABEL_KEY_1' | 'CUSTOM_LABEL_KEY_2' | 'CUSTOM_LABEL_KEY_3' | 'CUSTOM_LABEL_KEY_4' — The key of the label.
        - `value` string — The value of the label.
  - `lineItemId` string, int64 — Required. Immutable. The unique ID of the line item that the ad group belongs to.
  - `advertiserId` string, int64 — Output only. The unique ID of the advertiser the ad group belongs to.
  - `name` string — Output only. Identifier. The resource name of the ad group.
  - `displayName` string — Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
  - `adGroupFormat` 'AD_GROUP_FORMAT_UNSPECIFIED' | 'AD_GROUP_FORMAT_IN_STREAM' | 'AD_GROUP_FORMAT_VIDEO_DISCOVERY' | 'AD_GROUP_FORMAT_BUMPER' | 'AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM' | 'AD_GROUP_FORMAT_AUDIO' | 'AD_GROUP_FORMAT_RESPONSIVE' | 'AD_GROUP_FORMAT_REACH' | 'AD_GROUP_FORMAT_MASTHEAD' | 'AD_GROUP_FORMAT_DEMAND_GEN' — Required. Immutable. The format of the ads in the ad group.
  - `bidStrategy` BiddingStrategy — Settings that control the bid strategy. Bid strategy determines the bid price.
    - `fixedBid` FixedBidStrategy — A strategy that uses a fixed bidding price.
      - `bidAmountMicros` string, int64 — The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
    - `performanceGoalAutoBid` PerformanceGoalBidStrategy — A strategy that automatically adjusts the bid to meet or beat a specified performance goal.
      - `performanceGoalAmountMicros` string, int64 — Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
      - `customBiddingAlgorithmId` string, int64 — The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
      - `performanceGoalType` 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH' — Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
      - `maxAverageCpmBidAmountMicros` string, int64 — The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
    - `maximizeSpendAutoBid` MaximizeSpendBidStrategy — A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget.
      - `raiseBidForDeals` boolean — Whether the strategy takes deal floor prices into account.
      - `customBiddingAlgorithmId` string, int64 — The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
      - `maxAverageCpmBidAmountMicros` string, int64 — The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
      - `performanceGoalType` 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH' — Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
    - `demandGenBid` DemandGenBiddingStrategy — Settings that control the bid strategy for Demand Gen resources.
      - `value` string, int64 — Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0.
      - `effectiveBiddingValueSource` 'BIDDING_SOURCE_UNSPECIFIED' | 'BIDDING_SOURCE_LINE_ITEM' | 'BIDDING_SOURCE_AD_GROUP' — Output only. Source of the effective bidding value.
      - `type` 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC' — Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item.
      - `effectiveBiddingValue` string, int64 — Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0.
    - `youtubeAndPartnersBid` YoutubeAndPartnersBiddingStrategy — Settings that control the bid strategy for YouTube and Partners resources.
      - `type` 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE' — The type of the bidding strategy.
      - `value` string, int64 — The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
      - `adGroupEffectiveTargetCpaValue` string, int64 — Output only. The effective target CPA for ad group, in micros of advertiser's currency.
      - `adGroupEffectiveTargetCpaSource` 'BIDDING_SOURCE_UNSPECIFIED' | 'BIDDING_SOURCE_LINE_ITEM' | 'BIDDING_SOURCE_AD_GROUP' — Output only. Source of the effective target CPA value for ad group.
  - `targetingExpansion` TargetingExpansionConfig — Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.
    - `enableOptimizedTargeting` boolean — Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
    - `excludeDemographicExpansion` boolean — Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups.
    - `audienceExpansionSeedListExcluded` boolean — Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
    - `audienceExpansionLevel` 'UNKNOWN' | 'NO_REACH' | 'LEAST_REACH' | 'MID_REACH' | 'MOST_REACH' — Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
  - `adGroupInventoryControl` AdGroupInventoryControl — The inventory control of the ad group.
    - `selectedInventories` SelectedInventories — The inventory control of the ad group.
      - `allowYoutubeShorts` boolean — Whether the ad group is opted-in to YouTube shorts inventory.
      - `allowYoutubeStream` boolean — Whether the ad group is opted-in to YouTube in-stream inventory.
      - `allowYoutubeFeed` boolean — Whether the ad group is opted-in to YouTube in-feed inventory.
      - `allowDiscover` boolean — Whether the ad group is opted-in to Discover inventory.
      - `allowGoogleDisplayNetwork` boolean — Whether the ad group is opted-in to Google Display Network inventory.
      - `allowGmail` boolean — Whether the ad group is opted-in to Gmail inventory.
    - `adGroupInventoryStrategy` 'AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED' | 'AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY' | 'AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY' — The inventory strategy.

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/displayvideo.md) · [All operations](https://skmtc.dev/google/apis/displayvideo/llms.txt) · [OpenAPI document](https://skmtc.dev/google/apis/displayvideo/revisions/68b64e49eced?raw)