Targeting Settings

Learn how to configure user properties and context targeting using the REST API.

POST /property

Targeting Settings

cURL

curl --request POST \
  --url https://api-v2.adrop.io/property \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "uid": "<string>",
  "value": "<string>",
  "platform": "<string>",
  "adid": "<string>"
}
'

Success Response

{
    "code": 0,
    "msg": "OK"
}

Targeting allows you to display ads to specific user groups or contexts. The REST API supports both audience targeting and context targeting.

Audience Targeting

Target ads based on user properties.

Request Parameters

Authorization · string · required

App Key (found in adrop_service.json)

Content-Type · string · required

application/json

uid · string · required

User unique identifier

value · string · required

Property data (JSON string). Includes preset and custom properties.

platform · string

Platform. e.g., web, android, ios

adid · string

Advertising identifier (ADID/IDFA)

Response

code · integer

Response code. 0 indicates success.

msg · string

Response message

Success Response

{
    "code": 0,
    "msg": "OK"
}

---

Preset Properties

Standard properties predefined by Adrop. The same format is used across all SDKs and REST API.

Birth Date (BIRTH)

Key	Example Value	Format
BIRTH	2024	yyyy (year only)
BIRTH	202401	yyyyMM (year and month)
BIRTH	20240101	yyyyMMdd (full date)

Gender (GDR)

Key	Value	Meaning
GDR	M	Male
GDR	F	Female
GDR	U	Unknown

Unknown Values

Key	Value	Description
*	U	Use to represent “unknown” for any property

Preset property keys use uppercase: BIRTH, GDR

---

Custom Properties

You can use custom properties defined in the console.

Setting Custom Properties

1. In the Adrop Console, click Property in the left menu
2. Click Property Detail, add custom properties with + Add Property, and click Save (see Property Naming Rules)
3. Send the property key-value pairs via API

const properties = {
    // Preset properties
    BIRTH: '19931225',
    GDR: 'M',

    // Custom properties (defined in console)
    membership: 'premium',
    last_purchase_date: '2024-01-15',
    favorite_category: 'electronics'
};

All custom property values must be STRING type.

---

Context Targeting

Target ads based on page or content context. Add the contextId parameter to ad requests.

Setting Up Context Targeting

1. In the Adrop Console, go to Targeting → Context and create a context targeting (see Context Targeting)
2. In the targeting option’s condition, enter the Context IDs you will send in ad requests
3. Pass the same value in the contextId parameter when requesting ads

Context IDs are case-sensitive and must exactly match a value entered in a context targeting option’s condition in the console. Do not use commas (,) in Context IDs, because a comma separates multiple values both in the console and in an ad request. When requesting ads, pass the value exactly as entered in the console, without leading or trailing spaces.

If you don’t pass a Context ID, or pass a value that isn’t registered in the console, no error occurs. Only campaigns with context targeting are excluded, and other ads can still be served.

Applying Context to Ad Requests

GET https://api-v2.adrop.io/request?unit=YOUR_UNIT_ID&contextId=sport

To match more than one context in a single request, separate the IDs with commas. The first 5 IDs are used, and exclusion takes precedence over inclusion.

GET https://api-v2.adrop.io/request?unit=YOUR_UNIT_ID&contextId=hiking,outdoor,camping

Repeating the parameter (?contextId=hiking&contextId=outdoor) works the same way. For the full rules, see Passing Multiple Context IDs.

If a Context ID contains non-ASCII characters (such as Korean) or &, #, %, +, or spaces, URL-encode it. The params option in axios and Python requests encodes values automatically.

Node.js

const axios = require('axios');

const config = {
    method: 'get',
    baseURL: 'https://api-v2.adrop.io',
    url: '/request',
    params: {
        unit: 'YOUR_UNIT_ID',
        uid: 'USER_ID',
        pf: 'web',
        contextId: 'sport'  // Context ID entered in a context targeting option in the console
    },
    headers: {
        'Authorization': 'YOUR_APP_KEY'
    }
};

axios.request(config)
    .then((response) => {
        console.log(JSON.stringify(response.data));
    })
    .catch((error) => {
        console.log(error);
    });

---

Best Practices

Consistent User ID

Always use the same uid for the same user. Consistent IDs are key to accurate targeting.

Update Properties

Call the /property endpoint immediately when user information changes.

Follow Preset Formats

Use the exact specified formats for BIRTH and GDR properties.

Leverage Context

Use context targeting for page types like news, sports, shopping, etc.

---

Related Documentation

Audience Targeting

Configure audience targeting in the console

Context Targeting

Configure context targeting in the console