Warmup v2 Request

POST

https://localhost/v2/{publisherUUID}

This endpoint expects a warmup request. Each ad unit must include at least one of the following inputs:

searchQuery
categories
products

You can also provide multiple ad units in the adUnits array.

Path Parameters

publisherUUIDstringrequired
Description
The UUID of a publisher, this value is provided by Pentaleap during the integration process

Body Parameters

bodyRequestrequired
- userUserrequired
  - idstring
    Description
    Unique identifier for the end user. The value can be session cookie or any authenticated user identifier. At least one of id or loggedInId is required.
    Min Length
    1
    Max Length
    128
  - loggedInIdstring
    Description
    [Optional] A persistent user ID for logged in users/customers. At least one of id or loggedInId is required.
    Min Length
    1
    Max Length
    128
  - additionalIdsmap<string, string>
    Example
    { "partner_x_id": "id123", "partner_y_id": "id456" }
    Description
    [Optional] optional publisher-provided IDs for reporting and analytics purposes
    
    Validation Rules:
    
    maxProperties: 20 Each value:
    
    minLength: 1
    
    maxLength: 128
  - ipstring
    Description
    The IP address of the user, this value is provided by the publisher.
    Max Length
    60
  - agentstring
    Description
    The user agent of the user, this value is provided by the publisher.
    Max Length
    400
  - regionstring
    Example
    066
    Description
    Region of the user
    Max Length
    100
  - operationFlagsobject
    - noReportingboolean
      Description
      Use for test traffic in pre-production. When true, indicates to the Demand Source that the request should not be logged and counted.
  - limitedTrackingboolean
    Description
    Specifies whether the user has chosen to limit tracking.
- adUnitsAdUnit[]required
  Description
  Validation Rules:
  
  minItems: 1
  
  maxItems: 6
  - adUnitIdstringrequired
    Description
    Unique identifier for the ad unit. The value can be session cookie or any authenticated ad unit identifier.
    
    Validation Rules:
    
    minLength: 1
    
    maxLength: 100
    Min Length
    1
    Max Length
    100
  - searchQuerystring
    Description
    The search query that the user entered for the current request, this is valid for the search pages only.
    Max Length
    400
  - categoriesCategory
    Description
    At least one of current or additional is required.
    - currentstring
      Description
      The current category of the user, this value is provided by the publisher.
      
      Validation Rules:
      
      maxLength: 200
      Max Length
      200
    - additionalstring[]
      Description
      Additional categories of the user, this value is provided by the publisher.
      
      Validation Rules:
      
      maxItems: 20 Each value:
      
      maxLength: 200
  - productsProduct[]
    Description
    Products on the page (item or basket). This is valid for product-scoped ad units.
    
    Validation Rules:
    
    maxItems: 200
    - gtinstring
      Example
      00000000000000
      Description
      Is typically the "Global Trade Item Number" but generally a retailer's unique product identifier.
      
      Validation Rules:
      
      minLength: 1
      
      maxLength: 128
      Min Length
      1
      Max Length
      128
    - pricenumber
      Description
      Product price. Must be greater than or equal to 0.
      Minimum
      0
    - quantityinteger
      Description
      Product quantity. Must be greater than or equal to 0.
      Minimum
      0
    - availabilitystring<in_stock | out_of_stock>
      Description
      Product availability. Must be one of in_stock or out_of_stock.
      Allowed
      in_stockout_of_stock
  - excludedProductsexcludedProducts
    Description
    List of product GTINs that will be filtered out from the warmup demand if returned by DSPs for the given request. This only applies to SPA (Sponsored Product Ads).
    
    Validation Rules:
    
    maxItems: 200
- adUnitContextAdUnitContext
  Description
  Global context configurations used for all ad units in the request. This optional field provides shared contextual information that applies to every ad unit.
  - pageNumberinteger
    Description
    Page number must be between 1 and 100
  - filtersmap<string, string[]>
    Example
    filters: { "DSP_Name-1":["filter1", "filter2"], "DSP_Name-2":["filter1,filter2,filter3"] }
    Description
    This field contains demand source specific filters. The demand source names used here must be agreed upon with Pentaleap. Filters are passed to the demand source as-is, so they must follow the correct representation expected by the demand source especially in cases where a single filter is provided as a one-element array.
    
    Validation Rules:
    
    maxItems: 20
    
    maxLength: 600
  - excludedProductsexcludedProducts
    Description
    List of product GTINs that will be filtered out from the warmup demand if returned by DSPs for the given request. This only applies to SPA (Sponsored Product Ads).
    
    Validation Rules:
    
    maxItems: 200

Responses

200Request Successful and data is already processed

202Request Accepted and will be processed asynchronously

400One or more request parameters don't comply to the API specifications.

ErrorResponse
- errorsstring[]

curl

curl --request POST \
     --url https://localhost/v2/{publisherUUID} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "user": {},
     "adUnits": [
     {
     "adUnitId": ""
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "user": {},
   "adUnits": [
      {
         "adUnitId": ""
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://localhost/v2/{publisherUUID}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://localhost/v2/{publisherUUID}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "user": {},
   "adUnits": [
      {
         "adUnitId": ""
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://localhost/v2/{publisherUUID}"

payload = json.dumps({
   "user": {},
   "adUnits": [
      {
         "adUnitId": ""
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Request Successful and data is already processed

202

// Request Accepted and will be processed asynchronously

400

// One or more request parameters don't comply to the API specifications.
{
  "errors": [
    ""
  ]
}