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

# BrandsOptions

Reports options for brands promoted object campaigns.

```
object BrandsOptions
```

## Discussion

The `BrandsOptions` configures optional row behavior for `brands` report responses. The only supported value for `includeRows` is `GRAND_TOTAL`, which appends an aggregated summary row at the end of the result set. This totals all numeric metric fields across the full result page, giving a quick overview without requiring a client-side sum.

Note that `EMPTY_METRICS` (which is available for some other promoted object types) is explicitly unsupported for `brands` entities. If you omit `BrandsOptions` entirely from the report request, the response returns only individual data rows with no summary.

### Example

```json
{
  "includeRows": ["GRAND_TOTAL"]
}
```

---

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)