API d'événements
L'API d'événements offre une autre option pour les annonceurs souhaitant intégrer des données de conversion avec Rokt. En utilisant l'API d'événements, votre serveur backend peut se connecter de manière sécurisée à celui de Rokt, transmettant les données de conversion en temps réel.
Utiliser l'API d'événements comme une intégration autonome pour les données de conversion offre plusieurs avantages :
- Vitesse : Permet un échange de données entièrement automatisé et quasi en 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, résultant en une couverture des conversions sur le web, mobile et en magasin.
- Fiabilité : En tant qu'intégration serveur-à-serveur, l'API d'événements n'est pas sujette aux interférences des technologies web telles que les bloqueurs de publicité ou de navigateur. Elle prend également en charge la gestion des erreurs, garantissant que les données ne sont jamais perdues.
Authentification
Contactez votre gestionnaire de compte Rokt pour créer une paire de clés publique et secrète pour les comptes pour lesquels vous souhaitez
soumettre des événements de conversion. Ces clés prennent la forme de rpub- et rsec- respectivement.
Construisez vos en-têtes de requête
| Nom | Valeur | Requis | Description |
|---|---|---|---|
Content-Type | application/json | Oui | N/A |
Charset | utf-8 | Oui | N/A |
Rokt-Version | 2020-05-21 | Oui | Version de l'API pour Rokt. La version la plus récente est actuellement 2020-05-21. Remarque : Laisser cet en-tête vide applique la version la plus récente, ce qui pourrait potentiellement être incompatible avec les versions antérieures. Une valeur invalide entraînerait une 400 bad request. |
Authorization | Basic base64(rpub-...:rsec-...) | Oui | En-tête standard d'authentification de base, avec la valeur d'identification étant un encodage base64 de rpub- et rsec- joints par un deux-points. |
Consultez les détails complets de référence pour l'API Event.
Exemple
POST /v2/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 suggérés objectData
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 éléments suivants : email (email), email haché SHA-256 (emailsha256) ou Rokt ID (passbackconversiontrackingid) dans objectData pour 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 champ | Description | Exemple |
|---|---|---|
email | Email passé en texte brut, en minuscules et sans espaces de fin | john@email.com |
emailsha256 | Hachage SHA256 de l'adresse email. Avant le hachage, en minuscules et sans espaces de fin. | fab1e2e699b3b927cbf875046a64f222 5df02d5cb306f3857424c2bbb87be61f |
passbackconversiontrackingid | Également connu sous le nom de Rokt ID. 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 |
amount | Valeur de la transaction (permet les points décimaux) | 100.25 |
currency | Code de la devise | USD |
quantity | La quantité (entier) d'articles dans la conversion spécifique | 4 |
conversiontype | Utilisé 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 |
productname | Le nom du ou des produits achetés. Vous pouvez séparer plusieurs articles par une virgule. | Maroon 5 t-shirt, Warriors vs. Raptors |
sku | L'identifiant du produit acheté (Remarque : n'accepte qu'un seul SKU) | 230847, tshirt-blue-39487, 398fhdnff |
paymenttype | Le mode de paiement utilisé lors de la transaction | VISA, American Express |
margin | Marge bénéficiaire de la conversion en termes absolus - c'est-à-dire 10.12 pour une marge bénéficiaire de 10,12 $. | 10.12 |
transactionid | ID de transaction, utilisé pour identifier une transaction unique. Remarque : Si fourni, Rokt utilise cet identifiant pour dédupliquer les événements de conversion à travers les canaux. | ABC789 |
confirmationref | ID de référence de confirmation. Identifiant alternatif qui peut ê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 |
firstname | Prénom du client | John |
lastname | Nom de famille du client | Smith |
mobile | Numéro de téléphone mobile du client convertissant | 3053211654, +1 (323) 867-5309 |
ipaddress | Adresse IP du client | 172.3.51.182 |
Attributs personnalisés
Rokt dispose d'un système de mappage de données qui nous permet de mapper les noms de champs fournis à nos champs de données internes. Cependant, nous avons quelques noms de champs recommandés et exigences de formatage plus loin dans cet article. Si vous souhaitez utiliser des noms de champs alternatifs, faites-le nous savoir, et nous nous assurerons que vos champs sont gérés en conséquence. De plus, nous pouvons accepter tout champ supplémentaire si vous souhaitez les fournir à des fins de reporting.
Intégration premium : Combinaison du Web SDK et de l'Event API
Si possible, nous recommandons de configurer le reporting de conversion à la fois via le Web SDK et l'Event API. Cela aide à identifier toute anomalie et fournit 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'un des transactionid ou confirmationref dans les intégrations Web SDK et Event API. Rokt peut alors dédupliquer vos événements de conversion entrants en utilisant ces variables, garantissant ainsi que votre reporting est précis.