AppsReportingCampaign

Campaign metadata for apps report rows.

Declaration

object AppsReportingCampaign

Properties

Name	Type	Description
`id`	int64	The campaign’s unique identifier.
`promotedObject`	`PromotedObject`	See PromotedObject for details.
`promotedObjectType`	string	Always `APPSTORE_APP` for Apple Ads campaigns.
`promotedObjectId`	string	The Adam ID of the promoted App Store app.
`name`	string	The campaign name as configured at report time.
`status`	`AppsReportingCampaign.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`	`AppsReportingCampaign.SystemStatus`	Possible values: `RUNNING`, `NOT_RUNNING`.
`systemStatusReasons`	[`CampaignSystemStatusReason`]	System-applied reasons contributing to the current `systemStatus`. See CampaignSystemStatusReason for possible values.
`billingEvent`	`AppsReportingCampaign.BillingEvent`	Possible values: `TAPS`, `IMPRESSIONS`.
`systemStatusLimitingReasons`	[string]	System-applied reasons limiting delivery below maximum potential. See CampaignSystemLimitedStatusReason for possible values.
`targeting`	`AppsTargetingProjection`	The `targeting` field contains an `AppsTargetingProjection` snapshot of the campaign’s supply placement and App Store countries or regions targeted at the time of the report. See AppsTargetingProjection 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`	`AppsReportingCampaign.AdChannelType`	The advertising channel type for this campaign. Possible values: `SEARCH`, `DISPLAY`.
`countryOrRegion`	string	Country or region groupBy dimension value.
`deviceClass`	string	Device class groupBy dimension value.
`gender`	string	Gender groupBy dimension value.
`ageRange`	string	Age range groupBy dimension value.
`locality`	string	Locality groupBy dimension value.
`countryCode`	string	Country code groupBy dimension value.
`adminArea`	string	Administrative area groupBy dimension value.

Discussion

The AppsReportingCampaign object is the campaign metadata embedded in apps campaign report rows. It captures the campaign’s identity, operational status, budget, bid strategy, and targeting projection at report time.

The groupBy dimensions specified in the report request determine the values of the dimension fields (countryOrRegion, deviceClass, gender, ageRange, etc.).

Example

{
  "id": 555666777,
  "promotedObject": {
    "name": "AwayFinder"
  },
  "promotedObjectType": "APPSTORE_APP",
  "promotedObjectId": "123456789",
  "name": "AwayFinder - Search Results",
  "status": "ENABLED",
  "deleted": false,
  "displayStatus": "RUNNING",
  "modificationTime": "2025-01-10T08:00:00.000",
  "creationTime": "2024-11-01T08:00:00.000",
  "adAccountId": 987654321,
  "systemStatus": "RUNNING",
  "systemStatusReasons": [],
  "billingEvent": "TAPS",
  "systemStatusLimitingReasons": [],
  "targeting": {
    "supplyPlacement": {
      "include": ["APPSTORE_SEARCH_RESULTS"]
    },
    "lifetimeStorefronts": {
      "include": ["US"]
    },
    "countryOrRegion": {
      "include": ["US"]
    }
  },
  "dailyBudget": {
    "value": {
      "amount": "100.00",
      "currency": "USD"
    }
  },
  "startTime": "2024-11-01T08: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",
  "countryOrRegion": "US",
  "deviceClass": "IPHONE",
  "gender": "F",
  "ageRange": "25-34",
  "locality": "San Francisco",
  "countryCode": "US",
  "adminArea": "CA"
}

AppsReportingCampaign

Declaration

Properties

Discussion

Example

Topics

Type Aliases

See Also