2018-08-23 Release

New Campaign Management API endpoints moved from v0 beta version to v3 official version, various updates to Campaign Management Query API (previously Performance API), and VAST and VMAP parameters for Timeouts.

Official Release of New Campaign Management API Endpoints

The new Campaign Management API endpoints have been moved from v0 beta version to v3 official version. The base URLs are now:
  • Campaign Management Query API (previously Performance API)
    • Campaign Query: https://api.videoplaza.com/v3/campaigns
    • Goal Query: https://api.videoplaza.com/v3/goals
    • Ad Query: https://api.videoplaza.com/v3/ads
  • VAST URLs API
    • Campaign VAST URLs: https://api.videoplaza.com/v3/campaigns/{campaignId}/vasturl
    • Goal VAST URLs: https://api.videoplaza.com/v3/goals/{goalId}/vasturl
    • Ad VAST URLs: https://api.videoplaza.com/v3/ads/{adId}/vasturl
  • Banner Areas API: https://api.videoplaza.com/v3/banner-areas

Performance API Changed to Campaign Management Query API

The Campaign Management Query API (previously Performance API) has been moved from v0 beta version to v3 official version. The new version also includes various updates to the campaign’s, goal’s, and ad’s response bodies, as well as renaming of most of the elements. For more information, refer to Response Body Format.

Use the Campaign Management Query API to integrate faster, easily access the right information, and increase the performance of your system. The main benefits are in the following concepts:
  • Searchability: One endpoint for each entity, which supports advanced searching, filtering, and sorting
  • Improved scalability: Shorter response times to API calls, due to server side sorting, filtering, and pagination capabilities
  • Relationship visualization: Improved visualization of entity relationships, through links (default) or expansion of child entities within the same API call
  • Embedding additional information: Embed additional information, such as projected delivery and metrics, within the same API call
The following sections provide more details on what each endpoint enables you to do.

Campaign Query Endpoints

  • GET /v3/campaigns endpoint enables you to list all campaigns associated with your account. Various query parameters allow you to get very detailed and specific information on a subset of campaigns that match your query, all within one API call. You can expand goals and ads associated with the campaigns, which results in a nested structure representing the hierarchy between campaigns, goal, and ads. You can also embed metrics and this way quickly retrieve one, several, or all available metrics for the listed campaigns. Embedded metrics are only returned on the campaigns and not on expanded objects, to allow scaling for larger accounts with many goals and ads within campaigns. Paging is added by default but can also be specified using paging parameters, to further narrow down the result. This is especially important for heavy requests that include lots of embedded objects. Available query parameters:
    • expand: either expand=goals or expand=goals&expand=ads
    • embed: either embed=metrics to get all metrics or embed=metrics&metrics=<value> to get one or several metrics
    • includeDeletedGoals
    • includeDeletedCampaigns
    • campaigns.started.before
    • campaigns.started.after
    • campaigns.ended.before
    • campaigns.ended.after
    • campaign.state
    • ids
    • pageSize
    • pageNumber
  • GET /v3/campaigns/{campaignId} endpoint enables you to get one campaign associated with your account. You can expand goals and ads associated with the campaign, which results in a nested structure representing the hierarchy between campaigns, goals, and ads. You can also embed metrics and this way quickly retrieve one, several, or all available metrics for a campaign and its goals and ads, if expanded. If you expand goals associated with the campaign, you can embed projections and this way get information on the projected delivery for the goal at the time of the request. Available query parameters:
    • expand: either expand=goals or expand=goals&expand=ads
    • embed: either embed=metrics to get all metrics or embed=metrics&metrics=<value> to get one or several metrics
    • includeDeletedGoals

For detailed information and examples, refer to Campaign Query Requests.

Goal Query Endpoints

  • GET v3/goals endpoint enables you to list all goals associated with your account. Various query parameters allow you to get very detailed and specific information on a subset of goals that match your query, all within one API call. You can expand ads associated with the goals, which results in a nested structure representing the hierarchy between goals and ads. You can also embed projections, which gives you information on the projected delivery for the goals at the time of the request, as well as metrics, to quickly retrieve one, several, or all available metrics for the listed goals. Embedded metrics are only returned on the goals and not on expanded ads, to allow scaling for larger accounts with many ads within goals. Paging is added by default but can also be specified using paging parameters, to further narrow down the result. This is especially important for heavy requests that include lots of embedded objects. Available query parameters:
    • expand: expand=ads
    • embed: either embed=metrics to get all metrics, embed=metrics&metrics=<value> to get one or several metrics, or embed=projections to get the projected delivery for the goal at the time of the request
    • goals.started.before
    • goals.started.after
    • goals.ended.before
    • goals.ended.after
    • goal.name
    • campaign.name
    • campaign.id
    • campaign.state
    • pageSize
    • pageNumber
    • sorting
    • sortingOrder
  • GET v3/goals/{goalId} endpoint enables you to get one goal associated with your account. You can expand ads associated with the goal, which results in a nested structure representing the hierarchy between goals and ads. You can also embed metrics and this way quickly retrieve one, several, or all available metrics for a goal and its ads, if expanded. Available query parameters:
    • expand: expand=ads
    • embed: either embed=metrics to get all metrics, embed=metrics&metrics=<value> to get one or several metrics, or embed=projections to get the projected delivery for the goal at the time of the request

For detailed information and examples, refer to Goal Query Requests.

Ad Query Endpoints

  • GET v3/ads endpoint enables you to list all ads associated with your account. Various query parameters allow you to get very detailed and specific information on a subset of ads that match your query, all within one API call. You can also embed metrics to quickly retrieve one, several, or all available metrics for the listed ads. Paging is added by default but can also be specified using paging parameters, to further narrow down the result. This is especially important for heavy requests that include lots of embedded objects. Available query parameters:
    • embed: either embed=metrics to get all metrics or embed=metrics&metrics=<value> to get one or several metrics
    • ads.created.before
    • ads.created.after
    • goal.id
    • pageSize
    • pageNumber
  • GET v3/ads/{adsId} endpoint enables you to get one ad associated with your account. You can also embed metrics to quickly retrieve one, several, or all available metrics for an ad. Available query parameters:
    • embed: either embed=metrics to get all metrics or embed=metrics&metrics=<value> to get one or several metrics

For detailed information and examples, refer to Ad Query Requests.

VAST and VMAP parameters for Timeouts

Three timeouts are set up for each account at the time of its creation. If you have a direct VAST or VMAP integration with Pulse, you can now override these timeouts with the following parameters:

  • sat: to override the Start Ad Timeout.
  • tpt: to override the Third Party Timeout.
  • tpat: to override the Total PAssback Timeout.

For more information, refer to Timeout Parameters.

Subscribe to Ooyala Release Notes

See Subscribe to Ooyala Release Notes for instructions on how to subscribe for automated notifications of Ooyala release notes.
https://help.ooyala.com/sites/all/libraries/dita/en/video-advertising/oadtech/relnotes/2018-08-23.html

Was this article helpful?