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

# BrandsReportingSearchTerm

Search term metadata for brands report rows, extending the base reporting search term with brands-only internal fields.

```
object BrandsReportingSearchTerm
```

## Discussion

The `BrandsReportingSearchTerm` extends the base `ReportingSearchTerm` object with a `brands`-only `locationId` field. The base object provides the `searchTermText` and `searchTermSource`, along with `campaignId`, `adAccountId`, `adGroupId`, `adGroup`, `countryOrRegion`, and `deviceClass`, all inherited unchanged from [`ReportingSearchTerm`](/documentation/Apple-Ads-Platform-API/ReportingSearchTerm). The `keyword` field here is a `BrandsReportingKeyword` rather than the standard `ReportingKeyword`, capturing the `brands` keyword context that the search term matched against.

Search term reports require the ORTZ timezone. The `brands` search term reports exclude the `supplyPlacement` and `locationId` dimensions from `groupBy`. Only `deviceClass` is available if dimensioned grouping is needed.

### Example

```json
{
  "keyword": {
    "locationId": "555666777",
    "matchType": "PHRASE"
  },
  "locationId": "555666777"
}
```

---

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)