GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
Guides
These docs are for v2022.10. Click to read the latest docs for v2024.10.

Bid Multiplier

📝

A FEW THINGS TO KNOW

The Criteo engine maximizes advertising performance while optimizing the shopper experience. It can automatically and intelligently control how much a line item delivers on each page type. In addition, bid multipliers provide campaign managers more control over managing bids at the line item level while also optimizing campaign performance goals at a page-type level.

-Bid multipliers are available at the Open Auction line items level. In addition, campaign managers can modify bids only on enabled page types.

-Bids can be increased up to 500% or decreased up to 50% on each page targeted at the line item level.
For example: If a line item bid is $1, with a bid multiplier, you can increase the Search page bid by 20% and decrease the homepage bid by 10%. The Criteo engine will optimize more delivery and performance on the search page while also allowing the control of which page types budget is mostly allocated towards.

 

Endpoints

VerbEndpointDescription
GET /line-items/{lineItemId}/bidMultipliersReturns all bid multipliers for valid page types of the specified line item.
PUT /line-items/{lineItemId}/bidMultipliersReplaces all existing bid multipliers with the provided bid multipliers or the default value (1.0).

Note: A PUT operation with an empty attributes object will reset all values to their default.

 

Bid Multiplier Attributes

id
  • Data Type: string
  • Values: long-id

  • Description: Line item Id

Search
  • Data Type: decimal
  • Values: 1.0

  • Description: Bid Multiplier applied to the Search Page Type

Home
  • Data Type: decimal
  • Values: 1.0

  • Description: Bid Multiplier applied to the Home Page Type

Category
  • Data Type: decimal
  • Values: 1.0

  • Description: Bid Multiplier applied to the Category Page Type

ProductDetail
  • Data Type: decimal
  • Values: 1.0

  • Description: Bid Multiplier applied to the ProductDetail Page Type

Confirmation
  • Data Type: decimal
  • Values: 1.0

  • Description: Bid Multiplier applied to the Confirmation Page Type

Merchandising
  • Data Type: decimal
  • Values: 1.0

  • Description: Bid Multiplier applied to the Merchandising Page Type

Deals
  • Data Type: decimal
  • Values: 1.0

  • Description: Bid Multiplier applied to the Deals Page Type

 

Get Bid Multipliers

Returns all bid multipliers for valid page types of the specified line item.

https://api.criteo.com/<version>/retail-media/line-items/{lineItemId}/bid-multipliers

Sample Request

--Request

TO BE ADDED SOON

Sample Response

// Sample Response

{
  "data": {
    "id": "1234567890",
    "type": "BidMultipliersModel",
    "attributes": {
        "Search": 1,
        "Home": 1.2,
        "Category": 1,
        "ProductDetail": 1,
        "Confirmation": 1,
        "Merchandising": 1,
        "Deals": 1
    }
  },
  "errors": [
    "Line Item Does not exist"
  ],
  "warnings": [
  ]
}

Update Page Type Bid Multipliers

Replaces all existing bid multipliers with the provided bid multipliers or the default value (1.0).

  • Note: A PUT operation with an empty attributes object will reset all values to their default.
https://api.criteo.com/<version>/retail-media//line-items/{lineItemId}/bidMultipliers

Sample Request

Sample Request - full example to be added soon

--request_body
{
  "data": {
    "type": "BidMultipliersModel",
    "attributes": {
        "Search": 1,
        "Home": 1.2,
        "Category": 1,
        "ProductDetail": 1,
        "Confirmation": 1,
        "Merchandising": 1,
        "Deals": 1
    }
  }
}

Sample Response

// Sample Response

{
  "data": {
    "id": "1234567890",
    "type": "BidMultipliersModel",
    "attributes": {
        "Search": 1,
        "Home": 1.2,
        "Category": 1,
        "ProductDetail": 1,
        "Confirmation": 1,
        "Merchandising": 1,
        "Deals": 1
    }
  },
  "errors": [
    "Line Item Does not exist",
    "BidMultiplier Value is out of range",
    "Illegal Value Provided"
  ],
  "warnings": [
    "The following page types are not supported by retailer and were ignored: {PageType}, {PageType}, ..."
  ]
}

Responses

ResponseDescription
🔵 200Call executed with success
🔴 400BidMultiplierOutOfRange
A bid multiplier provided is out of range of the expected range and could not be accepted

IllegalValueProvided
An invalid page type or poorly formated bid multiplier was provided
🔴 401Unauthorized
User doesnt have permission to edit a specified line item
🔴 404LineItemDoesntExist
Attempted to fetch or manipulate a line item that does not exist