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

# ReportingSearchTerm

Search term metadata in a report row.

```
object ReportingSearchTerm
```

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

```json
{
  "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"
}
```

---

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)