Skip to end of metadata
Go to start of metadata

Targeting Value Service

The targeting-value service works in conjunction with the targeting-key service to allow you to create your own key/value combinations for use in targeting on line items, campaigns, and so on. (See Custom Key Value Targeting for more information.)

On This Page

REST API

Add a new targeting value:

Add multiple new targeting values:

Modify a targeting value:

View all targeting values for a specific key:  

View a specific targeting value: 

Delete a targeting value: 

JSON Fields

General

Field

Type (Length)

Description

Default

Required On

id

int

The ID of the targeting value.

Auto-generated number

PUT/ DELETE, in query string

targeting_key_id
int
The ID of the associated targeting key. The targeting key must exist before a value can be created. (See Targeting Key Service.) POST, GET in query string
name
string
The name of the targeting value. This name must be unique within a given targeting key.  
label
string
A label for the value, used for reporting purposes. This value is not required, but if you supply a value it must be unique within the a key. Labels can be a maximum of 190 characters.  
created_on
date
Read-only. The date and time the targeting value was created.  
last_modified
date
Read-only. The date and time the targeting value was last modified.  

Value Requirements

Number of values:

  • You can have up to 100,000 values per key.
  • You can have up to 2,500,000 total active values at one time.

Value naming:

  • Value names are not case-sensitive.
  • Maximum value name length is 100 characters.
  • Value names may contain whitespace, so they can be more than one word.
  • Value names cannot contain any of the following special characters:
    • " (double quotes)
    • ' (apostrophe)
    • = (equal sign)
    • ! (exclamation point)
    • + (plus sign)
    • # (hashtag)
    • * (asterisk)
    • ~ (tilde)
    • ; (semicolon)
    • ^ (caret)
    • () (parentheses)
    • < > (angle brackets)
    • [ ] (square brackets)
    • , (comma)
    • & (ampersand)
    • @ (at)
    • : (colon)
    • ? (question mark)
    • % (percent)
    • / (forward slash)

Examples

View all targeting values for a given key
View a specific targeting value
 Add a targeting value (string)
 Add multiple targeting values (string)
 Add a targeting value (numeric)
Modify a targeting value
 Sort by value name
Delete a targeting value

Related Topics