<!--
{
  "availability" : [
    "Apple Ads Platform API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Apple-Ads-Platform-API",
  "identifier" : "/documentation/Apple-Ads-Platform-API/BrandsReportingAdGroup",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Apple Ads Platform API"
    ],
    "preciseIdentifier" : "data:apple-ads-platform-api:BrandsReportingAdGroup"
  },
  "title" : "BrandsReportingAdGroup"
}
-->

# BrandsReportingAdGroup

Ad group metadata for brands report rows.

```
object BrandsReportingAdGroup
```

## Discussion

The `BrandsReportingAdGroup` object is the ad group metadata embedded in `brands` ad group report rows. It captures configuration at report time, including the `pricingModel`, `bidStrategy`, and the `brands`-specific `targeting` projection with supply placement and location group details.

The `campaign` field embeds a lightweight `ReportingCampaignMin` for parent campaign context. The system populates the `brands` dimension fields (`deviceClass`, `locationId`, `supplyPlacement`) based on the `groupBy` dimensions in the report request. Note that keyword and search term entities exclude `supplyPlacement` and `locationId` as `groupBy` options.

### Example

```json
{
  "id": 123456789,
  "campaignId": 987654321,
  "adAccountId": 555666777,
  "name": "AwayFinder - Brands Ad Group",
  "status": "ENABLED",
  "deleted": false,
  "systemStatus": "RUNNING",
  "systemStatusReasons": ["PROCESSING"],
  "systemStatusLimitingReasons": [],
  "automatedKeywordsOptIn": false,
  "automatedKeywordsRequired": false,
  "pricingModel": "CPT",
  "displayStatus": "RUNNING",
  "modificationTime": "2025-01-10T08:00:00.000",
  "creationTime": "2025-01-05T08:00:00.000",
  "startTime": "2025-01-05T08:00:00.000",
  "endTime": "2025-06-30T08:00:00.000",
  "campaign": {},
  "bidStrategy": {
    "bidStrategyType": "MANUAL_CPT",
    "bid": {
      "amount": "2.50",
      "currency": "USD"
    }
  },
  "targeting": {
    "supplyPlacement": {
      "include": ["MAPS_SEARCH_RESULTS", "MAPS_SEARCH_HOME"]
    },
    "lifetimeStorefronts": {
      "include": ["US", "CA"]
    },
    "supplySource": {
      "include": ["MAPS"]
    },
    "promotedLocationGroup": {
      "include": ["555666777"]
    },
    "promotedLocation": {
      "include": ["123456789"]
    }
  },
  "deviceClass": "IPHONE",
  "locationId": "123456789",
  "supplyPlacement": "MAPS_SEARCH_RESULTS"
}
```

## Topics

### Type Aliases

[`string BrandsReportingAdGroup.PricingModel`](/documentation/Apple-Ads-Platform-API/BrandsReportingAdGroup/PricingModel-data.typealias)

The unit of ad delivery the ad group is charged for, as captured at report time.

[`string BrandsReportingAdGroup.Status`](/documentation/Apple-Ads-Platform-API/BrandsReportingAdGroup/Status-data.typealias)

Advertiser-configurable serving status of the ad group at report time.

[`string BrandsReportingAdGroup.SystemStatus`](/documentation/Apple-Ads-Platform-API/BrandsReportingAdGroup/SystemStatus-data.typealias)

System-derived operational status of the ad group at report time.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)