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 qui vous convient. 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 pour livrer des données d'audience personnalisée à Rokt est l'utilisation d'une API.
Nous vous recommandons de regrouper vos demandes (jusqu'à 1 million de contacts par demande) avant de les envoyer à Rokt. Vous pouvez le faire plusieurs fois dans une même journée (ou à la fréquence qui vous convient).
Point de terminaison
| 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.
Autorisation
L'API attend un en-tête d'autorisation dans la requête. Cela permet de s'assurer que vous avez les permissions nécessaires pour envoyer des données vers votre compte sur la plateforme Rokt. La valeur de l'en-tête d'autorisation doit être la clé API unique de votre compte. Contactez votre gestionnaire de compte pour obtenir cette valeur.
Paramètres
Un seul des clés suivantes doit être présent dans le corps de la requête.
Si vous utilisez un e-mail haché, assurez-vous de supprimer d'abord les espaces vides et de mettre l'adresse e-mail en minuscules avant de la 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 |
Des paramètres supplémentaires incluent :
| Paramètre | Type | Description | Exemple |
|---|---|---|---|
| action | Requis | Utilisez include si vous souhaitez ajouter quelqu'un à la liste spécifiée. Utilisez exclude si vous souhaitez supprimer quelqu'un de la liste spécifiée. | include exclude |
| list | Optionnel | Le nom de la liste d'audience personnalisée à utiliser. Si aucune valeur de liste n'est fournie, les adresses e-mail seront importées dans la liste AdvertiserDatabase par défaut. | US_Customers |
Limites
| Type | Limit |
|---|---|
| Taille de la requête | 1000 emails par 1 requête. |
| Limite de taux | 1 par seconde. |
| Limite de concurrence | 1 |
Les limites ci-dessus sont recommandées pour cette API. Des quantités plus importantes peuvent réussir, mais ne sont pas recommandées.
Gestion des réponses
| Code d'état HTTP | Corps | Description |
|---|---|---|
| 201 | Créé | Le(s) email(s) ont été ajoutés ou supprimés avec succès de la liste d'audience personnalisée. |
| 400 | Requête incorrecte | Vous recevez une erreur 400 Bad Request s'il manque des champs obligatoires ou si votre requête est envoyée dans le mauvais format. |
Exemples en ligne de commande
Sur un système Linux ou Mac OS X avec la commande curl installée, la commande suivante effectue une importation 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 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 hachage SHA256 unique "1753bdb368271a785887ddbfb926164f2f7c6a88f609c07ff0401c5572955206" dans une liste d'audience personnalisée appelée US_Customers. Cette chaîne est le hachage SHA256 de hello@example.com (puisque nous nous attendons à ce que les hachages soient des adresses e-mail en minuscules, c'est le hachage que nous rechercherions pour déterminer si l'adresse e-mail HELLO@EXAMPLE.COM est dans la liste d'audience personnalisée):
cURL
curl 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"}'
Testing
Notez que les exemples ci-dessus renvoient à notre système de production en direct. Donc, si vous testez avec des adresses e-mail comme alice@example.com, alors, en plus de vos vrais clients, nous considérerions alice@example.com comme un membre de votre liste d'audience personnalisée dans Rokt. Si vous utilisez cette liste pour le ciblage d'exclusion, par exemple, nous n'afficherions pas le widget Rokt à quiconque a saisi alice@example.com comme adresse e-mail.