campaign_plan_list
List the campaign plans in your organization, with the money figures you would rank them by.
On this page
Lists every Campaign Plan in your organization: what you intend to run, on which channels, for how much, over what period.
Warning
A Campaign Plan is not a provider campaign
It is AdCrunch’s own planning document — written before anything is bought,
and possibly executed into several campaigns, or none. For campaigns that
exist on Meta or Google, use list_entities and
get_entity.
Input
Takes no arguments. Plans are always scoped to your active organization.
Output
Each plan comes back as summary facts rather than its contents — the Line Items themselves come from campaign_plan_get.
| Field | Description |
|---|---|
slug |
The stable handle every other tool takes. |
name, description |
What it is, in a line. |
currency |
ISO 4217. Every amount on the plan is in its minor units. |
totalBudget |
The envelope — what you have. null means no declared constraint, which is not zero. |
allocation |
allocated (what you have placed), unallocated (the remainder), unit, and comparable. |
startDate, endDate |
Either may be null; a null end means always-on. |
status |
draft or approved. |
lineItemCount, channels |
How many rows, and which channels they touch. |
Tip
Check `allocation.comparable` before you add anything up
When it is false, the plan’s lines do not share a unit — some read as a
total for a period, others as a rate per day — so there is no sum to state.
Say “not comparable” rather than adding them.
Requires the campaign_plan:read scope.