Employ KeyValues
Key-Values help Advertisers to target premium user-groups and site traffic, in turn boosting your revenue. Most KeyValues are used and re-used over many different sites, so Advertisers rely on standards to easily scale their campaign reach.
Basics
KeyValues can be sent by employing addKeyValue("key", "value") and addKeyValues({key: ["value1", "value2", "value3"})
Keys come in two flavors:
- Freeform: Values are open-ended, and you may pass any values you like. Employ these values in the way you deem best.
- Predefined: Values are set, use only the values as outlined in this document.
For all values, there are a few basic rules to follow:
- Do not use special characters or spaces inside keys or values.
- Always send keys & values in lowercase.
| ✅ Do this | ❌ Don't do this |
|---|---|
addKeyValue('keywords': 'regional_politics') | addKeyValue('Key Words': 'Regional Politics') |
addKeyValue('keywords': 'doppeltorschuetze') | addKeyValue('Key Words': 'Doppeltorschütze') |
Content related Key-Values
| Key | Values | Description |
|---|---|---|
| cid | freeform | Internal CMS ID or article identifier of the page the user is currently viewing. Can be used to map and report revenue generated for this identifier. For example: art146z2892 or 6789334 |
| eventtype | goal, substitution, minute75, default, startsecondhalf, startend, start, endfirsthalf, end, firstgoal | Can be used to pass current state of a sport match to the adserver, ads specificly target these events. Example: "This goal is presented by..." |
| fsk | 0, 6, 12, 16, 18 | Can be used to cluster the content to a specifc age group. AdServer could block or target certain ads to a given age group. |
| label | freeform | You can label the page with an identifier of your own choosing and later use if for reporting or ad campaign targeting. |
| pacont | freeform | pacont ist reserved for "paid contents" / "sponsored posts" or so called "advertorials". You can pass an identifier of your choosing, which in turn can be used by our AdOperations team to exclusivly book high priority advertisments campaigns of the specific advertiser to the site. |
| pagetype | fotoshow, artikel, rubrik, article, start, gallery, ticker, home, oped | Should you wish to differentiate between the types of your pages. Often used in conjunction with CMS Templates, where all content based on one template (for example: articles) should be targetable or reportable. |
| rcpingredients | freeform | Relevant for recipe databases / cooking sites. Pass ingredients of the recipe, which in turn will allow delivery of specific ads. For example: tomatoes |
| rcpcountry | freeform | Relevant for recipe databases / cooking sites. Pass the origin country of the recipse with this key. For example: indien |
| rcpoccasion | freeform | Relevant for recipe databases / cooking sites. Pass the occasion for which the recipe fits best. Can be seasonal or events. For example: spring or birthdayparty |
| rcppreparations | freeform | Relevant for recipe databases / cooking sites. Pass the method of preparation for this recipe. For example: cook or grill or cold |
| rcpdrinks | freeform | Relevant for recipe databases / cooking sites. Pass recommended drinks which fit to this recipe. For example: wine or beer |
| rcpcategory | freeform | Relevant for recipe databases / cooking sites. Pass the category the recipe fits best to. For example: glutenfree or vegan or snack |
| keywords | freeform | Keywords describing the content of the current page. For example: hardware or software or clothing |
| rfree | 0-99, 100-199, 200-299, 300-399, 400-499, 500+ | Use this value wenn you want to specify right free space in skyscraper slot |
| amp | 1, 0 | Marks a tag as being integrated into an "AMP" environment |
User related Key-Values
Please make sure to comply to your local law concerning sending user related data to 3rd party systems. Most legal requirements for sending this data require an explicit consent of the user for the data in question.
| Key | Values | Description |
|---|---|---|
| plz | 5 digit code | 5 digit german postal code. If you have less than 5 digits, please only pass the known digits. |
| age | 13-17, 18-24, 25-34, 35-44, 45-54, 55-up | Age of the user, clustered into groups. Please make sure to never use the actual age of the user, only send us the age group the user is part of. |
| country | Alpha-3 country code | Current country of the user, please use the IBAN Alpha-3 country code. https://www.iban.com/country-codes |