Ad media export file
Creating the URL
The URL required for creating an ad media data export file is build up as following:
https://export.net.[domain]/[your_api_key]/adm-admedia.[file_extension]?[filters]Once you have filled in your domain, your API key, your user ID and the relevant file extension and you have applied your filters, your URL should look more or less like this:
https://export-demonet.ingenioustech.biz/a1234a-8855-6584-abcd-363d08461785/adm-admedia.csvBy default your system-generated default API key is used in the export links.
Applying filters
For the ad media data export file, following filters can be applied:
Filter description | Filter name | Compulsory | Format |
|---|---|---|---|
Allows you to limit the export to the ad media of a specific advertiser. | mid | Yes | Use the MID (merchant ID) you find overview of your advertisers. |
These filters are to be added to the URL as parameters. Use the the question mark (?) for the first parameter and the ampersand (&) for all further parameters. Add the word filter, the filter name, the equals sign (=) and the relevant values according to the format mentioned in the table.
Output
The ad media export file contains the following data:
Name | Explanation | Example |
|---|---|---|
merchantid | The ID of the advertiser to which the ad media element belongs. | 123 |
bannerid | The ID of the ad media item. | 1234 |
type | The type of the ad media item. Possible values are banner, html, text (for text links) and flash. | banner |
title | The name of the ad media item. | Product banner 125 x 125 |
width | The width of the ad media item. For text links and html item, the value will be 0. | 125 |
height | The height of the ad media item. For text links and HTML item, the value will be 0. | 25 |
targeturl | The URL to which a costumer using the ad media item will be directed. | |
admdescription | The description of the ad media item. | Standard 125×25 banner. |
admcatid | The ID of the category in which the ad media item is stored. | 123 |
advars.target | The URL where the image used for the ad media item stored. For text links, this field will be empty. | |
advars.htmlsource | The source code of the HTML ad media . Obviously, this field is only relevant for HMTL ad media items. |
code |
advars.swfurl | The URL where the file used for your Flash ad media item is stored. This field is only relevant for Flash ad media items. | |
advars.clicktag | The value for the click tag parameter used for your Flash ad media item, i.e. the target URL of the flash ad media item. This field is only relevant for Flash ad media items. | |
advars.swfparameter | The value for an additional parameter that can be added to a Flash ad media item. This field is only relevant for Flash ad media items. | lang=ENG |
advars.altbanner | A brief text that will be used when a customer’s browser cannot load the image or HTML file related to the ad media item. | Click here for Shopping.com! |
advars.linktext | The text of a text link. This field is only relevant for text links. | Enjoy the spring collection on shopping.com! |
delete.admedia | This field indicates whether the ad media item has been deleted or not. 0 means the item is active, 1 means it has been deleted. |
|