Browse the help center

Create placement API JSON field targeting

Creates an API JSON field targeting rule for the specified placement.

Reference
POST https://YOUR-NETWORK-DOMAIN/rest-api/placement/{placementId}/targeting/api-json-field/create.do

Creates an API JSON field targeting rule for the specified placement. At ad-serving time the system calls the specified API URL, extracts the given JSON field from the response, and matches it against the expected value. Targeting is automatically enabled if it was previously disabled. Requires UPDATE permission on the placement and MANAGE_SUPPLY_PRE_TARGETING user permission.

Path Params

placementId integer required

Unique numeric ID of the placement

4001

Form Params

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

apiUrl string required

External API URL that returns a JSON response

https://api.example.com/check

jsonField string required

JSON field name to extract from the API response

eligible

jsonFieldValue string required

Expected value of the JSON field to match against

true

Responses

200

Success

400

Invalid targeting value

401

Unauthorized

403

Forbidden

404

Placement not found

500

Internal server error

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.