# Werbemittel-API - Dokumentation

Die Werbemittel API wird zum Aufruf der Werbemitteldaten genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werden:

| API | Parameter |
| :--- | :--- |
| Werbemittel | **get-campaigns_admedialist** |

Beispiel: 
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` | Die Abmessungen des Werbemittels. Dieser Wert ist nur bei Bannern relevant und zeigt die Größe des Werbemittels in Pixel. |
| `campaign_id` | Die ID der Kampagne, der das Werbemittel angehört. |
| `campaign_title` | Der Name der Kampagne, der das Werbemittel angehört. |
| `category_id` | Die ID der Werbemittel-Kategorie, der das Werbemittel angehört. |
| `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 Homepage. |
| `swfurl` | --KEINE RELEVANZ-- |
| `swfparameter` | --KEINE RELEVANZ-- |
| `valid_from` | Gültigkeit des Werbemittels. Erst ab diesen Tag werden Klicks und Views gezählt. |
| `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 wird. |
| `last_change` | Zeitraum in der das Werbemittel zuletzt bearbeitet wurde. |