ReportingKeyword
Keyword metadata in a report row.
Declaration
object ReportingKeywordProperties
| Name | Type | Description |
|---|---|---|
id | int64 | The keyword identifier. |
campaignId | int64 | The identifier of the campaign that owns the keyword. |
adAccountId | int64 | The identifier of the ad account that owns the keyword. |
deleted | boolean |
|
text | string | The keyword text. |
status | string | Possible values: |
matchType | string | Possible values: |
bid | Money | See Money for details. |
adGroupId | int64 | The identifier of the ad group that owns the keyword. |
modificationTime | date-time | The time the keyword was last modified. |
creationTime | date-time | The time the keyword was created. |
displayStatus | string | The computed display status of the keyword. |
adGroup | ReportingAdGroupMin | See ReportingAdGroupMin for details. |
countryOrRegion | string | Country or region groupBy dimension value. |
deviceClass | string | Device class groupBy dimension value. |
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
{
"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"
}