> For the complete documentation index, see [llms.txt](https://doc.commandersact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.commandersact.com/fr/fonctionnalites/destinations/destinations-catalog/openai-conversions-api.md).

# OpenAI Conversions API

[OpenAI](https://openai.com/) est un organisme de recherche en intelligence artificielle. Cette destination vous permet de tirer parti de [OpenAI Conversions API](https://developers.openai.com/ads/conversions-api) pour envoyer des événements de conversion directement à OpenAI à des fins d’attribution et de reporting en aval.

## Fonctionnalités clés

La destination OpenAI Conversions API offre les fonctionnalités clés suivantes :

* **Structure des événements** : notre modèle [Référence des événements](https://doc.commandersact.com/developers/tracking/events-reference) couvre les [événements OpenAI](https://developers.openai.com/ads/supported-events), ce qui signifie que vos données sont correctement mises en correspondance avec les champs attendus de manière optimisée.
* **Mappages prédéfinis** : le mappage des données pour les destinations basées sur les événements s’effectue automatiquement, ce qui simplifie les saisies des utilisateurs.
* **Hachage automatique** : les informations sont automatiquement hachées conformément aux spécifications du partenaire.
* **Mappage intelligent** : le mappage des données peut être ajusté à l’aide des champs définis dans votre datalayer.
* **Mappage des événements** : modifiez le mappage standard entre les événements OpenAI et les vôtres.
* **Prise en charge des données multi-éléments** : les informations incluses dans le tableau [élément](https://doc.commandersact.com/developers/tracking/events-reference#item) sont envoyées à OpenAI.
* **Prise en charge du mode batch** : envoyez plusieurs événements dans une seule requête.

## Configuration de la destination

Assurez-vous d’avoir accès à [OpenAI Ads](https://ads.openai.com/).

{% hint style="info" %}
La déduplication des événements est effectuée à l’aide de <mark style="color:bleu;">`id`</mark> et de <mark style="color:bleu;">`type`</mark> (voir [Mappages de champs](#field-mappings)) et du <mark style="color:bleu;">`Pixel Id`</mark> (voir [Configuration](#configuration)).
{% endhint %}

### Configuration

| Paramètres      | Description                                                                                                                                                                                                                                                                                                                                              |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `API Key`       | <p><em><strong><code>Required</code></strong></em><br>Votre clé API. Vous pouvez contacter l’équipe de votre compte OpenAI pour obtenir cette valeur.</p>                                                                                                                                                                                                |
| `Pixel Id`      | <p><em><strong><code>Required</code></strong></em><br>Votre identifiant de pixel. Vous pouvez contacter l’équipe de votre compte OpenAI pour obtenir cette valeur.</p>                                                                                                                                                                                   |
| `Event Mapping` | Modifiez le mappage standard entre les types d’événements OpenAI et vos événements. Valeurs acceptées pour `OpenAI event type` : `appointment_scheduled` , `checkout_started` , `contents_viewed` , `custom` , `items_added` , `lead_created` , `order_created` , `page_viewed` , `registration_completed` , `subscription_created` et `trial_started` . |

## Référence rapide

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Événements Commanders Act</th><th>Types d’événements OpenAI</th></tr></thead><tbody><tr><td><code>appointment_scheduled</code></td><td><code>appointment_scheduled</code></td></tr><tr><td><code>checkout_started</code><br><code>begin_checkout</code></td><td><code>checkout_started</code></td></tr><tr><td><code>contents_viewed</code></td><td><code>contents_viewed</code></td></tr><tr><td><code>custom</code></td><td><code>custom</code></td></tr><tr><td><code>items_added</code></td><td><code>items_added</code></td></tr><tr><td><code>lead_created</code><br><code>generate_lead</code></td><td><code>lead_created</code></td></tr><tr><td><code>order_created</code><br><code>purchase</code></td><td><code>order_created</code></td></tr><tr><td><code>page_view</code><br><code>page_viewed</code></td><td><code>page_viewed</code></td></tr><tr><td><code>registration_completed</code><br><code>sign_up</code></td><td><code>registration_completed</code></td></tr><tr><td><code>subscription_created</code></td><td><code>subscription_created</code></td></tr><tr><td><code>trial_started</code></td><td><code>trial_started</code></td></tr><tr><td><code>[Any Event]</code></td><td><code>[Any OpenAI Event Type]</code> <strong>[1]</strong></td></tr></tbody></table>

{% hint style="info" %}
**1.** Voir <mark style="color:bleu;">`Event Mapping`</mark> dans [Configuration](#configuration).
{% endhint %}

## Mappages de champs

{% hint style="info" %}
Les propriétés peuvent être remappées à l’aide de notre [Smart Mapping](https://doc.commandersact.com/features/destinations/advanced-mapping#smart-mapping) fonctionnalité.
{% endhint %}

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Champs Smart Mapping</th><th>Propriétés par défaut de Commanders Act</th><th>Propriétés OpenAI</th></tr></thead><tbody><tr><td><code>Event Id</code></td><td><code>context.event_id</code></td><td><code>id</code> <strong>[*]</strong></td></tr><tr><td>-</td><td><code>event_name</code></td><td><code>type</code> <strong>[1]</strong></td></tr><tr><td><code>Event Timestamp</code></td><td><code>context.event_timestamp</code></td><td><code>timestamp_ms</code> <strong>[2]</strong></td></tr><tr><td><code>Custom Event Name</code></td><td><p><code>partners.openai.custom_event_name</code></p><p><code>event_name</code></p></td><td><code>custom_event_name</code> <strong>[3]</strong></td></tr><tr><td><code>OpenAI Privacy Identifier</code></td><td><code>partners.openai.oppref</code></td><td><code>oppref</code></td></tr><tr><td><code>Action Source</code></td><td><code>type</code></td><td><code>action_source</code> <strong>[4]</strong></td></tr><tr><td><code>Page URL</code></td><td><code>context.page.url</code></td><td><code>source_url</code> <strong>[5]</strong></td></tr><tr><td><code>User Email</code></td><td><code>user.email</code></td><td><code>email_sha256</code> <strong>[6][7]</strong></td></tr><tr><td><code>User Phone</code></td><td><code>user.phone</code></td><td><code>phone_number_sha256</code> <strong>[6][7]</strong></td></tr><tr><td><code>User Id</code></td><td><code>user.id</code></td><td><code>external_id_sha256</code> <strong>[6][7]</strong><br><code>external_id</code> <strong>[6]</strong></td></tr><tr><td><code>Pays de l’utilisateur</code></td><td><code>user.country</code></td><td><code>country_sha256</code> <strong>[6][7]</strong></td></tr><tr><td><code>Ville de l’utilisateur</code></td><td><code>user.city</code></td><td><code>city_sha256</code> <strong>[6][7]</strong></td></tr><tr><td><code>Code postal de l’utilisateur</code></td><td><code>user.zipcode</code></td><td><code>zip_code_sha256</code> <strong>[6]</strong></td></tr><tr><td><code>Device IP</code></td><td><code>context.device.ip</code></td><td><code>ip_address</code> <strong>[6]</strong></td></tr><tr><td><code>Device User Agent</code></td><td><code>context.device.user_agent</code></td><td><code>user_agent</code> <strong>[6]</strong></td></tr><tr><td><code>Opt-out</code></td><td><code>partners.openai.opt_out</code></td><td><code>opt_out</code></td></tr><tr><td><code>Valeur</code></td><td><code>value</code></td><td><code>amount</code> <strong>[8]</strong></td></tr><tr><td><code>Devise</code></td><td><code>currency</code></td><td><code>currency</code></td></tr><tr><td><code>Identifiant du forfait</code></td><td><code>partners.openai.plan_id</code></td><td><code>plan_id</code> <strong>[9]</strong></td></tr><tr><td><code>Liste d’articles</code></td><td><code>items</code></td><td><code>contents</code> <strong>[10]</strong></td></tr><tr><td><code>Item Id</code></td><td><code>items.X.id</code></td><td><code>contents.X.id</code> <strong>[10]</strong></td></tr><tr><td><code>Nom de l’article</code></td><td><code>items.X.product.name</code></td><td><code>contents.X.name</code> <strong>[10]</strong></td></tr><tr><td><code>Type de contenu de l’article</code><br><code>Type de contenu</code></td><td><code>items.X.content_type</code><br><code>content_type</code></td><td><code>contents.X.content_type</code> <strong>[10][11]</strong></td></tr><tr><td><code>Item Price</code></td><td><code>items.X.product.price</code></td><td><code>contents.X.amount</code> <strong>[10]</strong></td></tr><tr><td><code>Quantité de l’article</code></td><td><code>items.X.quantity</code></td><td><code>contents.X.quantity</code> <strong>[10]</strong></td></tr><tr><td><code>Devise de l’article</code></td><td><code>items.X.currency</code></td><td><code>contents.X.currency</code> <strong>[10][12]</strong></td></tr></tbody></table>

{% hint style="info" %}
**\*** Propriété obligatoire.\
**1.** Consultez [Référence rapide](#quick-reference) pour plus de détails.\
**2.** Si elle n’est pas transmise, l’horodatage actuel est utilisé.\
**3.** Définie si <mark style="color:bleu;">`type`</mark> est <mark style="color:bleu;">`custom`</mark> . Valeur par défaut : valeur de <mark style="color:bleu;">`event_name`</mark> .\
**4.** Valeurs acceptées : <mark style="color:bleu;">`web`</mark> , <mark style="color:bleu;">`mobile_app`</mark> , <mark style="color:bleu;">`offline`</mark> , <mark style="color:bleu;">`physical_store`</mark> , <mark style="color:bleu;">`phone_call`</mark> et <mark style="color:bleu;">`email`</mark> . Valeur par défaut : valeur de <mark style="color:bleu;">`type`</mark> .\
**5.** Obligatoire si <mark style="color:bleu;">`action_source`</mark> est <mark style="color:bleu;">`web`</mark> .\
**6.** Défini dans <mark style="color:bleu;">`user`</mark> .\
**7.** Normalisé et haché automatiquement s’il est fourni en clair.\
**8.** La valeur est automatiquement multipliée par 100 et arrondie à l’entier le plus proche.\
**9.** Définie si <mark style="color:bleu;">`data.type`</mark> est <mark style="color:bleu;">`custom`</mark> ou <mark style="color:bleu;">`plan_enrollment`</mark> .\
**10.** Défini dans <mark style="color:bleu;">`data`</mark> lorsque <mark style="color:bleu;">`data.type`</mark> n’est pas <mark style="color:bleu;">`customer_action`</mark> .\
**11.** Priorité de gauche à droite. Valeur par défaut : <mark style="color:bleu;background-color:blue;">`product`</mark> .\
**12.** Obligatoire si <mark style="color:bleu;">`amount`</mark> est défini et <mark style="color:bleu;">`currency`</mark> (au niveau supérieur) n’est pas défini.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.commandersact.com/fr/fonctionnalites/destinations/destinations-catalog/openai-conversions-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
