API d'Événements
L'API d'Événements offre une autre option pour les annonceurs cherchant à intégrer les données de conversion avec Rokt. En utilisant l'API d'Événements, votre serveur backend peut se connecter en toute sécurité à celui de Rokt, transmettant des 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é, quasi en temps réel, maximisant le potentiel des outils d'optimisation automatisée de Rokt.
- Couverture : Permets l'intégration d'événements sur tous les canaux et appareils, résultant en une couverture pour les conversions sur le web, mobile et en magasin.
- Fiabilité : En tant qu'intégration serveur-à-serveur, l'API d'Événements n'est pas susceptible d'interférence par des technologies web telles que les bloqueurs de publicités ou de navigateurs. Elle prend également en charge la gestion des erreurs, garantissant que les données ne sont jamais perdues.
Authentification
Contactez votre responsable 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. Actuellement, la dernière version est 2020-05-21. Remarque : Laisser cet en-tête vide applique la dernière version, qui pourrait potentiellement être incompatible avec les versions précédentes. Une valeur invalide entraînerait 400 bad request. |
Authorization | Basic base64(rpub-...:rsec-...) | Oui | En-tête standard d'authentification de base, avec la valeur d'identifiant encodée en base64 de rpub- et rsec- jointes par un deux-points. |
Voir les détails de référence complète pour l'API des événements.
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 objectData suggérés
L'objet objectData est composé de paires clé-valeur contenant des métadonnées sur l'événement. Afin d'attribuer correctement les conversions, vous devez inclure l'un des email (email), e-mail haché SHA-256 (emailsha256), ou ID Rokt (passbackconversiontrackingid) dans objectData afin que Rokt puisse identifier le client.
Pour le cas d'utilisation de reporting 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 à la fin | john@email.com |
emailsha256 | Hachage SHA256 de l'adresse e-mail. Avant de hacher, en minuscules et sans espaces à la fin. | fab1e2e699b3b927cbf875046a64f222 5df02d5cb306f3857424c2bbb87be61f |
passbackconversiontrackingid | Également connu sous le nom d'ID Rokt. 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 décimales) | 100.25 |
currency | Code de la monnaie | 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. | T-shirt Maroon 5, Warriors vs. Raptors |
sku | L'identifiant du produit acheté (Remarque : n'accepte qu'un 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 | 10 |
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 entre les canaux. | ABC789 |
confirmationref | ID 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 est indisponible. | XYZ123 |
firstname | Prénom du client | John |
lastname | Nom de famille du client | Smith |
mobile | Numéro de téléphone mobile du client converti | 3053211654, +1 (323) 867-5309 |
ipaddress | Adresse IP du client | 172.3.51.182 |
Attributs personnalisés
Rokt dispose d'un système de mapping de données qui nous permet d'associer les noms de champs fournis à nos champs de données internes, cependant nous avons quelques noms de champs recommandés et des 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 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 recommandons de configurer le rapport de conversion via à la fois le Web SDK et l'API d'événements. Cela aide à identifier les anomalies 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 remplir l'un de transactionid ou confirmationref dans les intégrations Web SDK et API d'événements. Rokt peut alors dédupliquer vos événements de conversion entrants en utilisant ces variables, garantissant que vos rapports sont précis.