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

Antwortzonen

Die JSON-Antwort der Ad Placement API enthält die Zonen Array und die Renderer und Benutzer Objekte.

Auf dieser Seite erklären wir das Zonen Array, das alle Details zur Anzeige enthält, die deine Anzeigenanfrage gewonnen hat.

Das Array enthält für jede angeforderte Zonen-ID ein Objekt mit Anzeigendaten.

Eigenschaft
Beschreibung

idzone

Die ID der Anzeigenzone.

type

Das verwendete Anzeigenformat, z. B. banner.

data

Die Anzeigendaten (Objekt)

Nachfolgend findest du eine detaillierte Liste der Eigenschaften, die für jedes data Objekt entsprechend den verfügbaren Anzeigenformaten zurückgegeben werden.

Eigenschaft
Beschreibung

url

Die URL, auf die die Anzeige weiterleitet.

impression

Die Impression-URL

image

Das ursprünglich für die Anzeige hochgeladene Bild.

optimum_image

Wenn die hochgeladene Creative-Datei ein animiertes GIF ist, ist dies die optimierte MP4-Version davon, die für die Anzeige erstellt wird.

width

Die Breite der Anzeige in Pixeln.

height

Die Höhe der Anzeige in Pixeln.

media

Dies zeigt, welcher Bannertyp dies ist: Bild, HTML oder Video: Dies sollte jeweils img_banner, html_banner oder video_banner, jeweils.

Beispielantworten für Banner

Bildbanner:

HTML-Banner:

Video-Banner:

Sticky-Banner

Eigenschaft
Beschreibung

url

Die Klick-URL

impression

Die Impression-URL

image

Das ursprünglich für die Anzeige hochgeladene Bild.

optimum_image

In einem Sticky-Banner ist dies, wenn die hochgeladene Creative-Datei ein animiertes GIF ist, die optimierte MP4-Version davon, die für die Anzeige verwendet wird.

width

Die Breite der Anzeige in Pixeln.

height

Die Höhe der Anzeige in Pixeln.

frequency_period

Wie oft die Anzeige in Minuten angezeigt wird.

v_pos

Die vertikale Position der Anzeige.

h_pos

Die horizontale Position der Anzeige.

media

Dies zeigt, welcher Bannertyp dies ist: Bild, HTML oder Video: Dies sollte jeweils img_banner, html_banner, oder video_banner jeweils.

Beispiel für eine Sticky-Banner-Antwort

Sofortnachrichten

Eigenschaft
Beschreibung

url

Die Klick-URL

impression

Die Impression-URL

image

Die URL des Bildes

optimum_image

Wenn die hochgeladene Creative-Datei ein animiertes GIF ist, ist dies die optimierte MP4-Version davon, die für die Anzeige erstellt wird.

width

Die Breite der Anzeige in Pixeln.

height

Die Höhe der Anzeige in Pixeln.

frequency_period

Wie oft die Anzeige in Minuten angezeigt wird.

media

Dies zeigt, welcher Bannertyp verwendet wird: Bild, HTML oder Video: Dies sollte jeweils img_banner, html_banner, oder video_banner jeweils.

Beispiel für eine Sofortnachrichten-Antwort

Native-Anzeigen

Wenn die Antwort eine Native-Anzeige zurückgibt, geben zones.data zwei Objekte zurück: layout und ad_items

data.layout

Eigenschaft
Beschreibung

widgetHeaderContentHtml

Die URL des angezeigten „Powered by“-Brandings.*

branding_logo

Die URL des Branding-Logos, das angezeigt wird, wenn es aktiviert ist.*

branding_logo_hover

Die URL des Branding-Logos, das angezeigt wird, wenn der Nutzer mit der Maus darüber fährt.*

itemsPerRow

Die Anzahl der Anzeigen, die in jeder Zeile des Widgets angezeigt werden.

itemsPerCol

Die Anzahl der Anzeigen, die in jeder Spalte des Widgets angezeigt werden.

font_family

Die verwendete Schriftfamilie in der Anzeige.

header_font_size

Die Schriftgröße, die im Branding-Header verwendet wird.

header_font_color

Die Schriftfarbe, die im Branding-Header verwendet wird.

