ListSpendCaps

List spend caps for an ad account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the platform. Passed as a path parameter.

string
required

AdAccount id.

Query Params
string
enum
Defaults to UNKNOWN_SPEND_CAP_STATUS

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.
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json