For the complete documentation index, see llms.txt. This page is also available as Markdown.

Open RTB 2.4 Gebotsanfrage

Diese Seite erklärt, wie man Gebote anfordert

Gebotsanfrage-Header

  • OpenRTB-Version-HTTP-Header: x-openrtb-version: 2.4

  • Keep-Alive-HTTP-Header: Connection: Keep-Alive

  • JSON-Inhalt: Content-Type: application/json

Die folgenden Objekte sollten als JSON im Request-Body gesendet werden:

Gebotsanfrage

Attribut
Erforderlich?
Beschreibung

um

Ja

Auktionstyp, First-Price = 1 (int)

id

Ja

Eindeutige Gebotsanfrage-ID (String)

imp

Ja

Array von Imp-Objekten, die die angebotenen Impressions darstellen (Objekt).

site

Ja

Details über die Website des Publishers mithilfe eines Site-Objekts (Objekt).

App

Ja

Details über die App des Publishers über ein App-Objekt* (Objekt).

device

Ja

Details über das Gerät des Nutzers, dem die Impression geliefert wird, mithilfe eines Device-Objekts (Objekt).

user

Nein

Details über den menschlichen Nutzer des Geräts; die Werbezielgruppe (Objekt).

ext

Nein

Platzhalter für Erweiterungen von OpenRTB.

Nur eines der Objekte {site, app} sollte in jeder Anfrage vorhanden sein.

imp

Attribut
Erforderlich?
Beschreibung

id

Ja

Eindeutige Impression-ID innerhalb dieser Gebotsanfrage (String)

bidfloor

Nein

Mindestgebot für diese Impression (CPM) / Klick (CPC) und Kontowährung (Float)

bidfloorcur

Nein

Währung für den Mindestgebotswert, angegeben mit ISO-4217-Buchstabencodes (String)

native

Nur für native und Push-Impressions

Eine Native-Objekt-Gelegenheit (Objekt).

banner

Nur für Banner- und Full-Page-Interstitial-Impressions

Eine Banner-Objekt-Gelegenheit (Objekt).

instl

Nur für Pop-, Direct-Link-, E-Mail- und Full-Page-Interstitial-Klick-Impressions

Eine Fullscreen-Objekt-Gelegenheit (Objekt).

video

Nur für Video

Eine Video-Objekt-Gelegenheit (Objekt)

secure

Empfohlen

Kennzeichnung, ob die Impression sichere HTTPS-URL-Creative-Assets und Markup erfordert, wobei 0 = nicht sicher, 1 = sicher (empfohlene Option). Falls weggelassen, ist der Sicherheitsstatus unbekannt, es kann jedoch von Unterstützung für unsicheres HTTP ausgegangen werden (Integer)

el

Nein

Base64-kodierte E-Mail (String)

ext

Nein

Platzhalter für austauschspezifische Erweiterungen

imp.banner

Attribut
Erforderlich?
Beschreibung

w

Ja

Breite des Banners (Integer)

h

Ja

Höhe des Banners (Integer)

mimes

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 austauschspezifische 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 = Direktlink-/E-Mail-Klicks, 1 = Popunder/Full-Page-Interstitial

imp.native (für Native- und Push-Benachrichtigungsanzeigen)

Attribut
Erforderlich?
Beschreibung

request

Ja

Anfrage-Payload gemäß der Native-Ad-Spezifikation – ein JSON-kodierter String der Native-Ads-Anfrage einschließlich ihres native obersten 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)

context

Nein

Der Kontext, in dem die Anzeige erscheint. In diesem Fall ist es 1 (Inhaltszentrierter Kontext wie Newsfeed, Artikel, Bildergalerie, Videogalerie oder Ähnliches), optional (Integer)

plcmttype

Ja

Das Design/Format/Layout der angebotenen Anzeigeneinheit. Derzeit unterstützen wir 4 (Empfehlungs-Widget) und 500 (Push-Benachrichtigung) (Integer)

plcmtcnt

Nein

Die Anzahl identischer Platzierungen in diesem Layout. Max.: 10 (Integer) (Integer)

assets

Ja

