> ## Documentation Index
> Fetch the complete documentation index at: https://developers.criteo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API response structure

## Response Elements

All formats share the same API response structure, which is described below:

### `Status`

Type: `string`

Values: `OK`(for successful responses) or an error type.

In case of an error, an array will be added to the response with the list of applicable error message(s), such as: `Missing required parameter x`

***

### `Placements`

Type: `array of placement objects`

Each placement name is used as a key, like for example: `viewCategory_API_desktop-Video`.

The value of each key is an array of ads. Each ad has the below properties:

* **`format`**: indicates which format is returned.

* **`products`**: is a list of SKUs that are included in the ad format, along with additional metadata about each SKU (image, product URL, parent SKU ID, etc.)<br />

* **`products_order`**: some real time product substitutions are allowed based on availability of SKUs:<br />

  * **`products`**: an array of product IDs. The order of products returned by Criteo should match the order of SKUs displayed on the site, unless a SKU is unavailable or out of stock.<br />
  * **`isMandatory`**: If true, the overall ad unit should **not**be displayed if this product is not available. If false, the ad can be shown, but the button/product tile should be removed from the unit.

***

### `Rendering`

* **`rendering`**: format-specific properties to use when rendering the ad, including image assets, colors, and custom labels.

<Warning>
  All video parameters in the rendering section **must not be used to render the video format**. Please refer to [the table below](/retailer-integration/docs/api-response-structure#rendering-fields) for more details.

  Criteo reserves the right to delete these video values at any time in the future.
</Warning>

<Info>
  **Video formats**

  Please refer to the[ format specifications](/retailer-integration/docs/format-overview) (in the Ad rendering section) for more information on the rendering capability. You will also find in this section [the Commerce Video Spotlight specification.](/retailer-integration/docs/commerce-video-spotlight).
</Info>

Please refer to the `TagVideoVAST `field described below.

***

### `TAGVideoVAST`

* \*\*`TagVideoVAST`\*\*or **`XmlVideoVAST`:**
  * **`TagVideoVAST`** *(by default)* **:** a URL to load a VAST XML via a video player that supports VAST;
  * **`XmlVideoVAST`** *(if retailer opt-out of doing an extra API call to retrieve the VAST definition)*: The VAST XML to provide a video player that supports the VAST standard.

* **`OnViewBeacon`,`OnLoadBeacon`, `OnClickBeacon`, etc.**: the beacons to trigger/fire back to Criteo when specific actions take place. See the section for further information.

***

### VAST XML Example

```xml expandable theme={null}
&lt;VAST xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" version="4.2"&gt;
    &lt;Ad id="733362817287327744"&gt;
        &lt;InLine&gt;
            &lt;AdSystem&gt;Criteo&lt;/AdSystem&gt;
            &lt;AdTitle&gt;OnsiteVideo&lt;/AdTitle&gt;
            &lt;Impression&gt;
                <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=N828xWX4-LtKwVLQQMrVufHgiZCDxlFVYZwEVWNsJZKA4iHBMC038LfqxTk2EaafRqtVqIeRJhddzV1aM0qZUYvSm1P09IAML-qfQv6YV7JYH5ZjiZudOmTVJcr_ioxmU6_BDKHYCWNkiUJMR9OdrIhGtJYrnuQjO_Yd1EEO9Iknbvv5K5slpgK0L53FSoKGHwT5BaZpc6nHUrW1mZaunZQTWJI1vEO1_2a1KurAhKEX-GVbEJIaCTKeVso7Krh-A8WQRxv5M_iLotzapEj0g8sPvJxY6BYQiQH_hB7azdWek6GeIZMsuY1KG5jauKsnDsnggwmqOZBAwLY9nCIgUUcDN4HqXw8GQ-y2OOCHdEEhPAOof_hRJ3vtTBkxAWLB&ev=4]]>
            &lt;/Impression&gt;
            &lt;Error&gt;
                <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=xfGg-TglupgGazOqvVKBqhYrNNfbTpO8-1Rjh5wTAHP-VZ9x9Y99kaSQJwUgiTn7ETuV7rkBbFVrPBBtb5GRaHcboaadHyatnYid-1___CLzQzIWTEx6BT7tUVKlx6hNhr8GPpZNLrHtQ5_dqIxbmOc__g9YvYiz9p45DsB7rVD00FzayACSepeyw5n5GpRplBfHw1tnY3XbmJl_UTU7eT-p3MjB6Sywik2aY49THOMnMgap20hTgwgKYgtb1K7VLWS7xxDRUdE5bURv_0KjYvYAsIf8O3kaZewDY8v_opVnRTUHhB_MdGiLQwjyXusOBi6D9ednpAVeKsn3j_RdYPVGVXx5Ah--mIizoK-gnB9rgHCp3UaSxpNyxObomNELgQuIE9CZ98GahSeMNvxNAg&ev=4]]>
            &lt;/Error&gt;
            &lt;Creatives&gt;
                &lt;Creative id="730786603482791936"&gt;
                    &lt;Linear&gt;
                        &lt;Duration&gt;00:00:15.070&lt;/Duration&gt;
                        &lt;TrackingEvents&gt;
                            &lt;Tracking event="start"&gt;
                                <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=7rXxGcjNzVCOieqrcnI64P-N1xjGK8esvSUfzmR2MiE_6D-J73L9sb-u2dmaWhIQXhUcsHLfi9SX6zcf8A17afWPXjcNOjv3s4oGXYkS4Ukg8d-IcBR-xaobER0Ed9_ZfS7JYdKKKOudFMQvUrojvVAJV1Bv0XmwiP9wxR5UNQ6rS8ZOrNslPSULSb_R21a7Br-e_Ekrl-gynqWGSLjpQlrL_LW4F0JoPxh5GTeCl5iGaAcSwegwMoMB8M8bJYiMhofO0jjJXq5dWGY8c9YHGIb0j3uONe4rZKglCuUYRrWv5VcmSlqXk7uZPO7JztrAgmTjphrjAwB8S-9iXZZXu4YNpMgtTJKJU8K_0LIWuAeadYrRcAjNgY0392HUQXa3f2NnSPzDsVLRE9cbK-n2-aitwQOElaYR6nFg28Lg9VZ2iAUyWzGrv7HhVSGXCoLKiYFOXZl9VRPn6Hoigd44aw&ev=4]]>
                            &lt;/Tracking&gt;
                            &lt;Tracking event="firstQuartile"&gt;
                                <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=uU-OCnpWRYRebeUeaCehboM8v4orZkr8KHaxJ6mePRJMqoBU_nWy6aVJDJjJAuKSc1j9ajjMIM6CiXhBNTf9kUWQUTNeWBZ3kcL8nYHKYPmTUk-ydlRtWVFlHrF61J7LdZqWlNJtF3KJ-RnUePaB8P2WCmc4pfvaQm_UtU5sJmp2-5HUKuafp6ex8waKZG1CAgZiROwCfHlXN4CDgxC9IC52iKDyqSPcibKARY33SvS4eH_UWs4Kb_xb4jJ5zRpRQa_xNcYdspi8GaaJhVwpmjm9QbZjt7hgiSNnYPHUMN9BJJP6z01dmo23EXiV72d1uZGMB5-KPkrhkplXhaFkeQl1be6JM6QEmT7F0S2LXXBsZl1gUK62vis19llUuGkLmWkkQK309Cfs8VJR7ba9sA&ev=4]]>
                            &lt;/Tracking&gt;
                            &lt;Tracking event="midpoint"&gt;
                                <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=mRsY528apdPF-7oUo0ptsQdhd11y9JhDfkyvjjc-tWMsjdyHOEKmxXIkWHK7GfEEbRrLn1yUi8CTmpyKPeSad_Z7V8nNO9cFeaaLj5PHJ0aXe0YWUTKC4ObRR7N_MHyzwQviGvCe0Pa_6KfZnI0e9tg8CO1dvzUXprRxD1-Kfw8mu9q_V6doxRoB6FAo-Ix4cNNUtiOaYutemsK9yyz_kB4KD5I-XBZ99nJUl6FX8a7ft0PoqxB4ni-hKa5jhqXU7TWFT9MBgewW-V1QQ9w7_REITzS2KTk3lVtiVGoYAksYn6PYvk8TqAICBPJx9a-Kh06RvMZ8a7mGJo9Hr3MX0uA2m2oWLcKT-zXTyWpKe6jiSjZsepJ4NZ6gC_kREI2w&ev=4]]>
                            &lt;/Tracking&gt;
                            &lt;Tracking event="thirdQuartile"&gt;
                                <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=gwq-D2SK68tiinyyK-lvUPhg_XtL1-5s-7mI6ne8mb1gtCdPbe_VQeHjUGM3QKn-y3tBLJgmr-ixtDctHFHOdB7ymzU0ltbBuewtMwbPy-OxvTEncatOGt4F4vl6pTi4_xfdQHyg00R63396AXqxSAn9lgFrUvpRfCevO8t9frtH38enTt_Iu4MEb3zYqRqRArjqoFRrS6UnJDO6SukVh4HFsasiaa7i6MNJU0N5t5_wNbiSxD2cfhdKpyUm0pMAfdy36kUYDq8phWGOLKc0DfZg-dH8BDawwqTDgQHBKAu9M-9-YApjb-0dxibSa-nfrVehYCqbN2gEy3aNVqaXZNm_bP6WbiysHq0RfQ-3AtQxRlJTgo1L1Fhaq8NuMLEk&ev=4]]>
                            &lt;/Tracking&gt;
                            &lt;Tracking event="complete"&gt;
                                <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=YfHnvxrp_wv_Q4aWH3C3vySItSQRWXm_NXO5jx9kq-MAdvElWrAhLEzwjFc-rDuo9bjVO_c-GtbyQ4_FCni1hWNJo2pbQyaoeCFR2y6zo5Pxxep5JHKnR4xvcK3S0nxuLeEa4UbOzMty8HIPNigHShSxhIl_AmAayi3F1l7MG9vFC4QhvFCvqHKWid9JFMIBL9YDOKJU7CZ8FSRv0YVeuSSqqrmvO_l0-HEVJSt1X0ICV6S4e9B37iCyu076WYsrtCtzn404IuuRFgt7arU_re8HV6DkenH7vKwT83P_dDu42_4-oZD9epbXNRCxvJh6v-PHd_W1Dpu1VWuDRz9ho_9WD_6B8xJFPGTNYe3ozwLieLnuRnQv2PJuihny7XkX&ev=4]]>
                            &lt;/Tracking&gt;
                            <!-- Additional events continued... -->
                        &lt;/TrackingEvents&gt;
                        &lt;MediaFiles&gt;
                            &lt;MediaFile id="c2bf93dcf6e4d6f9dd150c4e4f8c222_discover_miracle_moisture_boost_with_rose_water" delivery="progressive" width="640" height="360" type="video/mp4" scalable="true" maintainAspectRatio="true"&gt;
                                <![CDATA[https://static.criteo.net/design/dt/commerce_max/retailer_1209/c2bf593dcf6e4d6f9dd150c4e4f8c222_discover_miracle_moisture_boost_with_rose_water.mp4]]>
                            &lt;/MediaFile&gt;
                            &lt;ClosedCaptionFiles&gt;
                                &lt;ClosedCaptionFile type="text/vtt" language="en"&gt;
                                    <![CDATA[https://staticassets-creator-design.criteo.net/captions/45fdce79-5556-4874-b139-bb09648436f2_water.mp4.vtt]]>
                                &lt;/ClosedCaptionFile&gt;
                            &lt;/ClosedCaptionFiles&gt;
                        &lt;/MediaFiles&gt;
                    &lt;/Linear&gt;
                &lt;/Creative&gt;
            &lt;/Creatives&gt;
            &lt;AdVerifications&gt;
                &lt;Verification vendor="criteo.com-omid"&gt;
                    &lt;JavaScriptResource apiFramework="omid" browserOptional="true"&gt;
                        <![CDATA[https://static.criteo.net/banners/js/omidjs/stable/omid-validation-verification-script-for-retail-media.js]]>
                    &lt;/JavaScriptResource&gt;
                    &lt;VerificationParameters&gt;
                        <![CDATA[{"beacons":{"omidTrackView":"https://b.us5.us.criteo.com/rm?rm_e=SoYp_oaegT_giaarGZ6g9XNamObRKuLSjYUIvB2divl-i6etKoYCsG1P6zCuD0GNPYcBr8yE71woWF9Mtf5b4mKGFdXsx5f8Y1wgX7FLKV6l107PltviTKUw9mP2WbXejbpXp1w0UMXsBdZV9gYJVNcrabInxciTKgHkGooYg_3ycS_IBZtF0mudsRA2jBQuzbtB_cKksu0U0aF9n_8y0UDi-e2WUFj5QVfDKyENH-wqHc9h6ZlAlK_oxbPM6zu05JgCZIDbdjEnOs3rwwHlXdKqJNXveBH_lTGZOB2jbLY21I04gVve8L-gaDn6akB9KLXQIQpen4G3B12zVAs_CZif4g-X0BuHEwVHKmkdp_TkFS2XWTNUIr10cf-pAbRS&ev=4","start":"https://b.us5.us.criteo.com/rm?rm_e=SWviCrA27etHx6soBhhs-sD-517BpDaseW819rlVkxA83c4N9pdRgWqyv_AuOdi8bSUri66g6GIAcQ1PZu54_0-ShYKun7GNQapPDrql3aOcOlvUcjmyQQNsFucjEH_9cNSZZ2F-t1eRfdSVr4VnwYJbPbFsptqstnbtYXeY4T49JElrhXvvRkSJIc2u70Rt8HdxUJvuj0S0wKGlzxwMw38KIbW3R0_KcXyWzQHFbF77f4W8RgsdKOIt_6wh7xRsOi4hkIHOvj2Zd7OOfieJCX62dkuaJ3X9RFoql7Lagoo2DlVkpCMCBHHzqDYTUyzw18ubDT1cDLxE3C9sdxvB70iuzT9GG255yDY9NUey9jXKd2GO_nyCRux2YQQ9ySth9stPuexRxDxV75SYx3Ry3w&ev=4"}}]]>
                    &lt;/VerificationParameters&gt;
                    &lt;TrackingEvents&gt;
                        &lt;Tracking event="verificationNotExecuted"&gt;
                            <![CDATA[https://b.us5.us.criteo.com/rm?rm_e=NP2S3CNj8qlbwnbax-mpIZdSzmebe8akuxIuy-2yKNGbdKIkcdiTd3lb5pkJtHnkVx6EtB7BRBTu1dYGhElIkVdTHmPz2YC1WGTsrWGK2pihCrGKCEMo9PajFsZj_MZqBcuAsngTMJxqTJzVreuo4SooUocZAJVaFamQNbdwFWPhsk4_9Bmj2-XNjwkHWAjkRH41Sc6iOokUPsszHpfkCH1JZtaoG7UdG5og7gwDPDqzrHrp63tnB77O3yus65ouvLLHnD_E-DCrwu4pnnj5pMK2RnUZZdGxLcflNtgVEYYyXCg6zd7akCSbEAAfQX-pI_wzitBhr31r3ROoQTBBj_z9wEBKGhajgF8RCEtaJdvl-Vu0kes9Q4TU9e5HizxgxG4ckzMeatq9PUbz0m9S7A&ev=4]]>
                        &lt;/Tracking&gt;
                    &lt;/TrackingEvents&gt;
                &lt;/Verification&gt;
            &lt;/AdVerifications&gt;
        &lt;/InLine&gt;
    &lt;/Ad&gt;
&lt;/VAST&gt;
```

***

### Closed Caption Files in VAST XML

When Closed Captioning is enabled, the VAST XML response will include a `ClosedCaptionFiles` element nested inside each `MediaFile` element within the `MediaFiles` section.

Each `ClosedCaptionFiles` container holds one or more `ClosedCaptionFile` entries, representing closed captions in different languages and formats (currently, `text/vtt` is supported). These are not video assets themselves and must not be interpreted as part of the video `src`.

**Example**

```xml theme={null}
&lt;MediaFiles&gt;
  &lt;MediaFile id="c2bf93dcf6e4d6f9dd150c4e4f8c222_discover_miracle_moisture_boost_with_rose_water"
             delivery="progressive"
             width="640"
             height="360"
             type="video/mp4"
             scalable="true"
             maintainAspectRatio="true"&gt;
    <![CDATA[https://static.criteo.net/design/dt/commerce_max/retailer_1209/c2bf593dcf6e4d6f9dd150c4e4f8c222_discover_miracle_moisture_boost_with_rose_water.mp4]]>
    &lt;ClosedCaptionFiles&gt;
      &lt;ClosedCaptionFile type="text/vtt" language="en"&gt;
        <![CDATA[https://staticassets-creator-design.criteo.net/captions/45fdce79-5556-4874-b139-bb09648436f2_water.mp4.vtt]]>
      &lt;/ClosedCaptionFile&gt;
    &lt;/ClosedCaptionFiles&gt;
  &lt;/MediaFile&gt;
&lt;/MediaFiles&gt;
```

***

### Product Beacons

```json theme={null}
{
"OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=s8ly6TMLiDfPTKFfXm_9jzkwZuAATAS9FwGwUZ5NvnDY6LnNvBC-8AFQtntlkS50apl_jVhQvRg0-u3hWpur4RF0HikgBSOlggUUkzoK6gg9E7yC-eas9rFlwoxTuvObWpo4Yv0uedvzqBKRk-BQgcCsPHzIURbtCi_Uf5InvFyWoUkbah_XRajDvrj7oLrV-RjcYeixGYTcBoi89hqLhak5FB7_2zPWNAZMVPUCw23MNX4t0OC70fDyIL68g7RUGtBtrVvbMkMafb30uMp_L1WlmSeGHdM-EP6aUYjKRS0VBwwZkaVStkauo1XrT5-dwiyB8zm2AlAVk0AwGMNdmFlCBac-MQWycvgjgOWm-p7cGLVi5Fq3gIrUGVI5Jqq&ev=4",
"OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=MrPLtLUJfBxGX1zJk2imKaKpINZcbhVh4D9KELEKwSgdZe8-YiW50o4eQvi4SQGyvk-qeuvO1GZCJkmhfpBHJYoxcNaFwMFqtBLjax-lgCevbaCxmjOQjxqFgBXAG0CAvZx4klriBNrRrVXKIk2NI8-jpplFURhS_hDuGcMgUICraKi4wi7x958r0VNKA7iE6f-N2yyQWLlILI4yNFgqZPp_0sP-b2ks72ZdxeiJQbDko0FVMJYPClVooJPRXBWJjOvph2OOrZyh0tY4LwGp6D2p8W_rD_5HN94RR5Cewl8ojB6WFjoq_PAaJGPptLjEUV9kx-EUMFhve6vGfAlHeJ7P-ILh44mp8nOKyIsoLSIwR9HYhghChXJ4M-3EVAs&ev=4",
"OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=mlh4P3Tin3uct-JUxYugi37w__lZ0FOoCZ06TrhlXtQKc2faGpFFiK6g4zKwyFmd2NwXBMhVZGVtFK5T9e9KvdteZRrqZxcVW08Y9i8ecjt9m1DbEQunU8uMblAIF8yZ3bqjt71Niurwrzm-iiF-B2av8zEd0lj-Lt5AGeX1dgyP3jJdO-5Ddmw6-H5L9JTAksWT8QWbKoVwOQtwYU8r2M4yzpCGGvcvvwu6QdoC_GCfazwEsIRt446HA0AVqOwss26id8ZDjTSrwbOjSVMu5JS92mGU_3wR3Fyb2w5M8AJcLUlIXTD8oaLc9CFyAQQrbkurtKsHFPfNWRyuZOxnZr0FgSgRvHIi55eP-yr5usr4of31iaYPQvKrdTbGiEX&ev=4",
"OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=F--9mZ6kqtpHdJjjowDoZJixm4BjF12sLm6qFd0fCcnunZ1oT-owxZowTezzt4Je3Q7MQiLTAyZNVlB7v-feDJHnczt4q-f43SEE67RxRFL-PWGl4jCW7F7CKBZ5WNMxBmU0eC4d88xec7diCgp-Ifhgs-Qp135jF8-BrQ7kVj9RlRan2QTtLKxCXTytdydHRhwaAsdCyOA-VStX4ZNRI297WGRTXfRepsCLAr6E5DTDdoccag4lx5v_LSUNO82i0D11y5O3xqs1QSKCIANY802UBDPdV89lEqbofgL1Gp7CYd0OSxM_545fzsFVA2RWG4ufFDIF71aXrbKhZuRencstNQ8xMWH0KMKACEk7DQWE9WObogGMEaoSf8t664O&ev=4"
}
```

***

### Placement / Format Beacon

Placement and format beacons will typically be right under the `TagVideoVAST`:

```json theme={null}
{
"OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=OvODs4ECUFFfQHTXDM5FiIOKZruyseTgpUr_Xt4DVTUPBoNNtG8VsH3Jo21jPK_hMV6-9I89Az0ZP2H8yslVjFaeW_HqR0Tee4gUCZ-aJMGxpkz2bjGguRcAv-jd9ocPs2HOgk24DtDHJ_D4MJJ1b0I2bILdRCp2AyfGmrj1acfyvMqngJeS4eWiDOYOkNTaYmd0uIo3bAcGObFt4DALVQE-AJXUhBjo3lyY6Kcn7n6xS1bAkK_kqT6sBtSk2KRmX_dPNKucLowpkgsRwpr-XgfcmV1VVvkCH8uXbmYbEPTQVE103_4r7zHgvpZaiU8qbROlMwCHVqvx-aY1tNuDKa0uwoqyCm6JHC2yTo06XfnqZhJphbc50hjGbPZHa24ZAdMq7bBr3G9YpxycnMQ_B-7zyNFQeSNH_M_pYAgIvo6eXjgAYA376LoJostZTGhmEEKUvgrY-7hbU_ezG5D2_BCA7Yh2xkDQHmERLd4FgWyUxcSlkksvUmIlpd1S5-b&ev=4",
"OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=qjke4FNkDL1z46EuOhojBxciTQ6Xp09cJDentgGUVT0kah-rPIHg9DUOFugsUOiCrUvFnJtuj5yYXehZp5-Ryvzf5WLl9gmin_wz4ekX7Fu_ePZKpnpNgyBBR-1Jjuqzdvkq6aIktA4r5HGzyyPF9TQDrrhYgmldAW8QYjfTk6WiI7jlZmUZnIvVah3HJi4I6QzTCTTwRXBJrFNYgJKgt2M419DkJA1UyGsnCmld5E-q4Ms3znTBEIF4fgVj6ExNAM1O_HgmgcKrDYCpo9ZVkd037dHoDiYiZVfmymlSIcubD73ZB_sBl20rsUxIujMsbLt3jliMFEthtJ8oZ3mL5Ax2HwOA2Qm58M0InNlmQf88ulFpw_IWYI6iklgleE3GrvqHb-eNj7Fg77qvKRYrHmE1gLF66WVjyactaWqP0RsIpqcAGlrjHTI7I_lQxE6&ev=4",
"OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=xt13W_TJWbSrXdNa2RG3qhZiHotcnySWD0gLaHC_PbIZyrh_V_zxUVBnIP66uaFp58Y8R0Q6ALpYjkAac-2iecIRrcEVriwqPrGkjbDFHjBsGPD4q0JTEH1mZrp2oMndYCXQEOQjAzDIBR4e52DU-koOXViZcXi9_S-bLmQA_PFop4u0ilGtfJ2AJeCOtwyNnluCwE3INkF1AEN4HqMnOgtiHcm00o9DojZemXKd_B-4bRl3eRmFR_s0jVRjwbAYHegtP7WKujHi5iRiBYogpOpVhMCkg3DciZZpza9IcBxsQVgEonlADyJYzUtvEzMZpzBE1_x6NyjUPECJUSHrxvzSI7UKgPwSukP5sCvSxY6AFqTIXXHCXKjJKFH2uQwsvi0VtHobEv_c13tm3QaIg&ev=4",
"OnFileClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=3wgFCc5lMY0fItQj4jiSm37070kK2zoFJlbFRWEZd3CB9_0DjnEp1Iq7Q1xG5mTffdi1SAarVTiAILArYOPRbbyiJ3eB_t4Y29BWqAhUbIrP6nAFT0W2DxVbOdlRLFYoISPpbV-EhVsA-oh9kXPKSk53p7w1MZAm9LS45SVZ_tZQh7-SPz2MLF4hoJGteus6hkWyfsVbgTym2gpu7JobVmaFLGrc8CyymYkfH5Xf1JKiGeNa2ZPsQtZxpnt1Dzl4Bm_BAfKYjQZnOCyWt6peHIN-azNeYwe34M9H85x1SWn5y_PKpIQZYiB_1YvdBac2VSrkBqO6SO1OgB2NiveM923Ew4Npm2rgUYUZ5bjvgL3KufQJK4FucRbvjAxEQJS&ev=4",
"OnBundleBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=FSx1IlEiuPZ8UZ6-SLMpMc_icIPoxT57Ozjvievjn-9la70L5yC5VtSagxSUpBlat4BEQLu8hrqXDcNY8kUTLylv7fdvT2B7x-NkYCfYEGZZj1lJdRLhQxckVsgIk-PyjILwpnwEODcV1wvMmXnFH5ttrA5iSp847tgW-2fvZxS1w7YX30tbLYvAmZTvJxPnOXKPcmwnJz3BJ6d8CMLgdVoJN67AtgRKTpkb1s0eYk-ANM_gv7cgtEME2142W8vlv6-NayvCwGvw_CtH-OWVZoEJ52TJMMbj3Aa6jPHBRgw9P-LVsFWY3f_kxauVNl7mHTAyVvajrcPeYl7_8ygq6hFtqm9IBryXB8iMctEXDronoGT-VHfrAqet9nVvPYMyATWjm-X21M88YLAGoaDuQ&ev=4"
}
```

***

## Rendering Fields

Below is an example of rendering fields in the API response:

```json theme={null}
"rendering": {
  	"background_video": "{\n  \"url\": \"https://static.criteo.net/design/dt/commerce_max/retailer_06/d97eb13b8e3d496eaddef7b4c998d286_video.mp4\",\n  \"width\": 720,\n  \"height\": 1280,\n  \"duration\": \"00:00:06\"\n}",
  	"video_caption_file": "https://static.criteo.net/video/onsite_cc/laptop_vertical.vtt",
  	"video_alt_text": "Laptop",
  	"border_color": "#712329",
  	"video_optional_redirect_url": "https://www.retailer.com/shop/search-results.html?q=laptop",
  	"video_optional_redirect_url_app": "",
  	"video_media_files": "[\"background_video\"]"
},
```

Below is the description of the API response fields for format rendering within the page.

<Warning>
  These fields are subject to change based on the video format.
</Warning>

<table>
  <thead>
    <tr>
      <th>
        <p>
          Field
        </p>
      </th>

      <th>
        <p>
          Description
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          <code>
            video\_background
          </code>

          (including all information within this field)
        </p>
      </td>

      <td>
        <p>
          <b>
            Do not use this field.
          </b>

          It is reserved for Criteo purposes only. All video-related information, assets and tracking must be used from the VAST XML only.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <code>
            video\_optional\_redirect\_url
          </code>

          <code>
            video\_optional\_redirect\_url\_app
          </code>
        </p>
      </td>

      <td>
        <p>
          <b>
            Do not use these fields.
          </b>

          It is reserved for Criteo purposes only. The optional redirection link to a landing page if the user clicks on the video player is available in the VAST definition (cf.

          <code>
            \<ClickThrough>
          </code>

          node). As only one redirection link is supported in VAST, Criteo will automatically return the right URL based on the page requesting ads.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <code>
            alternative\_text / background\_video\_alt\_text
          </code>

          (or equivalent naming)
        </p>
      </td>

      <td>
        <p>
          Text to display in an alt\_text div attribute for

          <a href="https://www.w3.org/WAI/standards-guidelines/wcag/">
            WCAG
          </a>

          compliancy purposes.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <code>
            optional\_legal\_text
          </code>
        </p>
      </td>

      <td>
        <p>
          Free text field to display a legal message upon user hover. This field is optional for the advertiser to complete.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <code>
            video\_media\_files
          </code>

          <code>
            video\_firework\_id
          </code>

          <code>
            video\_caption\_file
          </code>

          <code>
            video\_captions
          </code>
        </p>
      </td>

      <td>
        <p>
          <b>
            Do not use these fields.
          </b>

          It is reserved for Criteo purposes only.
        </p>
      </td>
    </tr>
  </tbody>
</table>

***

<br />

## What's next

* [Video player specifications](/retailer-integration/docs/video-player-specifications)
* [Tracking ad-related activity](/retailer-integration/docs/tracking-ad-related-activity)
* [Criteo-Owned Video Player Integration](/retailer-integration/docs/criteo-owned-video-player-integration)