Méthode : POST /api/v1/advertiser/campagne
Description : Vous pouvez créer une campagne publicitaire via l'API pour votre compte publicitaire HilltopAds.
Veuillez noter que cette méthode n'est disponible que pour les formats Popunder mobile et Popunder desktop.
Paramètres :
nom | description | exemple | commentaire |
key | Une clé API unique que vous pouvez générer dans la section API de votre compte HilltopAds. | nXzgO3Bc | Il s'agit d'un paramètre obligatoire dans la demande. |
format | Format publicitaire pour lequel la campagne doit être créée. | Popunder mobile | Vous ne pouvez spécifier qu'un seul format de publicité. Il s'agit d'un paramètre obligatoire dans la demande. |
rate | Prix pour 1000 impressions (CPM). | 1.53 | Tous les prix (taux) sont spécifiés dans la demande sans la devise, mais seront exprimés en USD dans le résultat. Il s'agit d'un paramètre obligatoire dans la demande. |
capTotal | Plafond de la fréquence d'impression. Ce paramètre indique le nombre de fois qu'une annonce est diffusée. | 2 | Vous ne pouvez spécifier qu'un seul numéro. |
capResetAfter | Plafond de la fréquence d'impression. Ce paramètre indique la durée d'affichage de la publicité. | 12 | Vous ne pouvez spécifier qu'un seul numéro. |
capForCampaign | Plafond de la fréquence d'impression. Ce paramètre indique si la règle s'applique à la campagne ou à la bannière. | campagne | Pour le format Popunder, vous ne pouvez spécifier que campagne. |
channels | Segment et catégorie de trafic pour lesquels la publicité doit être lancée. | Principal/non principal Haute activité Activités générales/non générales Activité moyenne Généraliste/non généraliste Faible activité | Pour spécifier plusieurs segments d'activité, vous devez les énumérer avec des virgules. Notez que vous ne pouvez spécifier qu'une seule catégorie de trafic - grand public ou non grand public. Il s'agit d'un paramètre obligatoire dans la demande. |
type | Type de campagne publicitaire | CPM, CPC | Veuillez noter qu'à l'heure actuelle, vous ne pouvez spécifier que le type de campagne CPM. Il s'agit d'un paramètre obligatoire dans la demande. |
name | Nom d'une campagne publicitaire. | Popunder_API | Le nom de la campagne doit être unique et ne pas être répété avec les noms des campagnes déjà créées. Il s'agit d'un paramètre obligatoire dans la demande. |
url | Proposer le lien URL où le trafic doit être envoyé. | Vous ne pouvez spécifier qu'un seul lien. Il s'agit d'un paramètre obligatoire dans la demande. | |
active | Indiquez le statut de la campagne créée : true - activé, false - désactivé. | Vrai, faux | Si le statut de la campagne est Vrai (ON), la campagne ne sera active qu'après modération. |
targeting | Paramètres de ciblage requis pour la campagne publicitaire.
| géo navigateur os dispositif transporteur mobile iprange osversions Application | Ces paramètres sont transmis sous la forme d'un objet. Chaque nouveau paramètre de ciblage est spécifié par une virgule. |
Exemple de demande :
Pour créer une campagne publicitaire avec les paramètres suivants :
Format de l'annonce - Popunder mobile
Taux - 1,53
Fréquence des captures - 2 affichages par 12 heures pour la campagne
Canaux - activité principale élevée и activité moyenne
Type - CPM (pour un format publicitaire Popunder, vous pouvez spécifier uniquement le CPM)
Nom - Popunder_API
URL - https://mywebsite.com.
Actif - Vrai
Ciblage - GEO : US, UK, DE ; Navigateur : Chrome, Safari ; Appareil - mobile
Veuillez noter que si votre lien contient le symbole "& ;", vous devez l'encoder au format URL-encodé. Dans le cas contraire, vous risquez de recevoir une erreur dans la réponse à la demande de modification du lien.
Par exemple, le lien
https://mywebsite.com/?token={{ctoken}}&zone={{zone_id}}doit être spécifié comme
https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D
Pour coder votre lien au format URL, vous pouvez utiliser l'outil.
Vous devez rédiger une demande dans le format suivant :
curl -X POST --data '{"format" : "Popunder mobile", "channels" :["Mainstream High Activity", "Mainstream Medium Activity"], "type" : "CPM", "rate":1.53, "name" : "Popunder_API", "url" : "https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D", "active":true, "capTotal":2, "capResetAfter":12, "capForCampaign" : "campaign", "targeting":{"geo":{"operator" : "in", "operand" :["US", "UK", "DE"]}, "browser":{"operator" : "in", "operand" :["Chrome", "Safary"]}, "device":{"operator" : "in", "operand" :["Mobile/smartphone"]}}}' https://hilltopads.com/api/v1/advertiser/campaign?key=nXzgO3Bc