Deprecation Warning

DSP API v1 will continue to receive critical bug and security fixes, but no new functionality will be added going forward. Next version of DSP API is under development and when ready DSP API v1 will be deprecated.

Activity

Advertising activities belong to clients and are constrained by budgets.

Contact your Delta Projects representative to get your mediaAgencyId!

List Activities

Description: List all activities on given client
Verb: GET
Path: /api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity

Request Parameters

Response JSON Body

Activity Object

Example Request

GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity?apikey=secret123

Example Response

[
  {
    "id": "86b35327-794c-11e4-8425-daf437376f87",
    "name": "Example Activity"
  }
]

Retrieve Activity

Description: Retrieve given activity
Verb: GET
Path: /api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>

Request Parameters

Response JSON Body

Example Request

GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87?apikey=secret123

Example Response

{
  "id": "86b35327-794c-11e4-8425-daf437376f87",
  "name": "Example Activity",
  "flightStart":"2014-12-31T22:00:00.000+0000",
  "flightStop":"2015-01-10T21:59:59.000+0000",
  "enabled":false,
  "budget":100000.0,
  "currentTargetSpend": 5054.345
}

Create Activity From Template

Description: Create a new activity using the given template and its settings
Verb: POST
Path: /api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/create_from_template

Request Parameters

Request JSON Body

Response

HTTP 201 Created with the URL to the created activity in the Location header.

Example Request

POST /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/create_from_template?apikey=secret123

Example Request Body

{
  "templateId": "16b35327-794c-11e4-8425-daf437376f87",
  "activityName": "Example Activity",
  "flightStart": "2015-01-01T00:00:01.0Z",
  "flightStop": "2015-02-01T00:00:01.0Z",
  "targetECPM": 2.4,
  "orderId": "GXK-77123",
  "budget": 100000.0,
  "impressionBudget": 500000,
  "enabled": false,
  "geoDetails": [
  {
  "lat": 69,
  "long": 21,
  "radius": 100
  },
  {
  "lat": 67,
  "long": 19,
  "radius": 34.5
  }
  ],
  "excludeGeo": true
}

Note:

• Leaving out "targetECPM" in request body will make the activity use the template "targetECPM" presets
• Leaving out "impressionBudget" in request body will make the activity use the template "impressionBudget" presets
• Leaving "geoDetails" out will result in using templates geo targeting presets. "geoDetails" can only be included when template already has geo targeting rule. When using "geoDetails", all fields must be set with valid latitude/longitude values and radius cannot be a negative. Multiple "geoDetails" are supported.
• Leaving "excludeGeo" out sets its value to false and can only be used together with "geoDetails" or will not be used.

Example Response

Location: /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87

Update Activity

Description: Update an existing activity
Verb: POST
Path: /api/v1/media_agency/<mediaAgencyId>/client/<clientId>/campaign/<campaignId>/activity/<activityId>

Request Parameters

Request JSON Body

Response

HTTP 200 Updated with the URL to the updated activity in the Location header.

Example Request

POST /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87?apikey=secret123

Example Request Body

{
  "activityName": "Renamed Activity",
  "flightStop": "2016-11-01T00:00:00Z",
  "targetECPM": 4.2,
  "orderId": "GXK-88123",
  "budget": 200000.0,
  "enabled": true,
  "geoDetails": [
  {
  "lat": 69,
  "long": 21.5,
  "radius": 100
  }],
  "excludeGeo": true
}

Note:

• Leaving "geoDetails" out will result in using existing geo targeting presets. "geoDetails" can only be included when activity for update already has geo targeting rule. When using "geoDetails", all fields must be set with valid latitude/longitude values and radius cannot be a negative. Multiple "geoDetails" are supported. Latitude/longitude and radius fields can be both integers or decimal numbers.
• Leaving "excludeGeo" out sets its value to false and can only be used together with "geoDetails" or will not be used.

Example Response

Location: /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87/campaign/default/activity/86b35327-794c-11e4-8425-daf437376f87

List Activity Templates

Description: List all activity templates
Verb: GET
Path: /api/v1/activity_templates

Request Parameters

Response JSON Body

Activity Object

Example Request

GET /api/v1/activity_templates?apikey=secret123

Example Response

[
  {
    "id": "16b35327-794c-11e4-8425-daf437376f87",
    "name": "Example Activity Template"
  }
]

Last modified: Mon Sep 23 2024 11:48:54 GMT+0200 (Central European Summer Time)