Contents

BrandsCampaignReportRow

A single row in an Apple Maps campaign report, containing campaign metadata, total metrics, and optional granular time-series metrics.

Declaration

object BrandsCampaignReportRow

Properties

NameTypeDescription
totalMetricsBrandsCampaignMetrics

Aggregated performance figures including the brands-specific engagement metrics (directions, calls, shares, etc.). See BrandsCampaignMetrics for details.

granularMetrics[BrandsCampaignMetrics]

Time-series breakdown, present when a granularity is specified in the request.

metadataBrandsReportingCampaign

Campaign identifiers, targeting projection, budget, and operational status at report time. See BrandsReportingCampaign for details.

Discussion

For brands reports, supported groupBy dimensions are deviceClass, locationId, and supplyPlacement. These appear as dimension values within the metadata object.

Example

{
  "totalMetrics": {
    "localSpend": {
      "amount": "845.50",
      "currency": "USD"
    },
    "impressions": 620000,
    "taps": 9800,
    "ttr": 0.0158,
    "cpt": {
      "amount": "0.09",
      "currency": "USD"
    },
    "cpm": {
      "amount": "1.36",
      "currency": "USD"
    },
    "getDirections": {
      "tap": 320
    },
    "call": {
      "tap": 145
    },
    "share": {
      "tap": 95
    }
  },
  "granularMetrics": [
    {
      "date": "2025-01-10",
      "localSpend": {
        "amount": "420.25",
        "currency": "USD"
      },
      "impressions": 310000,
      "taps": 4900,
      "ttr": 0.0158,
      "cpt": {
        "amount": "0.09",
        "currency": "USD"
      },
      "cpm": {
        "amount": "1.36",
        "currency": "USD"
      },
      "getDirections": {
        "tap": 160
      },
      "call": {
        "tap": 72
      },
      "share": {
        "tap": 48
      }
    }
  ],
  "metadata": {
    "id": 555666777,
    "promotedObjectType": "BUSINESS_BRAND",
    "promotedObjectId": "123456789",
    "name": "AwayFinder Apple Maps Campaign",
    "status": "ENABLED",
    "deleted": false,
    "displayStatus": "RUNNING",
    "modificationTime": "2025-01-10T08:00:00.000",
    "creationTime": "2025-01-05T08:00:00.000",
    "adAccountId": 987654321,
    "systemStatus": "RUNNING",
    "billingEvent": "IMPRESSIONS",
    "dailyBudget": {
      "value": {
        "amount": "50.00",
        "currency": "USD"
      }
    },
    "startTime": "2025-01-10T08:00:00.000",
    "endTime": "2025-12-31T08:00:00.000",
    "bidStrategy": {
      "bidStrategyType": "MANUAL_CPT",
      "bid": {
        "amount": "1.50",
        "currency": "USD"
      }
    },
    "deviceClass": "IPHONE",
    "locationId": "123456789",
    "supplyPlacement": "MAPS_SEARCH_RESULTS"
  }
}

See Also