Contents

TargetCpaRecommendationHistory

History record created when a target CPA recommendation is applied or dismissed.

Declaration

object TargetCpaRecommendationHistory

Properties

NameTypeDescription
recommendationIdstring

The ID of the original recommendation. Read-only.

recommendationTypeRecommendationCategory

The recommendation category. Value: TCPA. 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.

appliedTargetCPARecommendationMoney

The target CPA that was applied. Null on dismiss. See Money. Read-only.

recommendedTargetCPARecommendationMoney

The originally recommended target CPA. See Money. Read-only.

rankint32

Rank at time of action. Read-only.

installsint64

Historical install count. Read-only.

spendRecommendationMoney

Historical spend. See Money. Read-only.

averageCPARecommendationMoney

Historical average CPA. See Money. Read-only.

averageCPTRecommendationMoney

Historical average CPT. See Money. Read-only.

impressionint64

Historical impression count. Read-only.

tapsint64

Historical tap count. Read-only.

ttrdouble

Historical tap-through rate. Read-only.

expectedInstallsint64

Expected installs from the original recommendation. Read-only.

expectedSpendRecommendationMoney

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

expectedTapsint64

Expected taps from the original recommendation. Read-only.

expectedCPARecommendationMoney

Expected CPA from the original recommendation. 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 TargetCpaRecommendationHistory object is an immutable record that the system creates when you apply or dismiss a target CPA recommendation. The record preserves both recommendedTargetCPA and appliedTargetCPA (the value actually used, which may differ if the advertiser supplied a custom override).

Example

{
  "recommendationId": "123456789",
  "recommendationType": "TCPA",
  "promotedObjectId": "987654321",
  "promotedObjectType": "APPSTORE_APP",
  "campaignId": 555666777,
  "campaignName": "AwayFinder - US - Search",
  "state": "APPLIED",
  "status": "ENABLED",
  "appliedTargetCPA": {
    "amount": "5.50",
    "currency": "USD"
  },
  "recommendedTargetCPA": {
    "amount": "6.00",
    "currency": "USD"
  },
  "rank": 1,
  "installs": 1240,
  "spend": {
    "amount": "6820.00",
    "currency": "USD"
  },
  "averageCPA": {
    "amount": "5.50",
    "currency": "USD"
  },
  "averageCPT": {
    "amount": "0.85",
    "currency": "USD"
  },
  "impression": 980000,
  "taps": 8025,
  "ttr": 0.0082,
  "expectedInstalls": 1400,
  "expectedSpend": {
    "amount": "8400.00",
    "currency": "USD"
  },
  "expectedTaps": 9100,
  "expectedCPA": {
    "amount": "6.00",
    "currency": "USD"
  },
  "creationTime": "2025-01-05T08:00:00.000",
  "modificationTime": "2025-01-10T08:00:00.000",
  "appliedTime": "2025-01-10T08:00:00.000",
  "expirationTime": "2025-01-20T08:00:00.000"
}

See Also