Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Die Werbemittel API wird zum Aufruf der Werbemitteldaten genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werdenThe admedia API is used to get the admedia data. To do this, the following parameter must be appended to the API call:

API

Parameterparameter

Werbemitteladmedia

get-campaigns_admedialist

BeispielExample: https://www.domain.de/api//ACCESS-TOKEN/publisher/ID/get-campaigns_admedialist.csv

Definition der Felder in der Werbemittel API

Die Spaltennamen der heruntergeladenen Datei beinhalten folgende Parameter:

...

Feldname

...

Beschreibung

...

id

...

Die ID des Werbemittels.

...

title

...

Der Titel des Werbemittels.

...

mediatype

...

Die Art des Werbemittels. Hier gibt es bspw. die Unterscheidung zwischen Text-Link, Banner oder einem Newsletter.

...

status

...

Der Status des Werbemittels.

1 - aktiv

...

dimension

...

of the fields within the admedia API

The columns of the downloaded file contain the following parameters:

fieldname

definition

id

The ID of the admedia.

title

The title of the admedia.

mediatype

The type of admedia. For example, there is a distinction between text links, banners or a newsletter.

status

The status of the admedia.

1 - active
2 - paused

dimension

This value is only relevant for banners and shows the size of the admedia in pixels.

campaign_id

Die ID der Kampagne, der das Werbemittel angehörtThe ID of the campaign to which the ad media belongs.

campaign_titleDer

Name der Kampagne, der das Werbemittel angehörtThe title of the campaign to which the ad media belongs.

category_id

Die ID der Werbemittel-Kategorie, der das Werbemittel angehörtThe ID of the category to which the ad media belongs.

category_title

Der Name der Werbemittel-Kategorie, der das Werbemittel angehört.

clicklink

Der Klicklink, welcher beim Klick auf das Werbemittel ausgeführt wird. Wird in der Statistik als “Klick” gezählt.

viewlink

Der Viewlink, welcher beim Ansehen des Werbemittels ausgeführt wird. Wird in der Statistik als “View” gezählt.

adcode

Der HTML-Code zur Implementierung des Werbemittels auf der HomepageThe title of the category to which the ad media belongs.

clicklink

The clicklink that is executed when the admedia is clicked. Counts as "click" in statistics.

viewlink

The viewlink that is executed when the admedia is viewed. Counts as "view" in statistics.

adcode

The HTML of the the admedia to implement on the website.

swfurl

--KEINE RELEVANZNOT RELEVANT--

swfparameter

--KEINE RELEVANZNOT RELEVANT--

valid_from

Gültigkeit des Werbemittels. Erst ab diesen Tag werden Klicks und Views gezähltValidity of the advertising material. Clicks and views are only counted from this day on.

valid_until

Gültigkeit des Werbemittel. Bis zu diesem Tag werden Klicks und Views gezählt.

vouchercode

Wenn ein Gutscheincode am Werbemittel hinterlegt ist, wird dieser hier ausgegeben.

description

Die Beschreibung des Werbemittels.

statistic

Angabe, ob das Werbemittel in der Statistik berücksichtigt wirdValidity of the advertising material. Clicks and views are only counted until this date.

vouchercode

If a vouchercode is given on the admedia, it is stored here.

description

Description of the admedia.

statistic

Specifies whether the admedia is included in the statistics or not.

last_change

Zeitraum in der das Werbemittel zuletzt bearbeitet wurdeTime at which the admedia was last edited.