Demand Budget methods: create, get, list
The Demand Budget Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Demand Budget, one group of Demand Budget methods.
DemandBudget.create
Creates a Demand Budget. Verb page.
interface DemandBudgetVerbs {
create(input: DemandBudgetCreateInput, options?: SB.CallOptions): SB.Call<DemandBudget>
}Emits DemandBudget.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
amount | money | required | The monthly spend it funds; zero is the default. |
tier | string | required | One of $0, $100, $1k, $10k or $100k: the highest tier at or below the amount, whose Play mix it buys. |
target | string | required | The Metric value the spend must reach, such as cost per first Order under $40. |
stopRule | string | required | The reading that closes the budget, such as acquisition cost above margin for two weeks. |
until | date | The last day the budget runs before its Decision is read. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
demandBudget | Demand Budget | required | The Demand Budget. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const demandBudget = await $.DemandBudget.create({ amount: { amount: 29, currency: 'USD' }, tier: '$0', target: 'Example target', stopRule: 'Example stop rule' })DemandBudget.get
Returns one Demand Budget by id. Verb page.
interface DemandBudgetVerbs {
get(input: DemandBudgetGetInput, options?: SB.CallOptions): SB.Call<DemandBudget>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Demand Budget. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
demandBudget | Demand Budget | required | The Demand Budget. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const demandBudget = await $.DemandBudget.get({ id: 'demand_zQZUG08LwY' })DemandBudget.list
Returns Demand Budgets, newest first, one page at a time. Verb page.
interface DemandBudgetVerbs {
list(input?: DemandBudgetListInput, options?: SB.CallOptions): SB.ListCall<DemandBudget>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
demandBudgets | list of Demand Budget | required | One page of Demand Budgets. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const demandBudgets = await $.DemandBudget.list({ limit: 20 })