HQ APIAd campaigns
Create an ad campaign
Creates a new ad campaign with status active. Create equals submit — ads are transitioned to in_review as part of the request.
POST
/v1/hq/ad_campaignsAuthorizationBearer <token>
The Noona HQ API uses Bearer token for authentication.
Endpoints that return generic information that does not contain sensitive data do not require authentication. Endpoints that require authentication are specifically marked in the documentation.
Authorization: Bearer your-token
In: header
Query Parameters
select?array<string>
expand?array<string>
Request Body
application/json
company_id*string
name*string
budget*
Budget amounts are denominated in the company's own currency, which is why no currency is accepted here: an ad event charge is priced in the company currency, and a budget in any other currency could never be compared against the spend accumulated against it.
schedule?
targeting*
promotables*
Response Body
application/json
curl -X POST "https://api.noona.is/v1/hq/ad_campaigns" \ -H "Content-Type: application/json" \ -d '{ "company_id": "string", "name": "string", "budget": { "daily": { "amount": 10000 } }, "targeting": {}, "promotables": [ {} ] }'{
"id": "string",
"company": "string",
"name": "string",
"status": "pending_review",
"budget": {
"daily": {
"amount": 10000,
"currency": "ISK"
},
"total": {
"amount": 10000,
"currency": "ISK"
}
},
"schedule": {
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"duration_days": 1
},
"targeting": {
"location": {
"google_place_id": "string",
"address": {
"city": "string",
"postalCode": "string",
"street": "string",
"region": "string",
"locality": "string",
"country": "string"
},
"formatted_address": "string",
"lat_lng": {
"lat": 0.1,
"lng": 0.1
},
"country": {
"short_name": "IS",
"long_name": "Iceland"
},
"time_zone": "Atlantic/Reykjavik"
},
"radius": 0
},
"promotables": [
{
"type": "ad",
"ad": "string"
}
],
"spend": {
"total": {
"amount": 10000,
"currency": "ISK"
},
"today": {
"amount": 10000,
"currency": "ISK"
},
"today_date": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"starts_at": "2019-08-24T14:15:22Z"
}Empty
Empty
Empty
Empty
Empty
Empty