Getting Started1- A line item holds promoted products to advertise on any single retailer
2 - Line items have bid settings, start & end dates, and optional budgeting & pacing controls
3 - Budgets may additionally be controlled at the campaign level
4 - Several reports are available to measure line item performance
5 - Campaigns are limited to 10,000 non-archived line items
6 - Line items are archived automatically 90 days after their end date
Get all Preferred Deals Line items from a specific Campaign
POST
/campaigns/{campaignId}/preferred-line-items
Creates a Preferred Deals Line item
GET
/preferred-line-items/{lineItemId}
Get a specific Preferred Deals Line item
PUT
/preferred-line-items/{lineItemId}
Updates a specific Preferred Deals Line item
Create operations using the POST method expect every Required (R) field; omitting Optional (O) fields will set those fields to Default values* Update operations using the PUT method expect every Write (W) field; omitting these fields is equivalent to setting them to null, if possible
Is Nullable? YesLine item end date in the account `timeZone`; serves indefinitely if omitted or set to `null`Values: YYYY-MM-DDRead or Write WriteDefault Valuenull
Is Nullable? YesLine item end date in the account `timeZone`; serves indefinitely if omitted or set to `null`Values: at least 0Read or Write WriteDefault Valuenull
Is Nullable? YesAmount the line item has remaining until cap is hit; \null“ if budget is uncappedValues: between 0 and `budget`Read or Write -Default Valuenull
Is Nullable? -Way the budget will be spent, between the following values: accelerated (Spend as fast as possible) or standard (Spend evenly)Values:accelerated, standardRead or Write -Default Value -
Is Nullable? -Page type to serve onValues: -Read or Write -Default Value\search`, `home`, `checkout`, `category\, \productDetail`, `confirmation`, `merchandising`, `deals“
Optional.Is Nullable? -Categories to serve on. Only applies to \category`, `productDetail`and`merchandising“ page typesValues: -Read or Write -Default Value -
Is Nullable? -Line item status; can only be updated by a user to \active`or`paused“; all other values are applied automatically depending on flight dates, financials, or missing attributes required for line item to serveValues: -Read or Write -Default Value\active`, `paused`, `scheduled`, `ended`, `budgetHit`, `noFunds`, `draft`, `archived“
This endpoint creates a new onsite display line item in the specified campaign
Creative ID Association with the Line ItemWhen generating a new creative, the initial id is known as a “parentId,” of the creative. Every new update made to that creative creates a new “childId” which is a copy of the previous creative containing new updates. This means that the creativeId will change whenever a new update is made to the creative.To ensure that your line item is using the correct creativeId, your application will need to call the latest creativeId from the Get Creatives endpoint before associating a new creative to the line item.
This endpoint lists all onsite display line items in the specified campaign.Results are paginated using pageIndex and pageSize query parameters; if omitted, defaults to 0 and 25, respectively. See API Response.Sample Request
curl -X GET "https://api.criteo.com/{version}/retail-media/campaigns/8343086999167541140/preferred-line-items?pageIndex=0&pageSize=25" \ -H "Authorization: Bearer <MY_ACCESS_TOKEN>"
This endpoint updates the specified onsite display line item. In this example, we update the pacing status from accelerated to standard. Also, note the draft state of the line item because products to be promoted have not yet been added.Sample Request
