Sign in

v1

latestOpenAPI 3.0.02026-07-2678399358.2 KB
SpendCap

ListSpendCaps

List spend caps for an ad account.

get/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/spend-caps

Path parameters

platform_idstring required

Identifier of the platform. Passed as a path parameter.

ad_account_idstring required

AdAccount id.

Query parameters

filter.status'UNKNOWN_SPEND_CAP_STATUS' | 'SCHEDULED' | 'INACTIVE' | 'ACTIVE' | 'ENDED' | 'DEPLETED' | 'ERROR'

Filter by spend cap status.

  • SCHEDULED: The SpendCap is not in an Active state due to an unexpected error case Similar to the Scheduled state of a campaign, the SpendCap is in a “reserved” state because its period has not yet started.
  • INACTIVE: The status when the user manually changes the SpendCap from Active to Inactive.
  • ACTIVE: The SpendCap is in an Active state. As long as the amount is not depleted, the mapped campaigns can remain Active and serve ads without issues
  • ENDED: One of the cases where the SpendCap is no longer Active because its defined period has ended.
  • DEPLETED: The SpendCap has reached its allocated amount (0 remaining). As a result, the mapped campaigns can no longer remain active and ad serving stops, even though the period itself has not yet ended.
  • ERROR: Error state. The campaign state does not belong to any states above.

Response

A successful response.