Campaign Management APIs
The Campaign Management APIs include endpoints for sucessfully booking a campaign with goals and ads, as well as managing any campaign and goal targeting rules.
Refer to Tutorial: Create a Campaign for more information on the API calls required to successfully book a campaign.
The Campaign Management APIs also include a series of performance endpoints, which are meant to quickly retrieve performance metrics and information for your campaigns, goals and ads. These endpoints allow you to build your own interfaces to view the information in your account.
Take the following considerations into account when using to the
Performance REST API endpoints:
- The Performance endpoints give you quick access to the data collected for your campaigns, goals and ads, with only an ingestion delay of one hour.
- The Performance endpoints provide totals for the requested metrics. If you need a breakdown of the metrics based on time, like for each month, then use the Custom Reporting API.
- The Performance endpoints provide the metrics described in the endpoints for the campaigns, goals and ads. If you require other metrics, then use the Custom Reporting API.
| API component | API operations | Description |
|---|---|---|
| Campaign API | Use the Campaign API to define general settings for a campaign,
retrieve performance metrics for the campaign and its associated
goals and ads, and retrieve the VAST URLs for ad calls on a
campaign. Give the campaign a name, associate it with a client, set
the campaign priority, delivery mode and targeting rules. You can
then add goals and ads through endpoints described further down in
the table.
|
|
| Goal API | A goal is a schedule or placement that determines the delivery of
your ads. Use the Goal API to define, for example, how many
impressions should be delivered, at what frequency, how they appear
in ad breaks, the targeting rules, the start/end date of the
campaign, and to retrieve perfomance metrics for the goals and VAST
URLs for ad calls on a goal. You can have multiple goals in a
campaign if you, for example, need to reach different target
audiences, or deliver during different time periods. You can then
add ads through endpoints described further down in the table.
|
|
| Asset API | Assets refer to creative files that you need to associate with
your ads. Use the Asset API to upload and retrieve video assets and
other assets, such as ad images and flash files. Note: Uploaded
assets that have not been linked to an ad expire after 24 hours.
Querying for expired assets returns a 404 (Not Found)
error.
|
|
| Ad API | Use the Ad API to link an asset to an ad, add one or more ads of
supported format to a goal, target ads to specific device groups,
and set a different start/end date than the one set for the goal.
Also use the Ad API to retrieve performance metrics for the ads and
VAST URLs for ad calls on an ad. Note: Uploaded assets that have not
been linked to an ad expire after 24 hours. Querying for expired
assets returns a 404 (Not Found) error.
|
|
| Performance API | Warning: All Performance REST APIs
are currently on version 0, which means they have not been
finalised yet and may still change significantly.
Use the
Performance API to quickly access the data collected for your
campaigns, goals, and ads.Swagger documentation: Campaign API v2 |
|
| VAST URLs API | Warning: The VAST URLs REST API is currently on
version 0, which means it has not been finalised yet and may
still change significantly.
Use the VAST URLs API to
export the VAST URL for ad calls on a campaign, goal, or ad when
using Pulse for testing purposes or as a 3rd party ad server,
meaning you can extract the VAST URL from Pulse and implement it in
other ad servers. The provided URL works as a 3rd party call to
Pulse and then Pulse functions as a 3rd party redirect.Swagger documentation: Campaign API v2 - VAST URLs |
|
| Banner Areas API | Warning: The Banner Areas REST API is currently on
version 0, which means it has not been finalised yet and may
still change significantly.
Use the Banner Areas API to
quickly retrieve companion banner area (zone)
information.Swagger documentation: Campaign API v2 - Banner Areas |