Definition

A category flyout is a window that appears when a user hovers over different category options from the main browse menu.

Each change in category shown in the window will require its own API call, as the desired category changes.

Parameters

event-type

Value: viewCategoryMenu

Description: Indicates to the API that this is a category flyout event.

Required: Yes

page-id

Description: An identifier that tells Criteo which placements to return for the ad request. Placements are instantiated by your Technical Account Manager depending on your desired ad configuration. Below are the standard page-ids for this page type:

• In Americas: Typically follows the structure [event-type]_API_[environment], e.g., viewCategoryMenu_API_desktop, viewCategoryMenu_API_mobile, viewCategoryMenu_API_android, viewCategoryMenu_API_iOS.
• In EMEA: Typically follows the structure [event-type]Api[environment], e.g., viewCategoryMenuApiDesktop, viewCategoryMenuApiMobile, viewCategoryMenuApiAios, viewCategoryMenuApiAa.

Required: Yes

category

Description: The category or taxonomy of the page that the user is browsing. This value should match the product_type_key value in the products feed.

Examples:

• Category ID, full breadcrumb style: 123>4567>89012
• Category ID, end-node-only style: 89012
• Category name style: Computing>Keyboards and Mice>Mice

Required: Yes

page-uid

Description: This value is returned within the response of the initial call made on page load. By storing this value and including it in subsequent viewCategoryMenu event calls, Criteo is able to link the events to the initial ad request.

Example: 58d1ebf6-543e-4285-b9dce2f772d1f18f

Example Workflow for page-uid:

1. User arrives at the homepage, generating a viewHome ad request with a unique page-uid.
2. User browses/hovers over categories, generating viewCategoryMenu calls.
3. Each viewCategoryMenu call must include the initial page-uid from the first viewHome call.

Required: Yes

Sample calls

📘

The header values in the sample calls are illustrative. Make sure to replace them with the appropriate values for your implementation.

AMER

curl -X GET "https://d.us.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=12345" \
--data-urlencode "environment=d" \
--data-urlencode "retailervisitor-id=a1b2c3d4e5" \
--data-urlencode "customer-id=123456789" \
--data-urlencode "page-id=viewCategoryMenu_API_desktop" \
--data-urlencode "event-type=viewCategoryMenu" \
--data-urlencode "category=123>4567>89012" \
--data-urlencode "page-uid=58d1ebf6-543e-4285-b9dce2f772d1f18f" \
-H "Referer: https://www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"

EMEA

curl -X GET "https://d.eu.criteo.com/delivery/retailmedia" \
--data-urlencode "criteo-partner-id=12345" \
--data-urlencode "environment=d" \
--data-urlencode "retailervisitor-id=a1b2c3d4e5" \
--data-urlencode "customer-id=123456789" \
--data-urlencode "page-id=viewCategoryMenuApiAios" \
--data-urlencode "event-type=viewCategoryMenu" \
--data-urlencode "category=123>4567>89012" \
--data-urlencode "page-uid=58d1ebf6-543e-4285-b9dce2f772d1f18f" \
-H "Referer: https://www.criteo.com" \
-H "X-Forwarded-For: 123.456.789.012" \
-H "User-Agent: app_ios 1.2.3"