Contents

BrandsAdGroupReportResponse

The top-level response envelope for brands ad group reports.

Declaration

object BrandsAdGroupReportResponse

Properties

NameTypeDescription
resultBrandsAdGroupResultContainer

Wraps the array of report rows, each containing the ad group metadata (including targeting configuration) and performance metrics segmented by the requested groupBy dimensions. If no rows match the request, result is returned as an empty object. See BrandsAdGroupResultContainer for details.

paginationResponsePagination

Returned for paging through large result sets. See ResponsePagination for details.

errorError

See ErrorResponse for details.

Discussion

The brands ad group reports support groupBy dimensions deviceClass, locationId, and supplyPlacement.

Example

{
  "result": {
    "rows": [
      {
        "metadata": {
          "id": 555666888,
          "name": "AwayFinder - SF Metro Locations",
          "adAccountId": 123456789,
          "campaignId": 444555999,
          "status": "ENABLED",
          "deleted": false,
          "locationId": "loc-002"
        },
        "totalMetrics": {
          "localSpend": {
            "amount": "4200.00",
            "currency": "USD"
          },
          "impressions": 420000,
          "taps": 8400,
          "ttr": 0.02
        },
        "granularMetrics": [
          {
            "date": "2025-01-10",
            "localSpend": {
              "amount": "420.00",
              "currency": "USD"
            },
            "impressions": 42000,
            "taps": 840
          }
        ]
      }
    ],
    "summary": {
      "grandTotal": {
        "localSpend": {
          "amount": "4200.00",
          "currency": "USD"
        },
        "impressions": 420000,
        "taps": 8400
      }
    }
  },
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

See Also