Spezifikationen für offene RTB-Gebotsanfragen
Auf dieser Seite wird erklärt, wie man Angebote einholt
Angebotsanfrage-Kopfzeilen
- OpenRTB Version HTTP Header: x-openrtb-version: 2.4
- Keep-Alive HTTP Header: Verbindung: Keep-Alive
- Inhalt JSON: Inhalt-Typ: application/json
The following objects should be sent encoded as JSON in the request body:
Angebotsanfrage
| Attribut | Erforderlich? | Beschreibung |
|---|
| unter | Ja | Auktionstyp, erster Preis = 1 (int) |
| id | Ja | Eindeutige ID der Angebotsanfrage (String) |
| imp | Ja | Array von Imp-Objekten, die die angebotenen Eindrücke darstellen (Objekt). |
| website | Ja | Details über ein Site-Objekt über die Website des Herausgebers (Objekt). |
| app | Ja | Details via an App object about the publisher’s app* (object). |
| gerät | Ja | Angaben über ein Device-Objekt zum Gerät des Nutzers, an das der Eindruck geliefert wird (Objekt). |
| benutzer | Nein | Details über ein User-Objekt über den menschlichen Nutzer des Geräts; das Werbepublikum (Objekt). |
| ext | Nein | Platzhalter für Erweiterungen zu OpenRTB. |
Note: Only one of the objects {site, app} should be present in each request.
imp
| Attribut | Erforderlich? | Beschreibung |
|---|
| id | Ja | Eindeutige Impression-ID in dieser Gebotsanfrage (String) |
| bidfloor | Nein | Mindestgebot für diese Impression (CPM) / Klick (CPC) und Kontowährung (Float) |
| bidfloorcur | Nein | Währung für Mindestgebotswert unter Verwendung von ISO-4217-Alpha-Codes (String) |
| einheimische | Nur für native und Push-Imps | Eine Native Object Opportunity (Objekt). |
| banner | Nur für Bannerträger | Ein Banner Objekt Gelegenheit (Objekt). |
| instl | Nur für Pop-, Direktlink- und E-Mail-Klickimps | Ein Fullscreen-Objekt Opportunity (Objekt). |
| video | Nur für Video | A Videoobjekt Gelegenheit (Objekt) |
| sicher | Empfohlen | Kennzeichen, das angibt, ob die Impression sichere HTTPS-URL-Creative-Assets und Markup erfordert, wobei 0 = nicht sicher, 1 = sicher (empfohlene Option). Wird dieses Flag nicht angegeben, ist der sichere Status unbekannt, aber es kann von einer nicht sicheren HTTP-Unterstützung ausgegangen werden (Ganzzahl) |
| el | Nein | Base64-kodierte E-Mail (Zeichenfolge) |
| ext | Nein | Platzhalter für börsenspezifische Erweiterungen |
imp.banner
| Attribut | Erforderlich? | Beschreibung |
|---|
| w | Ja | Breite des Banners (Integer) |
| h | Ja | Höhe des Banners (Integer) |
| mimt | Nein | Liste der unterstützten Mime-Typen (String-Array). Wir unterstützen: image/jpeg, image/jpg, image/png, image/png, image/gif, image/webp, video/mp4 |
| ext | Nein | Platzhalter für börsenspezifische Erweiterungen (Objekt) |
imp.banner.ext
| Attribut | Erforderlich? | Beschreibung |
|---|
| image_output | Nein | Gibt das Ausgabeformat für Bildbanner an* (string) |
| video_Output | Nein | Gibt das Ausgabeformat für Videobanner an* (String) |
*Definiert das Format des adm-Feldes für das Bannerformat. Die Optionen sind xml oder html. Standardwert ist xml, falls das Feld nicht angegeben wird.
imp.instl
| Attribut | Erforderlich? | Beschreibung |
|---|
| instl | Ja | 0 = direkter Link/E-Mail-Klicks, 1 = Popunder |
imp.native (für Native und Push Notification Ads)
| Attribut | Erforderlich? | Beschreibung |
|---|
| anfrage | Ja | Anfrage-Payload gemäß der Native Ads-Spezifikation - ein JSON-kodierter String der Native Ads-Anfrage einschließlich des nativen Top-Level-Objekts (JSON-Objekt) |
| ver | Nein | Version der Dynamic Native Ads API, der request entspricht (string) |
imp.native.request
| Attribut | Erforderlich? | Beschreibung |
|---|
| ver | Ja | Version der verwendeten Native Markup Version (string) |
| kontext | Nein | Der Kontext, in dem die Anzeige erscheint. In diesem Fall ist es 1 (Inhaltsbezogener Kontext wie Newsfeed, Artikel, Bildergalerie, Videogalerie oder ähnliches), optional (ganze Zahl) |
| plcmttype | Ja | Das Design/Format/Layout des angebotenen Anzeigenblocks. Derzeit unterstützen wir 4 (Empfehlungs-Widget) und 500 (Push Notification) (Ganzzahl) |
| plcmtcnt | Nein | Die Anzahl der identischen Placements in diesem Layout. Max: 10 (Ganzzahl) (Ganzzahl) |
| vermögenswerte | Ja | Ein Array von Asset-Objekten. Jede Gebotsantwort muss dem in der Gebotsanfrage angegebenen Array von Elementen entsprechen (Array von JSON-Objekten) |
| seq | Nein | 0 für die erste Anzeige, 1 für die zweite Anzeige, und so weiter. Beachten Sie, dass dies in der Regel NICHT in Kombination mit plcmtcnt verwendet wird - entweder versteigern Sie mehrere identische Platzierungen (in diesem Fall plcmtcnt>1, seq=0) oder Sie führen getrennte Auktionen für verschiedene Positionen im Feed durch (in diesem Fall plcmtcnt=1, seq=>=1) |
imp.native.request.assets
| Attribut | Erforderlich? | Beschreibung |
|---|
| id | Ja | Eindeutige Asset-ID, die von der Börse zugewiesen wird. Typischerweise ein Zähler für das Array (Ganzzahl) 1: Bild-Asset-ID, 2: Titel-Asset-ID, 3: Beschreibung-Asset-ID |
| erforderlich | Nein | Auf 1 gesetzt, wenn Asset erforderlich ist, oder 0, wenn Asset optional ist (Ganzzahl) |
| plcmtcnt | Nein | Die Anzahl der identischen Platzierungen in diesem Layout (Integer) |
| img | Ja | Image-Objekt für Bild-Assets** (JSON-Objekt) |
| titel | Nein | Title-Objekt für Titel-Assets** (JSON-Objekt) |
| daten | Nein | Datenobjekt für Markenname, Beschreibung, Bewertungen, Preise usw.* (JSON-Objekt) |
*The amount of bids received for your Native request will be based on the value you set in "plcmtcnt". For example, a bid request with "plcmtcnt":3 will receive 3 different bid objects. You can find an example of this in the Response example page.
** In jedem Asset-Objekt sollte nur eines der Objekte {img, title, data} vorhanden sein
imp.native.request.assets.img
| Attribut | Erforderlich? | Beschreibung |
|---|
| typ | Nein | Typ-ID des vom Verlag unterstützten Bildelements. Wir unterstützen: 1 (Icon-Bild) (Ganzzahl), 3 (Große Bildvorschau für die Anzeige) (Ganzzahl) |
| w | Nein | Breite des Bildes in Pixel, optional (Ganzzahl) |
| h | Nein | Höhe des Bildes in Pixel, optional (Ganzzahl) |
| wmin | Ja | Die geforderte Mindestbreite des Bildes in Pixel (Ganzzahl) |
| hmin | Ja | Die geforderte Mindesthöhe des Bildes in Pixeln (Ganzzahl) |
*Push Notification-Symbol Abmessungen: 192px x 192px
imp.native.request.assets.title
| Attribut | Erforderlich? | Beschreibung |
|---|
| len | Ja | Maximale Länge des Textes im Titelelement. (Ganzzahl) |
imp.native.request.assets.data
| Attribut | Erforderlich? | Beschreibung |
|---|
| typ | Ja | Typ-ID des vom Verlag unterstützten Elements (Ganzzahl). Wir unterstützen: 1 (sponsored - Gesponserte Nachricht, deren Antwort den Markennamen des Sponsors enthalten sollte), 2 (desc - Beschreibender Text für das beworbene Produkt oder die Dienstleistung) |
| len | Nein | Maximale Länge des Textes in der Antwort des Elements (Ganzzahl) |
imp.video
| Attribut | Erforderlich? | Beschreibung |
|---|
| mimt | Nein | Liste der unterstützten Mime-Typen (String-Array) |
| protokolle | Nein | Liste der unterstützten Video-Bid-Response-Protokolle (int-Array) |
| überspringen | Nein | Gibt an, ob der Player das Überspringen des Videos zulässt, wobei 0 = nein, 1 = ja |
| überspringen nach | Nein | Anzahl der Sekunden, die ein Video abgespielt werden muss, bevor das Überspringen aktiviert wird; gilt nur, wenn die Anzeige überspringbar ist |
| skipmin | Nein | Videos mit einer Gesamtdauer von mehr als dieser Anzahl von Sekunden können übersprungen werden; gilt nur, wenn die Anzeige überspringbar ist |
Hinweis: Wenn Sie in der Anfrage nur "skip", aber nicht "skipafter" angeben, kann das Video nach 5 Sekunden übersprungen werden. In der Antwort wird "skipoffset" auf 5 gesetzt. Wenn Sie "skip", aber nicht "skipmin" angeben, kann das Video unabhängig von seiner Dauer übersprungen werden.
imp.ext
| Attribut | Erforderlich? | Beschreibung |
|---|
| video_cta | Nein | Gibt an, ob CTAs bereitgestellt werden sollen, wobei 0 = nein, 1 = ja (Standardwert 1) |
To see an example of CTA, please check our Response example page.
website
| Attribut | Erforderlich? | Beschreibung |
|---|
| id | Erforderlich | Eindeutige Standort-ID (String) |
| domain | Erforderlich | Domänenname der Website (String) |
| name | Erforderlich | Name des Standorts (String) |
| katze | Nein | IAB-Kategorie-ID (String-Array) |
| seite | Empfohlen | Vollständige URL der Seite, auf der die Anzeige erscheinen soll (String) |
| schlüsselwörter | Nein | Mit Hilfe von Schlüsselwörtern kann sichergestellt werden, dass Anzeigenbereiche die richtige Art von Werbung erhalten. Die Schlüsselwörter sollten aus einer durch Kommata getrennten Wortfolge bestehen. |
| ext | Nein | Platzhalter für börsenspezifische Erweiterungen von OpenRTB. |
site.ext
| Attribut | Erforderlich? | Beschreibung |
|---|
| austauschkatze | Nein | Benutzerdefinierte ExoClick-Kategorie-ID (ganze Zahl) |
| idzone | Nein | Benutzerdefinierte ExoClick-Anzeigenzonen-ID (ganze Zahl) |
app
| Attribut | Erforderlich? | Beschreibung |
|---|
| id | Erforderlich | Eindeutige Anwendungs-ID (String) |
| katze | Nein | IAB-Kategorie-ID (String-Array) |
| schlüsselwörter | Nein | Mit Hilfe von Schlüsselwörtern kann sichergestellt werden, dass Anzeigenbereiche die richtige Art von Werbung erhalten. Schlüsselwörter sollten eine durch Komma getrennte Wortfolge sein (String) |
| herausgeber | Nein | Details über den Herausgeber (Objekt) |
Anmerkung: Sie können das Objekt "app" nicht zusammen mit "site" senden oder umgekehrt.
app.publisher
| Attribut | Erforderlich? | Beschreibung |
|---|
| domain | Empfohlen | Höchste Domäne des Herausgebers (z. B. "publisher.com") (string) |
gerät
| Attribut | Erforderlich? | Beschreibung |
|---|
| ua | Ja | Browser-Benutzer-Agent (String) |
| geo | Nein | Als Standort des Geräts wird der aktuelle Standort des Benutzers angenommen, der durch ein Geo-Objekt definiert ist. |
| ip | Ja | IP-Adresse des Benutzers (String)* |
| ipv6 | Empfohlen | IPv6-Adresse des Benutzers (String)* |
| sprache | Empfohlen | Browsersprache nach ISO-639-1-alpha-2 (string) |
| os | Nein | Betriebssystem (string) |
| js | Nein | Unterstützung für JavaScript, wobei 0 = nein, 1 = ja (Ganzzahl) |
| ext | Nein | Platzhalter für börsenspezifische Erweiterungen zu OpenRTB |
Anmerkung: Sie müssen nur entweder ip oder ipv6 in Ihrer Anfrage angeben, nicht beides. Wenn Sie ipv6 verwenden, entfernen Sie das ip-Attribut, und umgekehrt. Die Angabe beider Attribute kann zu Fehlern führen.
gerät.geo
| Attribut | Erforderlich? | Beschreibung |
|---|
| land | Nein | Land ISO3 |
gerät.ext
| Attribut | Erforderlich? | Beschreibung |
|---|
| remote_addr | Nein | Haupt-IP-Adresse des Benutzers (String) |
| x_weitergeleitet_für | Nein | X-FORWARDED-FOR IP-Adresse des Benutzers oder leer, wenn nicht festgelegt (string) |
benutzer
| Attribut | Erforderlich? | Beschreibung |
|---|
| id | Ja | Eindeutige Benutzer-ID (String) |
Anmerkung: Wenn Sie keine Benutzer-ID-Zeichenkette erzeugen können, können Sie sie leer lassen (""). Die Anfrage erhält eine Antwort, solange das Objekt "user" in der Anfrage enthalten ist.
ext
| Attribut | Erforderlich? | Beschreibung |
|---|
| unter | Nein | Die Unter-ID. Dies sollte eine sechs- bis zehnstellige Zahl sein: Verwenden Sie keine Nullen am Anfang von Sub-IDs. |
| exportieren | Nein | Antworttyp kann "json" oder "xml" (String) sein. Standard ist "json". |
Note: Sub IDs should be a number between 1 and Int32: Do not use zeroes at the beginning of Sub IDs.
Beispiele
You can find a detailed list of Request examples in our example page