API d'importation d'audience personnalisée
Notre plateforme de gestion de données permet à Rokt de recevoir des données d'audience personnalisées à la fréquence que vous préférez. Si vous travaillez avec Rokt en tant qu'annonceur, ces listes peuvent être utilisées dans vos campagnes pour cibler ou exclure certains clients de voir 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 demandes (jusqu'à 1 000 contacts par demande) avant de les envoyer à Rokt. Vous pouvez le faire plusieurs fois par jour (ou à la fréquence que vous préférez).
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 le cadre de la requête. Cela permet de s'assurer que vous avez les bonnes permissions pour envoyer des données à 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
Exactement une des clés suivantes doit être présente dans le corps de la requête.
Si vous utilisez un email haché, assurez-vous d'abord de supprimer tous les espaces et de mettre l'adresse email en minuscules avant de la hacher.
| Paramètre | Description |
|---|---|
| Une seule adresse email | |
| emails | Un tableau d'adresses email |
| sha256 | Un seul email haché en SHA-256 |
| sha256s | Un tableau d'emails hachés en SHA-256 |
Les paramètres supplémentaires incluent :
| Paramètre | Type | Description | Exemple |
|---|---|---|---|
| action | Obligatoire | Utilisez include si vous souhaitez ajouter quelqu'un à la liste spécifiée qui pourrait ensuite ê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 d'audience personnalisée à utiliser. Si aucune valeur de liste n'est fournie, les adresses email seront importées par défaut dans la liste AdvertiserDatabase. | US_Customers |
Limites
| Type | Limite |
|---|---|
| Taille de la demande | 2000 emails par 1 demande. |
| Limite de taux | 4 par seconde. |
| Limite de concurrence | 4 |
Les limites ci-dessus sont recommandées pour cette API. Des montants plus élevés peuvent réussir, mais ne sont pas recommandés.
Gestion des réponses
| Code de statut 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 | Mauvaise Requête | Vous recevez une 400 Mauvaise Requête s'il manque des champs obligatoires ou si votre demande est envoyée dans le mauvais format. |
Exemples de 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 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 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 email en minuscules, c'est le hachage que nous rechercherions pour déterminer si l'adresse email 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"}'
Test
Notez que les exemples ci-dessus pointent vers 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 ne montrerions pas le widget Rokt à quiconque a entré alice@example.com comme adresse e-mail.