Skip to main content
POST
/preview/recommendation/search-conversational

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Conversational recommendation request parameters

adSetId
integer<int32>
required

Id of the AdSet. This field is optional and is resolved automatically for adsets previously configured.

conversation
object[]
required

Conversation between the user and the agent.

nbRequestedProducts
integer<int32>
required

Amount of products to recommend.

partnerId
integer<int32>
required

Id of the partner.

userId
string
required

One user identifier: a Criteo bundle, GAID, IDFA, internal user id, or an agentic partner user id.

adId
integer<int32>

Id of the Ad. This field is optional, it allows to setup Reco controls at Ad level.

identityType
enum<string>

Type of the user identifier (CtoBundle, Idfa, Gaid, AgenticUserId...) Optional if its type is CtoBundle

Available options:
CtoBundle,
Idfa,
Gaid,
InternalUserId,
AgenticUserId
product
object

Information about a product used as context for conversational recommendation

userIdOrigin
string

When IdentityType is AgenticUserId, the issuer should recognize themselves with their organization name issued by Criteo.

Response

200 - application/json

Success

Recommendation response

extraInfos
integer<int32>[] | null

Additional information in case of warnings, errors...

impressionId
string | null

Identifier of the recommendation impression, to be used to correlate displays and clicks

products
object[] | null

Recommended products