Ein Array von Asset-Objekten. Jede Gebotsantwort muss dem im Gebots-Request angegebenen Array von Elementen entsprechen (Array von JSON-Objekten)

seq

Nein

0 für die erste Anzeige, 1 für die zweite Anzeige usw. Beachten Sie, dass dies im Allgemeinen NICHT in Kombination mit plcmtcnt verwendet wird – entweder versteigern Sie mehrere identische Platzierungen (in diesem Fall plcmtcnt>1, seq=0) oder Sie führen separate Auktionen für unterschiedliche Elemente im Feed durch (in diesem Fall plcmtcnt=1, seq=>=1)

imp.native.request.assets

Attribut
Erforderlich?
Beschreibung

id

Ja

Eindeutige Asset-ID, von der Exchange zugewiesen. Typischerweise ein Zähler für das Array (Integer) 1: Bild-Asset-ID, 2: Titel-Asset-ID, 3: Beschreibungs-Asset-ID

erforderlich

Nein

Setzen auf 1 wenn das Asset erforderlich ist oder 0 wenn das Asset optional ist (Integer)

plcmtcnt

Nein

Die Anzahl identischer Platzierungen in diesem Layout (Integer)

img

Ja

Bildobjekt für Bild-Assets** (JSON-Objekt)

title

Nein

Titelobjekt für Titel-Assets** (JSON-Objekt)

data

Nein

Datenobjekt für Markenname, Beschreibung, Bewertungen, Preise usw.* (JSON-Objekt)

*Die Anzahl der Gebote, die Sie für Ihre Native-Anfrage erhalten, basiert auf dem Wert, den Sie in "plcmtcnt" festlegen. Beispielsweise erhält eine Gebotsanfrage mit "plcmtcnt":3 3 verschiedene Gebotsobjekte. Ein Beispiel dazu finden Sie in der Seite mit dem Antwortbeispiel.

** In jedem Asset-Objekt sollte nur eines der {img, title, data}-Objekte vorhanden sein

imp.native.request.assets.img

Attribut
Erforderlich?
Beschreibung

type

Nein

Typ-ID des vom Publisher unterstützten Bildelements. Wir unterstützen: 1 (Icon-Bild) (Integer), 3 (Große Bildvorschau für die Anzeige) (Integer)

w

Nein

Breite des Bildes in Pixeln, optional (Integer)

h

Nein

Höhe des Bildes in Pixeln, optional (Integer)

wmin

Ja

Die angeforderte Mindestbreite des Bildes in Pixeln (Integer)

hmin

Ja

Die angeforderte Mindesthöhe des Bildes in Pixeln (Integer)

*Push-Benachrichtigungssymbol-Abmessungen: 192px x 192px

imp.native.request.assets.title

Attribut
Erforderlich?
Beschreibung

len

Ja

Maximale Textlänge im Titel-Element. (Integer)

imp.native.request.assets.data

Attribut
Erforderlich?
Beschreibung

type

Ja

Typ-ID des vom Publisher unterstützten Elements (Integer). Wir unterstützen: 1 (sponsored - Sponsored-By-Nachricht, bei der die Antwort den Markennamen des Sponsors enthalten sollte), 2 (desc - Beschreibender Text zum beworbenen Produkt oder Dienst)

len

Nein

Maximale Textlänge in der Antwort des Elements (Integer)

imp.video

Attribut
Erforderlich?
Beschreibung

mimes

Nein

Liste der unterstützten MIME-Typen (String-Array)

protocols

Nein

Liste der unterstützten Protokolle für Video-Gebotsantworten (Integer-Array)

skip

Nein

Gibt an, ob der Player das Überspringen des Videos erlaubt, wobei 0 = nein, 1 = ja

skipafter

Nein

Anzahl der Sekunden, die ein Video abgespielt werden muss, bevor das Überspringen aktiviert wird; nur anwendbar, wenn die Anzeige überspringbar ist

skipmin

Nein

Videos mit einer Gesamtdauer von mehr als dieser Anzahl von Sekunden können überspringbar sein; nur anwendbar, wenn die Anzeige überspringbar ist

