1. Connatix
  2. APIs Documentation
  3. Server-side APIs

Placements

Avatar
Follow

Contents

  1. Placements Search
  2. Placements Clone
  3. Placements Save
  4. Placements Get

Placements Search

Request
Method GET
Target

https://console.connatix.com/api/placements/search
Headers  content-type: application/json
cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body  JSON object with properties
state number optional  Placement state
0 Only active placements
1 Only inactive placements
null All placements, active and inactive
search string optional Text search  
pageSize number optional  Number of items per page
pageNumber number optional  Page number
sortBy string optional  Sort results option
"name"  
"updatedAt"  
sortOrder string optional  Sort order option
"asc"  
"desc"  

 

Response
Status  HTTP Status Code
Headers  set-cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body

JSON object with properties

items [object] Array of placement objects
id number
name string
state number
token string
siteId number
updatedAt string
date formated as "/Date(<unix_timestamp>)/"

Placement Clone

Request
Method POST
Target

https://console.connatix.com/api/placements/clone
Headers  content-type: application/json
cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body  JSON object with properties
id number optional Source placement identifier (see Placements Search )
name string required Name for the new placement  
siteId number required Site identifier (see Sites Search )

 

Response
Status  HTTP Status Code
Headers  set-cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body

JSON object with properties

id number Placement identifier
token string Placement token
message string Server message in case of failure

Placement Save

Request
Method POST
Target

https://console.connatix.com/api/placements/save
Headers  content-type: application/json
cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body  JSON object with properties
id number optional Placement identifier
set to 0 in case of new placement
name string required Name for the new placement  
siteId number required Site identifier (see Sites Search )
state number required Placement state
0 Active
1 Inactive
countryTargeting number required Country targeting flag
    0 Target all countries
    2 Block countries
countries [number] conditional Array of blocked countries identifiers 
required in case countryTargeting set to 2  (see Location Get )
devices [number] required Array of targeted devices  identifiers (see Devices )
categories [number] required Array of targeted categories identifiers (see Categories Get )
creativeTypes [number] required Array of targeted creatives and video sizes identifiers
     0 Video Size Small
     1 Video Size Medium
     2 Video Size Large 
     3 Destination Page
if chosen, must supply Destination page URL in settings
     4 External Link
     5 Third Party
     6 Destination Overlay
     7 Branded Content
if chosen, must include one Video Size i.e. 0,1 or 2 (only one)
     8 Video Monetization
if chosen, must include one Video Size i.e. 0,1 or 2 (only one)
playbackMode number required Video player playback behaviour
     0 Autoplay
     1 Scroll To Play
     2 Click To Play
playlistID number optional Video playlist identifier
set to 0 to play all videos
prerollBreak number optional Pre-Roll Break (milliseconds)
settings string (json) required JSON stringified object with various Video Player Controls, Video Ad Opportunities and Look & Feel settings
languages [number] optional Array of targeted languages  identifiers (see Languages )
servingSettings string (json) required JSON stringified object with various ad serving filtering options

Settings

Optional properties should not be set on the object in case the default behaviour is desired.

Player Controls
s number required Sound Settings
    0 Mute
    1
Sound On
    2
Hover to play
vcb number required Video player close button
    0
Off
    1
Always On
    2
After First Ad
un number required Up next. Video player playlist behaviour
    0
Loop
    1
Move to Next
    2
Stop
Player Ad Opportunities
pob number optional Post-Roll Break (milliseconds)
mr boolean required Mid-Roll on/off
mtab number optional Min Time Before Ad Break (milliseconds)
ta number optional Total video ads number 
bp string optional Bidding Parameters
Look & Feel
ip string required Container css selector
ipos number required Insert position  
    0
Within Container
    -1
Before Container
    -2
After Container
    -3
Replace Container
    -4
Hide Container
    positive number
Any other positive number
vdm number required Video display mode
    0
Lightbox
    1
Instead of Placement
    2
Instead of Image
    3
Below Placement
    4
Inplace Play
df string required Date format
h string required General HTML markup
vh string optional Video HTML markup
dc string optional Destination Overlay Custom CSS. Relevant when 'Destination Overlay' creatives are allowed (see creativeTypes property)
dp string conditional Destination page URL. Required when 'Destination Page' creatives are allowed (see creativeTypes property)
mw boolean optional Mute watermark. If enabled, the mute icon is always shown (not only when hovering over the video)
cr boolean optional Video carousel feature
fvm number required Floating Video Mode. Deprecated, replaced with fv
    0
Off
    1
Scroll Up & Down
    2
Scroll Up
    3
