Endpoints
Method | Endpoint | Description |
|---|---|---|
GET |
| Get all auction line items from a specific campaign |
POST |
| Create a new auction line item |
GET |
| Get a specific auction line item |
PUT |
| Update a specific auction line item |
Createoperations using thePOSTmethod expect every Required field; omitting Optional fields will set those fields to Default values.Updateoperations using thePUTmethod expect every Writeable field; omitting these fields is equivalent to setting them tonull, if possible.
Line Item Attributes
Attribute | Data Type | Description |
|---|---|---|
| string | Auction line item ID, generated internally by Criteo Accepted values: string of int64 Writeable? N / Nullable? N |
| string | Line item name, must be unique within the Campaign Accepted values: between 2 and 255-chars string Writeable? Y / Nullable? N |
| string | Campaign ID, in which the respective line item belongs and generated internally by Criteo Accepted values: string of int64 Writeable? N / Nullable? N |
| string | Retailer ID where the line item will serve ads on. For retailer-budgets campaigns, must match the campaign’s Accepted values: string of int64 Writeable? N / Nullable? N |
| date | Start date of the line item, used to schedule its activation and start serving ads. To understand the conditions that will cause a status to change, check out Campaign & Line Item Status ℹ️ This now supports datetime offset to define the desired time zone, in the format of Accepted values: Writeable? Y / Nullable? N |
| date | End date of the line item; serves ads indefinitely if omitted or set to ℹ️ This now supports datetime offset to define the desired time zone, in the format of Accepted values: Default: if Writeable? Y / Nullable? Y |
| decimal | Lifetime spend cap of line item (optional), uncapped if omitted or set to Accepted values: Default: Writeable? Y / Nullable? Y |
| decimal | Budget amount the line item has already spent Accepted values: Default: Writeable? N / Nullable? N |
| decimal | Amount the line item has remaining until cap is hit; Accepted values: 0 ≤ Default: Writeable? N / Nullable? Y |
| decimal | Amount the line item can spend per calendar month (optional), in the Account time zone. Omitting or setting to Accepted values: Default: Writeable? Y / Nullable? Y |
| decimal | Amount the line item can spend per calendar day (optional), in the Account time zone. It resets each day; overwritten by calculation if Accepted values: Default: Writeable? Y / Nullable? Y |
| boolean | To activate, either line item Accepted values: Default: Writeable? Y / Nullable? N |
| enum | Indicate whether Adaptive CPC is enabled or not Accepted values: Default: Writeable? Y / Nullable? N |
| enum | Bid algorithm optimizing for sales conversions, sales revenue or clicks Accepted values: Default: Writeable? Y / Nullable? N |
| bidStrategy decimal | If optimizing for ℹ️ Note:
Accepted values: at least the greatest value of Default: Writeable? Y / Nullable? Y |
| decimal | If optimizing for ℹ️ Note:
Accepted values: at least ⚠️ Note: As of Writeable? Y / Nullable? Y |
| enum | Line item status; can only be updated by a user to Accepted values: Writeable? Y / Nullable? N |
| object | Settings allowing custom scheduling for serving ads serving, organized by a combination of Accepted values: see below Writeable? Y / Nullable? Y |
| enum | Keyword strategy used to target users according to the promoted products appended in the line item and their competitors ℹ️ Note: “Conquesting” is not available for all retailers; when creating a new line item for those retailers, a validation error will return which can be avoided by omitting this attribute from the request Accepted values:
Default: Writeable? Y / Nullable? N |
| timestamp | Timestamp of line item creation, in UTC Accepted values: Writeable? N / Nullable? N |
| timestamp | Timestamp of last line item update, in UTC Accepted values: Default: same as Writeable? N / Nullable? N |
- Writeable (Y/N): Indicates if the field can be modified in requests.
- Nullable (Y/N): Indicates if the field can accept null/empty values.
- Primary Key: A unique, immutable identifier of the entity, generated internally by Criteo. Primary keys are typically ID fields (e.g.,
retailerId,campaignId,lineItemId) and are usually required in the URL path.
Flight Schedule Legs Attributes
Attribute | Data Type | Description |
|---|---|---|
| enum | Day of the week or day type that the respective Accepted values: Writeable? Y / Nullable? N |
| time | Start time that the respective ℹ️ This time value will be interpreted considering the time zone provided in the Accepted values: Writeable? Y / Nullable? N |
| time | End time that the respective ℹ️ This time value will be interpreted considering the time zone provided in the Accepted values: Writeable? Y / Nullable? N |
Get all Onsite Sponsored Products Line Items
This endpoint lists all Onsite Sponsored Products line items in the specified campaign. Results are paginated usingoffset and limit query parameters; if omitted, defaults to 0 and 500, respectively. See API Response.
Sample Request
Create an Onsite Sponsored Products Line Item
This endpoint creates a new Onsite Sponsored Products line item in the specified campaign. Sample RequestGet a Specific Onsite Sponsored Products Line Item
This endpoint returns the specified Onsite Sponsored Products line item. Sample RequestSample request with uncapped or missing budget
Update a Specific Onsite Sponsored Products Line Item
This endpoint updates the specified Onsite Sponsored Products line item. In this example, we are:- renaming the line item and start date, to be scheduled to deliver during Q4.
- enabling auto daily pacing by setting a monthly pace simultaneously. Note that with auto daily pacing enabled, daily pacing is automatically calculated and overwrites its previous value, if any.
- modifying the day scheduling to deliver ads during extended weekend evenings only, i.e., Fridays, Saturdays and Sundays from 18h until 0h (local time)
Responses
Response | Title | Description |
|---|---|---|
🔵 | Call completed with success | |
🔵 | Line item created with success | |
🔴 | Invalid | Cannot turn on |
🔴 | Conquesting not enabled |
|
🔴 |
|
|