Methode: POST /api/v1/advertiser/campaign
Beschreibung: Sie können eine Werbekampagne über API für Ihr HilltopAds Werbekonto erstellen.
Bitte beachten Sie, dass diese Methode nur für die Formate Popunder mobile und Popunder desktop zur Verfügung steht.
Parameter:
Name | Beschreibung | Beispiel | Kommentar |
key | Ein eindeutiger API-Schlüssel, den Sie im API-Bereich Ihres HilltopAds-Kontos generieren können | nXzgO3Bc | Dies ist ein erforderlicher Parameter in der Anfrage. |
format | Werbeformat, für das die Kampagne erstellt werden soll. | Popunder mobil | Sie können nur ein Werbeformat angeben. Dies ist ein erforderlicher Parameter in der Anfrage. |
rate | Preis für 1000 Impressionen (TKP). | 1.53 | Alle Preise (Tarife) werden in der Anfrage ohne Währung angegeben, aber im Ergebnis in USD gesetzt. Dies ist ein erforderlicher Parameter für die Anfrage. |
capTotal | Obergrenze der Einblendungshäufigkeit. Dieser Parameter gibt an, wie oft eine Anzeige gezeigt wird. | 2 | Sie können nur eine Nummer angeben. |
capResetAfter | Obergrenze der Einblendungshäufigkeit. Dieser Parameter gibt an, wie lange die Anzeige gezeigt werden soll. | 12 | Sie können nur eine Nummer angeben. |
capForCampaign | Obergrenze der Einblendungshäufigkeit. Dieser Parameter gibt an, ob die Regel für die Kampagne oder das Banner gilt. | Kampagne | Für das Popunder-Format können Sie nur Kampagne angeben. |
channels | Segment und Verkehrskategorie, für die die Anzeige geschaltet werden soll. | Mainstream/Nicht-Mainstream Hohe Aktivität Mainstream/Nicht-Mainstream Mittlere Aktivität Mainstream/Non-Mainstream Geringe Aktivität | Um mehrere Aktivitätssegmente anzugeben, führen Sie diese mit Kommas auf. Beachten Sie, dass Sie nur eine Verkehrskategorie - Mainstream oder Non-Mainstream - angeben können. Dies ist ein erforderlicher Parameter in der Anfrage. |
type | Art der Werbekampagne | CPM, CPC | Bitte beachten Sie, dass Sie derzeit nur den CPM-Kampagnentyp angeben können. Dies ist ein erforderlicher Parameter für die Anfrage. |
name | Name einer Werbekampagne. | Popunder_API | Der Kampagnenname muss eindeutig sein und darf sich nicht mit Namen bereits erstellter Kampagnen wiederholen. Dies ist ein erforderlicher Parameter für die Anfrage. |
url | Bieten Sie einen URL-Link an, an den der Verkehr weitergeleitet werden soll. | Sie können nur einen Link angeben. Dies ist ein erforderlicher Parameter für die Anfrage. | |
active | Geben Sie den Status der erstellten Kampagne an: true - EIN, false - AUS. | Wahr, falsch | Wenn Sie den Kampagnenstatus als Wahr (EIN) angeben, wird die Kampagne erst nach der Moderation aktiv. |
targeting | Erforderliche Targeting-Einstellungen für die Werbekampagne.
| geo Browser os Gerät Mobilfunkträger iprange osversionen App | Diese Parameter werden als Objekt übergeben. Jeder neue Targeting-Parameter wird mit einem Komma angegeben. |
Beispiel für eine Anfrage:
So erstellen Sie eine Werbekampagne mit den folgenden Parametern:
Anzeigenformat - Popunder mobile
Tarif - $1.53
Häufigkeit der Einblendungen - 2 Anzeigen pro 12 Stunden für die Kampagne
Kanäle - Hauptstrom hohe Aktivität и mittlere Aktivität
Typ - CPM (für ein Popunder-Anzeigenformat können Sie nur CPM angeben)
Name - Popunder_API
URL - .https://mywebsite.com
Aktiv - Wahr
Targeting - GEO: US, UK, DE; Browser: Chrome, Safary; Gerät - mobil
Bitte beachten Sie, dass Sie, wenn Ihr Link das Symbol '&' enthält, diesen in ein URL-kodiertes Format umwandeln müssen. Andernfalls erhalten Sie möglicherweise eine Fehlermeldung in der Antwort auf die Linkänderungsanfrage.
Zum Beispiel, der Link
https://mywebsite.com/?token={{ctoken}}&zone={{zone_id}}sollte angegeben werden als
https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D
Um Ihren Link in ein URL-kodiertes Format zu kodieren, können Sie .the tool verwenden
Sie müssen einen Antrag in folgendem Format schreiben:
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