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

# ReportingSearchTerm

Search term metadata in a report row.

## Declaration

```data
object ReportingSearchTerm
```

## 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 ReportingKeyword 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.

## Discussion

Discussion The ReportingSearchTerm object is the search term metadata embedded in search term report rows. The keyword field links the search term back to the keyword that matched it, enabling attribution of observed query behavior to specific bids. Search term reports exclusively require the ORTZ timezone. UTC isn’t supported. The report populates the dimension fields (countryOrRegion, deviceClass) based on the groupBy dimensions in the report request. The adGroup field provides a lightweight parent ad group summary for display and grouping purposes. Example {   "campaignId": 123456789,   "adAccountId": 987654321,   "searchTermText": "awayfinder travel app",   "searchTermSource": "SEARCH",   "keyword": {     "id": 555666777,     "campaignId": 123456789,     "adAccountId": 987654321,     "deleted": false,     "text": "awayfinder travel app",     "status": "ENABLED",     "matchType": "BROAD",     "bid": {       "currency": "USD",       "amount": "1.50"     },     "adGroupId": 234567891,     "modificationTime": "2025-01-10T08:00:00.000",     "creationTime": "2025-01-05T08:00:00.000",     "displayStatus": "RUNNING",     "adGroup": {       "name": "AwayFinder Search - Broad",       "deleted": false     },     "countryOrRegion": "US",     "deviceClass": "IPHONE"   },   "adGroupId": 234567891,   "adGroup": {     "name": "AwayFinder Search - Broad",     "deleted": false   },   "countryOrRegion": "US",   "deviceClass": "IPHONE" }

## See Also

- [TimeRange](apple-ads-platform-api/timerange.md)
- [Filter](apple-ads-platform-api/filter.md)
- [Sorting](apple-ads-platform-api/sorting.md)
- [RequestPagination](apple-ads-platform-api/requestpagination.md)
- [ReportingMoney](apple-ads-platform-api/reportingmoney.md)
- [ReportingBidStrategy](apple-ads-platform-api/reportingbidstrategy.md)
- [ReportingCampaignMin](apple-ads-platform-api/reportingcampaignmin.md)
- [ReportingAdGroupMin](apple-ads-platform-api/reportingadgroupmin.md)
- [ReportingCreativeSpec](apple-ads-platform-api/reportingcreativespec.md)
- [ReportingDestination](apple-ads-platform-api/reportingdestination.md)
- [ReportingKeyword](apple-ads-platform-api/reportingkeyword.md)
- [ActionMetrics](apple-ads-platform-api/actionmetrics.md)
- [CostMetrics](apple-ads-platform-api/costmetrics.md)
- [RateMetrics](apple-ads-platform-api/ratemetrics.md)
- [ReportingAdChannelType](apple-ads-platform-api/reportingadchanneltype.md)