Contents

ReportingCampaign

The response to a request to fetch campaign-level reports.

Declaration

object ReportingCampaign

Properties

NameTypeDescription
adChannelTypestring

The channel type of ad in a campaign.

See AdChannelType for value descriptions.

You can use the EQUALS Selector Condition operator with Get Campaign-Level Reports.

appCampaignAppDetail

The name of the app and the adamId.

campaignIdint64

The identifier for the campaign.

You can use the EQUALS, IN, and STARTSWITH Selector Condition operators with Get Campaign-Level Reports.

biddingStrategystring

The bid strategy for the campaign. See Campaigns.

You can use the EQUALS, IN, and STARTSWITH Selector Condition operators with Get Campaign-Level Reports.

campaignNamestring

The unique name of the campaign.

You can use the EQUALS, IN, and STARTSWITH Selector Condition operators with Get Campaign-Level Reports.

campaignStatusstring

The status of the campaign.

See CampaignStatus for value descriptions.

You can use the EQUALS Selector Condition operator with Get Campaign-Level Reports.

countriesOrRegions[string]

The App Store geoterritories where you’re promoting your app.

This field requires an ISO 3166-1 alpha-2 country code value for the locations where you’re promoting. The default value is US.

You can use the EQUALS, CONTAINS_ANY, and CONTAINS_ALL Selector Condition operators with Get Campaign-Level Reports.

countryOrRegionServingStateReasonsReportingCampaign.CountryOrRegionServingStateReasons

The map of reasons that returns when a campaign isn’t running.

dailyBudgetMoney

The daily budget amount available to the campaign. This is the equivalent of dailyBudgetAmount in your Campaign.

deletedboolean

The indicator of whether the campaign is soft-deleted.

You can use the EQUALS and IN Selector Condition operators with Get Campaign-Level Reports.

displayStatusstring

The status of the campaign. The status resolves according to servingStatus and additional criteria.

modificationTimedate-time

The date and time of the most recent modification of the object.

orgIdint64

The identifier of the organization that owns the campaign. Your orgId is the same as your account in Apple Ads.

servingStateReasons[string]

A list of reasons that displays when a campaign can’t run.

See CampaignServingStateReasons for value descriptions.

servingStatusstring

The status of the campaign.

You can use the EQUALS Selector Condition operator with Get Campaign-Level Reports.

supplySources[string]

The ad placements for a campaign.

See SupplySource for value descriptions and validations.

You can use the CONTAINS_ANY, CONTAINS_ALL, and EQUALS Selector Condition operators with Get Campaign-Level Reports.

targetCpaReportingCampaign.TargetCpa

The target cost-per-acquisition for MAX_CONVERSIONS campaigns. The Target CPA is the average amount you want to spend per tap-through install. This amount is used to calculate optimal bids for each search query, with the goal of maximizing the number of installs near your target CPA.

totalBudgetMoney

Mentioned in

Topics

Objects

Dictionaries

See Also

Reports Request and Response Objects