widget_background_color

Der Hex-Code der Hintergrundfarbe, die für das Widget verwendet wird.

widget_width

Die Breite des gesamten Widgets.

minimum_width_for_full_sized_layout

Die Mindestbreite für ein Layout in voller Größe in Pixeln.

item_height

Die Höhe jeder einzelnen Anzeige.

item_padding

Der Abstand zwischen den einzelnen Anzeigen.

image_height

Die Höhe des Bildes in jeder Anzeige.

image_width

Die Breite des Bildes in jeder Anzeige.

text_margin_top

Die Größe des oberen Textrands in Pixeln.

text_margin_bottom

Die Größe des unteren Textrands in Pixeln.

text_margin_left

Die Größe des linken Textrands in Pixeln.

text_margin_right

Die Größe des rechten Textrands in Pixeln.

title_font_size

Die Schriftgröße des Titels jeder Anzeige.

title_font_color

Die Schriftfarbe des Titels jeder Anzeige.

title_font_weight

Die Schriftstärke des Titels jeder Anzeige.

title_decoration

Ob der Titel unterstrichen ist oder nicht.

title_hover_color

Die Schriftfarbe, wenn der Titel mit der Maus darüber bewegt wird.

title_hover_font_weight

Die Schriftstärke, wenn der Titel mit der Maus darüber bewegt wird.

title_hover_decoration

Ob der Titel beim Darüberfahren unterstrichen wird oder nicht.

description_font_size

Die Schriftgröße der Beschreibung jeder Anzeige.

description_font_color

Die Schriftfarbe der Beschreibung jeder Anzeige.

description_font_weight

Die Schriftstärke der Beschreibung jeder Anzeige.

description_decoration

Ob die Beschreibung unterstrichen ist oder nicht.

description_hover_color

Die Schriftfarbe, wenn die Beschreibung mit der Maus darüber bewegt wird.

description_hover_font_weight

Die Schriftstärke, wenn die Beschreibung mit der Maus darüber bewegt wird.

description_hover_decoration

Ob die Beschreibung beim Darüberfahren unterstrichen wird oder nicht.

open_in_new_window

Ob die Anzeige beim Klicken in einem neuen Fenster geöffnet werden soll. 1=ja, 0=nein.

mobile_responsive_type

Der Typ der Anpassung an mobile Geräte (d. h. keine oder kompakt). 1=kompakt, 0=nein.

header_is_on_top

Ob das Branding oberhalb oder unterhalb der Anzeigen angezeigt werden soll. 1=ja, 0=nein.

header_text_align

Die horizontale Ausrichtung des Branding-Headers.

title_enabled

Ob der Titel aktiviert ist oder nicht. 1=ja, 0=nein.

description_enabled

Ob die Beschreibung aktiviert ist oder nicht. 1=ja, 0=nein.

image_border_size

Die Größe des Bildrahmens in Pixeln.

image_border_color

Die Hex-Code-Farbe des Bildrahmens.

text_align

Die Ausrichtung des Textes: links, zentriert oder rechts.

customcss_enabled

Ob benutzerdefiniertes CSS aktiviert ist oder nicht. 1=ja, 0=nein.

customcss

Wenn aktiviert, wird das benutzerdefinierte CSS hier angezeigt.

header_enabled

Ob der Header aktiviert ist oder nicht. 1=ja, 0=nein.

mobile_breakpoint

Der Breakpoint in Pixeln zwischen Desktop- und Mobile-Ansichten der Anzeigenzone.

spacing_v

Der vertikale Abstand in Pixeln zwischen den Anzeigen, festgelegt in den erweiterten Optionen.

spacing_h

Der horizontale Abstand in Pixeln zwischen den Anzeigen, festgelegt in den erweiterten Optionen.

zoom

Ob die Anzeige beim Darüberfahren hinein- oder herauszoomt.

mobile_rows

Die Anzahl der Anzeigenreihen im mobilen Widget.

mobile_cols

Die Anzahl der Anzeigenspalten im mobilen Widget.

use_v2_script

Ob die Anzeigenzone mit dem neueren V2-Setup oder dem älteren v1 erstellt wurde.

