Ad

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/patentpad.com/ads/ad_1",
  "$type": "Ad",
  "format": "search",
  "spend": {
    "amount": 499,
    "currency": "USD"
  }
}

RelationshipsCopy Anchor Link

• An Ad promotes one Offer: each Ad sells one Offer. promotes, inverse promotedBy.
• An Ad is run in one Campaign: a Campaign places Ads that share its budget and window. runIn, inverse runs.
• An Ad targets many Audiences: an Ad is shown to the people its Audiences select. targets, inverse targetedBy.

VerbsCopy Anchor Link

1. createCreates an Ad.
   POST /{namespace}/adsdoAd.created
2. getReturns one Ad by id.
   GET /{namespace}/ads/{id}readNo Event
3. listReturns Ads, newest first, one page at a time.
   GET /{namespace}/adsreadNo Event
4. updateChanges the given properties of an Ad.
   PATCH /{namespace}/ads/{id}doAd.updated
5. deleteDeletes an Ad; its history is kept.
   DELETE /{namespace}/ads/{id}doAd.deleted

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Add an ad to ShiftNote.

ExampleCopy Anchor Link

A short-video Ad shows a meal-planning App filling a week of dinners from one fridge photo. It targets an Audience of parents who save recipe posts, spends $40 a day, and links to the 7-day trial Offer.