AdGroupCreate

The request body for creating a new ad group.

Declaration

object AdGroupCreate

Properties

Name	Type	Description
`name` Required	string	The advertiser-given name of this ad group.
`campaignId` Required	int64	The campaign this ad group belongs to. Immutable after creation.
`startTime`	date-time	The scheduled start date and time of this ad group in ISO 8601 format.
`endTime`	date-time	The scheduled end date and time. Omit to inherit the campaign end date.
`pricingModel` Required	`AdGroupCreate.PricingModel`	The pricing model for this ad group (`CPA`, `CPM`, or `CPT`). Must match the campaign’s billing event: `CPT` pairs with `billingEvent: TAPS`, `CPM` pairs with `billingEvent: IMPRESSIONS`. See PricingModel. Immutable after creation.
`automatedKeywordsOptIn`	boolean	Auto opt-in for Search Match. When enabled, the system automatically targets additional relevant search terms beyond the explicit keyword list.
`status`	`AdGroupCreate.Status`	Advertiser-configurable serving status. No default is applied when this field is omitted. See AdGroupStatus.
`automatedKeywordsRequired`	boolean	Whether automated keyword generation is required for this ad group.
`bidStrategy`	`AdGroupCreate.BidStrategy`	The bid strategy for this ad group. If omitted, the campaign-level bid strategy applies. See BidStrategyCreate.
`targeting`	`AdGroupCreate.Targeting`	Audience and placement targeting for this ad group (device class, age, gender, location, etc.). See AdGroupTargetingCreate.
`cpaCap`	`AdGroupCreate.CpaCap`	Deprecated. Use `bidStrategy` with `MAX_CONVERSIONS` instead. See CPAGoalCreate.

Discussion

The AdGroupCreate object is the request payload for creating a new ad group via POST /v1/adgroups (Create an Ad Group).

You can’t create keywords or negative keywords inline. Create the ad group first, then add keywords and negative keywords with separate calls.

Example

{
  "name": "AwayFinder iOS — New Users 18-34",
  "campaignId": 444555666,
  "startTime": "2025-09-01T00:00:00.000",
  "endTime": "2025-12-31T23:59:59.000",
  "pricingModel": "CPT",
  "automatedKeywordsOptIn": false,
  "status": "ENABLED",
  "automatedKeywordsRequired": false,
  "bidStrategy": {
    "bidStrategyType": "MANUAL_CPT",
    "bidStrategyGoal": "TAP",
    "bid": {
      "amount": "2.50",
      "currency": "USD"
    }
  },
  "targeting": {
    "deviceClass": {
      "include": [
        "IPHONE"
      ]
    },
    "minAge": {
      "include": [
        "18"
      ]
    },
    "maxAge": {
      "include": [
        "34"
      ]
    },
    "appDownloader": {
      "include": [
        "123456789"
      ]
    }
  }
}

AdGroupCreate

Declaration

Properties

Discussion

Example

Topics

Dictionaries

Type Aliases

See Also