text_enabled

Ob der Texttitel und die Beschreibung angezeigt werden sollen. 1=ja, 0=nein.

mobile_image_width

Die Breite des Bildes in jeder Anzeige auf Mobilgeräten.

mobile_text_box_size

Die Größe des Textfelds auf Mobilgeräten. Gültiger Bereich 50-500.

mobile_text_enabled

Ob der Titel auf Mobilgeräten aktiviert ist oder nicht. 1=ja, 0=nein.

mobile_text_position

Die Position des Textes auf Mobilgeräten: unten oder rechts.

item_spacing_on_each_side

Der Abstand auf jeder Seite der Anzeigen, wenn sie mit dem alten v1-Setup eingerichtet wurden.

text_position

Ob der Text auf der linken oder rechten Seite positioniert ist.

text_box_size

Die Größe des Textfelds in Pixeln. Bereich 50-500.

widget_height

Die Höhe des gesamten Widgets.

brand_enabled

Ob das Branding aktiviert ist oder nicht.

brand_font_size

Die Schriftgröße des Brandings.

brand_font_color

Die Schriftfarbe des Brandings.

brand_font_weight

Die Schriftstärke des Brandings.

brand_decoration

Ob die Schrift unterstrichen ist oder nicht.

mobile_image_height

Die Höhe des Bildes in jeder Anzeige auf Mobilgeräten.

publisherAdType

Welche Art von nativer Anzeige dies ist, d. h. Empfehlung, Exit oder Interstitial: native-recommendation, native-interstitial.

data.ad_items

Eigenschaft
Beschreibung

idvariation

Die ID der Variation.

image

Das ursprünglich für die Anzeige hochgeladene Bild.

url

Die Klick-URL.

impression

Die Impression-URL.

title

Der Titeltext der Anzeige.

description

Der Beschreibungstext der Anzeige.

brand

Der Markentext der Anzeige.

original_url

Die ursprüngliche URL der Landingpage.

image_position

Die Position des Anzeigenbildes (wie das Bild zugeschnitten wird).

size

Die Größe des ausgewählten Anzeigenformats

iframe_url

Wenn ein iframe als Variation verwendet wird, ist dies die URL des iframes.

video_thumb_id

Der Bezeichner des Video-Thumb-Assets (falls vorhanden), das mit dem Anzeigenmotiv verknüpft ist.

video_thumb_url

Die URL des Video-Thumb-Assets (falls vorhanden).

video_thumb_enabled

Der Status des Video-Thumb-Assets (falls vorhanden).

Beispiel für eine Antwort mit nativen Anzeigen

Outstream-Video

Eigenschaft
Beschreibung

url

Die Klick-URL

Tracking

Ein Objekt mit Tracking-Infos.

Video

Die Videodatei der Anzeige oder der zu ladende VAST-Link.

brandingEnabled

Flag zum Aktivieren des Brandings. Dieser Wert wird derzeit nicht verwendet

frequencyPeriod

Wie oft die Anzeige in Minuten angezeigt wird.

maximumWidth

Videobreite.

isVast

Gibt an, ob die gewinnende Kampagne eine normale Videoanzeige (false) oder eine VAST-Link-Kampagne (true) ist.

ctaEnabled

Flag, um eine CTA in der Anzeige anzuzeigen

cta

Ein Objekt mit den Details der CTA

impression

Die Impression-URL

data.tracking

Im Moment gibt das data.tracking Objekt nur ein progress Array mit Objekten zurück, die zur Nachverfolgung der Videowiedergabe dienen. Von diesen Objekten ist das mit "offset": "00:00:10.000" dasjenige, das aufgerufen werden muss, um die Videoansicht zu speichern. Die Eigenschaften der einzelnen Objekte werden unten erklärt:

Eigenschaft
Beschreibung

offset

Fortschrittsmarkierung in Sekunden oder als Prozentsatz der abgespielten Videoanzeige

url

Tracking-URL

data.cta

Eigenschaft
Beschreibung

displayUrl

Mit der Landingpage der Anzeige verknüpfte URL

text

Text, der im CTA-Element verwendet werden soll

Beispiel für die Outstream-Video-Antwort

