API Workflows

  • Get a list of Auction Packages by calling the LIST API, which supports filtering by external_deal_id.

  • Create a new Auction Package by ensuring a unique external_deal_id, calling the Create API, and optionally uploading a logo.

  • Update an existing Auction Package by using the LIST API to find the package, modifying the desired fields, and then calling the Patch API with the necessary "updateMask".

  • During the beta process, created Auction Packages must be set to "DISCOVERY_OBJECT_STATUS_PAUSED" and cannot be updated, allowing exchanges to test without visibility in the DV3 UI.

  • Each exchange has a quota of 2000 active and 2000 paused packages.

This guide describes common API workflows for creating, retrieving, and updating Auction Packages in Display & Video 360.

Get a list of Auction Packages

Call the LIST API. Supports filtering by external_deal_id.

Create a new Auction Package

  1. external_deal_id must be unique. Call LIST with external_deal_id to see if the ID has already been used.
  2. Call the Create API. A unique name will be assigned, and can be used to get the created package.
  3. Call the Get API to see details of the created Auction Package.
  4. Optionally, Upload a logo for the created package.

Update Auction Package

  1. If you don't store the created Auction Package Name, call the LIST API filtered by external_deal_id to get the Auction Package you want to update.
  2. Update the fields based on results from the LIST API.
  3. Call the Patch API to update the Auction Package. The updateMask is required. It indicates which fields you want the update to be applied to. Only fields that are allowed to be updated can be set in the updateMask.

Beta Process

The only difference between Beta and GA is that during beta, Auction Packages created must have status set to DISCOVERY_OBJECT_STATUS_PAUSED, and status cannot be updated. PAUSED packages aren't visible in the DV360 UI. This provides exchanges a way to test out API integration without showing test packages.

It is common to create all the "real" packages in beta as PAUSED and then activate them once in GA.

Quota

2000 active packages per exchange.

2000 paused packages per exchange.

Previous
Overview