Admedia API
- Markus Wigbels
- Daniel Steinweg
The admedia API is used to get the admedia data. To do this, the following parameter must be appended to the API call:
API | parameter |
|---|---|
admedia | get-campaigns_admedialist |
Example: https://www.domain.de/api//ACCESS-TOKEN/publisher/ID/get-campaigns_admedialist.csv
Definition 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 |
dimension | This value is only relevant for banners and shows the size of the admedia in pixels. |
campaign_id | The ID of the campaign to which the ad media belongs. |
campaign_title | The title of the campaign to which the ad media belongs. |
category_id | The ID of the category to which the ad media belongs. |
category_title | The 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 | --NOT RELEVANT-- |
swfparameter | --NOT RELEVANT-- |
valid_from | Validity of the advertising material. Clicks and views are only counted from this day on. |
valid_until | Validity 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 | Time at which the admedia was last edited. |