Digital Signage

Deliver Retail Media experiences in physical stores via digital signage integration.

The Digital Signage integration uses the POST Get ads, the same request used for retrieving ads for your digital platform.

Retrieving ads for generic screens

All ads that should be displayed will be returned. Once all ads have been displayed, the API must be called again to retrieve the next batch of items to be shown.

🚧 Don't display the same items twice, as display metrics will only be counted once.

Request example:


_34{
_34    "context": "digital_signage",
_34    "session_id": "random id",
_34    "device_id": "screen identifier",
_34    "store_name": "location identifier",
_34    "placements": {
_34        "name_of_the_location_where_the_screen_is": {
_34            "size": "1080x1920",
_34            "types": ["digital_signage"],
_34            "quantity": 1
_34        }
_34    },
_34    "segmentation": [
_34        {
_34            "key": "STATE",
_34            "values": [
_34                "RJ"
_34            ]
_34        },
_34        {
_34            "key": "CITY",
_34            "values": [
_34                "Rio de Janeiro"
_34            ]
_34        },
_34        {
_34            "key": "NEIGHBOURHOOD",
_34            "values": [
_34                "Cascadura",
_34                "Madureira"
_34            ]
_34        }
_34    ]
_34}

Retrieving ads during checkout at the POS

In some cases, it is possible to identify the user making a purchase, typically during the payment process at the point of sale (POS).

Once the user is identified, you can request a personalized ad for that user.

🚧 For segmented campaigns, an audience integration is required.

Request example:


_35{
_35    "context": "digital_signage",
_35    "user_id": "user identifier",
_35    "session_id": "random id",
_35    "device_id": "unique screen identifier",
_35    "store_name": "unique location identifier",
_35    "placements": {
_35        "name_of_the_location_where_the_screen_is": {
_35            "size": "1080x1920",
_35            "types": ["digital_signage"],
_35            "quantity": 5
_35        }
_35    },
_35    "segmentation": [
_35        {
_35            "key": "STATE",
_35            "values": [
_35                "RJ"
_35            ]
_35        },
_35        {
_35            "key": "CITY",
_35            "values": [
_35                "Rio de Janeiro"
_35            ]
_35        },
_35        {
_35            "key": "NEIGHBOURHOOD",
_35            "values": [
_35                "Cascadura",
_35                "Madureira"
_35            ]
_35        }
_35    ]
_35}

Response

See the available response attributes on POST Get ads.

Response example:


_17{
_17    "placement_name": [
_17        {
_17            "type": "digital_signage",
_17
_17            "assets": [
_17                {
_17                   "type": "image|video",
_17                   "url": "image URL",
_17                   "duration": 30
_17                }
_17            ],
_17
_17            "impression_url": "impression URL"
_17        }
_17    ]
_17}