Advertiser data export file
Creating the URL
The URL required for creating an advertiser data export file is build up as following:
https://export.net.[domain]/[your_api_key]/adm-merchantexport_[user_ID].[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/d1902f1e-b611-5fac-ac77-361d08461f98/adm-merchantexport_288.csv?products=true
By default your system-generated default API key is used in the export links.
Applying filters
For the advertiser data export file, following filters can be applied:
Filter description | Filter name | Compulsory | Format |
---|---|---|---|
Allows you to import all data related to the product categories for the advertisers. | product_cat_data | Yes | Either use true to export the information, or use false to block. |
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 file you export via the URL you’ve created will contain the following data:
Name | Explanation | Example |
---|---|---|
advertiser_ID | The ID of the advertiser you are exporting, corresponding with the MID (merchant ID) in the UI. | 123 |
url | The main website of the advertiser. | |
name_native | The name of the advertiser in the language used on its website. | Shopping COM |
regeln_landessprache | The URL where the terms and conditions in the native language of the advertiser are stored. | |
status | The status of the advertiser. 1 means the advertiser is active; 2 means the advertiser is deactivated; 3 means the advertiser is deleted. | 1 |
logo_url | The URL where the logo of the advertiser is stored. | |
entity_ID | The ID of the so called entity, the legal body responsible for the payout of the partners, to which the advertiser is assigned. |
|
name_english | The name of the advertiser in English. | 16 |
cross_selling | Internal advertiser setting, the value should always be 1. | 1 |
billing_mode | The billing mode of the advertiser. | no_billing |
language | The ISO-3 language code representing the language used on the advertiser’s website. | ENG |
The email address of the user responsible for the advertiser. | ||
date_created | The time and date on which the basic settings for the advertiser were defined and the advertiser was created. | 2013-05-10 13:25:04.567756+00 |
date_started | The time and date on which the status of the advertiser was set to active. | 2013-05-10 13:25:04.567756+00 |
hidden | This value informs you whether the advertiser is visible for partners or not. 0 means the advertiser is visible for the partners, the values 1, 2 and 3 defines various hidden statuses. For more information, please read the article on the advertiser’s basic settings. | 0 |
currency_iso3 | The ISO 3 of the currency in which transactions for the advertiser are recorded. | EUR |
country | The ISO 3166-1 codes code of the countries in which the advertiser is operating. Please note both the alpha 2 and the alpha 3 code will be included. | {LVA_LA} |
key_account_manager | The ID of the platform user responsible for the program. | 12 |
domain_list | The list of domains to which the advertiser is directing traffic coming from ad media items. | .shopping. |
alias | The alias is the name used to identify your advertiser in tracking applications. | shopping |
deposit_amount | The amount of money the advertiser has to pay to the network as a deposit. Please note this value is only relevant if prepayment is selected as a billing mode. In all other cases, the value will be 0. | 10000 |
deposit_treshold | The treshold of the deposit the advertiser needs to pay. Please note this value is only relevant if prepayment is selected as a billing mode. In all other cases, the value will be 0. | 2000 |
product_feed | This value informs you whether a product feed has been uploaded for the advertiser. 0 means it has not been activated, 1 means it has. | 1 |
seo_tracking_mode | This value informs you whether SEO optimized tracking has been activated for the advertiser. 0 means it has not been activated, 1 means it has. | 1 |
deeplink_enable | This value informs you whether or not a deeplink generator has been activated. 0 means it has not been activated, 1 means it has. | 1 |
deeplink_admedia | If a deeplink generator has been activated, you will find the ID used to identify it in the ad media management and the reporting here. | 1122 |
fallback_behavior | This value defines what will be done with traffic generated after the advertiser has been deactivated or deleted. The numbers represent the three options as discussed in the article on tracking settings. | 2 |
fallback_image | If option 3 is selected as fallback behavior, you will find the image of the error message replacing the advertiser’s ad media. | |
fallback_url | If option 2 or 3 is selected as fallback behavior, you will find the URL where the traffic will be redirected here. | |
trackdomain | The URL of the domain on which transactions generated for this advertiser are tracked. | |
category_label | The label of the advertiser’s category. Please note the value will be empty when the advertiser wasn’t categorized. | Fashion |
category_type | The type of the advertiser’s category. Please note the value will be empty when the advertiser wasn’t categorized. | Purchase |
category_id | The ID of the advertiser’s category. Please note the value will be empty when the advertiser wasn’t categorized. | 21 |
subcategory_label | The label of the advertiser’s subcategory. Please note the value will be empty when the advertiser wasn’t categorized. | Men’s clothing |
subcategory_type | The type of the advertiser’s subcategory. Please note the value will be empty when the advertiser wasn’t categorized. | Fashion |
subcategory_id | The ID of the advertiser’s subcategory. Please note the value will be empty when the advertiser wasn’t categorized. | 42 |
text_description_english | The description of the advertiser in English, aimed at partners. | Generate sales for Shopping.com and profit from the best commissions. |
text_description_native | The description of the advertiser in the language used on the advertiser’s website, aimed at partners. | Générer des ventes pour Shopping.com et profiter des meilleures commissions. |
labels | The labels given to the advertiser. | Fashion, men’s clothing, exclusive |
entity_tax_office | The tax office of the entity to which the advertiser is allocated. | Tax office for cooperate organizations, Berlin. |
entity_title | The name of the entity to which the advertiser is allocated. | Shopping.com Ltd. |
If you apply the product category filter, you will be able to import all data related to the product categories for the advertisers. You will receive the same output as mentioned above, however ‘name_native’ and ‘name_english’ will display the names of your categories, in the language used on the website of the advertiser and English respectively.
Name | Explanation |
---|---|
productcategory_ID | The ID of the product category |
productcategory_URL | The URL related to the product category. This can be a separate page, but it might also be the homepage of the advertiser. |
end_date | The date on which the product category will no longer be valid. If the field is empty, this means there is not end date. |
postclick_mode | This value defines the attribution model applied to the customer journey of conversions. LCW stands for “last click wins”; FCW stands for “first cookie wins”. |
postclick_cookie_time | This value defines how many days a cookie placed after a click on an ad media will be taken into consideration when a conversion is assigned to partners. |
postview_cookie_time | This value defines how many days a cookie placed after an ad media view will be taken into consideration when a conversion is assigned to partners. |
postview_mode | This value defines whether post view tracking is activated or not. 0 means it is not activated, 1 means it is. |
sem_permitted | This value defines whether search engine marketing is permitted to the partners who participate in the advertiser program. |
product_url | This URL leads to a website with information on the product category, created by the advertiser. |
hidden_mode | This value defines whether the product category is visible for partners. 0 means it is visible, 1 means is has been hidden. |