Scroll Down
fs number conditional
Show Floating. Required when Floating Video Mode (fvm) is not Off  Deprecated, replaced with fv
    0
Always
    1
After In View
fv number required
Floating Video Mode
    0
Off
    1
Always
    2
After In View
fcb number conditional
Show Close Button. Required when Floating Video Mode (fvm) is not Off
    0
Never
    1
Always
    2
After Video Ad
fut number conditional
Floating Video Up Top (pixels). Required when Floating Video Mode (fvm) set to Scroll Up & Down or Scroll Up. Deprecated.
fur number conditional Floating Video Up Right  (pixels). Required when Floating Video Mode (fvm) set to Scroll Up & Down or Scroll Up. Deprecated.
fub number conditional Floating Video Up Bottom  (pixels). Required when Floating Video Mode (fvm) set to Scroll Up & Down or Scroll Up. Deprecated.
ful number conditional Floating Video Up Left  (pixels). Required when Floating Video Mode (fvm) set to Scroll Up & Down or Scroll Up. Deprecated.
fuw number conditional Floating Video Up Width (pixels). Required when Floating Video Mode (fvm) set to Scroll Up & Down or Scroll Up. Deprecated.
fdt number conditional Floating Video Top (pixels). Required when Floating Video Mode (fv) set to Always or After In View. Should be supplied along with Floating Video Left (fdl) or Floating Video Right (fdr).
fdr number conditional Floating Video Right (pixels). Required when Floating Video Mode (fv) set to Always or After In View. Should be supplied along with Floating Video Top (fdt) or Floating Video Bottom (fdb).
fdb number conditional Floating Video Bottom (pixels). Required when Floating Video Mode (fv) set to Always or After In View. Should be supplied along with Floating Video Left (fdl) or Floating Video Right (fdr).
fdl number conditional Floating Video Left (pixels). Required when Floating Video Mode (fv) set to Always or After In View. Should be supplied along with Floating Video Top (fdt) or Floating Video Bottom (fdb).
fdw number conditional Floating Video Width (pixels). Required when Floating Video Mode (fv) set to Always or After In View.

Note: Valid combinations of floating video positioning settings are 

  • fdt & fdl : floating video will be positioned in the top-left corner
  • fdt & fdr : floating video will be positioned in the top-right corner
  • fdb & fdl : floating video will be positioned in the bottom-left corner
  • fdb & fdr : floating video will be positioned in the bottom-right corner

ServingSettings

Same as with Settings, properties should not be set on the object in case the default behaviour is desired.

d string optional

Domain Targeting. Should be a valid hostname. If specified the placement will receive ads only when hosted on the set hostname plus sub-domains.

Examples:

If the domain is set to abc.com then it will work on abc.com, x.abc.com, y.x.abc.com etc.

If set to x.abc.com it will not render on abc.com as it's not a subdomain of x.abc.com
up [string] optional

URL Path. Array of strings, each representing path items. If set the placement will receive ads only if the URLs include all the path items.
qp [object] optional

Query parameters. Array of objects for filtering query parameters.

k string Query parameter key
v string Query parameter value
jm [object] optional

JSON Metadata. Array of objects validated against custom JSON metadata set on attribute c-metadata.

k string Query parameter key
v string Query parameter value
       
Response
Status  HTTP Status Code
Headers  set-cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body

JSON object with properties

id number Placement identifier
token string Placement token
message string Server message in case of failure

Placement Get

Request
Method GET
Target

https://console.connatix.com/api/placements/get/<id>

id number Placement identifier
Headers  content-type: application/json
cookie: ConnatixAuth=<connatix_auth_cookie_value>

 

Response
Status  HTTP Status Code
Headers  set-cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body

JSON object with properties

id number Placement identifier
name string Placement name
siteId number Site identifier (see Sites Search )
state number Placement state
countryTargeting number Country targeting flag
   0 Target all countries
   2 Blocked countries
countries [number] Array of blocked countries identifiers 
With values in case countryTargeting is 2, empty in case countryTargeting equals 0. (see Location Get )
devices [number] Array of targeted devices  identifiers (see Devices )
categories [number] Array of targeted categories identifiers (see Categories Get )
creativeTypes [number] Array of targeted creatives and video sizes identifiers
playbackMode number Video player playback behaviour
playlistID number Video playlist identifier
prerollBreak number Pre-Roll Break (milliseconds)
settings string (json) JSON stringified object with various Video Player Controls, Video Ad Opportunities and Look & Feel settings.

See section Placements Save / Settings for more information.
languages [number] Array of targeted languages  identifiers (see Languages )
servingSettings string (json) JSON stringified object with various ad serving filtering options
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.

© Connatix 2018