Video-Slider

Eigenschaft
Beschreibung

url

Die Klick-URL

Tracking

Ein Objekt mit Tracking-Infos.

Video

Die Videodatei der Anzeige oder der zu ladende VAST-Link.

screenDensity

Ganze Zahl, die den Anteil des maximalen Bildschirmbereichs angibt, den die Anzeige auf dem Gerät eines Benutzers einnimmt

onComplete

Gibt das Verhalten der Anzeige an, nachdem das Video fertig abgespielt wurde. "hide" bedeutet, dass die Anzeige ausgeblendet werden soll, während "repeat" bedeutet, dass die Anzeige auf der Seite bleiben soll, damit der Benutzer sie erneut abspielen kann

closeAfter

Gibt die Anzahl der Sekunden an, die vergehen müssen, bevor der Schließen-Button in der Anzeige angezeigt wird

brandingEnabled

Flag zum Aktivieren des Brandings. Diese Eigenschaft wird derzeit nicht verwendet

frequencyPeriod

Wie oft die Anzeige in Minuten angezeigt wird.

impression

Die Impression-URL

isVast

Gibt an, ob die gewinnende Kampagne eine normale Videoanzeige (false) oder eine VAST-Link-Kampagne (true) ist.

ctaEnabled

Flag, um eine CTA in der Anzeige anzuzeigen

cta

Ein Objekt mit den Details der CTA

data.tracking

Im Moment gibt das data.tracking Objekt nur ein progress Array mit Objekten zurück, die zur Nachverfolgung der Videowiedergabe dienen. Von diesen Objekten ist das mit "offset": "00:00:10.000" dasjenige, das aufgerufen werden muss, um die Videoansicht zu speichern. Die Eigenschaften der einzelnen Objekte werden unten erklärt:

Eigenschaft
Beschreibung

offset

Fortschrittsmarkierung in Sekunden oder als Prozentsatz der abgespielten Videoanzeige

url

Tracking-URL

data.cta

Eigenschaft
Beschreibung

displayUrl

Mit der Landingpage der Anzeige verknüpfte URL

text

Text, der im CTA-Element verwendet werden soll

Beispiel für die Video-Slider-Antwort

Vollseiten-Interstitials

Eigenschaft
Beschreibung

url

Die Klick-URL

impression

Die Impression-URL

image

Das ursprünglich für die Anzeige hochgeladene Bild.

optimum_image

Wenn die hochgeladene Creative-Datei ein animiertes GIF ist, ist dies die optimierte MP4-Version davon, die für die Anzeige erstellt wird.

width

Die Breite der Anzeige in Pixeln.

height

Die Höhe der Anzeige in Pixeln.

frequency_count

Wie oft die Anzeige angezeigt werden kann

frequency_period

Wie oft die Anzeige in Minuten angezeigt wird

frequency_trigger_type

Flag, das angibt, ob die Häufigkeit dieser Anzeige auf Impressionen (0) oder Klicks (1) basiert

ad_trigger_method

Für diese Anzeigenzone aktivierte Auslösemethode

ad_trigger_classes

Klassen, die die Anzeige auslösen sollen, falls vorhanden

first_trigger_clicks

Anzahl der Klicks, die beim ersten Besuch des Benutzers erforderlich sind, um die Anzeige auszulösen

next_trigger_clicks

Anzahl der Klicks, die nach dem ersten Auslösen der Anzeige erforderlich sind, damit die Anzeige erneut angezeigt wird

chrome_enabled

Flag, das angibt, ob diese Anzeigenzone für Chrome aktiviert (1), deaktiviert (0) oder ausschließlich für diesen Browser aktiviert (2) ist

capping_enabled

Flag, das angibt, ob für diese Anzeigenzone ein Capping erzwungen werden soll oder nicht

media

Dies zeigt, welcher Bannertyp dies ist: Bild, HTML oder Video: Dies sollte jeweils img_banner, html_banner oder video_banner, jeweils.

Hinweis: Die meisten Eigenschaften der Fullpage-Interstitial-Antwort beziehen sich auf das Capping und das Auslösen der Anzeige. Da Sie für das Rendern der Anzeige verantwortlich sind, liegt es an Ihnen zu entscheiden, ob Sie diese Eigenschaften berücksichtigen möchten oder nicht.

