Back to All
added

API 2.0

about 1 month ago by Lillie Ratliff

V2 APIs are now in beta! The 2.0 release includes support for uploading data statefully via cloud bucket; simplifies authentication to a single token; and cleans up many outdated fields.

Important: switching to the 2.0 API will be a breaking change for existing API users!

Endpoint Changes

In v2, we have consolidated the endpoints to /measure /creative /benchmarks. These endpoints remain REST endpoints that return JSON.

GMP and planning use cases are supported via the new Stateful APIs.

Stateful APIs

As well as new API endpoints, v2 now supports integration via cloud buckets. These new Stateful APIs work using AWS, GCP or Azures buckets. Cloud bucket uploads do not have the row count limitations like on version 1.x endpoints. Multiple file types supported. Newline Delimited JSON, CSV, Avro, Parquet. Emissions reports can be push back to desired bucket location.

New APIs:

Uploads via new stateful APIs bring a deeper integration into the CSP and are managed through a purpose built Integrate UI. For most use cases, we recommend using these new Stateful APIs.

Authentication

For the v2 stateless endpoints (/measure /creative /benchmarks) the authentication mechanism has switched to bearer token. See the V2 auth guide on how these tokens are generated and used.

Channel naming

Channel names have been simplified. display-web and display-app are now web and app respectively. If you are using streaming-video for either websites or app this can be switched the channel can be app or web with the video format described in the new creative fields. If you are using streaming-video for CTV use the new ctv/bvod channel.

Field changes

There are number of changes to inputs fields:

  • Site and app inputs are now covered by one combined inventory_id input
  • The creative input fields have been updated and expanded to support detailed modeling of creatives, including the introduction of ad formats
  • Date is now utcDatetime

To see the new inputs in full visit the v2 api reference.

Response format change

The response from v2 REST endpoints has been updated and includes additional metrics, inventory intelligence information and a dedicated emissions breakdown section.

The output responses for the Stateful APIs are configurable. Media Delivery responses can contain supplied input fields and emissions measurement fields. Response configuration is done in the Integrate UI.

See whats new in V2 page for more information.