Ad methods: update, delete
The Ad Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Ad, one group of Ad methods.
Ad.update
Changes the given properties of an Ad. Verb page.
interface AdVerbs {
update(input: AdUpdateInput, options?: SB.CallOptions): SB.Call<Ad>
}Emits Ad.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Ad. |
format | string | One of search, display, image, or video. | |
spend | money | What it has cost so far. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
ad | Ad | required | The Ad. |
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 ad = await $.Ad.update({ id: 'ad_yVW4IAmeOW', format: 'search' })Ad.delete
Deletes an Ad: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface AdVerbs {
delete(input: AdDeleteInput, options?: SB.CallOptions): SB.Call<Ad>
}Emits Ad.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Ad. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
ad | Ad | required | The Ad. |
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 ad = await $.Ad.delete({ id: 'ad_yVW4IAmeOW' })