Beispiel für die Fullpage-Interstitial-Antwort

Beachten Sie, dass, obwohl das Beispiel ein Desktop-Fullpage-Interstitial zeigt, die Antwort für ein Mobile-Fullpage-Interstitial bis auf die zone.type identisch sein sollte.

In-Page-Push

Eigenschaft
Beschreibung

url

Die Klick-URL

impression

Die Impression-URL

image

Das ursprünglich für die Anzeige hochgeladene Bild.

optimum_image

Wenn die hochgeladene Creative-Datei ein animiertes GIF ist, ist dies die optimierte MP4-Version davon, die für die Anzeige erstellt wird.

title

Titel der Benachrichtigung

description

Beschreibung der Benachrichtigung

horizontal_position

Gibt die horizontale Position auf der Seite an (left, center, right)

vertical_position

Gibt die vertikale Position auf der Seite an (top, middle, bottom)

delay

Anzahl der Sekunden, bevor die Benachrichtigung nach dem Laden der Seite angezeigt wird

max_notifications_on_page

Anzahl der Benachrichtigungen, die gleichzeitig auf der Seite angezeigt werden können

once_closed_hide_for

Dauer in Sekunden, für die die Anzeige nach dem Schließen verborgen wird (erfordert Cookie-Einwilligung des Nutzers)

user_session_capping

Anzahl der Male, die die Anzeige dem Nutzer angezeigt wird (erfordert Cookie-Einwilligung des Nutzers)

delay_between_notifications

Anzahl der Sekunden, bevor die nächste Benachrichtigung nach dem Laden der vorherigen angezeigt wird

Beispiel für die In-Page-Push-Benachrichtigungsantwort

Mehrformat

Eine Antwort auf eine Mehrformat-Anfrage kann unterschiedliche Ergebnisse zurückgeben:

  • Wenn die gewinnende Anzeige eine Native-Kampagne ist, enthält die Antwort ein reguläres Native-Datenobjekt.

  • Wenn die gewinnende Anzeige eine Banner-Kampagne ist und Sie ein Einzelzone im Layout haben, enthält die Antwort ein reguläres Banner-Datenobjekt.

  • Wenn die gewinnende Anzeige eine Banner-Kampagne ist und Sie ein Layout mit mehreren Anzeigen, enthält die Antwort ein group Objekt mit den folgenden Eigenschaften:

Eigenschaft
Beschreibung

orientation

Die Ausrichtung des Multi-Zonen-Layouts, die "horizontal" oder "vertical" sein kann

ad_items

Array mit Anzeigendaten für jeden Platz im Layout.

Unabhängig vom Ergebnis wird die Eigenschaft multizoneid der Antwort hinzugefügt und gibt die Zonen-ID der Mehrformat-Anzeigenzone an, auf die sich diese Antwort bezieht.

Beispiel für die Mehrformat-Antwort

Das folgende Beispiel zeigt das Zonen Objekt für eine Mehrformat-Anzeigenzone mit einem Horizontal x 3 Layout:

Responsive Display-Anzeigen

Einige Formate, wie Banner und Fullpage-Interstitials, können Responsive Display-Anzeigen aktiviert werden, um neben der Nachfrage aus Native-Ads-Kampagnen auch Nachfrage aus ihren ursprünglichen Anzeigenformaten zu erhalten. In diesen Fällen enthält die Antwort das original_zone Objekt, das den Typ und die Daten des ursprünglichen Formats angibt.

Hier ist ein Beispiel für ein Banner-Anzeigenformat:

Impression-Tracking

Stellen Sie sicher, dass Sie einen GET-Aufruf für die Impression-URL ausführen, um die Impressionen für Ihre Anzeigenanfragen zu erfassen. Eine Möglichkeit, dies zu erreichen, besteht darin, eine unsichtbare Bilddatei zu erstellen, indem Sie die Impression-URL als Quelle auf der Seite verwenden, auf der die Anzeige angezeigt wird, z. B.:

Zuletzt aktualisiert

War das hilfreich?