Data keys

Aside from keywords, location, and platform-based targeting, AdButler also lets you target specific audiences using key value-based attributes. These are called data keys. Like the other forms of targeting, you must create and define data keys before you can use them.

By default, only the Administrator can create, edit, and delete data keys. You can edit a user account's permissions or role to allow them to manage data keys as well.

Data keys are disabled by default. Please open a ticket from your AdButler dashboard and submit a request if you want us to enable it in your account.

This guide will show you:

  1. How to create data keys.
  2. How to assign data keys.
  3. How to create data key rules and groups.
  4. Using data key rules templates..
  5. How to set data keys.

How to create data keys

  1. Click Targets in the left navigation menu. The Targets section will appear.
  2. Click Manage Data Keys to go to the Data Keys subsection.

The Data Keys subsection in AdButler

  1. Click Create New. The Data Key window will appear.
  2. Give the data key a name, select its type, then click Save.

The data keys you created will be listed in the table in the Data Keys subsection.

Back to top

How to assign data keys

  1. Click Advertisers in the left navigation menu to go to the Advertisers section.
  2. Click on the appropriate advertiser to go to its dashboard.
  3. Click on the appropriate campaign to go to its dashboard.
  4. Under Zone Assignments, create a new zone assignment or click on the existing zone assignment that you want to use.
  5. In the Assignments page, click on Targeting to expand the Targeting menu, then click Manage Target. The Manage Data Key Rules window will appear.

The Manage Target button in the Assignment Details page

  1. Create data key rules or groups as needed.
  2. Click Save Changes.

Back to top

How to create data key rules and groups

In the Manage Data Key Rules window, each line is a rule. Use data keys together with the provided operators and options to define your target audience.

The Manage Data Key Rules window

Conditional logic operators and options

  • All: The target audience is one that meets all listed requirements.
  • Any: The target audience can be anyone that meets at least one of the listed requirements.
  • = : is equal to.
  • != : is not equal to.
  • < : is less than.
  • <= : is less than or equal to.
  • > : is greater than.
  • >= : is greater than or equal to.
  • starts with: the conditional characters must be at the start of the retrieved string.
  • ends with: the conditional characters must be at the end of the retrieved string.
  • contains: the conditional characters can be anywhere in the retrieved string.
  • does not contain: the conditional characters must not be in the retrieved string.
  • is after: the retrieved time must come after the conditional value.
  • is before: the retrieved time must come before the conditional value.
  • is between: the retrieved time must be between the conditional values.

To add a rule, click +Add, then click +Rule. By default, all rules for an assignment fall under either All or Any. In other words, your target audience either meets all of the rules, or just one or more unspecified rules. If you want to define a target audience that must meet specific rules but not necessarily all rules, you should create a group. A group is a set of rules that are treated as one rule. It allows you to use both All and Any in the same set of rules. To add a group, click +Add, then click +Group.

Example 1 wants to serve ads to males aged 21 to 65 years old.

Data Key Rules Example 1

Example 2 wants to serve ads to males aged 21 to 65 years old, and whose last names end in "son", "er", or "phy". The group of rules made it possible to define a target audience that must meet the first three rules, but comply with only one of the rules in the group.

Data Key Rules Example 2

Example 3 wants to serve ads to males of any age, or to females aged 21 to 65 years old. The group of rules made it possible to define a target audience that can meet either the first rule or the group. However, the latter has a set of requirements that must all be met.

Data Key Rules Example 3

A group can also include a group, but the sub-group can include only rules.

Back to top

Data key rules templates

While creating a set of rules, you can save it as a template. This lets you apply it to future placements without redefining the rules from scratch every time.

  1. Click Templates on the upper right corner of the Manage Data Key Rules window.

Saving data key rules as a template

  1. Click Save current rules to new template. The Create Template window will appear.
  2. Enter a name for the template then click Create.

To apply a saved data key rules template:

  1. Click Templates on the upper right corner of the Manage Data Key Rules window.
  2. Click on the name of the template in the dropdown that appears. The set of rules in the template will appear.

The list of data key templates

To edit a template:

  1. Click Templates on the upper right corner of the Manage Data Key Rules window.
  2. Click on the name of the template in the dropdown that appears. The set of rules in the template will appear.
  3. Make your desired changes.
  4. Click Save change to current template.

To delete a template:

  1. Click Templates on the upper right corner of the Manage Data Key Rules window.
  2. Click on the trash can icon next to the template's name. A confirmation prompt will appear.
  3. Click Remove Template Permanently.

Back to top

How to set data keys

  1. Click Publishers in the left navigation menu to go to the Publishers section.
  2. Click on the appropriate publisher to go to its dashboard.
  3. In the table of zones, look for the zone where the data key-targeted campaign is assigned.

The Zone Tags button in a specific publisher's section

  1. Click on Get Tags under the Zone Tags column of that zone. The Zone Tags window will appear.
  2. Look for keywords: abkw in the code snippet.
  3. Type dataKeys: {'Name of Data Key' : 'Value'} before keywords: abkw. The following example uses the data key Age and the variable agevariable:

How to set data keys

  1. Repeat Step 5 for each data key used in the rules you created. Each variable must be separated with a comma.

  2. Paste the modified zone tag into the publisher's website.

Back to top


Can't find what you're looking for?

Send us an email

hello@adbutler.com

Visit the blog

For more ad serving tips, industry news and AdButler insights.