Aller au contenu principal

API d'événement

L'API d'événement offre une autre option aux annonceurs souhaitant intégrer des données de conversion avec Rokt. En utilisant l'API d'événement, votre serveur backend peut se connecter en toute sécurité à celui de Rokt, transmettant ainsi les données de conversion en temps réel.

L'utilisation de l'API d'événement en tant qu'intégration autonome pour les données de conversion offre plusieurs avantages :

  • Rapidité : Permet un échange de données entièrement automatisé et quasi temps réel, maximisant le potentiel des outils d'optimisation automatisés de Rokt.
  • Couverture : Permet l'intégration d'événements sur tous les canaux et appareils, ce qui se traduit par une couverture des conversions sur le web, le mobile et en magasin.
  • Fiabilité : En tant qu'intégration serveur à serveur, l'API d'événement n'est pas susceptible d'être perturbée par des technologies web telles que les bloqueurs de navigateur ou de publicités. Elle prend également en charge la gestion des erreurs, garantissant que les données ne sont jamais perdues.

Ajouter l'API d'événement​

  1. Assurez-vous de pouvoir vous connecter à my.rokt.com de Rokt et obtenir votre ID de compte. Si vous n'avez pas de compte, contactez votre gestionnaire de compte.

  2. Obtenez votre ID d'application et votre secret d'application depuis my.rokt.com. Vous avez besoin de ces informations pour vous authentifier auprès de l'API d'événement. Consultez les étapes pour récupérer vos informations d'identification.

  3. Assemblez votre charge utile pour l'API d'événement. Vous pouvez utiliser le point de terminaison POST /v1/events pour envoyer n'importe quel type d'événement de conversion à Rokt.

    1. Pour ce cas d'utilisation, définissez toujours eventType sur conversion afin que Rokt sache déclencher le processus d'attribution de conversion.

    2. Incluez des paires clé-valeur pertinentes dans objectData. Fournir des données contextuelles pertinentes permet à Rokt d'optimiser vos campagnes à l'avenir.

      Rokt exige au moins une des informations suivantes : l'e-mail (email), l'e-mail haché en SHA-256 (emailsha256) ou l'ID Rokt (passbackconversiontrackingid) afin de pouvoir identifier le client. Les champs suggérés pour objectData sont disponibles dans le tableau ci-dessous.

    Référence complète du point de terminaison

    Consultez tous les détails de référence pour l'API d'événement.

Exemple​

POST /v1/events
{
    "accountId": "12345",
    "events": [
        {
            "clientEventId": "ff3bd69c-ca74-4337-af91-4d5d0bd00e38",
            "eventTime": "2020-05-22T10:21:29.339Z",
            "eventType": "conversion",
            "objectData": [
                {
                    "name": "email",
                    "value": "email123@emailserver.com"
                },
                {
                    "name": "transactionid",
                    "value": "123456789"
                },
                {
                    "name": "amount",
                    "value": "99.80"
                },
                  {
                    "name": "currency",
                    "value": "USD"
                },
                {
                    "name": "quantity",
                    "value": "2"
                },
                {
                    "name": "conversiontype",
                    "value": "hotel_booking"
                },
                {
                    "name": "margin",
                    "value": "10"
                },
            ]
        }
    ]

Champs objectData suggérés​

L'objet objectData est composé de paires clé-valeur qui contiennent des métadonnées sur l'événement. Afin d'attribuer correctement les conversions, vous devez inclure l'un des champs suivants dans objectData : email (email), email haché en SHA-256 (emailsha256) ou ID Rokt (passbackconversiontrackingid), afin que Rokt puisse identifier le client.

Pour le cas d'utilisation du rapport de conversion, nous vous recommandons d'inclure les attributs suivants.

Nom du champDescriptionExemple
emailEmail transmis en texte brut, en minuscules et sans espaces à la finjohn@email.com
emailsha256Hachage SHA256 de l'adresse e-mail. Avant le hachage, en minuscules et sans espaces à la fin.fab1e2e699b3b927cbf875046a64f222 5df02d5cb306f3857424c2bbb87be61f
passbackconversiontrackingidÉgalement connu sous le nom d'ID Rokt. Un ID généré par Rokt utilisé pour faire correspondre les événements de conversion au clic d'origine. Nécessite une intégration séparée.1bc29b36f623ba82aaf6724fd3b16718
amountValeur de la transaction (autorise les décimales)100.25
currencyCode de deviseUSD
quantityLa quantité (entier) de l'article dans la conversion spécifique4
conversiontypeUtilisé pour différencier les différents événements de conversion. Remarque : Applicable uniquement si le type d'événement de conversion par défaut est fourni.ticketpurchase, seatupgrade signup
productnameLe nom du/des produit(s) acheté(s). Vous pouvez séparer plusieurs articles par une virgule.T-shirt Maroon 5, Warriors vs. Raptors
skuL'identifiant du produit acheté (Remarque : n'accepte qu'un seul SKU)230847, tshirt-bleu-39487, 398fhdnff
paymenttypeLe mode de paiement utilisé lors de la transactionVISA, American Express
marginMarge bénéficiaire de la conversion10
transactionidID de transaction, utilisé pour identifier une transaction unique. Remarque : Si fourni, Rokt utilise cet identifiant pour dédupliquer les événements de conversion sur les canaux.ABC789
confirmationrefID de référence de confirmation. Identifiant alternatif pouvant être utilisé pour identifier une transaction unique et/ou suivre les confirmations de commande. Remarque : Si fourni, Rokt utilise cet identifiant pour dédupliquer les événements de conversion et transactionid n'est pas disponible.XYZ123
firstnamePrénom du clientJohn
lastnameNom de famille du clientSmith
mobileNuméro de téléphone portable du client convertissant3053211654, +1 (323) 867-5309
ipaddressAdresse IP du client172.3.51.182
Attributs personnalisés​

Rokt dispose d'un système de mappage des données qui nous permet de mapper les noms de champ fournis à nos champs de données internes, cependant nous avons quelques noms de champ recommandés et des exigences de formatage plus tard dans cet article. Si vous souhaitez utiliser des noms de champ alternatifs, faites-le nous savoir et nous veillerons à ce que vos champs soient gérés en conséquence. De plus, nous pouvons accepter des champs supplémentaires si vous souhaitez les fournir à des fins de reporting.

Intégration Premium : Combinaison du Web SDK et de l'API d'événements​

Si possible, nous vous recommandons de configurer le reporting des conversions à la fois via le Web SDK et l'API d'événements. Cela permet d'identifier les anomalies et offre une redondance en cas de problèmes sur le frontend ou le backend.

Si vous choisissez de configurer les deux intégrations, assurez-vous de renseigner l'une des variables transactionid ou confirmationref dans les intégrations Web SDK et Event API. Rokt peut ensuite dédupliquer les événements de conversion entrants en utilisant ces variables, garantissant ainsi l'exactitude de votre reporting.

Cet article vous a-t-il été utile ?