BrandsReportingCampaign

Campaign metadata for Apple Maps report rows.

Declaration

object BrandsReportingCampaign

Properties

Name	Type	Description
`id`	int64	The campaign’s unique identifier.
`promotedObject`	`PromotedObject`	See PromotedObject for details.
`promotedObjectType`	string	Possible values: `BUSINESS_BRAND`.
`promotedObjectId`	string	The brand ID of the promoted Maps business.
`name`	string	The campaign name as configured at report time.
`status`	`BrandsReportingCampaign.Status`	Possible values: `ENABLED`, `PAUSED`.
`deleted`	boolean	Whether the campaign has been soft-deleted.
`displayStatus`	string	System-computed, rolled-up delivery state combining `status` and `systemStatus` into a single label. See CampaignDisplayStatus.
`modificationTime`	date-time	Timestamp of the campaign’s last modification (ISO 8601).
`creationTime`	date-time	Timestamp when the campaign was created (ISO 8601).
`adAccountId`	int64	The ad account this campaign belongs to.
`systemStatus`	`BrandsReportingCampaign.SystemStatus`	Possible values: `RUNNING`, `NOT_RUNNING`.
`systemStatusReasons`	[`CampaignSystemStatusReason`]	System-applied reasons contributing to the current `systemStatus`. See CampaignSystemStatusReason for possible values.
`billingEvent`	`BrandsReportingCampaign.BillingEvent`	Possible values: `TAPS`, `IMPRESSIONS`.
`systemStatusLimitingReasons`	[string]	System-applied reasons limiting delivery below maximum potential. See CampaignSystemLimitedStatusReason for possible values.
`targeting`	`BrandsTargetingProjection`	See BrandsTargetingProjection for details.
`dailyBudget`	`ReportingMoney`	See ReportingMoney for details.
`startTime`	date-time	Campaign start time.
`endTime`	date-time	Campaign end time.
`lifetimeBudget`	`ReportingMoney`	Lifetime budget for the campaign. See ReportingMoney for details.
`bidStrategy`	`ReportingBidStrategy`	See ReportingBidStrategy for details.
`adChannelType`	`BrandsReportingCampaign.AdChannelType`	The advertising channel type for this campaign. Possible values: `SEARCH`, `DISPLAY`.
`deviceClass`	string	Device class groupBy dimension value.
`locationId`	string	Location ID groupBy dimension value.
`supplyPlacement`	string	Supply placement groupBy dimension value.

Discussion

The BrandsReportingCampaign object is the campaign metadata embedded in brands campaign report rows. It captures the campaign’s full configuration at report time: identity, budget (dailyBudget), bid strategy, billing event, and the BrandsTargetingProjection snapshot of active supply placement and location targeting.

The promotedObjectType field is always BUSINESS_BRAND for Maps-based campaigns. The system populates the brands dimension fields (deviceClass, locationId, supplyPlacement) based on the groupBy dimensions in the report request.

Example

{
  "id": 555666777,
  "promotedObject": {
    "name": "AwayFinder Downtown"
  },
  "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",
  "systemStatusReasons": [],
  "billingEvent": "IMPRESSIONS",
  "systemStatusLimitingReasons": [],
  "targeting": {
    "supplyPlacement": {
      "include": ["MAPS_SEARCH_RESULTS", "MAPS_SEARCH_HOME"]
    },
    "lifetimeStorefronts": {
      "include": ["US", "CA"]
    },
    "supplySource": {
      "include": ["MAPS"]
    },
    "promotedLocationGroup": {
      "include": ["555666777"]
    },
    "promotedLocation": {
      "include": ["123456789"]
    }
  },
  "dailyBudget": {
    "value": {
      "amount": "50.00",
      "currency": "USD"
    }
  },
  "startTime": "2025-01-10T08:00:00.000",
  "endTime": "2025-12-31T08:00:00.000",
  "lifetimeBudget": {
    "value": {
      "amount": "5000.00",
      "currency": "USD"
    }
  },
  "bidStrategy": {
    "bidStrategyType": "MANUAL_CPT",
    "bid": {
      "amount": "1.50",
      "currency": "USD"
    }
  },
  "adChannelType": "SEARCH",
  "deviceClass": "IPHONE",
  "locationId": "123456789",
  "supplyPlacement": "MAPS_SEARCH_RESULTS"
}

BrandsReportingCampaign

Declaration

Properties

Discussion

Example

Topics

Type Aliases

See Also