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

# ReportingKeyword

Keyword metadata in a report row.

```
object ReportingKeyword
```

## Discussion

The `ReportingKeyword` object is the keyword metadata embedded in keyword report rows and within search term rows (via the `keyword` field). It captures the keyword’s text, match type, bid amount, and status at report time, along with its organizational context (`campaignId`, `adGroupId`, `adAccountId`).

The `bid` field is the keyword-level bid amount in the account currency, and `adGroup` provides a lightweight summary of the parent ad group. The report populates the dimension fields (`countryOrRegion`, `deviceClass`) when you specify those dimensions in the report request.

### Example

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

---

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)