Wenn Sie in der Anfrage nur "skip" angeben, aber nicht "skipafter", kann das Video nach 5 Sekunden übersprungen werden. Die Antwort setzt "skipoffset" auf 5. Wenn Sie "skip" angeben, aber nicht "skipmin", 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 (Standard: 1)

Um ein CTA-Beispiel zu sehen, schauen Sie sich unsere Seite mit dem Antwortbeispiel.

site

Attribut
Erforderlich?
Beschreibung

id

Erforderlich

Eindeutige Site-ID (String)

domain

Erforderlich

Domainname der Website (String)

Name

Erforderlich

Name der Website (String)

cat

Nein

IAB-Kategorie-ID (String-Array)

page

Empfohlen

Vollständige URL der Seite, auf der die Anzeige angezeigt wird (String)

keywords

Nein

Schlüsselwörter können verwendet werden, um sicherzustellen, dass Anzeigenzonen die richtige Art von Werbung erhalten. Schlüsselwörter sollten eine Zeichenfolge aus durch Kommas getrennten Wörtern sein.

ext

Nein

Platzhalter für austauschspezifische Erweiterungen zu OpenRTB.

site.ext

Attribut
Erforderlich?
Beschreibung

exchangecat

Nein

Benutzerdefinierte ExoClick-Kategorie-ID (Integer)

idzone

Nein

Benutzerdefinierte ExoClick-Anzeigenzonen-ID (Integer)

App

Attribut
Erforderlich?
Beschreibung

id

Erforderlich

Eindeutige App-ID (String)

cat

Nein

IAB-Kategorie-ID (String-Array)

keywords

Nein

Schlüsselwörter können verwendet werden, um sicherzustellen, dass Anzeigenzonen die richtige Art von Werbung erhalten. Schlüsselwörter sollten eine Zeichenfolge aus durch Kommas getrennten Wörtern sein (String)

Publisher

Nein

Details zum Publisher (Objekt)

app.publisher

Attribut
Erforderlich?
Beschreibung

domain

Empfohlen

Domäne der obersten Ebene des Publishers (z. B. "publisher.com") (String)

device

Attribut
Erforderlich?
Beschreibung

ua

Ja

Browser-User-Agent (String)

geo

Nein

Standort des Geräts, angenommen als aktueller Standort des Nutzers, definiert durch ein Geo-Objekt.

ip

Ja

IP-Adresse des Nutzers (String)*

ipv6

Empfohlen

IPv6-Adresse des Nutzers (String)*

language

Empfohlen

Browsersprache gemäß ISO-639-1-Alpha-2 (String)

os

Nein

Betriebssystem (String)

js

Nein

Unterstützung für JavaScript, wobei 0 = nein, 1 = ja (Integer)

ext

Nein

Platzhalter für austauschspezifische Erweiterungen zu OpenRTB

Sie müssen in Ihrer Anfrage nur entweder ip oder ipv6 angeben, nicht beides. Wenn Sie ipv6 verwenden, entfernen Sie das Attribut ip, und umgekehrt. Beides anzugeben kann Fehler verursachen.

device.geo

Attribut
Erforderlich?
Beschreibung

country

Nein

Ländercode ISO3

device.ext

Attribut
Erforderlich?
Beschreibung

remote_addr

Nein

Haupt-IP-Adresse des Nutzers (String)

x_forwarded_for

Nein

X-FORWARDED-FOR-IP-Adresse des Nutzers oder leer, falls nicht gesetzt (String)

user

Attribut
Erforderlich?
Beschreibung

id

Ja

Eindeutige Benutzer-ID (String)

Wenn Sie keine User-ID-Zeichenfolge generieren können, können Sie sie leer lassen (""). Die Anfrage erhält eine Antwort, solange das "user"-Objekt in der Anfrage enthalten ist.

ext

Attribut
Erforderlich?
Beschreibung

sub

Nein

Die Sub-ID. Dies sollte eine Zahl mit ein bis zehn Ziffern sein: Verwenden Sie bei Sub-IDs keine führenden Nullen.

Export

Nein

Der Antworttyp kann "json" oder "xml" sein (String). Standard ist "json".

Beispiele

Eine detaillierte Liste mit Anfragebeispielen finden Sie in unserer Beispielseite

Zuletzt aktualisiert

War das hilfreich?