API d'importation d'audience personnalisée
Notre plateforme de gestion des données permet à Rokt de recevoir des données d'audience personnalisée à la fréquence de votre choix. Si vous travaillez avec Rokt en tant qu'annonceur, ces listes peuvent être utilisées dans vos campagnes pour cibler ou supprimer certains clients de la visualisation de vos offres. Si vous travaillez avec Rokt en tant que partenaire, ces listes peuvent être utilisées pour déterminer quels clients voient l'expérience Rokt sur votre site.
Une méthode courante de livraison des données d'audience personnalisée à Rokt est l'utilisation d'une API.
Nous recommandons de regrouper vos requêtes avant de les envoyer à Rokt. Vous pouvez le faire plusieurs fois en une seule journée (ou à toute fréquence de votre choix).
Point de terminaison
| URL du point de terminaison | https://data.rokt.com/v3/import/suppression |
|---|
L'API accepte une charge utile JSON. Vous devez définir l'en-tête Content-Type sur application/json.
Authentification
Remarque : Actuellement en version bêta publique
Contactez votre responsable de compte Rokt pour créer une paire de clés publique et secrète pour les comptes que vous souhaitez soumettre des événements de conversion. Les clés que vous recevrez seront :
| Nom | Valeur |
|---|---|
| Clé publique Rokt | rpub-*****-* |
| Clé secrète Rokt | rsec-*****-* |
Corps de la demande
Exactement une des clés suivantes doit être présente dans le corps de la demande.
Si vous utilisez un e-mail haché, assurez-vous d'abord de supprimer tout espace blanc et de mettre l'adresse e-mail en minuscules avant de le hacher.
| Paramètre | Description |
|---|---|
| Une seule adresse e-mail | |
| emails | Un tableau d'adresses e-mail |
| sha256 | Un seul e-mail haché en SHA-256 |
| sha256s | Un tableau d'e-mails hachés en SHA-256 |
Les paramètres supplémentaires incluent :
| Paramètre | Type | Description | Exemple |
|---|---|---|---|
| accountId | Obligatoire | Identifiant de compte Rokt tel qu'apparaissant dans OnePlatform. | 123456789 |
| action | Obligatoire | Utilisez include si vous souhaitez ajouter quelqu'un à la liste spécifiée qui pourrait alors être utilisée pour le ciblage ou la suppression. Utilisez exclude si vous souhaitez retirer quelqu'un de la liste spécifiée. | include exclude |
| list | Optionnel | Le nom de la liste de public ciblé à utiliser. Si aucune valeur de liste n'est fournie, les adresses e-mail seront importées par défaut dans la liste AdvertiserDatabase. | US_Customers |
Limites
| Type | Limite |
|---|---|
| Taille de la requête | 100,000 emails par 1 requête. |
| Limite de taux | 4 par seconde. |
| Limite de concurrence | 4 |
Les limites ci-dessus sont recommandées pour cette API. Des quantités plus grandes peuvent être réussies, mais ne sont pas recommandées.
Gestion de la réponse
| Code d'état HTTP | Corps | Description |
|---|---|---|
| 201 | Créé | Les email(s) ont été ajoutés avec succès à la liste d'audience personnalisée ou supprimés de celle-ci. |
| 400 | Mauvaise requête | Vous recevez une erreur 400 Mauvaise requête si des champs requis manquent ou si votre requête est envoyée dans un format incorrect. |
Exemples de ligne de commande
Sur un système Linux ou Mac OS X avec la commande curl installée, la commande suivante effectue un import des adresses email alice@example.com et bob@example.com, en supposant que la variable d'environnement API_KEY est définie sur votre clé API :
cURL
curl -X POST https://data.rokt.com/v3/import/suppression \
--header "Authorization: Basic base64(rpub-*:rsec-*)" \
--header "Content-Type: application/json" \
--data '{"accountId": "REPLACE_ME", "emails":["alice@example.com","bob@example.com"],"action":"include"}'
La commande suivante importerait le hash SHA256 unique "1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206" dans une liste d'audience personnalisée appelée US_Customers. Cette chaîne est le hash SHA256 de hello@example.com (comme nous nous attendons à ce que les hashes soient des adresses email en minuscules, c'est le hash que nous rechercherions pour déterminer si l'adresse email HELLO@EXAMPLE.COM est dans la liste d'audience personnalisée) :
cURL
curl -X POST https://data.rokt.com/v3/import/suppression \
--header "Authorization: Basic base64(rpub-*:rsec-*)" \
--header "Content-Type: application/json" \
--data '{"accountId": "REPLACE_ME", "list":"US_Customers","sha256":"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206","action":"exclude"}'
Authentification (Hérité)
L'API attend un en-tête d'autorisation dans la requête. Cela permet de s'assurer que vous avez les bonnes autorisations pour envoyer des données à votre compte sur la plateforme Rokt. La valeur de l'en-tête d'autorisation doit être votre clé API unique. Contactez votre responsable de compte pour obtenir cette valeur si vous utilisez encore l'API héritée.
Point de terminaison (Hérité)
| URL du point de terminaison | https://data.rokt.com/api/1.0/import/suppression |
|---|
L'API accepte une charge utile JSON. Vous devez définir l'en-tête Content-Type sur application/json. Le corps de la requête, les limites de l'API et la gestion des réponses sont exactement les mêmes que pour l'API POST /v3/import/suppression.
Exemples de ligne de commande (Hérité)
Sur un système Linux ou Mac OS X avec la commande curl installée, la commande suivante effectue un import des adresses e-mail alice@example.com et bob@example.com, en supposant que la variable d'environnement API_KEY est définie sur votre clé API :
cURL
curl -X POST https://data.rokt.com/api/1.0/import/suppression \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--data '{"emails":["alice@example.com","bob@example.com"],"action":"include"}'
La commande suivante importerait le hash SHA256 unique "1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206" dans une liste d'audience personnalisée appelée US_Customers. Cette chaîne est le hash SHA256 de hello@example.com (puisque nous nous attendons à ce que les hashes soient des adresses e-mail en minuscules, c'est le hash que nous rechercherions pour déterminer si l'adresse e-mail HELLO@EXAMPLE.COM est dans la liste d'audience personnalisée) :
cURL
curl -X POST https://data.rokt.com/api/1.0/import/suppression \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--data '{"list":"US_Customers","sha256":"1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206","action":"exclude"}'
Test
Notez que les exemples ci-dessus pointent vers notre système de production en direct. Donc si vous testez avec des adresses email comme alice@example.com, alors, en plus de vos vrais clients, nous considérerions alice@example.com comme membre de votre liste d'audience personnalisée dans Rokt. Si vous utilisez cette liste pour le ciblage d'exclusion, par exemple, nous ne montrerions pas le widget Rokt à quiconque ayant saisi alice@example.com comme adresse email.