Contents

BrandsCampaignReportResponse

The top-level response envelope for Apple Maps campaign-level reports.

Declaration

object BrandsCampaignReportResponse

Properties

NameTypeDescription
resultBrandsCampaignResultContainer

Contains the array of campaign report rows. Each row includes the campaign metadata, capturing targeting, budget, and status at report time, along with totalMetrics and optional granularMetrics. If no rows match the request, result is returned as an empty object. See BrandsCampaignResultContainer for details.

paginationResponsePagination

Provided for iterating through large result sets. See ResponsePagination for details.

errorError

See ErrorResponse for details.

Discussion

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

Example

{
  "result": {
    "rows": [
      {
        "metadata": {
          "id": 444555999,
          "name": "AwayFinder - Brand Q1",
          "adAccountId": 123456789,
          "promotedObjectType": "BUSINESS_BRAND",
          "promotedObjectId": "9151314442816847872",
          "promotedObject": {
            "name": "AwayFinder"
          },
          "bidStrategy": {
            "bidStrategyType": "MAX_ENGAGEMENTS"
          },
          "status": "ENABLED",
          "deleted": false,
          "locationId": "loc-001"
        },
        "totalMetrics": {
          "localSpend": {
            "amount": "4200.00",
            "currency": "USD"
          },
          "impressions": 420000,
          "taps": 8400,
          "ttr": 0.02,
          "cpt": {
            "amount": "0.50",
            "currency": "USD"
          },
          "firstActions": {
            "tap": 170
          },
          "actions": {
            "tap": 170
          },
          "getDirections": {
            "tap": 1260
          }
        },
        "granularMetrics": [
          {
            "date": "2025-01-10",
            "localSpend": {
              "amount": "42.00",
              "currency": "USD"
            },
            "impressions": 4200,
            "taps": 84,
            "actions": {
              "tap": 21
            },
            "getDirections": {
              "tap": 13
            }
          }
        ]
      }
    ],
    "summary": {
      "grandTotal": {
        "localSpend": {
          "amount": "4200.00",
          "currency": "USD"
        },
        "impressions": 420000,
        "taps": 8400
      }
    }
  },
  "pagination": {
    "pageSize": 20,
    "offset": 0,
    "totalCount": 1
  }
}

See Also