Manage grid section
Overview
This document describes how to retrieve data about grids, which are a key component of on-site ad campaigns. A grid represents a retailer's definition of ad placements for a given context. An ad request attempts to fill this grid with as many ads as possible.
A grid is a collection of GridSection objects for a given page type. A GridSection defines which ad formats a retailer wants to display for a specific placement on a given pageType.
Main endpoints
| Method | Endpoint | Description | Reference |
|---|---|---|---|
| GET | https://api.kaminoretail.dev/v2/websites/{website_id}/grid-sections |
Retrieves the grid sections for a specific website. | List grid sections |
| GET | https://api.kaminoretail.dev/v2/websites/{website_id}/grid-sections/export |
Exports all grid sections for a website as a CSV file. | Export grid sections |
Attributes
The following table describes the attributes for a grid section.
| Attribute | Data type | Description | Example |
|---|---|---|---|
active |
boolean | A boolean indicating whether the grid section is active. If false, associated creatives are unavailable in the Kamino ad delivery engine. |
true |
allowedFormats |
array[object] |
The list of formats allowed in this grid section. Each object contains the following:
|
[{"id": 1, "name": "billboard", "formatType": "video"}] |
id |
integer | The unique Id of the grid section, generated by the Kamino platform. | 123 |
maxAds |
integer | The maximum number of times the same format can appear in this placement. Supported values are from 1 through 30. | 17 |
pageType |
string | The page type associated with the grid section. | home |
position |
string | The position where the ad renders on the retailer's page. | "top" |
rank |
integer | The internal ranking generated by the Kamino platform. Determines the ranking used to fill ads across grid sections for the same pageType. The value starts at 0. |
4 |