---
title: BrandsReportingSearchTerm
framework: Apple Ads Platform API
role: symbol
role_heading: Object
platforms: [apple ads platform api 1.0+]
path: apple-ads-platform-api/brandsreportingsearchterm
---

# BrandsReportingSearchTerm

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

## Declaration

```data
object BrandsReportingSearchTerm
```

## Properties

campaignId: The identifier of the campaign that owns the search term. adAccountId: The identifier of the ad account that owns the search term. searchTermText: The actual user-entered query string. searchTermSource: Indicates whether the search term came from a direct user search or an auto-match source. keyword: See BrandsReportingKeyword for details. adGroupId: The identifier of the ad group that owns the search term. adGroup: See ReportingAdGroupMin for details. countryOrRegion: Country or region groupBy dimension value. deviceClass: Device class groupBy dimension value. locationId: Location ID groupBy dimension value.

## Discussion

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. 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 {   "keyword": {     "locationId": "555666777",     "matchType": "PHRASE"   },   "locationId": "555666777" }

## See Also

- [BrandsReportingRequest](apple-ads-platform-api/brandsreportingrequest.md)
- [BrandsReportingCampaign](apple-ads-platform-api/brandsreportingcampaign.md)
- [BrandsReportingAdGroup](apple-ads-platform-api/brandsreportingadgroup.md)
- [BrandsReportingAd](apple-ads-platform-api/brandsreportingad.md)
- [BrandsReportingCreative](apple-ads-platform-api/brandsreportingcreative.md)
- [BrandsReportingKeyword](apple-ads-platform-api/brandsreportingkeyword.md)
- [BrandsCampaignReportResponse](apple-ads-platform-api/brandscampaignreportresponse.md)
- [BrandsCampaignReportRow](apple-ads-platform-api/brandscampaignreportrow.md)
- [BrandsCampaignReportSummary](apple-ads-platform-api/brandscampaignreportsummary.md)
- [BrandsCampaignResultContainer](apple-ads-platform-api/brandscampaignresultcontainer.md)
- [BrandsAdGroupReportResponse](apple-ads-platform-api/brandsadgroupreportresponse.md)
- [BrandsAdGroupReportRow](apple-ads-platform-api/brandsadgroupreportrow.md)
- [BrandsAdGroupReportSummary](apple-ads-platform-api/brandsadgroupreportsummary.md)
- [BrandsAdGroupResultContainer](apple-ads-platform-api/brandsadgroupresultcontainer.md)
- [BrandsAdReportResponse](apple-ads-platform-api/brandsadreportresponse.md)