---
title: AdGroup
framework: Apple Ads
role: symbol
role_heading: Object
platforms: [search ads 2.0+]
path: apple_ads/adgroup
---

# AdGroup

The response to ad group requests.

## Declaration

```data
object AdGroup
```

## Properties

automatedKeywordsOptIn: The parameter for enabling and disabling Search Match. If true, the system automatically adds optimized keywords in addition to those you explicitly add to the ad group. Can be toggled true or false for standard ad groups in MAX_CONVERSIONS campaigns. Required to be true for automated ad groups. See Create an Ad Group. See Ad Groups. You can use the EQUALS selector Condition operator with Find Ad Groups. automatedKeywordsRequired: A read-only field indicating if this is the automated ad group. Defaults to false. An automated ad group must exist for Maximize Conversions campaigns to run. See Create an Ad Group. biddingStrategy: The bid strategy for the campaign. See Campaigns campaignId: The unique identifier for a campaign. You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Find Ad Groups. cpaGoal: Optional. The cost-per-acquisition goal. Cannot be set for ad groups in MAX_CONVERSIONS campaigns. Returned as null for Max Conversions ad groups. important: You can update the cpaGoal only in campaigns that use the APPSTORE_SEARCH_RESULTS supply source. defaultBidAmount: The default maximum cost-per-tap or cost-per-impression bid for the ad group. You can use the EQUALS, GREATER_THAN, and LESS_THAN selector Condition operators with Find Ad Groups. deleted: The indicator of whether the ad group is soft-deleted. This includes keywords that belong to an ad group. You can use the EQUALS and IN selector Condition operators with Find Ad Groups. displayStatus: The status of the ad group. The status resolves according to servingStatus and additional criteria. endTime: The scheduled end time and date for the ad group, which the system determines from the ad group with the latest end time. The endTime must be after the startTime. The endTime is updatable until you reach the designated time. The endTime must be in UTC. id: The unique identifier for the ad group that you can use as adGroupId in endpoint resources. You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Find Ad Groups. modificationTime: The date and time of the most recent modification of the object. name: The unique name of the ad group. Responses don’t include deleted ad groups. You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Find Ad Groups. orgId: The identifier of the organization that owns the campaign. Your orgId is the same as your account in Apple Ads. paymentModel: The payment model that you set through Apple Ads. If you don’t set a payment model, campaigns can’t run. See PaymentModel for value descriptions. If you don’t select a payment model, you can still create campaigns. You must select a payment model before a campaign is eligible to run. See BudgetOrder for details about setting a payment model. pricingModel: The type of pricing model for a bid. See PricingModel for value descriptions. servingStateReasons: A list of reasons that displays when an ad group isn’t running. servingStatus: The status of whether the ad group is serving. startTime: The scheduled start date and time for the ad group with the earliest start time in the campaign. The startTime must be greater than the current time, and before the campaign endTime, if you set it. If you don’t set a startTime, the campaign defaults to the campaign request timestamp and the startTime is updatable until you reach the designated time. The startTime must be in UTC. status: The user-controlled status to enable or pause the ad group. This field is updatable. You can use the EQUALS selector Condition operator with Find Ad Groups. targetingDimensions: The targeting criteria to narrow the audience.

## Mentioned in

Apple Ads Campaign Management API 4

## See Also

### Ad Group Request and Response Objects

- [AdGroupUpdate](apple_ads/adgroupupdate.md)
- [AdGroupResponse](apple_ads/adgroupresponse.md)
- [AdGroupListResponse](apple_ads/adgrouplistresponse.md)