Get creatives and parse response

Overview

This document explains how to get creatives and how to parse the response.

Get creatives

To gets ads for a page, use the creatives/fill-grid endpoint. For more information, see Get creatives.

Response parsing

The Kamino Delivery Engine returns a JSON response containing the ads to deliver. For each ad, the response includes the assets to serve, the products to advertise, and tracking beacons.

The JSON response uses the following structure:

  • Part 1 — Placement data: The location where to insert the creative, including  creativeId, format, zoning, and placement. The placement value uses the format format-zoning-x, where x represents the rank of the creative in the zoning.
  • Part 2 — Assets: The assets required to create the format. Assets are classified by type (video, image, button, or product) in a table.
  • Part 3 — Beacons: The tracking beacons (trackingLinks) for the creative.
  • Part 4 — Campaign details: The details of the campaign, including the campaignId and lineItemId.

API time-out best practice

Equativ recommends setting a time-out of 300 milliseconds for all API calls. This safeguard protects against potential delays or disruptions. Monitor time-outs regularly to identify performance issues and ensure a smooth experience for all users.