Contents

DailyCapRecommendationHistory

History record created when you apply or dismiss a daily budget recommendation.

Declaration

object DailyCapRecommendationHistory

Properties

NameTypeDescription
recommendationIdstring

The ID of the original recommendation. Read-only.

recommendationTypeRecommendationCategory

The recommendation category. Value: DAILYCAP. Read-only.

promotedObjectIdstring

The ID of the promoted object. For APPSTORE_APP, this is the app Adam ID. For BUSINESS_BRAND, this is the brand ID. Read-only.

promotedObjectTypePromotedObjectType

The type of the promoted object. Read-only.

campaignIdint64

The campaign ID. Read-only.

campaignNamestring

Display name of the campaign. Read-only.

stateRecommendationState

Terminal state. Values: APPLIED, DISMISSED. Read-only.

statusRecommendationStatus

Operational status. Read-only.

appliedDailyBudgetAmountRecommendationMoney

The daily budget that was applied. Null on dismiss. See Money. Read-only.

suggestedDailyBudgetAmountRecommendationMoney

The originally suggested daily budget. See Money. Read-only.

rankint32

Rank at time of action. Read-only.

installsint64

Historical install count at time of action. Read-only.

spendRecommendationMoney

Historical spend at time of action. See Money. Read-only.

averageCPARecommendationMoney

Historical average CPA at time of action. See Money. Read-only.

averageCPTRecommendationMoney

Historical average CPT at time of action. See Money. Read-only.

impressionint64

Historical impression count. Read-only.

tapsint64

Historical tap count. Read-only.

ttrdouble

Historical tap-through rate. Read-only.

expectedImpressionsint64

Expected impressions from the original recommendation. Read-only.

expectedImpressionsLowint64

Lower bound of the expected impressions confidence interval. Read-only.

expectedImpressionsHighint64

Upper bound of the expected impressions confidence interval. Read-only.

expectedInstallsint64

Expected installs from the original recommendation. Read-only.

expectedInstallsLowint64

Lower bound of the expected installs confidence interval. Read-only.

expectedInstallsHighint64

Upper bound of the expected installs confidence interval. Read-only.

expectedSpendRecommendationMoney

Expected spend from the original recommendation. See Money. Read-only.

expectedSpendLowRecommendationMoney

Lower bound of the expected spend confidence interval. See Money. Read-only.

expectedSpendHighRecommendationMoney

Upper bound of the expected spend confidence interval. See Money. Read-only.

expectedTapsint64

Expected taps from the original recommendation. Read-only.

expectedTapsLowint64

Lower bound of the expected taps confidence interval. Read-only.

expectedTapsHighint64

Upper bound of the expected taps confidence interval. Read-only.

expectedCpaRecommendationMoney

Expected CPA from the original recommendation. See Money. Read-only.

expectedCpaLowRecommendationMoney

Lower bound of the expected CPA confidence interval. See Money. Read-only.

expectedCpaHighRecommendationMoney

Upper bound of the expected CPA confidence interval. See Money. Read-only.

creationTimedate-time

When the original recommendation was created. Read-only.

modificationTimedate-time

When this history record was last modified. Read-only.

appliedTimedate-time

When the action was taken. Read-only.

expirationTimedate-time

When the original recommendation would have expired. Read-only.

Discussion

The DailyCapRecommendationHistory object is an immutable record created when you apply or dismiss a daily budget recommendation. The record preserves both suggestedDailyBudgetAmount and the appliedDailyBudgetAmount actually used, so you can check whether you overrode the suggestion.

Example

{
  "recommendationId": "123456789",
  "recommendationType": "DAILYCAP",
  "promotedObjectId": "987654321",
  "promotedObjectType": "APPSTORE_APP",
  "campaignId": 555666777,
  "campaignName": "AwayFinder - Search Campaign",
  "state": "APPLIED",
  "status": "ENABLED",
  "appliedDailyBudgetAmount": {
    "amount": "150.00",
    "currency": "USD"
  },
  "suggestedDailyBudgetAmount": {
    "amount": "150.00",
    "currency": "USD"
  },
  "rank": 1,
  "installs": 420,
  "spend": {
    "amount": "980.50",
    "currency": "USD"
  },
  "averageCPA": {
    "amount": "2.33",
    "currency": "USD"
  },
  "averageCPT": {
    "amount": "0.85",
    "currency": "USD"
  },
  "impression": 154000,
  "taps": 3200,
  "ttr": 0.0208,
  "expectedImpressions": 220000,
  "expectedImpressionsLow": 190000,
  "expectedImpressionsHigh": 250000,
  "expectedInstalls": 600,
  "expectedInstallsLow": 520,
  "expectedInstallsHigh": 680,
  "expectedSpend": {
    "amount": "1400.00",
    "currency": "USD"
  },
  "expectedSpendLow": {
    "amount": "1250.00",
    "currency": "USD"
  },
  "expectedSpendHigh": {
    "amount": "1550.00",
    "currency": "USD"
  },
  "expectedTaps": 4600,
  "expectedTapsLow": 4000,
  "expectedTapsHigh": 5200,
  "expectedCpa": {
    "amount": "2.33",
    "currency": "USD"
  },
  "expectedCpaLow": {
    "amount": "2.05",
    "currency": "USD"
  },
  "expectedCpaHigh": {
    "amount": "2.60",
    "currency": "USD"
  },
  "creationTime": "2025-01-08T08:00:00.000",
  "modificationTime": "2025-01-10T08:00:00.000",
  "appliedTime": "2025-01-10T08:00:00.000",
  "expirationTime": "2025-01-15T08:00:00.000"
}

See Also