Skip to main content

Ads

M
Written by Megan Pratt
Updated over a month ago

CRUD operations for ads

Endpoints

Method

Endpoint

Description

GET

/v3/ads

Get a list of current ads

POST

/v3/ads

Create new ad

GET

/v3/ads/[id]

Get details for a specific ad

PUT

/v3/ads/[id]

Update a specific ad

Get Ads

Method: GET
Endpoint: /v3/ads

JSON

{ "data": [ ..., { "budget_id": 246921, "campaign_id": 168785, "creative_id": 43494, "id": 454017, "name": "ad name" }, { "budget_id": 246921, "campaign_id": 168785, "creative_id": 56012, "id": 454018, "name": "ad name" }, ... }

Get Ad

Method: GET
Endpoint: /v3/ads/[id]

Example

Response

{ "data": { "budget_id": 246921, "creative_id": 43494, "id": 454017, "name": "ad name", "serving_status": "deleted" } }

Create Ad

Method: POST
Endpoint: /v3/ads

Parameters

Parameter

Type

Description

name

string

Optional name of the ad. Will be inherited from creative if left null.

creative_id (required)

integer

ID of creative that will be linked to the ad.

budget_id (required)

integer

ID of budget that ad will be linked to.

third_party_tag (read-only)

string

This tag contains Nativo JS and budget information for budgets serving via 3rd party ad server within this budget. To use this tag, input into your 3rd party ad server.

Example

Payload

{ "budget_id": 217462, "creative_id": 62101, "name": "Ad name" }

Response

{ "data": { "budget_id": 217462, "creative_id": 62101, "id": 426661, "name": "Ad name" } }

Update Ad

Method: PUT
Endpoint: /v3/ads/[id]

Example

Update the campaign name.

Payload

{ "name": "Updated Name" }

Response

{ "data": { "budget_id": 217462, "creative_id": 62101, "id": 426661, "name": "Updated Name" } }
Did this answer your question?