AdGroup

Primary unit governing targeting, bid strategy, pricing model, and scheduling within a campaign.

Declaration

object AdGroup

Properties

Name	Type	Description
`name`	string	The advertiser-given name of this ad group. Mutable.
`adAccountId`	int64	The ad account this ad group belongs to. Read-only.
`campaignId`	int64	The campaign this ad group belongs to. Immutable after creation.
`startTime`	date-time	Ad group schedule start time. ISO 8601 format, for example `2025-09-01T00:00:00.000`. Mutable.
`endTime`	date-time	Ad group schedule end time. ISO 8601 format, for example `2025-12-31T23:59:59.000`. Mutable.
`pricingModel`	`AdGroup.PricingModel`	The pricing model for this ad group. Values: `CPA`, `CPM`, `CPT`. See PricingModel. Immutable after creation. Must match the parent campaign’s billing event.
`automatedKeywordsOptIn`	boolean	Opt in to Search Match, which automatically matches search terms without requiring explicit keywords. Mutable.
`status`	`AdGroup.Status`	Advertiser-configurable status for this ad group. See AdGroupStatus. Mutable.
`systemStatus`	`AdGroup.SystemStatus`	System-computed operational status reflecting the ad group’s current serving state. See AdGroupSystemStatus. Read-only.
`systemStatusReasons`	[`AdGroup.SystemStatusReasons`]	System-applied reasons that contribute to the current `systemStatus`. See AdGroupSystemStatusReason for all values. Read-only.
`systemStatusLimitingReasons`	[`AdGroup.SystemStatusLimitingReasons`]	System-applied reasons that limit delivery below maximum potential. See AdGroupSystemLimitedStatusReason for details. Read-only.
`automatedKeywordsRequired`	boolean	Auto keyword generation required. Immutable after creation.
`displayStatus`	`AdGroup.DisplayStatus`	System-computed, rolled-up delivery state combining `status` and `systemStatus` into a single delivery label, more intuitive than a binary running-or-not-running signal. See AdGroupDisplayStatus. Read-only.
`bidStrategy`	`AdGroup.BidStrategy`	The bid strategy for this ad group. If omitted, the campaign-level bid strategy applies. See BidStrategy. Mutable.
`targeting`	`AdGroup.Targeting`	Targeting configuration for this ad group. See AdGroupTargeting. Mutable.
`id`	int64	The unique identifier for this ad group. Read-only.
`creationTime`	date-time	Timestamp when the ad group was created. Read-only.
`modificationTime`	date-time	Timestamp of the last modification to the ad group. Read-only.
`deleted`	boolean	Indicates if the ad group has been deleted. Read-only.
`cpaCap`	`AdGroup.CpaCap`	Deprecated. Use `bidStrategy` with `MAX_CONVERSIONS` instead. See CPAGoal.

Discussion

An AdGroup is the primary unit for governing ad delivery within a campaign. Multiple ad groups within a campaign allow different targeting strategies, bids, and schedules to compete and optimize within the same promoted app or brand.

Fields you can filter and sort on when querying ad groups are listed in Query Ad Groups.

Example

{
  "id": 555666777,
  "name": "AwayFinder iOS — New Users 18-34",
  "adAccountId": 123456789,
  "campaignId": 444555666,
  "startTime": "2025-09-01T00:00:00.000",
  "endTime": "2025-12-31T23:59:59.000",
  "pricingModel": "CPT",
  "automatedKeywordsOptIn": false,
  "automatedKeywordsRequired": false,
  "status": "ENABLED",
  "systemStatus": "RUNNING",
  "systemStatusReasons": [],
  "systemStatusLimitingReasons": [],
  "displayStatus": "RUNNING",
  "bidStrategy": {
    "bidStrategyType": "MANUAL_CPT",
    "bidStrategyGoal": "TAP",
    "bid": {
      "amount": "5.00",
      "currency": "USD"
    }
  },
  "targeting": {
    "deviceClass": {
      "include": [
        "IPHONE"
      ]
    },
    "minAge": {
      "include": [
        "18"
      ]
    },
    "maxAge": {
      "include": [
        "34"
      ]
    },
    "appDownloader": {
      "include": [
        "123456789"
      ]
    }
  },
  "cpaCap": null,
  "deleted": false,
  "creationTime": "2025-01-10T08:00:00.000",
  "modificationTime": "2025-01-10T08:00:00.000"
}

AdGroup

Declaration

Properties

Discussion

Example

Topics

Dictionaries

Type Aliases

See Also