Prebid.js Bidder on Prebid + Prebid Server Bidder on Prebid
# Mobile SDKThe Mobile SDK should be considered legacy functionality. It's not used for new implementations.
Information on the mobile Adhese SDK's can be found on the following GitHub pages: Android: [https://github.com/adhese/ava](https://github.com/adhese/ava) iOS: [https://github.com/adhese/avi](https://github.com/adhese/avi) # Request API For integrations where you don't want to use an SDK or other library, we provide the request endpoint so you can build the request URLs yourself. Both GET and POST requests are supported, but there is a slight difference between them. ## POST endpoint This endpoint provides access to the ad server and gateway functionality for server applications. This functionality allows implementers to send an HTTP POST request to their Adhese endpoint, returning an array of ads for the requested ad slots. The POST body can contain a number of parameters, the structure of which is documented below. The API is public and requires no authentication. Any client-side framework that can interpret a JSON response can request the same endpoint. ### Endpoint URL To obtain the endpoint URL for your account, contact [Adhese Support](https://documentation.adhese.org/books/introduction/page/adhese-support). Default look of the endpoint URL: ```html https://ads-{customer}.adhese.com/json/ ``` ### Request Type HTTP POST request over an HTTPS connection. In a production environment, no cookies are needed; all data is passed in the request body. For debugging purposes, add a ‘set-cookie’ header with the value ‘debugKey=\[any\_value\]’. This will make all activity from your requests available in [Gateway Debug Logging](https://documentation.adhese.org/books/adhese-gateway/page/adhese-gateway#bkmrk-gateway-debug-loggin).Do not use this debug cookie for production requests. If used on a large scale, it will add significant latency to your responses.
### POST Body The body of your POST request can contain JSON following a fixed structure. There are three main properties. ``` { "slots": [ { "slotname": "some_slot" }, ... ], "parameters": { "kw": [ "cheese", "wine" ], ... }, "user": { "ext": { "eids": [] } } } ``` #### slots An array of slot objects containing all the ad units required for a given page or state of the end-user application. At least one slot is required. Each slot contains at least a 'slotname', which is a unique identifier for a specific advertisement placement. This string is stored in the Adhese database and used for targeting campaigns. ``` "slots": [ { "slotname": "some_slot" }, { "slotname": "another_slot" } ] ``` #### parameters An object that contains a set of properties and their corresponding array of values. The purpose of this object is to define one or more attributes that tell you something about the page, user, context, etc. The parameter keys are fixed two-character codes defined in your Adhese account. The value is always an array of strings. All parameter properties are optional. You can leave them out if they are empty or irrelevant, or send an empty array as value. ``` "parameters": { "kw": [ "cheese", "wine" ], "mi": [ "ABCDEF123456" ] } ``` *In the example above, “kw“ is used for “search keyword“and “mi” for “member id.”* #### slot level parameters A slot can also contain a 'parameters' attribute that follows the same structure. Parameters can be defined at both the request and slot levels. The values of these parameters will be merged for each corresponding slot. ``` "slots": [ { "slotname": "some_slot", "parameters": { "ps": "top" } }, { "slotname": "another_slot", "parameters": { "ps": "bottom" } } ] ``` #### user The user property is reserved for situations where external ID providers are available, and their identifiers need to be transferred to buyers further down the line. This is mainly useful in an open market context. For more info, please contact our Support Team. ### Example of a complete request body ``` { "slots": [ { "slotname": "homepage_banner" }, { "slotname": "homepage_rectangle_top" }, { "slotname": "homepage_rectangle_bottom" }, { "slotname": "homepage_halfpage", "parameters": { ... } } ], "parameters": { // Example user ID "id": [ "1234567890ABCD" ], // Example product categories "ct": [ "computers", "laptops" ], // search keywords "kw": [ "cheese", "wine" ] } } ``` ### Response Codes #### 200 All is OK. If no advertisements are available, an empty array will be in the response body. #### 454 No slots were added to the request body, so no advertisements can be returned. An error message containing the message' slots cannot be empty' is added to the response as header ‘x-adhese-bad-request’. #### 442 A duplicate slotname has been used for one or more slots. An error message is added to the response as header ‘x-adhese-bad-request’ containing message ‘request contains duplicate slots: \[list of duplicate slots\]’ #### 500 Internal server error. Further information could be available in the debug log if it was a debug request or via Adhese Support. ### Response ObjectTo be moved to its own page
The response object contains a number of attributes. A full description can be found here: [https://github.com/adhese/sdk#response-object-structure](https://github.com/adhese/sdk#response-object-structure). The relevant attributes for a server-side integration are the following: ## slotName A string containing the name of the slot for which this response is intended. When requesting multiple slots simultaneously, this can be used as a key to link the responses to the slots you have added to the request body. ## tag The ad markup used to render the advertisement on the client is returned as a string and can be of any type interpretable by the client or requester. For typical web and display advertising, the markup is usually a fragment of HTML that can be inserted into a container on the page. For video or audio advertising, the markup is usually a VAST-compliant XML document. For native advertising, the markup typically comprises a JSON object containing all the elements required by a client application or browser script to render the ad correctly.The markup can contain JSON as a string, which the application consuming the responses must parse to get the actual JSON.
## width The ad container width in pixels is needed for the ad to display as intended. ## height The ad container height in pixels is needed for the ad to display as intended. ## trackedImpressionCounter The client application can call a unique URL when the ad is added to a page, even if it is not yet visible and the user has to scroll to see it. The call to the URL can be asynchronous, and the response can be ignored. The call to this URL registers a 'paid impression' for a specific ad, as defined by the IAB. ## viewableImpressionCounter The client application can call a unique URL when the ad is visible in the viewport for at least 50% and for at least one second. The call to the URL can be asynchronous, and the response can be ignored. A call to this URL will register a 'viewable impression', a metric defined by the IAB and used in digital advertising. ## clickTag The clickTag attribute contains a unique URL that can be used to create a link that is counted as a 'click' on the ad and redirects the user to the ad's landing page. When implemented in an application that does not use links or URLs, the clickTag URL can register a click while ignoring the response, just like the impression counters. ## Event trackingTo be moved to its own page
### Creating an Event Tracking URL You can create unique URLs based on the JSON output to register any event related to the ad once it is rendered on screen. A tracking event URL structure looks like this: ``` https://[ad_request_host]/track-[your_event_string]/[response.id]/sl[response.slotID]/II[response.impressionID] ``` ### Adding an Event Tracking URL to a template In an Advar or HTML5 template, event-tracking URLs can be created using [server-side request parameters](https://documentation.adhese.org/books/integrations-and-delivery/page/server-side-request-parameters). A tracking event would then look like this: ``` https://[adheseDomain:ad_host]/track-[your_event_string]/[adheseLogID]/sl[adheseReplace:sl]/II[adheseReplace:II] ``` ## Example of a full response object ``` [ { "dm": "dmDMGo2g0c0;ADV0", "adType": "714x224", "adFormat": "714x224", "timeStamp": "1642511791000", "share": "0", "priority": "0", "orderId": "2", "adspaceId": "2", "adspaceKey": "CI-ADH-12345678", "body": "", "trackingUrl": "", "tracker": "https://ads-demo.adhese.com/track/121//sl6/brChrome/brChrome97/brOSX/brdesktop/dtdesktop/ogcontrol/II19656e55-a3cd-4a39-8ed5-28f575a2e9b1/tlnone/ctaardappel-groente-fruit/ctkruiden-knoflook-pepers/umknown/kwkaas/om0/cuc/cxveel-gebruikt:snel/cxkeuken:italiaans/cxmomenten:wat_eten_we_vandaag/id1234567890ABCD/miAH0099887766/A2127.68.78.84/?t=1642610778623", "extraField1": "", "extraField2": "", "altText": "", "height": "224", "width": "714", "tag": "{ '_links': { 'self': { 'href': 'https://ads-demo.adhese.com/raylene//sl6/brChrome/brChrome97/brOSX/brdesktop/dtdesktop/ogcontrol/II19656e55-a3cd-4a39-8ed5-28f575a2e9b1/tlnone/ctaardappel-groente-fruit/ctkruiden-knoflook-pepers/umknown/kwkaas/om0/cuc/cxveel-gebruikt:snel/cxkeuken:italiaans/cxmomenten:wat_eten_we_vandaag/id1234567890ABCD/miAH0099887766/A2127.68.78.84/ad121-4/UR/acties/' } }, 'resourceType': 'Editorial', 'type': 'HalfWidthSmallResponsiveEditorial', 'position': { 'x': 'left', 'y': 'top' }, 'contentSize': 'half', 'color': 'drop', 'text': { 'title': 'Maak kans op een exclusieve Bud Dreams Jacket', 'body': 'Bekijk de actie' }, 'images': [ { 'title': 'More info about the VAST standard can be found on the IAB's website
VAST offers a set of features intended to make online video advertising easy. - **Platform—and device-agnostic:** Nothing about the protocol of VAST is specific to the functioning of a certain device or platform. This allows Adhese to serve ads across several video players in different situations, such as websites, mobile websites and applications, Internet-connected TVs, or set-top box environments. - **Support for different ad types:** VAST supports different video ad formats. Next to the well-known linear and non-linear video ad formats, VAST enables the delivery of companion ads, skippable linear ads, and ad pods. - **Tracking:**To provide details about the delivered ads, VAST enables the simultaneous tracking of several user events related to the video ad. That is to say, VAST can tell you, for example, whether a video ad was completely viewed or if the user has muted the sound. VAST can also notify you if a user skipped a linear ad by explicitly closing it before completion, or if the user clicked a non-linear ad away. - **Detailed error reporting:** When a video player cannot display an ad, VAST enables the player to provide specific feedback to the ad server about why the ad can not be served. # Instream & Outstream The biggest difference between instream and outstream video ads is the placement. Instream video ads are placed within an existing video player that will be used to play content, while outstream video ads are placed in a standalone player which gets embedded in a page similar to a display banner. ## Instream [](https://documentation.adhese.org/uploads/images/gallery/2024-12/tIyBbBcrkN7NjPrR-image.png) ### Linear Linear video ads are played before, between or after the playback of video content. Linear video advertising is known to interrupt the playback of a video clip, with the linear ad taking over the full video experience for a period of time. There are three distinct formats of linear video advertising: - **Pre-roll** ads play before the start of the video playback; - **Mid-roll** ads play during the playback of the video clip; - **Post-roll** ads play after the end of the video playback. ### Non-linear Non-linear video ads do not disrupt the playback of a video; they run alongside the video content within the video player for a brief period of time or after the ad is clicked away. The original video content remains visible throughout the duration of the non-linear video ad, which is displayed in a portion of the video player. Non-linear video ads are typically displayed in the bottom area of a video player. An **overlay ad** is a banner ad delivered over the video content at the bottom of the video player. The ad uses text, graphics, or video overlays to convey the message of the advertiser. ### Companion ads To enhance the campaign's visibility, a linear or non-linear video ad can be paired with a companion ad that is in tune with the original video ad. A companion ad is served outside the video player's environment. Any display advertising format can be coupled. An example of a companion ad is a **branded player**. A branded player consists of an outer layer or skin that is wrapped around the video player. ## Outstream Video creatives that are used for linear advertising can also be used for outstream advertising. The difference is that outstream video will be placed in it's own player. # Audio # Digital Out Of Home # DOOH endpoints Adhese has three endpoints in place for DOOH integrations: 1. Assets Download Endpoint (aka Headsup request) https://headsup-\[customer\].adhese.org/api/headsup/download-list/sl\[positioncode\] 2. Playlist Endpoint with a limited number of ads https://ads-\[customer\].adhese.com/m/stack/sl\[positioncode\]?max\_ads=\[amount\] 3. Playlist Endpoint with unlimited amount of ads https://ads-\[customer\].adhese.com/e/stack/sl\[positioncode\]The **Headsup** and **Unlimited Playlist** endpoints must be enabled by Adhese support before they can be used.
## Assets download endpointTo ensure that the assets are included in the response, the '**Use in heads-up file**' setting must be enabled at format level. This action can be performed by all admin users in the Adhese UI.
```markdown https://headsup-[customer].adhese.org/api/headsup/download-list/sl[positioncode] ```| Parameters | Value | Required |
| customer | The name of your Adhese account | Yes |
| position code | The code of the position you wish to request: \[location code\]\[optional position code\]-\[format code\]. This value is always prefixed by 'sl'. | Yes |
| Parameters | Value | Required |
| customer | The name of your Adhese account | Yes |
| position code | The code of the position you wish to request is \[location code\]-\[format code\]. This value is always prefixed by 'sl'. | Yes |
| max\_ads | The maximum number of ads you wish to request | Yes |
| player ID | The ID of the player. The value must be prefixed by a two-letter code. Adhese support needs to configure this code. | No |
| Parameters | Value | Required |
| customer | The name of your Adhese account | Yes |
| position code | The code of the position you wish to request: \[location code\]-\[format code\]. This value is always prefixed by 'sl'. | Yes |
| player ID | The ID of the player. Value needs to be prefixed by a 2-letter code. Adhese support needs to configure this code. | No |
| Item | Description |
|---|---|
| **Discovery URL** | Your OIDC discovery endpoint, typically `https:// |
| **Authorization endpoint** | URL where we redirect users to authenticate |
| **Token endpoint** | URL where we exchange the authorisation code for tokens |
| **UserInfo endpoint** | URL where we can retrieve additional user claims (if not all included in the ID token) |
| **JWKS URI** | URL to your public signing keys for token validation |
| **Client ID** | The client identifier registered for Adhese in your IdP |
| **Client Secret** | The client secret associated with the Client ID |
| **Supported scopes** | Confirmation that the required scopes (see section 4) are available |
| Item | Description |
|---|---|
| **Redirect URI (Callback URL)** | We will provide the exact redirect URI that must be registered as an allowed callback in your IdP. |
| **Required scopes** | See section 4 |
| **Required claims** | See section 4 |
| Scope | Purpose |
|---|---|
| `openid` | Mandatory for OIDC. Returns the `sub` (subject) claim. |
| `email` | Required. Must return the `email` and `email_verified` claims. |
| Claim | Scope | Required | Expected Value | Description |
|---|---|---|---|---|
| `sub` | `openid` | Yes | Unique user ID | Unique identifier for the user |
| `email` | `email` | Yes | Valid email address | The user's email address |
| `email_verified` | `email` | Yes | `true` | Must be `true`. Users with `email_verified: false` or a missing `email_verified` claim will be denied access. |
| Claim | Scope | Required | Description |
|---|---|---|---|
| `name` | `profile` | No | Full display name |
| `given_name` | `profile` | No | First name |
| `family_name` | `profile` | No | Last name |
| `preferred_username` | `profile` | No | Username |
| Role | Description |
|---|---|
| `classic_admin` | Full admin. Has full permissions in the Classic UI. |
| `classic_read_only` | Read-only access to the Classic UI. |
| Role | Description |
|---|---|
| `admin` | Full administrator |
| `creative_approver` | Can approve creatives |
| `creative_master` | Full creative management |
| `managed_ad_master` | Managed advertising management |
| `self_service_ad_master` | Self-service advertising management |
| `viewer` | Read-only access |
| `access_all_advertisers_debtors_brands` | Access across all advertisers, debtors, and brands |
| **Field name** | **Description** |
| additionalCreatives | Lists the additional creatives |
| adDuration | Duration in seconds of the primary creative |
| adDuration2nd | Duration in seconds of the second creative file |
| adDuration3rd | Duration in seconds of the third creative file |
| adDuration4th | The optional duration of the fourth creative file |
| adDuration5th | The optional duration of the fifth creative file |
| adDuration6th | The optional duration of the sixth creative file |
| adFormat | the assigned format name determined by your Adhese account, e.g. wideskyscraper (the **Code export** field from the [Admin > Formats](https://documentation.adhese.org/books/inventory-management/page/formats#bkmrk-create-a-format) screen) |
| adspaceEnd | The end date of the booking in UNIX timestamp |
| adspaceId | The Adhese booking ID |
| adspaceKey | An optional creative foreign key |
| adspaceStart | The start date of the booking in UNIX timestamp |
| adType | The name of the format as requested, e.g. SKY (the **Code tag** field from the [Admin > Formats](https://documentation.adhese.org/books/inventory-management/page/formats#bkmrk-create-a-format) screen) |
| advertiserId | The ID of the advertiser |
| altText | Optional text to be shown as the value of the `` attribute of the container |
| auctionable | The auctionable (compete with RTB) setting of a booking, can be used for header bidding |
| body | The third-party code to be inserted in a container (if applicable) |
| clickTag | The URL of the click tag used for the counting of clicks and which should be followed by the actual target URL |
| comment | Optional free text comment |
| creativeName | The name of the creative as determined in the Adhese interface |
| deliveryGroupId | The ID of the booking or creative group for all-together or one-at-a-time bookings |
| deliveryMultiples | The type of delivery |
| dm | The ID of the delivery limitation |
| ext | The extension of the file type |
| extraField1 | Optional field used by the uploader |
| extraField2 | Second optional field used by the uploader |
| height | The height of the primary creative in pixels |
| height3rd | The height of the third creative file in pixels |
| height4th | The height of the fourth creative file in pixels |
| height5th | The height of the fifth creative file in pixels |
| height6th | The height of the sixth creative file in pixels |
| heightLarge | The height of the second creative file in pixels |
| id | The traffic ID of the link between an uploaded creative and a booking |
| impressionCounter | The URL to count a tracked impression |
| libId | The ID of the uploaded creative |
| orderId | The ID of the campaign |
| orderName | The name of the campaign |
| orderProperty | An optional comma-separated list of properties containing codes as defined by your Adhese account |
| origin | String identifying the source of the ad: JERLICIA or RUBICON |
| originData | An object containing more info related to the origin of the ad |
| poolPath | An optional path to a CDN where files for this creative can be retrieved |
| priority | The priority of the campaign |
| share | An optional number that indicates the weight of the creative |
| slotName | The value of the prefix `sl` as requested |
| swfSrc | The URL of the primary creative file |
| swfSrc2nd | The URL of the second creative file |
| swfSrc3rd | The URL of the third creative file |
| swfSrc4th | The URL of the fourth creative file |
| swfSrc5th | The URL of the fifth creative file |
| swfSrc6th | The URL of the sixth creative file |
| tag | The complete HTML code for inserting in the container |
| tagUrl | An optional URL of the tag's content |
| timeStamp | The timestamp of the latest change to this creative (can be used for caching) |
| tracker | The tracker URL that needs to be requested for counting an impressions |
| trackingUrl | The third-party tracking URL that needs to be requested when visualising the ad's creative |
| url | The click-through URL |
| viewableImpressionCounter | The URL to count a viewable impression |
| width | The width of the primary creative in pixels |
| width3rd | The width of the third creative file in pixels |
| width4th | The width of the fourth creative file in pixels |
| width5th | The width of the fifth creative file in pixels |
| width6th | The width of the sixth creative file in pixels |
| widthLarge | The width of the second creative file in pixels |
The image resizing feature is a custom feature that **requires setup and integration**. Please [contact Support](http://support.adhese.com/) if you would like to use it.
As the image resizer uses an external service, enabling this feature may incur **additional costs** depending on your licensing agreement with Adhese. Please contact us if you are unsure.
### Why use image resizing? Using resized images improves responsive design and reduces bandwidth usage. Setting a viewport threshold ensures that smaller images are served to smaller displays, thereby reducing file sizes and bandwidth consumption. This is particularly beneficial for mobile-based implementations. ### How to use image resizing? By adding an extra parameter `.width.{px}` to the image URL, you can request a resized version with a specific width. The height will scale automatically to maintain the aspect ratio. The logic to add the extra '**width**' value could be added to an Advar template in Adhese itself or to the code that processes the ad markup client-side. For example: ``` https://demo-preview.adhese.org/pool/lib/8_2nd_1.png https://demo-preview.adhese.org/pool/lib/8_2nd_1.png.width.150 ``` [](https://documentation.adhese.org/uploads/images/gallery/2026-04/p6eO44kuKkBdhqaK-image.png) # Request target parametersAll target codes which are part of the following list and all codes starting with **x**, **y** or **z** are reserved
| **Reserved for the Adhese backend** | |||
| **Code** | **Reserved** | **Description** | **Example** |
| co | yes | Country as alpha 2, based on IP | coBE |
| CO | yes | Country as alpha 3 | |
| rg | yes | Sub devision of a country, based on IP | rgBE11 |
| ci | yes | City postcode, based on IP | ci9000 |
| da | yes | Reserverd for newsletter implementations | da20140110 |
| il | yes | Adhese impression ID | |
| pr | yes | Reserved for rotation file 'priority' logic | |
| SL | yes | Position as a string | |
| A2 | yes | Adhese cookie prefix | |
| dm | yes | Booking groups (all-together etc) | |
| dt | yes | device type | |
| sl | yes | Position (or the combination of a location and template, slot is used as backend name) | sl\_nbo\_22\_156\_-LAYER |
| tl | yes | Binary consent | tlnone tlall |
| xt | yes | IAB consent string | |
| yd | yes | Device type (based on useragent) | Desktop, console, TV\_Device, ... |
| ys | yes | Device OS (based on useragent) | ChromeOS, Linux, macOS,... |
| yb | yes | Browser (based on useragent) | Chrome, Edge, Firefox, ... |
| yp | yes | Device Maker(based on useragent) | Samsung, Philips, Lenovo, ... |
| **Reserved for general use** | |||
| **Code** | **Reserved** | **Description** | **Example** |
| br | yes | Pre-configured parameter for target group 'brands'. Often used to capture and target device data | brChrome;Chrome7;Mac |
| in | yes | Pre-configured parameter for target group 'interests'. Often used to capture page data |
| OpenRTB | |||
| **Code** | **Reserved** | **Description** | **Example** |
| xa | yes | (Gateway specific) Allows passing target information to Dale | xatl,1 |
| xb | yes | (Gateway specific) Bundle ID. For Apple iOS devices pass iTunes ID. For Android devices pass package name (e.g. com.foo.mygame). | iOS: iTunes ID Android: package name |
| xc | yes | (Gateway specific) Coordinates. Latitude;longitude: two floats separated by a semicolon, e.g. \[-90..90\];\[-180..180\]. | |
| xs | yes | (Gateway specific) SHA1-encoded device ID | |
| xn | yes | (Gateway specific) video min duration | |
| xx | yes | (Gateway specific) video max duration | |
| xk | yes | (Gateway specific) | xk123 |
| xd | yes | (Gateway specific) | |
| xu | yes | (Gateway specific) | |
| xi | yes | (Gateway specific) | |
| xv | yes | (Gateway specific) Unique visit ID | |
| x5 | yes | ||
| xd | yes | ||
| xe | yes | ||
| xf | yes | ||
| xg | yes | ||
| xh | yes | ||
| xl | yes | ||
| xm | yes | ||
| xo | yes | ||
| xp | yes | ||
| xr | yes | ||
| xs | yes | ||
| xt | yes | ||
| xv | yes | ||
| xy | yes | ||
| xz | yes | ||
| xj | yes | ||
| xq | yes |
The content cache is a custom feature that requires setup. Please [contact Support](https://adhese.atlassian.net/servicedesk/customer/portals) if you would like to make use of it.
### Content Cache Setup There are two main ways to make use of the content cache feature. - Configure your Adhese Prebid server to use the feature by default. - Explicitly request caching in a post request. In both cases the value that must be added or enabled is: ``` "vastContentAsUrl": true ``` When caching is enabled, the VAST content will be available via a URL with a time-to-live of 3,5 hours, after which a new request must be made to the ad adserver. # Attribute Sync # Introduction Attribute sync enables users to be linked to attributes that can be used for inventory management, campaign analysis and targeting. These associations are retrieved when an ad is requested. ## Consent As the data is associated with a user ID, consent is required. When you push data to Adhese via attribute-sync, we assume that the sender has validated the consent. Do not send us data for which no consent has been given. We do validate consent on the ad-request side. Ad requests without a userID or consent will not be linked to data pushed via attribute-sync. ## Pushing data ### Authentication The first step in pushing data is to retrieve a valid JSON Web Token (JWT) from our Keycloak server. We use the ROPC flow, but this may change in the future. You will be provided with login credentials for an account that is specifically used for attribute-sync. An example request to retrieve a JWT token ```bash curl --location 'https://auth.we.adhese.org/realms/user-sync/protocol/openid-connect/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'client_id=user-sync-app' \ --data-urlencode 'username=[username]' \ --data-urlencode 'password=[password]' \ --data-urlencode 'grant_type=password' ``` This token can be used multiple times before it expires. #### IP-filtering Upon request, we can enable IP-filtering on the attribute-sync endpoint. If IP-filtering is enabled, we will only accept data from a predefined list of IP addresses. ### Uploading data The uploading of data actually happens via the https://ads-\[customer\].adhese.com/usersync/attributesync endpoint (POST with json payload). Ensure that the access token from the prior steps is used as a bearer token in the `Authorization` header. ```json { "reportDateTimeValid": "2026-02-11T17:11:00Z", "entries": [ { "identifier": { "name": "DIGIMON_ID", "value": "userId1" }, "attributes": [ { "name": "firstAttribute", "value": [ "known_app_user", "example_value" ] }, { "name": "secondAttribute", "value": [ "known_app_user2", "known_test_trait_pageview_less_then_2" ] } ] }, { "identifier": { "name": "DIGIMON_ID", "value": "foobar" }, "attributes": [ { "name": "firstAttribute", "value": [ "known_app_user", "another_example_value" ] } ] } ] } ``` Above you can see an example payload.| reportDateTimeValid | Optional | For how long should we store the data from this request? If this is not specified, we default to seven days in the future. By default, we limit the validity to 30 days. |
| entries | Mandatory | Each user is represented by one entry. We accept up to 500 entries per request. If you need to store data for more than 500 users, please submit multiple requests. |
| entries.identifier.value | Mandatory | This field represents the userId of this entry. |
| entries.identifier.name | Mandatory | Some customers have different types of userIDs (e.g. an actual userID and a deviceID) and want to be able to store different data for the same ID if it came from a different source. You can think of this as a namespace for your userIDs. These can be arbitrary, but must be used consistently. Please inform our support agents which ones you plan to use. Even if you only use a single source of user IDs, you still need to choose a value. |
| entries.attributes | Mandatory but can be empty | Can be left empty for deleting data. See below. |
| entries.attributes.name | Mandatory | The attribute for which you want to store values for the specific userId. |
| entries.attributes.values | Mandatory | The values you want to store with the attribute for the specific userId. |
| **Currency Code** | **Currency** |
| EUR | Euro |
| USD | United States Dollar |
| GBP | British Pound Sterling |
| CHF | Swiss Franc |
| JPY | Japanese Yen |
| AUD | Australian Dollar |
| CAD | Canadian Dollar |
| PLN | Polish Złoty |
| DKK | Danish Krone |
| SGD | Singapore Dollar |
| SEK | Swedish Krona |
| NOK | Norwegian Krone |
| CZK | Czech Koruna |
Please [contact Support](https://documentation.adhese.org/books/support/page/adhese-support) if you’d like to make use of this feature.
# DCO ### What is DCO? DCO, or Dynamic Creative Optimisation, is a feature that enables the dynamic fetching and updating of components within a banner. For example, we have a banner advertising a product that is currently on sale. [](https://documentation.adhese.org/uploads/images/gallery/2025-08/Ujq2P0ekUgBZz2SW-schermafdruk-20250822-112849-1.png) This banner can consist of multiple parts: - Title - Product description - Order button - CTA - Pricing information - Special offer information - Product Image(s) - Company Image With a regular banner, if any part needs to be changed, it must be done manually. This can be achieved by either creating a new banner or accessing the creative and updating it. With DCO, these fields can be linked to a feed, enabling automatic updates. For example, the price of a product changes. This change is implemented in the feed, which then updates the banner automatically. If the title of the advertisement is changed, it can also be updated via the feed without requiring manual intervention. Changes can also be made based on contextual or audience information. Let’s say a user sees this banner in Europe. They do not need American financing options. Since we know that this user is from a European country, we can automatically update the banner they see with information from the feed. A simple example of DCO is the automatic rotation of multiple product banners on a single position, which creates a product carousel: DCO is used to change banner content based on context, audience and up-to-date product information. It enables the automatic assembly and updating of various banner elements, such as images, headlines, and calls to action, to create and deliver personalised ad creatives in real time. This can significantly reduce the workload for AdOps by decreasing the number of manual actions required to keep banners up to date and reducing the number of banners that need to be set up in the first place. Targeting can also be taken into account. If a user has shown interest in a specific product category, the feed can assemble banners based on that category, even if the user is viewing other products (provided the user has granted consent or is logged in). This means that all products and information can be bundled into one feed and displayed to the user based on either known audience information or contextual page information. Furthermore, feeds can take external information into account. For example, if you want to display a banner advertising barbecues in the summer, but only when it’s relatively sunny, you can connect the feed to a weather service to ensure that BBQ-related banners are only displayed when the conditions are right. Information about stores, such as their location and stock levels, can also be connected to the feed. This ensures that products that aren’t available at a particular store aren’t shown. ### How does DCO work? A DCO setup consists of two parts: - One or more product feeds - An HTML5 or an Advar creative Advertisers can administer the feed either by syncing a custom feed to Adhese locally every time it is updated or by hosting files directly on Adhese. When someone visits a site with inventory connected to a DCO campaign, our Content Delivery Network (CDN) system will display banners based on up-to-date information synced from the advertiser's feed. To give an example setup related to the feed shown above, we have three items in a Product Feed format: [](https://documentation.adhese.org/uploads/images/gallery/2025-08/o9pMlBTAbVcbskeM-schermafdruk-20250822-113912.png) These creatives are defined by an Advar template that contains elements such as the image, call to action (CTA) and price. [](https://documentation.adhese.org/uploads/images/gallery/2025-08/ckNyexekyERf94v9-schermafdruk-20250822-113946.png) In a second campaign, we have a product carousel creative that links to these three feed items: [](https://documentation.adhese.org/uploads/images/gallery/2025-08/kpwwag47SCcKAixT-schermafdruk-20250822-114530.png) [](https://documentation.adhese.org/uploads/images/gallery/2025-08/gpRCOakyIM0taow9-schermafdruk-20250822-114510.png) And this carousel is what's displayed on the actual position. Every time one of the feed items is updated, the carousel will change accordingly. If you would like to implement a DCO banner either on Adhese or on your own CDN, please [contact support](https://documentation.adhese.org/books/introduction/page/adhese-support). ### Reporting As always, the default reporting on campaign, booking and creative levels is available in Adhese. For more granular reporting on DCO banners, custom reporting with custom trackers can be set up using BQ/Looker Studio. With this, we can take into account information such as: - Product ID - Pricing - Codes - Etc… # CPM Priority Sorting Adhese determines share via priority. The end date of a booking also increases priority: the earlier the end date, the higher the priority and the larger the share. Two bookings with the same priority setting, but with different end dates will result in the booking with the earlier end date receiving a larger share. The same share advantage for the booking end date applies when two bookings have different CPM values. Depending on your business case, this may be undesirable, as the booking with the earliest end date and the lowest CPM receives a greater share than a competing booking with a later end date and a higher CPM. Adhese has an account configuration that can alter the Publish logic to prioritise bookings with a higher CPM instead of bookings with an earlier end date. In the event of two bookings with different end dates and CPM values, the booking with the higher CPM will receive a larger share. This setting can be enabled for one priority level across the entire account. This means that the other priority levels will still be sorted by end date.To enable CPM Priority Sorting, please [contact Support](https://adhese.atlassian.net/servicedesk/customer/portals).