DailyCapRecommendationHistory
History record created when you apply or dismiss a daily budget recommendation.
Declaration
object DailyCapRecommendationHistoryProperties
| Name | Type | Description |
|---|---|---|
recommendationId | string | The ID of the original recommendation. Read-only. |
recommendationType | RecommendationCategory | The recommendation category. Value: |
promotedObjectId | string | The ID of the promoted object. For |
promotedObjectType | PromotedObjectType | The type of the promoted object. Read-only. |
campaignId | int64 | The campaign ID. Read-only. |
campaignName | string | Display name of the campaign. Read-only. |
state | RecommendationState | Terminal state. Values: |
status | RecommendationStatus | Operational status. Read-only. |
appliedDailyBudgetAmount | RecommendationMoney | The daily budget that was applied. Null on dismiss. See Money. Read-only. |
suggestedDailyBudgetAmount | RecommendationMoney | The originally suggested daily budget. See Money. Read-only. |
rank | int32 | Rank at time of action. Read-only. |
installs | int64 | Historical install count at time of action. Read-only. |
spend | RecommendationMoney | Historical spend at time of action. See Money. Read-only. |
averageCPA | RecommendationMoney | Historical average CPA at time of action. See Money. Read-only. |
averageCPT | RecommendationMoney | Historical average CPT at time of action. See Money. Read-only. |
impression | int64 | Historical impression count. Read-only. |
taps | int64 | Historical tap count. Read-only. |
ttr | double | Historical tap-through rate. Read-only. |
expectedInstalls | int64 | Expected installs from the original recommendation. Read-only. |
expectedSpend | RecommendationMoney | Expected spend from the original recommendation. See Money. Read-only. |
expectedCpa | RecommendationMoney | Expected CPA from the original recommendation. See Money. Read-only. |
creationTime | date-time | When the original recommendation was created. Read-only. |
modificationTime | date-time | When this history record was last modified. Read-only. |
appliedTime | date-time | When the action was taken. Read-only. |
expirationTime | date-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,
"expectedInstalls": 600,
"expectedSpend": {
"amount": "1400.00",
"currency": "USD"
},
"expectedCpa": {
"amount": "2.33",
"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
TargetCpaRecommendationTargetCpaRecommendationHistoryDailyCapRecommendationApplyTargetCpaRecommendationApplyDailyCapRecommendationResponseEnvelopeResponseErrorResponseErrorDetailResponsePaginationMoneyRecommendationApplyDailyBudgetResponseRecommendationApplyTargetCpaResponseRecommendationBidStrategyRecommendationDismissDailyBudgetResponseRecommendationDismissTargetCpaResponse