LiveRail API

APPLICATION PROGRAMMING INTERFACE

USER MANUAL

Version: 1.7

Date: 24 January 2013

LiveRail API ForewordThis mini-guide is intended to be a quick overview of all the available Liverail APImethods. It's not an exhaustive documentation and does not explain all theinternals of LiveRail.

The LiveRail API is available using simple POST over HTTP requests sent to theLiveRail API server. The API server response is always in XML format. There aretwo available API servers that can be used at any given time.

api4.int.liverail.com pre-production server To be used only for API client testing.It's just a sandbox that allows you to test your client implementation. The databasebehind is a daily snapshot of the production database so any errors in the clientimplementation will not affect the data in production.

Parameters

Each API call contains required and optional parameters. Here is an overview of theparameters you can add to this particular API request, where required parametersare written in orange:

Name Required Type Overview ExampleRequiredparameter yes sample

typesampleoverview sample example

token yes stringAuthenticationsession token(receivedafter /login).

token=f5a81cdde43c6334feffcfc13ad53717

Optionalparameter no sample


Return <liverailapi requested="/connection/resolve/name" api_version="X.Y.Z"> <connections> <connection> <connection_id>the id of the connection</connection_id> <name>the name of the connection</name> </connection> ...

<connections> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason

LOGGING IN AND OUT

The login process is achieved using the /login API method. It requires two parameters: 1.username: the full e-mail address (username) of the LiveRail client 2. password: the username’spassword sent as an MD5 hash. The /login method will return an XML containing theauthentication token or session ID. This token must be passed to all API sub sequential callsthrough the token parameter and is considered to be an implied parameter for all the methods.Before disconnecting from the LiveRail API, a polite API client must use the API method /logout.

/login/logout

Method Name: /login

Method Description

A simple method for logging in an user.

Parameters


Name Required Type Overview Example

username yes string The user's loginname. username=test123

password yes stringMD5 hash format ofthe user's clear-textpassword

password=???

api_key no string

MD5 hash formatkey which identifiesthe permissiongiven to the user fora certain entity. Itcan limit access foran entity and all itschildren. When thekey does not havean entity attached,it will work for allthe entities (theprevious loginsystem). If theentered key is notcorrect, it will beignored. Thedefault value is"null".

api_key=awre8g6yad766253dgiewf9

Return

<liverailapi requested="/login" api_version="X.Y.Z"> <error> <code>Error code</code> <message>Human readable error message.</message> </error> <user> <id>User's numeric ID</id> <name>User's full name</name> <admin>1 only for special root users</admin> <email>User's e-mail</email> <timezone>User's timezone (GMT offset)</timezone> </user> <auth> <token>Authentication session token</token> </auth> <status>success or fail</status> <buildtime metric="second">Response build time in seconds (float)</buildtime> <executiontime metric="second">Method execution time in seconds (float)</executiontime> <executiontime metric="second">Method execution time in seconds (float)</executiontime></liverailapi>

<error>...</error> is returned only if status is fail.

Change History


Method Name: /logout

Method Description

A simple method for logging out an user.

Parameters



token yes stringAuthenticationsession token(received after/login).


Return

<liverailapi requested="/login" api_version="X.Y.Z"> <error> <code>Error code</code> <message>Human readable error message.</message> </error> <user> <id>User's numeric ID</id> <name>User's full name</name> <admin>1 only for special root users</admin> <email>User's e-mail</email> <timezone>User's timezone (GMT offset)</timezone> </user> <auth> <token>Authentication session token</token> </auth> <status>success or fail</status> <buildtime metric="second">Response build time in seconds (float)</buildtime> <executiontime metric="second">Method execution time in seconds (float)</executiontime> <executiontime metric="second">Method execution time in seconds (float)</executiontime></liverailapi>

<error>...</error> is returned only if status is fail.

Change History


SET / UNSET ENTITY

After the API client is logged in, the client must select an entity. To select an entity, the API clientmust use the /set/entity method, using the entity ID as a value for the parameter entity_id.

/set/entity/unset/entity

Method Name: /set/entity

Method Description

Select and attach the current user to an entity.

Parameters





entity_id yes integerThenumerical IDof the entityto be edited.

entity_id=788

Return <liverailapi requested="/set/entity" api_version="X.Y.Z"> <error> <code>Error code</code> <message>Human readable error message.</message> </error> <user> <id>User's numeric ID</id> <name>User's full name</name> <admin>1 only for special root users</admin> <email>User's e-mail</email> <timezone>User's timezone (GMT offset)</timezone> </user> <auth> <entity> <entity_id>Selected entity's ID</entity_id> <user_role>User's role on the selected entity (admin, cust-ro, cust-rw)</user_role> <entity_name>Name of the entity</entity_name> <perspective>The perspective of the current user over the selected entity</perspective> <parent_id>The parent entity ID for the current entity. Can be null.</parent_id> </entity> <token>Authentication session token</token> </auth> <status>success or fail</status> <buildtime metric="second">Response build time in seconds (float)</buildtime> <executiontime metric="second">Method execution time in seconds (float)</executiontime> <executiontime metric="second">Method execution time in seconds (float)</executiontime></liverailapi>

Change History


Method Name: /unset/entity

Method Description

Detach the current user from any previously attached entities.

Parameters





Return <liverailapi requested="/unset/entity" api_version="X.Y.Z"> <error> <code>Error code</code> <message>Human readable error message.</message> </error> <user> <id>User's numeric ID</id> <name>User's full name</name> <admin>1 only for special root users</admin> <email>User's e-mail</email> <timezone>User's timezone (GMT offset)</timezone> </user> <auth> <token>Authentication session token</token> </auth> <status>success or fail</status> <buildtime metric="second">Response build time in seconds (float)</buildtime> <executiontime metric="second">Method execution time in seconds (float)</executiontime> <executiontime metric="second">Method execution time in seconds (float)</executiontime></liverailapi>

Change History


ENTITIES

All the methods related to entities are displayed here.

/entity/add/entity/edit/entity/list/entity/delete/entity/list/bychar/entity/resolve/name/entity/exchange/list/entity/publisher/category/list/entity/network/type/list/entity/network/type/parameter/list/entity/integration/get

Method Name: /entity/list

Method Description

List all the available entities or the information for a given entity.

Parameters





entity_id no integer

The numericID of theentity forwhich theinformationwill bereturned. Ifyou havemultiple id(s)you can makea single callby gluingthem togetherwith | or ,

entity_id = 1|7|120 or entity_id = 1,7,120

parent_id no integer

The numericID of theparent entityfor which thechildrenentities will bereturned. Ifyou havemultiple id(s)you can makea single callby gluingthem togetherwith | or ,

parent_id = 1|7|120 or parent_id = 1,7,120

like_organization no string

Returns onlythe entitiesthat have anorganizationname startingwith thisstring ( thismethod couldbe used toorganize theentities bystarting letters). If you setthisparameter to#, the call willreturn onlythe entitiesthat don't startwith a..z.

like_organization=te

count_only no integer

If you set thisflag to 1, theAPI will returnonly the countof entitiesmatching theparameterset.

count_only=1

limit no intLimit thenumber ofresults forpagination(s).

limit=50

offset no int

The offsetfrom wherethe limitshould beapplied ( ifyou display10 entities perpage and youneed to getthe 3rd pageyou shouldset offset to20 and limit to10 ). Do notuse withoutspecifying thelimitparameter aswell.

offset=5

Return <liverailapi requested="/entity/list" api_version="X.Y.Z"> <total>The total number of listed entities</total> <entities> <entity> <entity_id>entity's ID</entity_id> <parent_id>null if the entity is a root entity, parent's entity ID otherwise</parent_id> <perspective>the perspective of the entity; P for Publisher, N for Network, A for Advertiser, M for Marketplace</perspective> <creation_time>entity's creation full date (YYYY-MM-DD HH:MM:SS)</creation_time> <organization>entity's name (organization)</organization> <address>entity's postal address, can be null</address> <description>entity's description, can be null</description> <status>entity's status, active, inactive, paused or cancelled</status> <hosted>1 if the entity is hosted with LiveRail, 0 otherwise</hosted>

<type>type of the entity, internal use</type> <contact_email>contact email for this entity</contact_email> <built_in>1 if the entity is considered as a 3rd party ad source, 0 otherwise</built_in> <site_url>The entity's website URL</site_url> <category_id>main category ID for this entity</category_id> <admap>existing AD map for this entity; can be null</admap> <campaign_acceptance>how the entity accepts new orders, manually or automatically</campaign_acceptance> <parent_campaign_acceptance>how the entity accepts new orders from its parent entity, manually or automatically</parent_campaign_acceptance> <parent_id>The numerical ID of the parent entity</parent_id> <marketplaces_availability>The availability for the marketplaces</marketplaces_availability> <domain_policy>The permission policy for domains.</domain_policy> <inte_truste_id>Truste numerical ID</inte_truste_id> <inte_evidon_client_id>Evidon Client ID</inte_evidon_client_id> <inte_evidon_campaign_id>Evidon Campaign ID</inte_evidon_campaign_id> <inte_proximic_enabled>yes|no</inte_proximic_enabled> <business_type> The business type</business_type> <inte_afine_line_item_id>Afine line item ID</inte_afine_line_item_id> <inte_safecount_campaign_id>Safecount campaign ID</inte_safecount_campaign_id> <inte_safecountin_enabled>yes|no</inte_safecountin_enabled> <inte_aperture_enabled>yes|no</inte_aperture_enabled> <inte_doubleverify_campaign_id>DouleVerify Campaign ID</inte_doubleverify_campaign_id> <inte_doubleverify_client_id> <inte_doubleverify_behavior>R|B|RB</inte_doubleverify_behavior> <inte_adxpose_id>AdXpose ID</inte_adxpose_id> <inte_vizu_campaign_id>Vizu Campaign ID</inte_vizu_campaign_id> <inte_vizu_agency_enabled>yes|no</inte_vizu_agency_enabled> <inte_adsafe_enabled>Adsafe enabled: "yes" | "no"</inte_adsafe_enabled> <inspector_enabled>yes|no</inspector_enabled> <adsource_available>yes|no</adsource_available> <realtime_dashboard_enabled>yes|no</realtime_dashboard_enabled> <rtb_enabled>yes|no</rtb_enabled> <inte_nielsen_client_id>Nielsen Client ID</inte_nielsen_client_id> <inte_nielsen_password>Nielsen password</inte_nielsen_password> <inte_nielsen_api_key>Nielsen API Key</inte_nielsen_api_key> </entity> </entities> ... <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


14 May 2012 Added integrations Align withAPI

25 May 2012 Added auto_retarget, updated status values. Align withAPI

28 May 2012 Removed bid_optimization, moved to/connection/list

Align withAPI

21 July 2012 Added 2 more parameters Align withAPI

30 July 2012 Added 1 more inte parameter Align withAPI

10 September2012 Added 1 more inte parameter Align with

API30 September2012 Added inte_adsafe_enabled Align with

API04 December2012

Added adsource_available,realtime_dashboard_enabled

Align withAPI

08 January 2013 Added rtb_enabled Align withAPI

Method Name: /entity/resolve/name

Method Description

Simple method that returns the entity name of a given entity ID. You can specifymultiple entity IDs, separated by comma (,).

Parameters





entity_id yes integer

The entity'sID for whichtheorganizationname will bereturned.

entity_id=788

Return <liverailapi requested="/entity/resolve/name" api_version="X.Y.Z"> <entities> <entity> <entity_id>entity's ID</entity_id> <organization>entity's organization name</organization> </entity> .... </entities> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/list/bychar

Method Description

List all the available entities by char.

Parameters





Return <liverailapi requested="/entity/list/bychar" api_version="X.Y.Z"> <list> <no>number</no> <char>char</char> </list> ... <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/add

Method Description

Demand side entities must contain child “sites”, or destinations for advertisers’campaigns. These site entities are required for assigning to order line items duringthe trafficking process. Creating a new Site causes the Site to become a childentity of the Network account.

Related Methods

There are 2 related methods for this method:

/entity/network/type/list

/entity/publisher/category/list

Parameters



token yes string Authentication sessiontoken (received after /login). token=f5a81cdde43c6334feffcfc13ad53717

organization yes string The name of the new entity. organization=test123

business_type yes enum

The business type of theentity. The accepted valuesare: "advertiser", "agency","trading_desk", "dsp","ad_network","vertical_content_network","publisher","marketplace_buyer","lrc_seller".

business_type=lrc_seller

perspective no string

The new entity can beeither another network orpublisher entity ( thesupported values are N(network), P (publisher), Aand M (market) ). If notgiven, it defaults to N.

perpective=P

address no string The entity's mailing address address example

contact_email no string

A contact email address oraddresses. Multipleaddresses can be used,separated by comma. Thisparameter is optional. If thespecified value is"LR_API_NULL", theintegration will be cleared.

[email protected]

hosted no 0 / 1

Specify if the entity ishosted with LiveRail or not.The accepted values are 1or 0, with the default valuebeing 1.

hosted=0

status no stringThe accepted values are"active" | "trial" | "paused" |"cancelled" , with the defaultvalue being "active".

status=trial

inspector_enabled no enum

The accepted values are"yes" | "no" with the defaultvalue being "null". Thisparameter is optional andavailable only to root users.

inspector_enabled=yes

domain_policy no enumThe accepted values are"allow" | "deny" with thedefault value being "deny".This parameter is optional.

domain_policy=allow

description no string The description of the entity description=This entity is newly created.

type no stringThe type of the entity. Inorder to get the availabletypes please use/entity/network/type/list

type=xyz

site_url no string The site url. url=www.testentity.com

category_id no stringThe category of the entity.In order to get the availablecategories please use/entity/publisher/category/list

category_id=777

admap no stringSpecify the existing AD mapfor this entity; it can also benull.

admap=xyz

connect_to_parent no 0 / 1Connect the entity to parent.The accepted values are 1or 0, with the default valuebeing 1.

connect_to_parent=0

parent_id no integerThe numerical ID for theparent entity. This parent_id=5478

parameter is optional.

built_in no 0 / 1

Specify if the entity isconsidered as a 3rd partyad source or not. Theaccepted values are 1 or 0,with the default value being0.

built_in=1

campaign_acceptance no enum

Specify how will the entityaccept new orders:manually or automatically.The accepted values are:automatically |automatically_1h |automatically_24h |manually . The default valueis "automatically".

campaign_acceptance=manually

parent_campaign_acceptance no enum

Specify how will the entityaccept new orders from itsparent entity: manually orautomatically. The acceptedvalues are: automatically |automatically_1h |automatically_24h |manually . The default valueis "automatically".

parent_campaign_acceptance=manually

has_truste no enum

Specify is the entity hasTruste integration. Theaccepted values are "yes" or"no".The default value isnull.

has_truste=yes

has_evidon no enum

Specify is the entity hasEvidon integration. Theaccepted values are "yes" or"no".The default value isnull.

has_evidon=yes

has_proximic no enum

Specify is the entity hasProximic integration. Theaccepted values are "yes" or"no".The default value isnull.

has_proximic=yes

has_affine no enum

Specify is the entity hasAffine integration. Theaccepted values are "yes" or"no".The default value isnull.

has_affine=yes

has_safecount no enum

Specify is the entity hasSafeCount integration. Theaccepted values are "yes" or"no".The default value isnull.

has_safecount=yes

has_aperture no enum

Specify is the entity hasAperture integration. Theaccepted values are "yes" or"no".The default value isnull.

has_aperture=yes

has_doubleverify no enum

Specify is the entity hasDoubleVerify integration.The accepted values are"yes" or "no".The defaultvalue is null.

has_doubleverify=yes

has_adxpose no enum

Specify is the entity hasAdXpose integration. Theaccepted values are "yes" or"no".The default value isnull.

has_expose=yes

has_vizu no enumSpecify is the entity has Vizuintegration. The acceptedvalues are "yes" or "no".Thedefault value is null.

has_vizu=yes

has_adsafe no enum

Specify is the entity hasAdSafe integration. Theaccepted values are "yes" or"no".The default value isnull.

has_adsafe=yes

has_nielsen no enum

Specify is the entity hasNielsen integration. Theaccepted values are "yes" or"no".The default value isnull.

has_nielsen=yes

has_exelate no enum

Specify is the entity hasExelate integration. Theaccepted values are "yes" or"no".The default value isnull.

has_exelate=yes

has_lotame no enum

Specify is the entity hasLotame integration. Theaccepted values are "yes" or"no".The default value isnull.

has_lotame=yes

Control the availability of thead sources. When set to

adsource_available no enum

"no", the following actions:creation and editing of adsource connection,scenarios and price floorrules are not possible. Theaccepted values are "yes"and "no", with the defaultvalue being "yes". Thisparameter is available onlyto the root users.

adsource_available=no

realtime_dashboard_enabled no enum

Control the visibility of realtime analytics. Theaccepted values are "yes"and "no", with the defaultvalue being "no". Thisparameter is available onlyto the root users.

realtime_dashboard_enabled=yes

rtb_enabled no enum

Control the Real TimeBidding. The acceptedvalues are "yes" and "no",with the default value being"yes". This parameter isavailable only to the rootusers.

rtb_enabled=no

Return <liverailapi requested="/entity/add" api_version="X.Y.Z"> <entity_id>the numeric ID of the newly created entity</entity_id> <my_campaigns_connection_id>self-connection as a publisher for the newly created entity</my_campaigns_connection_id> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History



25 May 2012 Updated status with cancelled. Align withAPI

28 May 2012 Removed bid_optimization, moved to/connection/add

Align withAPI

21 July 2012 Added 2 more inte parameters Align withAPI




API04 December2012


Align withAPI


Method Name: /entity/edit

Method Description

Edit the details of a given entity.

Related Methods


/entity/network/type/list

/entity/publisher/category/list

Parameters



token yes string Authentication session token(received after /login). token=f5a81cdde43c6334feffcfc13ad53717

entity_id yes integer The numerical ID of theentity to be edited. entity_id=788

organization no string The new name of the entity. organization=test123

perspective no string

The new perspective for theentity ( the supported valuesare N, P, A and M). Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

perpective=P

address no string The entity's new mailingaddress address example

contact_email no string

A contact email address oraddresses. Multipleaddresses can be used,separated by comma. Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way. If thespecified value is"LR_API_NULL", theintegration will be cleared.

[email protected]

hosted no 0 / 1

Specify if the entity is hostedwith LiveRail or not. Theaccepted values are 1 or 0.This parameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

hosted=0

status no string

The new status of the entity.The accepted values are"active" | "trial" | "paused" |"cancelled". This parameteris optional, meaning that, ifnot given, the parametervalue is not altered in anyway.

status=trial

inspector_enabled no enum

The accepted values are"yes" | "no". This parameteris optional, meaning that, ifnot given, the parametervalue is not altered in anyway. It is available only toroot users.

inspector_enabled=yes

The accepted values are"allow" | "deny" This

domain_policy no enum parameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

domain_policy=allow

description no string The new description of theentity description=This entity is newly created.

type no string

The new type of the entity. Inorder to get the availabletypes please use/entity/network/type/list. Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

type=xyz

site_url no string

The new site url. Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

url=www.testentity.com

category_id no string

The new numerical IDcategory of the entity. Inorder to get the availablecategories please use/entity/publisher/category/list.This parameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

category_id=777

admap no string

Specify the existing AD mapfor this entity. This parameteris optional, meaning that, ifnot given, the parametervalue is not altered in anyway.

admap=xyz

connect_to_parent no 0 / 1

Connect the entity to parent.The accepted values are 1or 0. This parameter isoptional, meaning that, if notgiven, the parameter value isnot altered in any way.

connect_to_parent=0

parent_id no integer

The numerical ID for theparent entity. This parameteris optional, meaning that, ifnot given, the parametervalue is not altered in anyway.

parent_id=6584

built_in no 0 / 1

Specify if the entity isconsidered as a 3rd party adsource or not. The acceptedvalues are 1 or 0. Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

built_in=1

campaign_acceptance no enum

Specify how will the entityaccept new orders: manuallyor automatically. Theaccepted values are:automatically |automatically_1h |automatically_24h | manually. This parameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

campaign_acceptance=manually

parent_campaign_acceptance no enum

Specify how will the entityaccept new orders from itsparent entity: manually orautomatically. The acceptedvalues are: automatically |automatically_1h |automatically_24h | manually

parent_campaign_acceptance=manually

. This parameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

marketplaces_availability no set

Specify the availability formarketplaces. Possiblevalues are: "available","unavailable". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

marketplaces_availability=available

domain_policy no set

Specify the domainpermission policy. Possiblevalues are: "allow", "deny".This parameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

domain_policy=allow

has_truste no enum

Specify is the entity hasTruste integration. Theaccepted values are "yes" or"no". The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_truste=yes

has_evidon no enum

Specify is the entity hasEvidon integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_evidon=yes

has_proximic no enum

Specify is the entity hasProximic integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_proximic=yes

has_affine no enum

Specify is the entity hasAffine integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_affine=yes

has_safecount no enum

Specify is the entity hasSafeCount integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_safecount=yes

has_aperture no enum

Specify is the entity hasAperture integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is not

has_aperture=yes

altered in any way.

has_doubleverify no enum

Specify is the entity hasDoubleVerify integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_doubleverify=yes

has_adxpose no enum

Specify is the entity hasAdXpose integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_expose=yes

has_vizu no enum

Specify is the entity has Vizuintegration. The acceptedvalues are "yes" or "no".Theaccepted values are "yes" or"no". This parameter isoptional, meaning that, if notgiven, the parameter value isnot altered in any way.

has_vizu=yes

has_adsafe no enum

Specify is the entity hasAdSafe integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_adsafe=yes

has_nielsen no enum

Specify is the entity hasNielsen integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_nielsen=yes

has_exelate no enum

Specify is the entity hasExelate integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_exelate=yes

has_lotame no enum

Specify is the entity hasLotame integration. Theaccepted values are "yes" or"no".The accepted valuesare "yes" or "no". Thisparameter is optional,meaning that, if not given,the parameter value is notaltered in any way.

has_lotame=yes

adsource_available no enum

Control the availability of thead sources. When set to"no", the following actions:creation and editing of adsource connection,scenarios and price floorrules are not possible. Theaccepted values are "yes"and "no".This parameter is

adsource_available=no

optional, meaning that, if notgiven, the parameter value isnot altered in any way. Thisparameter is available onlyto the root users.

realtime_dashboard_enabled no enum

Control the visibility of realtime analytics. The acceptedvalues are "yes" and "no".This parameter is optional,meaning that, if not given,the parameter value is notaltered in any way. Thisparameter is available onlyto the root users.

realtime_dashboard_enabled=no

rtb_enabled no enum

Control the Real TimeBidding. The acceptedvalues are "yes" and "no".This parameter is optional,meaning that, if not given,the parameter value is notaltered in any way. Thisparameter is available onlyto the root users.

rtb_enabled=no

Return <liverailapi requested="/entity/edit" api_version="X.Y.Z"> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History



25 May 2012 Updated status with cancelled. Align withAPI

28 May 2012 Removed bid_optimization, moved to/connection/edit

Align withAPI

21 July 2012 Added 2 more inte parameters Align withAPI




API04 December2012


Align withAPI


Method Name: /entity/delete

Method Description

Deletes an existing entity.

Parameters





entity_id yes integerThe numericID of theentity to bedeleted.

entity_id=788

Return <liverailapi requested="/entity/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/exchange/list

Method Description

Returns the LRC entity.

Parameters





Return <liverailapi requested="/entity/exchange/list" api_version="X.Y.Z"> <exchange> <entity_id>the id of LRC</entity_id> <parent_id>null if the entity is a root entity, parent's entity ID otherwise</parent_id> ... </exchange> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/publisher/category/list

Method Description

Returns the list of available category id(s).

Parameters





Return <liverailapi requested="/entity/publisher/category/list" api_version="X.Y.Z"> <exchange> <categories> <category> <id>the id of the category</id> <name>the name of the category</name> </category> ... </categories> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/network/type/list

Method Description

Lists the type(s) of entities.

Parameters





Return <liverailapi requested="/entity/network/type/list" api_version="X.Y.Z"> <types> <type> <id>the type</id> <enabled_in>flag that tells if IN orders are supported; can be 0 or 1</enabled_in> <enabled_ov>flag that tells if OV orders are supported; can be 0 or 1</enabled_ov> </type> ... </types> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/network/type/list

Method Description

Lists the type(s) of entities.

Related Methods

Network type retrieval:

To get the available network types, please use this link

Parameters



token yes stringAuthentication sessiontoken (received after/login).


type yes stringThe type of the entity.To get the availabletypes please use/entity/network/type/list

type=ABCD

Return <liverailapi requested="/entity/network/type/list" api_version="X.Y.Z"> <parameters> <parameter> <type>the type of the entity</type> <code>the code of the parameter</code> <name>the name of the parameter</name> <description>the description of the parameter</description> <value_type>the type of the parameter</value_type> <required>flag that tells you if the parameter is required or not; if this flag is 1 then the parameter is required, if it's 0, the parameter is optional</required> </parameter> </parameters> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/integration/get

Method Description

Retrieve the available integrations for an entity.

Parameters





entity_id yes string

The numericalID of the entityfor which theintegrationsare listed.

entity_id=7665

Return <liverailapi requested="/entity/integration/get" api_version="X.Y.Z"><integrations> <integration> <entity_id>The entity ID</entity_id> <has_vizu>yes|no</has_vizu> <has_adxpose>yes|no</has_adxpose> <has_doubleverify>yes|no</has_doubleverify> <has_aperture>yes|no</has_aperture> <has_safecount>yes|no</has_safecount> <has_affine>yes|no</has_affine> <has_evidon>yes|no</has_evidon> <has_truste>yes|no</has_truste> <has_proximic>yes|no</has_proximic> <has_adsafe>yes|no</has_adsafe> <has_nielsen>yes|no</has_nielsen> <has_exelate>yes|no</has_exelate> <has_lotame>yes|no</has_lotame> </integration></integrations><user>..</user><auth>...</auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History

Date Description Reason22.01.2013 Updated parameters in xml Align with API

USERS

All the methods related to users are displayed here.

/user/add/user/edit/user/list/user/delete/user/settings/set/user/settings/get

Method Name: /user/list

Method Description

List the users currently connected to the current selected entity or attached toanother entity.

Parameters





entity_id yes string

The numerical IDof the entity forwhich the userswill be listed. Ifyou have multipleid(s) you canmake a single callby glueing themtogether with | or ,This method willnot return usersthat have"inherited"rights on theentity, but onlyusers that haveDIRECT rightson it.


user_id no integer

The numerical IDof the user to bereturned. If youhave multiple id(s)you can make asingle call byglueing themtogether with | or ,

user_id = 1|7|120 or user_id = 1,7,120

name no string

Optional, thename of the userfor which thedetails arereturned.,

name=User123

email no string

Optional, theemail of the userfor which thedetails arereturned.

[email protected]

not_like_role no string

Optional, specifythe user's role forwhich the detailsare NOTreturned.

not_like_role=admin

accept_emails no enum

Optional, searchbased on theemail acceptanceof the user. Theaccepted valuesare "yes", "no".

accept_emails=yes

start_string no stringRun the searchbased on theusers's first part start_string=Tel

of the name.

search_string no string

Optional, returnonly the userswith the namethat are LIKE%search_string%.

search_string=cro

limit no integerLimit the numberof results forpagination(s).

limit=10

offset no integer

The offset fromwhere the limitshould be applied( if you display 10users per pageand you need toget the 3rd pageyou should setoffset to 20 andlimit to 10 ). Thisparametershouldn't be givenwithout giving thelimit parameter aswell.

offset=20

Return

<liverailapi requested="/user/list" api_version="X.Y.Z"> <users> <user> <id>user's ID</id> <name>user's full name</name> <email>user's email / login name</email> <timezone>user's timezone (GMT offset)</timezone> <accept_emails>yes or no, send or don't send e-mails to this user</accept_emails> <admin>0|1</admin> <entity_id></entity_id> <role>user's account role</role> </user> ... </users> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

Change History


Method Name: /user/add

Method Description

Adds a new user or attaches an existing one to the current selected entity.

Parameters


Name Required Type Overview Examplename yes string The user's login name. name=bbb

email yes string User's email address, used asa login name too. [email protected]

password yes stringMD5 hash format of the user'sclear-text password. Mustcontain at least 5 characters.

password=???

role no string

User's account role on thecurrent entity; admin -administrator, cust-rw -customer read-write, cust-ro -customer read-only. Thedefault value is "null"

role=cust-rw

timezone no float


timezone=5

admin no enum


admin=1

commision no float


commision

accept_emails no string


accept_emails=no

status no enumUser's status. The possiblevalues are: active, trial. Thedefault value is "active"."

status=trial

Return

<liverailapi requested="/user/add" api_version="X.Y.Z"> <user_id>the user ID of the newly created user</user_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ... returned only if status is fail.

Change History


Method Name: /user/edit

Method Description

Adds a new user or attaches an existing one to the current selected entity. Note:to change the password for an user, use /user/recover/init followed by/user/recover.

Parameters





user_id yes stringThenumerical IDof the user tobe edited.

user_id=564

name no string

The user'slogin name.Thisparameter isoptional,meaning that,if not given,the parametervalue is notaltered in anyway.

name=bbb

email no string

User's emailaddress, usedas a loginname too.Thisparameter isoptional,meaning that,if not given,the parametervalue is notaltered in anyway.

[email protected]

string

MD5 hashformat of theuser's clear-textpassword.Must containat least 5characters.

password no string Thisparameter isoptional,meaning that,if not given,the parametervalue is notaltered in anyway.

password=???

timezone no float

User'stimezone.Thisparameter isoptional,meaning that,if not given,the parametervalue is notaltered in anyway.

timezone=4

accept_emails no enum

Specify if thenew user willaccept emailsor not. Theacceptedvalues are"yes" , "no".Thisparameter isoptional,meaning that,if not given,the parametervalue is notaltered in anyway.

accept_email=yes

admin no enum

Specify if thenew user willbe admin ornot. Theacceptedvalues are "0", "1". Thisparameter isoptional,meaning that,if not given,the parametervalue is notaltered in anyway.

admin=1

enum

User's status.The possiblevalues are:active, trial.Thisparameter is

status no enum optional,meaning that,if not given,the parametervalue is notaltered in anyway.

status=active

Return

<liverailapi requested="/user/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ... returned only if status is fail.

Change History


Method Name: /user/delete

Method Description

Delete an existing user.

Warning: from the customer's perspective, this method has the sameeffect as /user/detach.

Parameters





user_id yes integerThe numericID of the userto be deleted.

user_id = 1752

Return

<liverailapi requested="/user/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

Change History


Method Name: /user/recover

Method Description

Change the password of an existing user.

Parameters





email yes stringUser's emailaddress, usedas a loginname too.

[email protected]

password yes string

MD5 hashformat of theuser's clear-textpassword.Must containat least 5characters.

password=???

hash yes string

Theauthorizationhash which ispart of theresetpasswordlink; last blockof charactersfrom the URI.

hash=ext

Return

<liverailapi requested="/user/recover" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ... returned only if status is fail.

Change History

Date Description Reason23 February 2012 Method added Method added in API.

Method Name: /user/recover/init

Method Description

Request a new password for an existing user. An e-mail with a confirmation linkwill be sent to the user.

Parameters





email yes string

The e-mailaddress of theuser for whichyou want tochange thepassword.

[email protected]

Return

<liverailapi requested="/user/recover/init" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ... returned only if status is fail.

Change History

Date Description Reason23 February 2012 Method added Method added in API.

Method Name: /user/settings/set

Method Description

Specify the settings for a particular user's numerical ID.

Parameters



name yes string Specify the name. Names in format "3p_%"are not allowed. name=lrtester

value no string Specify the value. If the value is specified as"LR_API_NULL", this setting will be cleared. value=winter

user_id no string Specify the settings for a particular user'snumerical ID. user_id=5485

Return

<liverailapi requested="/user/settings/set" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


18.01.2012 Method added to APItester/documentation

Method needed to allow 3rd partyintegrations based on settings table.

Method Name: /user/settings/get

Method Description

List the specific user settings.

Parameters



user_id no string Display all the settings attached to a specificuser numerical ID. user_id=5485

name no string Search for the user's exact name. Partialmatches will not be accepted. name=lrtester

Return

<liverailapi requested="/user/settings/get" api_version="X.Y.Z"> <settings> <setting> <user_id>974</user_id> <name>brindusatest</name> <value>the defined value, if any</value> </setting> ... </settings> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


18.01.2012 Method added to APItester/documentation

Method needed to allow 3rd partyintegrations based on settings table.

ENTITY USERS

All the methods related to entity users are displayed here.

/entity/user/list/user/attach/user/detach

Method Name: /entity/user/list

Method Description

Returns the complete list of users that have rights on the given entity.

Parameters





Return <liverailapi requested="/entity/user/list" api_version="X.Y.Z"> <users> <user> <user_id>the id of the user</user_id> <email>the user's email</email> <accept_emails>flag that tells the system if the user accepts emails; can be 'yes' or 'no'</accept_emails> <role>the role of the user</role> <inherited>flag that tells if the role on this entity is inherited from a parent entity or not; can be 1 ( the role is inherited ) or 0 ( the role is specified for this entity )</inherited> </user> ... </users> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /user/attach

Method Description

Attach an existing user to an entity.

Parameters






The numericID of theentity towhich theuser will beattached.

entity_id = 225

user_id yes integerThe numericID of the userto beattached.

user_id = 558

role yes string

User'saccount roleon the entity;admin -administrator,cust-rw -customerread-write,cust-ro -customerread-only

role=admin

Return

<liverailapi requested="/user/attach" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

Change History


Method Name: /user/detach

Method Description

Detach an existing user from an entity.

Parameters






The numericID of theentity fromwhich theuser will bedetached.

entity_id = 225

user_id yes integerThe numericID of the userto bedetached.

user_id = 558

Return

<liverailapi requested="/user/detach" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

Change History


ENTITY CATEGORIES

All the methods related to entity categories are displayed here.

/entity/category/domain/add/entity/category/domain/edit/entity/category/domain/list

Method Name: /entity/category/domain/list

Method Description

List all the available domains for a given entity.

Parameters





entity_id not string

Search for adomain with aspecific numericalID. If you havemultiple id(s) youcan make a singlecall by glueingthem togetherwith | or ,

entity_id=788,333

domain no string

Search for adomain with aspecific name.This paramenteris optional.

domain=context.com

category no stringSearch for acategory with aspecific name.

category=music

domain_search no string

Return only thedomains with thename that areLIKE%search_string%.This paramenteris optional.

domain_searc=cont

category_search no string

Return only thecategories withthe name that areLIKE%search_string%.This paramenteris optional.

category_search=mus

status no stringDisplay thestatus. Thisparamenter isoptional.

status=...

approved_after no DateTime

Return only theentries that arenewer than thespecified dateand time. Thisparamenter isoptional.

approved_after=10.10.2012 00:00:00


Return only thedomains andcategories withthe name that areLIKE%search_string%.

search_string=tras

source no enum

Return only thedomains andcategories withthe specifiedsource. Possiblevalues: "system'"user". Thisparameter isoptional.

source=user

Return only thedomains andcategories withthe specifiedquality. Possiblevalues: "Premium"

quality no string"Prosumer""RON". If youhave multiplevalues, you canmake a single callby glueing themtogether with | or ,This parameter isoptional.

quality=Premium,RON

Return <liverailapi requested="/entity/category/domain/list" api_version="X.Y.Z"> <domains> <domain> <domain_name>The name of the domain</domain_name> <entity_id>The numerical ID of the corresponding entity</entity_id> <categories> <category> <category_id></category_id> <parent_category_id></parent_category_id> <category_name></category_name> </category> ... </categories> <entity_domain_id>The numerical ID of the domain</entity_domain_id> <duration></duration> <autoplay></autoplay> <quality>Premium|Prosumer|RON or NULL</quality> <companions></companions> <audio></audio> <content></content> <floor></floor> <above></above> <player></player> <ts>Start time and date</ts> <approved_ts></approved_ts> <inv></inv> <status>Status of the domain (possible values are: new, pending, approved, not_approved)</status> <pitch>Pitch of the domain</pitch> <avg_daily_inv></avg_daily_inv> <estimate_monthly_volume></estimate_monthly_volume> <ad_unit_types>The ad unit types</ad_unit_types> <platform></platform> <content_duration></content_duration> <content_type></content_type> <player_url></player_url> <min_cpm></min_cpm> <notes></notes> <not_approved_reason></not_approved_reason> <source>system|user</source> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason31 August 2012 New parameter added: source Align with API

Method Name: /entity/category/domain/add

Method Description

Add a new domain for a given entity.

Parameters





entity_id yes integerThe numerical ID ofthe entity to whichthe new domain willbe added.

entity_id=123

name yes string The name of thenew domain. name=testdomain

estimate_monthly_volume_us yes floatThe estimatedmonthly trafficvolume for USA.

estimate_monthly_volume_us=2.23

min_cpm_us_instream yes floatSpecify for USA: theminimum CPMaccepted for thisdomain on Instream.

min_cpm_us_instream=5.1

min_cpm_us_in_banner yes floatSpecify for USA: theminimum CPMaccepted for thisdomain on InBanner

min_cpm_us_in_banner=6.1

min_cpm_us_overlay yes floatSpecify for USA: theminimum CPMaccepted for thisdomain on Overlay.

min_cpm_us_overlay=1.2

player_url yes string Specify the playerurl. player_url=www.test.com

ad_unit_types yes set

Specify the type ofthe Ad unit.Accepted valuesare: "preroll" |"midroll" | "postroll".

ad_unit_types=midroll

placement yes set

Specify theplacement of the Ad.Accepted valuesare: Acceptedvalues are: "In-Stream" | "overlay" |"In-Banner","Interstitial".

placement=In-Banner

above yes set

Specify if the playeris above or belowthe fold. Theaccepted valuesare: "yes" | "no".

above=no

companions yes set

Specify the size ofthe companions.The acceptedvalues are: "728x90"| "300x600" |"300x250"|"160x600" |"180x150".

companions="728x90"

Specify the type of

autoplay yes set

the video contentplay: autoplay oruser-initiated. Theaccepted values:are "Auto Play" |"Click to Play".

autoplay=Auto Play

audio yes set

Specify whether thevideo content willinitiate with audio onor off. The acceptedvalues are: "sound-on" | "sound-off".

audio=sound-on

category_id yes integer

The numeric ID ofthe category (s) towhich the newdomain will beadded. A warningmessage* will begiven if one or moreof the numerical IDsis incorrect. If all IDsare incorrect, thedomain will not beadded. Multiple IDscan be specified,separated by pipe (| ).

category_id=123

content_duration yes set

Specify the contentduration on thewebsite. Theaccepted valuesare: "short" | "long" |"game" | "live".

content_duration=live

duration yes set

Specify themaximum video adduration limit inseconds. Theaccepted valuesare: "15" | "30" | "60"| "no_limit".

duration=60

pitch no string The pitch pitch=???avg_daily_inv no string ... avg_daily_inv=???

estimate_monthly_volume_non_us no floatSpecify for others:the estimatedmonthly trafficvolume.

estimate_monthly_volume_non_us=4.2

estimate_monthly_volume_uk no floatSpecify for UnitedKingdom: theestimated monthlytraffic volume.

estimate_monthly_volume_uk=4.2

estimate_monthly_volume_au no floatSpecify for Australia:the estimatedmonthly trafficvolume.


estimate_monthly_volume_ca no floatSpecify for Canada:the estimatedmonthly trafficvolume.

estimate_monthly_volume_ca=4.2

targeting_strengths no setThe targetaudience. Acceptedvalues are: "male" |"female".

targeting_strengths=male

other_platform no set

Specify the platform,if operating on otherplatforms. Theaccepted valuesare: "iptv", "mobile","game", "tv".

other_platform=tv

Specify the video

platform no set

playertechnology/platformthe site operates on.The acceptedvalues are:"Brightcove","Castfire", "Delve","FlowPlayer", "JWPlayer", "Kaltura","Kickapps", "OMSF","Ooyala","ThePlatform","Twistage", "UnicornMedia", "Viddler","Custom AS3Player(LiveRailIntegration)","Custom AS3Player(VASTCompliant)","Custom AS3Player(VAST+VPAIDCompliant)","Custom HTML5Player", "Interstitial".

platform=Ooyala

player no set

Specify the video orgame playerwidth(s). Theaccepted valuesare: "small" (300 to480) | "medium"(480 to 640) |"large" (640 andabove).

player=small

aspect_ratio no set

Specify the video orgame player aspectratio(s). Theaccepted valuesare: "16:9" | "4:3".

aspect_ratio=16:9

restricted_advertising no string

Specify therestricted types ofadvertising,advertisers, ornetworks. Theaccepted valuesare: 'Alcohol','DietarySupplements','Firearms', 'Land-based Casinos','Online Gambling','Political','Prescription Drugs','Religion', 'SexualContent','SweepstakesContests', 'Tobacco','Violence','InteractiveAds (VPAID)'

restricted_advertising=Political

min_cpm_uk_instream no float

Specify for UnitedKingdom: theminimum CPMaccepted for thisdomain on Instream.

min_cpm_uk_instream=7.2

min_cpm_uk_overlay no float

Specify for UnitedKingdom: theminimum CPMaccepted for thisdomain on Overlay.

min_cpm_uk_overlay=7.2

Specify for United

min_cpm_uk_in_banner no floatKingdom: theminimum CPMaccepted for thisdomain on InBanner.

min_cpm_uk_in_banner=7.2

min_cpm_au_instream no floatSpecify for Australia:the minimum CPMaccepted for thisdomain on Instream.

min_cpm_au_instream=7.2

min_cpm_au_overlay no floatSpecify for Australia:the minimum CPMaccepted for thisdomain on Overlay.

min_cpm_au_overlay=7.2

min_cpm_au_in_banner no floatSpecify for Australia:the minimum CPMaccepted for thisdomain on InBanner.

min_cpm_au_in_banner=7.2

min_cpm_ca_instream no floatSpecify for Canada:the minimum CPMaccepted for thisdomain on Instream.

min_cpm_ca_instream=7.2

min_cpm_ca_overlay no floatSpecify for Canada:the minimum CPMaccepted for thisdomain on Overlay.

min_cpm_ca_overlay=7.2

min_cpm_ca_in_banner no floatSpecify for Canada:the minimum CPMaccepted for thisdomain on InBanner.

min_cpm_ca_in_banner=7.2

min_cpm_other_instream no floatSpecify for others:the minimum CPMaccepted for thisdomain on Instream.

min_cpm_other_instream=7.2

min_cpm_other_overlay no floatSpecify for others:the minimum CPMaccepted for thisdomain on Overlay.

min_cpm_other_overlay=7.2

min_cpm_other_in_banner no floatSpecify for others:the minimum CPMaccepted for thisdomain on InBanner.

min_cpm_other_in_banner=7.2

Return <liverailapi requested="/entity/category/domain/add" api_version="X.Y.Z"> *<warnings> <warning>The numerical ID of the invalid category</warning> </warnings> <entity_domain_id>The numerical ID of the newly created domain</entity_domain_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/category/domain/edit

Method Description

Edit an existing domain for a given entity.

Parameters





entity_domain_id yes integerThe numerical ID ofthe entity to whichthe new domain willbe added.

entity_domain_id=123456

name no string The name of thenew domain. name=testdomain

estimate_monthly_volume_us no floatThe estimatedmonthly trafficvolume for USA.

estimate_monthly_volume_us=2.23

min_cpm_us_instream no floatSpecify for USA: theminimum CPMaccepted for thisdomain on Instream.

min_cpm_us_instream=5.1

min_cpm_us_in_banner no floatSpecify for USA: theminimum CPMaccepted for thisdomain on InBanner

min_cpm_us_in_banner=6.1

min_cpm_us_overlay no floatSpecify for USA: theminimum CPMaccepted for thisdomain on Overlay.

min_cpm_us_overlay=1.2

player_url no string Specify the playerurl. player_url=www.test.com

ad_unit_types no set

Specify the type ofthe Ad unit.Accepted valuesare: "preroll" |"midroll" | "postroll".

ad_unit_types=midroll

placement no set

Specify theplacement of the Ad.Accepted valuesare: Acceptedvalues are: "In-Stream" | "overlay" |"In-Banner","Interstitial".

placement=In-Banner

above no set

Specify if the playeris above or belowthe fold. Theaccepted valuesare: "no" | "no".

above=no

companions no set

Specify the size ofthe companions.The acceptedvalues are: "728x90"| "300x600" |"300x250"|"160x600" |"180x150".

companions="728x90"

Specify the type of

autoplay no set

the video contentplay: autoplay oruser-initiated. Theaccepted values:are "Auto Play" |"Click to Play".

autoplay=Auto Play

audio no set

Specify whether thevideo content willinitiate with audio onor off. The acceptedvalues are: "sound-on" | "sound-off".

audio=sound-on

category_id no integer

The numeric ID ofthe category (s) towhich the domainwill be added. Awarning message*will be given if oneor more of thenumerical IDs isincorrect. If all IDsare incorrect, thedomain will not beadded. Multiple IDscan be specified,separated by pipe (| ).

category_id=123

content_duration no set

Specify the contentduration on thewebsite. Theaccepted valuesare: "short" | "long" |"game" | "live".

content_duration=live

duration no set

Specify themaximum video adduration limit inseconds. Theaccepted valuesare: "15" | "30" | "60"| "no_limit".

duration=60

pitch no string The pitch pitch=???avg_daily_inv no string ... avg_daily_inv=???

estimate_monthly_volume_non_us no floatSpecify for others:the estimatedmonthly trafficvolume.

estimate_monthly_volume_non_us=4.2

estimate_monthly_volume_uk no floatSpecify for UnitedKingdom: theestimated monthlytraffic volume.


estimate_monthly_volume_au no floatSpecify for Australia:the estimatedmonthly trafficvolume.


estimate_monthly_volume_ca no floatSpecify for Canada:the estimatedmonthly trafficvolume.

estimate_monthly_volume_ca=4.2

targeting_strengths no setThe targetaudience. Acceptedvalues are: "male" |"female".

targeting_strengths=male

other_platform no set

Specify the platform,if operating on otherplatforms. Theaccepted valuesare: "iptv", "mobile","game", "tv".

other_platform=tv

Specify the video

platform no set

playertechnology/platformthe site operates on.The acceptedvalues are:"Brightcove","Castfire", "Delve","FlowPlayer", "JWPlayer", "Kaltura","Kickapps", "OMSF","Ooyala","ThePlatform","Twistage", "UnicornMedia", "Viddler","Custom AS3Player(LiveRailIntegration)","Custom AS3Player(VASTCompliant)","Custom AS3Player(VAST+VPAIDCompliant)","Custom HTML5Player", "Interstitial".

platform=Ooyala

player no set

Specify the video orgame playerwidth(s). Theaccepted valuesare: "small" (300 to480) | "medium"(480 to 640) |"large" (640 andabove).

player=small

aspect_ratio no set

Specify the video orgame player aspectratio(s). Theaccepted valuesare: "16:9" | "4:3".

aspect_ratio=16:9

restricted_advertising no string

Specify therestricted types ofadvertising,advertisers, ornetworks. Theaccepted valuesare: 'Alcohol','DietarySupplements','Firearms', 'Land-based Casinos','Online Gambling','Political','Prescription Drugs','Religion', 'SexualContent','SweepstakesContests', 'Tobacco','Violence','InteractiveAds (VPAID)'

restricted_advertising=Political

min_cpm_uk_instream no float

Specify for UnitedKingdom: theminimum CPMaccepted for thisdomain on Instream.

min_cpm_uk_instream=7.2

min_cpm_uk_overlay no float

Specify for UnitedKingdom: theminimum CPMaccepted for thisdomain on Overlay.

min_cpm_uk_overlay=7.2

Specify for United

min_cpm_uk_in_banner no floatKingdom: theminimum CPMaccepted for thisdomain on InBanner.

min_cpm_uk_in_banner=7.2

min_cpm_au_instream no floatSpecify for Australia:the minimum CPMaccepted for thisdomain on Instream.

min_cpm_au_instream=7.2

min_cpm_au_overlay no floatSpecify for Australia:the minimum CPMaccepted for thisdomain on Overlay.

min_cpm_au_overlay=7.2

min_cpm_au_in_banner no floatSpecify for Australia:the minimum CPMaccepted for thisdomain on InBanner.

min_cpm_au_in_banner=7.2

min_cpm_ca_instream no floatSpecify for Canada:the minimum CPMaccepted for thisdomain on Instream.

min_cpm_ca_instream=7.2

min_cpm_ca_overlay no floatSpecify for Canada:the minimum CPMaccepted for thisdomain on Overlay.

min_cpm_ca_overlay=7.2

min_cpm_ca_in_banner no floatSpecify for Canada:the minimum CPMaccepted for thisdomain on InBanner.

min_cpm_ca_in_banner=7.2

min_cpm_other_instream no floatSpecify for others:the minimum CPMaccepted for thisdomain on Instream.

min_cpm_other_instream=7.2

min_cpm_other_overlay no floatSpecify for others:the minimum CPMaccepted for thisdomain on Overlay.

min_cpm_other_overlay=7.2

min_cpm_other_in_banner no floatSpecify for others:the minimum CPMaccepted for thisdomain on InBanner.

min_cpm_other_in_banner=7.2

Return <liverailapi requested="/entity/category/domain/edit" api_version="X.Y.Z"> *<warnings> <warning>The numerical ID of the invalid category</warning> </warnings> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY DOMAIN LIST

All the methods related to entity domain lists are displayed here.

/entity/domain/list/add/entity/domain/list/edit/entity/domain/list/list/entity/domain/list/delete/entity/domain/list/resolve/name/entity/domain/list/clear/list/entity/domain/list/duplicate/list

Method Name: /entity/domain/list/list

Method Description

List the details for one or more domain lists from an entity.

Parameters





entity_domain_list_id yes string

The numericalID(s) of the listsfor which thedetails will belisted. If you havemultiple ID(s) youcan make a singlecall by glueingthem togetherwith | or ,

entity_domain_list_id=11,35

list_name no string Search based onthe list name. list_name=test123000

entity_id no integer Search based onthe entity_id entity_id=8765


Return only thedomain lists withthe name that areLIKE%search_string%.

search_string=test

Return <liverailapi requested="/entity/domain/list/list" api_version="x.y.z"> <domain_lists> <domain_list> <entity_domain_list_id>The numerical ID of the list </entity_domain_list_id> <entity_id>The numerical ID of the entity </entity_id> <list_name>The name of the list</list_name> <description>The description of the list</description> <domain_count>Number or domains</domain_count> </domain_list> </domain_lists> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason02.10.2012 Added search_string Align with API

Method Name: /entity/domain/list/add

Method Description

Add a new domain list to an entity.

Parameters





list_name yes stringThe name ofthe newdomain list.

list_name=test123

description no stringThedescription ofthe domainlist

description=a test list

entity_id no string

The numericID of theentity towhich thedomain listwill be added

entity_id=452

Return <liverailapi requested="/entity/domain/list/add" api_version="X.Y.Z"> <entity_domain_list_id>The numerical ID of the newly created list.</entity_domain_list_id> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/list/edit

Method Description

Edits a domain list.

Parameters





entity_domain_list_id yes stringThenumerical IDof the list tobe edited.

entity_domain_list_id=11

list_name no string

The newname of thelist. Thisparameter ismandatory ifthere is nonewdescriptionspecified.

list_name=test123000

description no string

The newdescription ofthe list. Thisparameter ismandatory ifthere is nonewlist_namespecified.

description=another test list

Return <liverailapi requested="/entity/domain/list/edit" api_version="X.Y.Z"> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Method Name: /entity/domain/list/delete

Method Description

Delete a domain list.

Parameters





entity_domain_list_id yes stringThenumerical IDof the list tobe deleted.


Return <liverailapi requested="/entity/domain/list/delete" api_version="x.y.z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/list/resolve/name

Method Description

Return the list name based on its numerical ID.

Parameters






Specify thenumericalID(s) of thelist for whichthe name willbe returned. Ifyou havemultiple ID(s)you can makea single callby glueingthem togetherwith | or ,

entity_domain_list_id = 1|7|120 orentity_domain_list_id = 1,7,120

Return <liverailapi requested="/entity/domain/list/resolve/name" api_version="x.y.z"> <domain_lists> <domain_list> <entity_domain_list_id>The numerical ID of the list</entity_domain_list_id> <list_name>The name of the list</list_name> </domain_list> </domain_lists> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/clear/list

Method Description

Delete all the domains from a domain list.

Parameters






Thenumerical IDof the list thatwill becleared.


Return <liverailapi requested="/entity/domain/clear/list" api_version="x.y.z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/list/duplicate/list

Method Description

Duplicate the list, including all its domains.

Parameters





entity_domain_list_id yes stringThenumerical IDof the list tobe duplicated.


Return <liverailapi requested="/entity/domain/list/duplicate/list" api_version="x.y.z"> <domain_list> <entity_domain_list_id>The numerical ID of the duplicate list.</entity_domain_list_id> </domain_list> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY DOMAIN LIST DOMAINS

All the methods related to entity domain list domains are displayed here.

/entity/domain/list/domain/add/entity/domain/list/domain/list/entity/domain/list/domain/delete

Method Name: /entity/domain/list/domain/list

Method Description

List the details for one or more domains from one or more list(s) in an entity.

Parameters






The numerical ID(s)of the lists for whichthe details will belisted. If you havemultiple ID(s) youcan make a singlecall by glueing themtogether with | or , (examples: if youneed to get theinformation for listID(s) 1, 7 and 120you can useentity_domain_list_id= 1|7|120 orentity_domain_list_id= 1,7,120 ).


domain_name no string Search based on thedomain name. domain_name=test123.com

search_string no stringReturn only thedomains with thename that are LIKE%search_string%.

domain_name=test123

Return <liverailapi requested="/entity/domain/list/domain/list" api_version="X.Y.Z"> <domains> <domain> <entity_domain_list_id>The numerical ID of the list </entity_domain_list_id> <domain_name>The name of the domain</domain_name> </domain> ... </domains> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Method Name: /entity/domain/list/domain/add

Method Description

Add one or more new domain(s) to a list of domains on an entity.

Parameters





entity_domain_list_id yes stringThe numerical ID of the listto which the new domain(s)is(are) added.


domain_name yes string

The name of the domain(s)to be added on the list. Ifyou have multiple domainsyou can make a single callby glueing them togetherwith | or , (examples: if youneed to add the followingdomains test1.ro, test2.comand test2.net you can usedomain_name =test1.ro|test2.com|test2.netor domain_name =test1.ro,test2.com,test2.net)

domain_name=test123.com

Return <liverailapi requested="/entity/domain/list/domain/add" api_version="X.Y.Z"> <inserted_domains>The number of the domains inserted</inserted_domains> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/list/domain/delete

Method Description

Delete one or more new domain(s) from a list of domains on an entity.

Parameters





entity_domain_list_id yes stringThe numerical ID of the listfrom which the domain(s)is(are) removed.


domain_name yes string

The name of the domain(s)to be deleted from the list. Ifyou have multiple domainsyou can make a single callby glueing them togetherwith | or , (examples: if youneed to delete the followingdomains test1.ro, test2.comand test2.net you can usedomain_name =test1.ro|test2.com|test2.netor domain_name =test1.ro,test2.com,test2.net)

domain_name=test123.com

Return <liverailapi requested="/entity/domain/list/domain/delete" api_version="X.Y.Z"> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY DOMAIN GEO

All the methods related to Entity Domain Geo are displayed here.

/entity/domain/geo/list/entity/domain/geo/distinct/vertical/list

Method Name: /entity/domain/geo/list

Method Description

List the distict verticals based on geo entry of a specific domain(s).

Parameters





Search based on the numerical ID ofthe entity. When specified, thegrouping will be done by domain andentity_id. If you have multiple ID(s)you can make a single call by glueingthem together with | or , ( examples: ifyou need to get the information forentity ID(s) 1, 7 and 120 you can useentity_id = 1|7|120 or entity_id =1,7,120 ).

entity_id=687

not_entity_id no integer

All the entity IDs specified here willnot be displayed in the result array. Ifyou have multiple ID(s) you can makea single call by glueing them togetherwith | or , ( examples: if you do notneed to get the information for entityID(s) 3, 18 and 530 you can useentity_id = 3|18|530 or entity_id =3,18,530 ).

not_entity_id=3547,474

vertical_id no integer Search based on vertical ID. vertical_id=18

not_vertical_id no integer

All the vertical IDs specified here willnot be displayed in the result array. Ifyou have multiple ID(s) you can makea single call by glueing them togetherwith | or , ( examples: if you do notneed to get the information for verticalID(s) 3, 18 and 530 you can useno_vertical_id = 3|18|530 ornot_vertical_id = 3,18,530 ).

not_vertical_id=3547,474

domain no string Search based on the domain'scomplete name. domain=test

country_code no string Search based on the domain'scountry code. country_code=RO

not_country_code no string

All the country codes specified herewill not be displayed in the resultarray. If you have multiple code(s)you can make a single call by glueingthem together with | or , ( examples: ifyou do not need to get theinformation for country code(s) US,FR and RO you can usenot_country_code = US|FR|RO ornot_country_code = US,FR,RO ).

not_country_code=DE

region no string Search based on the domain's region. region=CA

not_region no string

All the regions specified here will notbe displayed in the result array. If youhave multiple region(s) you can makea single call by glueing them togetherwith | or , ( examples: if you do notneed to get the information forregion(s) NEWSOUTHWALESARIZONA and CLUJ you can usenot_region =

not_region=CLUJ

NEWSOUTHWALES|ARIZONA|CLUJor not_region =NEWSOUTHWALES,ARIZONA,CLUJ)..

metro no string Search based on the domain's metro. metro=Los Angeles

not_metro no string

All the metros specified here will notbe displayed in the result array. If youhave multiple metro(s) you can makea single call by glueing them togetherwith | or , .

not_metro=NEWYORK

domain_search no stringSearch based on th estring containedby the domain name. The search willbe performed in all entries or only inthe specified entity_id.

domain_search=media

return_type no enum

Specify the return type. Thesupported values are: all (returnsindividual data and summed data),no-total (returns only individual data),total (returns only summed data), big-total (returns only the total groupedby domain), country-aggregation(returns only the aggregated datafrom each country). The default valueis: "all".

return_type=no-total

**There are 3 distinct cases for usageof the entity_id, vertical_id andnon_vertical_id. Assume that entity_id= 1,2,3 vertical_id=10,11,12,13,14,15not_entity_id=4,5. vertical_id 10 and13 are attached to entity_id 1 andvertical_id 10 is also attached toentity_id 2. - When calling onlyentity_id=1,2 the result will displaythe information for entity_id=1 andvertical_id=10,13. - When callingentity_id=1,2,3 and vertical_id are inthe same request, the result willdisplay the information for entity_id=2and vertical_id=10. - When entity_id,vertical_id and not_entity_id are inthe same request, the result willdisplay the information for entity_id=3and not_entity_id=4,5. Whenremoving the entity_id from therequest, the result will displayvertical_id=10,11,12,13,14,15 andnot_entity_id=4,5In addition, the call will automaticallydetect matches between the locationparameters ( country_code, regionand metro ) and instead of simplyusing the conditions glued togetherby ANDs, it will create a condition setglued by ORs which ensures that thedisplayed result will not be generatedby mutually exclusive parts. Countrycodes that do not correspond to theregiond and/or metro will be filteredby the call matching system and onlythe correct matches will be groupedtogether by "AND". For example,specifying the following parameters:country_code=FR,ROregion=CALIFORNIA,CLUJ will triggerthe results from the pair RO andCLUJ, along with the results from FRand the results from CALIFORNIA(grouped by "OR").

Return

<liverailapi requested="/entity/domain/geo/list" api_version="X.Y.Z"> <domains> <domain> <entity_id>The numerical ID of the entity</entity_id> <vertical_id>The numerical ID of the vertical</vertical_id> <data>JSON Array</data> <ts>Time stamp</ts> <domain>The name of the domain.</domain> <country_code>Country Code</country_code> <region>Region</region> <metro>Metro</metro> </domain> ... </domains> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason17 May 2012 Added method into help file Align with API13 July 2012 Added country-aggregation, not- parameters Align with API

Method Name: /entity/domain/geo/distinct/vertical/list

Method Description

List the geo entry of a specific domain(s).

Parameters






Search basedon thenumerical IDof the entity. Ifyou havemultiple ID(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need toget theinformationfor entity ID(s)1, 7 and 120you can useentity_id =1|7|120 orentity_id =1,7,120 ).

entity_id=687

Return <liverailapi requested="/entity/domain/geo/distinct/vertical/list" api_version="X.Y.Z"> <verticals> <vertical> <vertical_id>The numerical ID of the vertical</vertical_id> </vertical> ... </verticals> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason13 July 2012 Added method into help file Align with API

ENTITY DOMAIN FREQUENCY

All the methods related to entity domain frequency are displayed here.

/entity/domain/frequency/list

Method Name: /entity/domain/frequency/list

Method Description

Returns the list of entity domain frequency.

Parameters





entity_domain_id no integerOptionally,the domainID.


Return

<liverailapi requested="/entity/domain/frequency/list" api_version="x.y.z"> <frequencies> <frequency> <entity_domain_frequency_id>Frequency Domain ID</entity_domain_frequency_id> <entity_domain_id>Domain ID</entity_domain_id> <frequency>Numerical value</frequency> <percentage>percentage value</percentage> <ts>2time stamp</ts> </frequency> ...</frequencies><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


ENTITY DOMAIN AUDIENCE

All the methods related to entity domain audience are displayed here.

/entity/domain/audience/add/entity/domain/audience/edit/entity/domain/audience/list/entity/domain/audience/delete

Method Name: /entity/domain/audience/list

Method Description

List the audience entry of a specific domain(s).

Parameters





entity_domain_audience_segment_id yes integer

Search basedon the domainaudiencesegmentnumerical ID.

entity_domain_audience_segment_id=3548

entity_domain_id yes integerSearch basedon the entitydomainnumerical ID


audience_segment_id yes integer

Search basedon theaudiencesegmentnumerical ID.

audience_segment_id=8877655

Return <liverailapi requested="/entity/domain/audience/list" api_version="X.Y.Z"> <entity_domain_audience_segments> <entity_domain_audience_segment> <entity_domain_audience_segment_id>The numerical ID of the entity domain audience segment</entity_domain_audience_segment_id> <entity_domain_id>The numerical ID of the entity domain </entity_domain_id> <audience_segment_id>The numerical ID of the audience segment</audience_segment_id> <percentage>The percentage.</percentage> </entity_domain_audience_segment> ... </entity_domain_audience_segments> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/audience/add

Method Description

Add an entity domain segment entry.

Parameters





entity_domain_id yes integer

Thenumerical IDof the entitydomain forwhich theaudience isadded.



Thenumerical Idof thesegment to beadded.

audience_segment_id=8877655

percentage yes percent ... percentage=76%

Return <liverailapi requested="/entity/domain/data/add" api_version="X.Y.Z"> <entity_domain_audience_segment_id>The numerical ID of the new audience.</entity_domain_audience_segment_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/audience/edit

Method Description

Edits an entity domain segment entry.

Parameters






Thenumerical IDof the entitydomainsegment forwhich theaudience isedited.


percentage no percent ... percentage=76%

Return <liverailapi requested="/entity/domain/data/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/audience/delete

Method Description

Delete an entity domain segment entry.

Parameters






Thenumerical IDof the entitydomainsegment to bedeleted.


Return <liverailapi requested="/entity/domain/data/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY MARKETPLACE

All the methods related to entity marketplace are displayed here.

/entity/marketplace/list/entity/marketplace/margin/list/entity/marketplace/margin/set

Method Name: /entity/marketplace/list

Method Description

Get the list of advertiser(s).

Parameters





Return <liverailapi requested="/entity/marketplace/list" api_version="X.Y.Z"><marketplaces> <marketplace> <entity_marketplace_id>The numeric ID of the marketplace</entity_marketplace_id> <entity_id>The numeric ID of the entity</entity_id> <marketplace_name>The name of the marketplace</marketplace_name> <marketplace_description>Description of the marketplace</marketplace_description> <marketplace_logo>The name of the marketplace's logo</marketplace_logo> <disabled>yes|no</disabled> </marketplace> ...</marketplaces><user>...</user><auth>...</auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History

Date Description Reason17 May 2012 Updated XML response Align with API

Method Name: /entity/marketplace/margin/list

Method Description

Get the list of margin(s).

Parameters





Return <liverailapi requested="/entity/marketplace/margin/list" api_version="X.Y.Z"> <entity_marketplace_margins> <entity_marketplace_margin> <margin></margin> <entity_id>The numeric ID of the entity</entity_id> <organization>The name of the entity</organization> </entity_marketplace_margin> ... </entity_marketplace_margins> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/marketplace/margin/set

Method Description

Set or edit a margin.

Parameters






Thenumerical IDof the entityfor which themargin isset/edited


margin no string

Set the newvalue for themargin (ifanother valueexists already,it will be over-written)

margin=200

Return <liverailapi requested="/entity/marketplace/margin/set" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY VERTICALS

All the methods related to entity verticals are displayed here.

/entity/vertical/add/entity/vertical/edit/entity/vertical/list/entity/vertical/delete/entity/vertical/resolve/name/entity/vertical/publisher/list/entity/vertical/available

Method Name: /entity/vertical/list

Method Description

This method is available only to network entities: list all the verticals for theirpublishers.

Parameters






Search basedon the stringcontained bythe verticalname. Thisparameter isoptional.

search_string=temp

vertical_name no string

Search basedon thecompletevertical name.Thisparameter isoptional.

vertical_name=temporar_vertical

vertical_id no integer

Optional, thenumeric ID ofthe vertical forwhich theinformationwill bereturned. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need toget theinformationfor verticalid(s) 1, 7 and120 you canusevertical_id =1|7|120 orvertical_id =1,7,120 ).

vertical_id=68574

limit no string

Limit thenumber ofresults forpagination(s).Thisparameter isoptional.

limit=10

offset no string

The offsetfrom wherethe limitshould beapplied ( ifyou display10 entities perpage and youneed to getthe 3rd pageyou shouldset offset to20 and limit to10 ). Thisparameter isoptional andshouldn't begiven withoutgiving the limitparameter aswell.

offset=20

return_deleted no string

Acceptedvalues: 0 | 1.If set to 1, willreturn onlythe IDs of thedeletedverticals. Thedefault valueis "0"

return_deleted=1

Return <liverailapi requested="/entity/vertical/list" api_version="X.Y.Z"> <verticals> <vertical> <vertical_id>The numeric ID of the vertical_name</vertical_id> <entity_id>The numeric ID of the entity to which the vertical is linked</entity_id> <vertical_name>The sanitized vertical name. If the name contains non-letter / non-numeric characters, they will be replaced with "_"</vertical_name> </vertical> ... </verticals> <count>The number of verticals</count> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Method Name: /entity/vertical/publisher/list

Method Description

This method is available only to network entities: list all the verticals for theirpublishers.

Parameters





publisher_id no integer

The numericID of thepublisher.Separatemultiplevalues withcomma (,).

publisher_id=75

vertical_id no integer

The numericID of thevertical.Separatemultiplevalues withcomma (,).

vertical_id=77

start_with no string

Run thesearch basedon thevertical's firstpart of thename.

start_with=dom


Run thesearch basedon any part ofthe vertical'sname.

search_string=omain


Run thesearch basedon thevertical'sname.

vertical_name=domain

limit no integerLimit thenumber ofresults forpagination(s).

limit=50

offset no integer

The offsetfrom wherethe limitshould beapplied ( ifyou display10 verticalsper page andyou need toget the 3rdpage youshould setoffset to 20and limit to 10). Do not usewithoutspecifying thelimitparameter aswell.

offset=5

group_by_vertical_name no set

Possiblevalues:yes|no. If setto yes, it willreturn avertical nameonly once. Ifthe value isset to no, thesame verticalname mightbe returnedseveral times( equal to thenumber ofpublishersthat use thevertical ).

group_by_vertical_name=no

Return <liverailapi requested="/entity/vertical/publisher/list" api_version="X.Y.Z"> <verticals> <vertical> <vertical_id>The numeric ID of the vertical_name</vertical_id> <entity_id>The numeric ID of the current vertical</entity_id> <vertical_name>The sanitized vertical name. If the name contains non-letter / non-numeric characters, they will be replaced with "_".</vertical_name> </vertical> ... </verticals> <count>The number of verticals</count> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/vertical/available

Method Description

Verify the number of available verticals remaining for the specified entity.

Parameters





Return <liverailapi requested="/entity/vertical/available" api_version="X.Y.Z"> <available>The available number of verticals remaining for the specified entity.</available> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/vertical/resolve/name

Method Description

Resolve the vertical names for a list of vertical IDs.

Parameters





vertical_id yes integer

The numericID of thevertical to beresolved.Multiple IDscan be used,separated by"," or "|".

vertical_id=7,88

Return <liverailapi requested="/entity/vertical/resolve/name" api_version="X.Y.Z"> <verticals> <vertical> <vertical_id>The numeric ID of the resolved vertical</vertical_id> <vertical_name>The sanitized vertical name. If the name contains non-letter / non-numeric characters, they will be replaced with "_"</vertical_name> </vertical> ... </verticals> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/vertical/add

Method Description

Add a new vertical to the entity. A vertical market (often referred to simply as a"vertical") is a group of similar businesses and customers that engage in tradebased on specific and specialized needs. Often, participants in a vertical marketare very limited to a subset of a larger industry (a niche market). An example ofthis sort of market is the market for point-of-sale terminals, which are oftendesigned specifically for similar customers and are not available for purchase tothe general public. Vertical marketing can be witnessed at trade shows. Theopposite of vertical marketing is horizontal marketing.

Parameters





vertical_name yes string

The name ofthe newvertical. If thenamecontains non-letter / non-numericcharacters,they will bereplaced with"_"

vertical_name=Electronics

Return <liverailapi requested="/entity/vertical/add" api_version="X.Y.Z"> <vertical_id>The numeric ID of the newly created vertical</vertical_id> <vertical_name>The sanitized vertical name, if it contains non-letter / non-numeric characters.</vertical_name> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/vertical/add

Method Description

Edit an existing vertical. If the vertical name is changed, the vertical_idnumeric value will also be updated.Please check the new vertical_id allocated by the system to avoid any confusions.The numeric ID of the vertical_id remains unchanged if the vertical name is notchanged either.

Parameters





vertical_id yes integerThenumerical IDof the verticalto be edited.

vertical_id=25


The newname of thenew vertical.If the namecontains non-letter / non-numericcharacters,they will bereplaced with"_"

vertical_name=Electronics

Return <liverailapi requested="/entity/vertical/edit" api_version="X.Y.Z"> <vertical_id>The new numeric ID of the vertical for which the name was edited</vertical_id> <vertical_name>The sanitized vertical name, if it contains non-letter / non-numeric characters.</vertical_name> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/vertical/delete

Method Description

Delete an existing vertical.

Parameters





vertical_id yes integerThe numericID of thevertical to bedeleted.

vertical_id=77

Return <liverailapi requested="/entity/vertical/publisher/list" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY CONTACTS

All the methods related to entity contacts are displayed here.

/entity/contact/add/entity/contact/edit/entity/contact/list/entity/contact/delete

Method Name: /entity/contact/delete

Method Description

List all the available contacts or the information for a given entity. If no entity isspecified, all the contacts of the current entity will be listed.

Parameters





entity_id no integerSearch for thecontactdetails of aspecific entity

entity_id=5584

entity_contact_id no integerSearch for thedetails of aspecificcontact

entity_contact_id=44

Return <liverailapi requested="/entity/contact/list" api_version="X.Y.Z"> <contacts> <contact> <entity_contact_id>The numerical ID of the contact full_name</entity_contact_id> <entity_id>The numerical ID of the current entity</entity_id> <type>The type of contact</type> ... </contact> </contacts> ... <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/contact/add

Method Description

Add a new contact to the entity. If no entity is specified, the newly created contactwill be directly attached to the current entity.

Parameters





type yes enum

The type ofthe contact.The acceptedvalues are"business","technical","emergency".

type=emergency

full_name no stringThe name ofthe newcontact

full_name=firstname lastname

title no stringThe title ofthe newcontact.

title=Mr

email no string

The contact'semailaddress. Ifyou havemultiple emailaddresses,you can makea single callby glueingthem togetherwith comma"," or pipe "|"

[email protected]

phone no stringThe contact'sprimaryphonenumber.

phone=0554858

phone1 no stringThe contact'ssecondaryphonenumber.

phone1=0554860

city_state no string The ContactCity and State city_state=Cluj Romania

notify_emails no string

Specify theemailnotificationaddress. Ifyou havemultiple emailaddresses,you can makea single callby glueingthem togetherwith comma

[email protected]

"," or pipe "|"

support_zone no string The contact'ssupport zone. support_zone=RO

Return <liverailapi requested="/entity/contact/add" api_version="X.Y.Z"> <entity_contact_id>The numeric ID of the newly created contact</entity_contact_id> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/contact/edit

Method Description

Edit a specific contact for an entity.

Parameters





entity_contact_id yes integerThenumerical IDof the contactto be edited.


type no enum

The type ofthe contact.The acceptedvalues are"business","technical","emergency".Only onecontact ofeach type isaccepted bythe entity.

type=emergency

full_name no stringThe name ofthe newcontact

full_name=firstname lastname

title no stringThe title ofthe newcontact.

title=Mr

email no string

The contact'semailaddress. Ifyou havemultiple emailaddresses,you can makea single callby glueingthem togetherwith comma"," or pipe "|"

[email protected]

phone no stringThe contact'sprimaryphonenumber.

phone=0554858

phone1 no stringThe contact'ssecondaryphonenumber.

phone1=0554860

city_state no string The ContactCity and State city_state=Cluj Romania

notify_emails no string

Specify theemailnotificationaddress. Ifyou havemultiple emailaddresses,you can makea single callby glueingthem togetherwith comma"," or pipe "|"

[email protected]

support_zone no string The contact'ssupport zone. support_zone=RO

Return <liverailapi requested="/entity/contact/edit" api_version="X.Y.Z"> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/contact/delete

Method Description

Deletes a specific contact from an entity.

Parameters





entity_contact_id yes integerThe numericID of thecontact to bedeleted.


Return <liverailapi requested="/entity/contact/delete" api_version="X.Y.Z"> <user> .. </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY TRACKERS

All the methods related to Entity Trackers are displayed here.

/entity/tracker/add/entity/tracker/edit/entity/tracker/list/entity/tracker/delete

Method Name: /entity/tracker/list

Method Description

List the trackers associated with a entity.

Parameters






The numericID of theentity forwhich thetrackers willbe listed.

entity_id=5412

Return <liverailapi requested="/entity/tracker/list" api_version="X.Y.Z"> <entity> <trackers> <tracker> <entity_tracker_id>the numeric ID of the tracker</entity_tracker_id> <event>the event of tracker</event> <url>the URL of the tracker</url> </tracker> ... </trackers> </entity> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason17 May 2012 Added method into the help file Align with API

Method Name: /entity/tracker/add

Method Description

Adds a new tracker for a specified entity.

Parameters






The numericID of theentity towhich thetracker will beadded.

entity_id=5412

event yes string

The trackerevent:impression -impression,accept -acceptinvitation,clickthru -video click-through,view25 - firstquartile (25%watched),view50 -midpoint(50%watched),view75 - thirdquartile (75%watched),view100 -completeview (100%watched),pause - videopaused, mute- video muted,minimize -minimizeoverlay, close- close,companion -companionimpression,error - error,skip, custom1

event=close

from custom8- customevents thatcan be sendfrom player

url yes string The URL ofthe tracker url=http://www.tracker-url.com/tracker2

Return <liverailapi requested="/entity/tracker/add" api_version="X.Y.Z"> <entity_tracker_id>the numeric ID of the new tracker</entity_tracker_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason17 May 2012 Added method into the help file Align with API11 July 2012 Changed event values Align with API11 September 2012 Added 'error' in event values Align with API

Method Name: /entity/tracker/edit

Method Description

Edits a tracker for a specified entity.

Parameters






The numericID of theentity forwhich thetracker will beedited.

entity_id=5412

entity_tracker_id yes integerThe numericID of thetracker whichwill be edited.

entity_tracker_id=224

event no string

The newtracker event:impression -impression,accept -acceptinvitation,clickthru -video click-through,view25 - firstquartile (25%watched),view50 -midpoint(50%watched),view75 - thirdquartile (75%watched),view100 -completeview (100%watched),pause - videopaused, mute- video muted,minimize -

event=close

minimizeoverlay, close- close,companion -companionimpression,error - error,skip, custom1from custom8- customevents thatcan be sendfrom player

url no string The new URLof the tracker url=http://www.tracker-url.com/tracker2

Return <liverailapi requested="/entity/tracker/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason17 May 2012 Added method into the help file Align with API11 July 2012 Changed event values Align with API11 September 2012 Added 'error' in event values Align with API

Method Name: /entity/tracker/delete

Method Description

Deletes a tracker attached to an entity.

Parameters






The numeric IDof the entityfrom which thetracker will bedeleted.

entity_id=5412

entity_tracker_id no integer

Optional, thenumeric ID ofthe tracker to bedeleted. If noentity_tracker_idis specified, allthe trackersattached toentity_id will bedeleted.

entity_tracker_id=224

Return <liverailapi requested="/entity/tracker/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason17 May 2012 Added method into the help file Align with API

ENTITY DOMAIN CONTROL

All the methods related to entity domain control are displayed here.

/entity/domain/control/add/entity/domain/control/list/entity/domain/control/delete

Method Name: /entity/domain/control/list

Method Description

List all the available controlled domains or the information for a given entity.

Parameters






The numericID of the entityfor which theinformationwill bereturned. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or ,


domain_name no string

The name ofthe domain tobe returned.The searchwill beperformedonly in thecurrent orspecifiedentity_id.

domain_name=test

domain_search no string

The searchstring for thedomain_name.The searchwill beperformedonly in thecurrent orspecifiedentity_id.

domain_search=te


limit=50

The offsetfrom wherethe limitshould be

offset no int

applied ( ifyou display 10domains perpage and youneed to getthe 3rd pageyou should setoffset to 20and limit to 10). Do not usewithoutspecifying thelimit parameteras well.

offset=5

Return <liverailapi requested="/entity/domain/control/list" api_version="X.Y.Z"> <domains> <domain> <entity_id>The numeric ID of the entity</entity_id> <domain_name>The name of the controlled domain</domain_name> </domain> ... </domains> ... <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/control/add

Method Description

Add a new controlled domain for a specified entity.

Parameters





domain_name yes stringThe name ofthe newcontrolleddomain.

domain=test.com

Return <liverailapi requested="/entity/domain/control/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/domain/control/delete

Method Description

Deletes an existing controlled domain from an entity.

Parameters





domain_name yes stringThe name ofthe domain tobe deleted.

domain_name=test

Return <liverailapi requested="/entity/domain/control/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ENTITY AUDIENCE

All the methods related to entity audience are displayed here.

/entity/audience/provider/list/entity/audience/segment/list

Method Name: /entity/audience/provider/list

Method Description

List all the audience providers for a specific entity.

Parameters






The numericID of theentity forwhich theaudienceproviders willbe listed. If novalue isspecified, thesearch will beperformed onthe currententity.

entity_id=788

Return <liverailapi requested="/entity/audience/provider/list" api_version="x.y.z"> <providers> <provider> </provider> ... </providers> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/audience/segment/list

Method Description

List all the audience segments for a specific entity.

Parameters






The numericID of theentity forwhich thesudencesegments willbe listed. If novalue isspecified, thesearch will beperformed onthe currententity.

entity_id=788

Return <liverailapi requested="/entity/audience/segment/list" api_version="x.y.z"> <count>The number of segments.</count> <segments> <segment> </segment> ... </segments> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


AUDIENCE

All the methods related to audience are displayed here.

/audience/provider/resolve/name/audience/segment/resolve/name

Method Name: /audience/provider/resolve/name

Method Description

Resolve the name of one or more audience providers.

Parameters





audience_id yes integer

The numericID of theaudienceprovider to beresolved.Multiple IDscan be used,separated by"," or "|".

audience_id=7,88

Return <liverailapi requested="/audience/provider/resolve/name" api_version="x.y.z"> <providers> <provider> <audience_id>The numerical ID of the audience.</audience_id> <audience_name>The name of the audience</audience_name> </provider> ... </providers> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /audience/segment/resolve/name

Method Description

Resolve the name of one or more audience segments.

Parameters






The numericID of theaudiencesegment to beresolved.Multiple IDscan be used,separated by"," or "|".

audience_segment_id=7,88

Return <liverailapi requested="/audience/segment/resolve/name" api_version="x.y.z"> <segments> <segment> <audience_segment_id>The numerical ID of the audience segment.</audience_segment_id> <audience_segment_name>The name of the audience segment.</audience_segment_name> <audience_name>The name of the audience.</audience_name> </segment> ... </segments> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


CATEGORIES

All the methods related to categories are displayed here.

/categories/list/categories/resolve/name

Method Name: /category/list

Method Description

List all the available categories.

Parameters





category_id no string

The numericID of thecategory forwhich theinformationwill bereturned. Ifyou havemultiple ID(s)you can makea single callby glueingthem togetherwith | or ,

category_id = 1|7|120 or category_id =1,7,120

parent_category_id no string

The numericID of theparentcategory forwhich thechildrencategories willbe returned. Ifyou havemultiple ID(s)you can makea single callby glueingthem togetherwith | or ,

parent_category_id = 1|7|120 orparent_category_id = 1,7,120

search_string no stringReturns onlythe categorythat has thisname.

search_string=music


limit=50

offset no int

The offsetfrom wherethe limitshould beapplied ( ifyou display10 entities perpage and youneed to getthe 3rd pageyou shouldset offset to

offset=5

20 and limit to10 ). Do notuse withoutspecifying thelimitparameter aswell.

source no string

Specify thecategorysource(LiveRail orYoutube). Theacceptedvalues are:"lr" and "yt".

source=yt

return_deleted no stringReturns onlythe deletedcategories.

return_deleted=yes

Return <liverailapi requested="/category/list" api_version="X.Y.Z"> <categories> <category> <category_id>The numeric ID of the category</category_id> <parent_category_id>The numeric ID of the parent category</parent_category_id> <category_name>The name of the category_id</category_name> <source>lr / yt</source> </category> ... <categories> ... <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /category/resolve/name

Method Description

Resolve the category names for a list of category IDs.

Parameters





category_id yes integer

The numericID of thecategory tobe resolved.Multiple IDscan be used,separated by"," or "|".

category_id = 1|7|120 or category_id =1,7,120

Return <liverailapi requested="/category/resolve/name" api_version="X.Y.Z"> <categories> <category> <category_id>The numeric ID of the resolved category</category_id> <category_name>The category name.</category_name> <source>The source of the category</source> </category> ... </categories> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


SUB SITES

All the methods related to entity sub sites are displayed here.

/entity/sub/site/list/entity/sub/site/set

Method Name: /entity/sub/site/list

Method Description

Displays the information related to entity sub-site(s).

Parameters





network_id no integer

Thenumerical IDof thenetwork to belisted.

network_id=8976

sub_site_id no integerThenumerical IDof the subsiteto be listed.

sub_site_id=5487

Return <liverailapi requested="/entity/sub/site/list" api_version="X.Y.Z"> <sub_sites> <sub_site> <network_id>the id of the entity acting as a network ( the current entity )</network_id> <sub_site_id>the id of the entity acting as a sub site</sub_site_id> <organization>the name of the sub site</organization> <connections> <connection> <connection_id>The numerical ID of the connection</connection_id> <enabled_network>values: 1/0</enabled_network> <enabled_publisher>values: 1/0</enabled_publisher> <enabled_ov>values: 1/0</enabled_ov> <enabled_in>values: 1/0</enabled_in> <cost_model>values: cpm/cpc</cost_model> </connection> </connections> </sub_site> ... </sub_sites> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /entity/sub/site/set

Method Description

Set a given entity as a subsite.

Parameters





network_id yes integer

Thenumerical IDof thenetwork to beset assubsite.

network_id=8976

sub_site_id yes integerThenumerical IDof the subsite.

sub_site_id=398756

Return <liverailapi requested="/entity/sub/site/list" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


NETWORK LABEL

All the methods related to the network labels are displayed here.

/network/label/add/network/label/edit/network/label/list/network/label/delete/network/site/label/list/network/site/label/set

Method Name: /network/label/list

Method Description

Lists the network label(s).

Parameters





label_id no integer

Return onlythe labelswith thespecifiednumerical ID.Multiple IDscan be bindtogether by "|"or ","

label_id=556


Return onlythe labels thathave a titlematching thegiven searchstring.

search_string=music

Return <liverailapi requested="/network/label/list" api_version="X.Y.Z"> <labels> <label> <label>The name of the label</label> <label_id>The numerical ID of the label</label_id> <network_id>The numerical ID of the network</network_id> </label> ... </labels> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /network/label/add

Method Description

Add a label to the network.

Parameters





label yes string The name of thenew label. label=testnetwork

Return <liverailapi requested="/network/label/add" api_version="X.Y.Z"> <label_id>The numerical ID of the newly created label</label_id> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /network/label/edit

Method Description

Edits an existing label.

Parameters





label_id yes integerThenumerical IDof the label tobe edited.

label_id=5556

label yes stringThe newname of thelabel.

label=testnetworknew

Return <liverailapi requested="/network/label/edit" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /network/label/delete

Method Description

Deletes an existing label.

Parameters





label_id yes integer

Thenumerical IDof the label tobe deleted. Ifthe label to bedeleted is setwithpublishers, allassociationswill bedeleted.

label_id=556

Return <liverailapi requested="/network/label/delete" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /network/site/label/list

Method Description

Lists the network label(s).

Parameters





label_id no integer

Return onlythe labelswith thespecifiednumerical ID.Multiple IDscan be bindtogether by "|"or ","

label_id=556


Return onlylabelsattached tothe publisherwith thespecifiednumerical ID.Multiple IDscan be bindtogether by "|"or ","

publisher_id=5241, 7856

Return <liverailapi requested="/network/site/label/list" api_version="X.Y.Z"> <labels> <label> <publisher_id>The numerical ID of the publisher.</publisher_id> <publisher_name>The name of the publisher</publisher_name> <label_id>The numercial ID of the label</label_id> <label>The name of the label</label> <enabled_in>1</enabled_in> <enabled_ov>1</enabled_ov> </label> ... </labels> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error>

...</liverailapi>

Change History


Method Name: /network/site/label/set

Method Description

Set label(s) to a site (publisher).

Parameters





publisher_id yes integer

The numericalID of thepublisher towhich the labelwill be attached.

publisher_id=5241, 7856

label_id yes integer

The numericalID of the label(s)to be attachedto the publisher.If the value isspecified as"LR_API_NULL",all the labelsattached to asite will becleared.

label_id=556

Return <liverailapi requested="/network/site/label/set" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


SUMMARY

All the methods related to summaries are displayed here.

/summary/domain/list/summary/fingerprint/list/summary/tag/list/summary/media/list/summary/partner/list/summary/vertical/list/summary/order/list/summary/order/line/list/summary/creative/list/summary/creative/campaign/list

Method Name: /summary/domain/list

Method Description

List the domain(s) summary for the current or specified entity.

Parameters





entity_id no string

The numericID of theentity forwhich theinformationwill bereturned.

entity_id=6084

search_domain no int

The searchstring for thedomain name.The searchwill beperformedonly in thecurrent orspecifiedentity_id.

search_domain=blogspot


limit=10

offset no int

The offsetfrom wherethe limitshould beapplied ( ifyou display10 domainsper page andyou need toget the 3rdpage youshould setoffset to 20and limit to 10). Thisparametershouldn't be

offset=20

given withoutgiving the limitparameter aswell.

Return <liverailapi requested="/summary/domain/list" api_version="x.y.z"> <domains> <list> <domain> <domain>The domain name</domain> </domain> ... </list> </domains> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason07 June 2012 Added method in documentation. Align with API tester

Method Name: /summary/fingerprint/list

Method Description

List the fingerprint(s) summary for the current or specified entity(es).

Parameters





entity_id no string

The numeric IDof the entity forwhich theinformation willbe returned. Ifyou havemultiple id(s)you can make asingle call byglueing themtogether with |or , ( examples:if you need toget the entitiesfor id(s) 1, 7 and120 you can useentity_id =1|7|120 orentity_id =1,7,120 ). Bydefault themethod willreturn thefingerprints forthe currententity.

entity_id=6084, 8876

search_fingerprint no int

The searchstring for thefingerprintname. Thesearch will beperformed onlyin the current orspecifiedentity_id.

search_fingerprint=intro

If you havemultiplefingerprints, youcan make asingle call by

fingerprint no stringglueing themtogether with |or , By defaultthe method willreturn thefingerprints forthe currententity.

fingerprint=fin_intro, fin_dual

limit no intLimit the numberof results forpagination(s).

limit=10

offset no int

The offset fromwhere the limitshould beapplied ( if youdisplay 10fingerprints perpage and youneed to get the3rd page youshould set offsetto 20 and limit to10 ). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

offset=20

group_by no string

Group by. If thevalue is"LR_API_NULL",the grouping willbe cleared.

group_by=LR_API_NULL

group_by_name no enum

Specify if thegrouping will bedone by name.The possiblevalues are "yes"| "no". Defaultvalue is "no".

group_by_name=yes

Return <liverailapi requested="/summary/fingerprint/list" api_version="x.y.z"> <fingerprints> <list> <fingerprint> <fingerprint>The fingerprint name</fingerprint> </fingerprint> ... </list> </fingerprints> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

</liverailapi>

Change History


Method Name: /summary/tag/list

Method Description

List the tag(s) summary for the current or specified entity.

Parameters





entity_id no string


entity_id=6084

search_tag no int

The searchstring for thetag. It mustcontain atleast 3 letters.The searchwill beperformedonly in thecurrent orspecifiedentity_id. Theresult willreturn onlythe tags withthe namematching thesearch string.Thisparameter isoptional.

search_tag=intro


limit=10

The offsetfrom wherethe limitshould beapplied ( ifyou display

offset no int

10 tags perpage and youneed to getthe 3rd pageyou shouldset offset to20 and limit to10 ). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

offset=20

Return <liverailapi requested="/summary/tag/list" api_version="x.y.z"> <tags> <list> <tag> <tag>The tag name</tag> </tag> ... </list> </tags> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /summary/media/list

Method Description

List the media(s) summary for the current or specified entity(es).

Parameters





entity_id no string

The numeric IDof the entity forwhich theinformation willbe returned. Ifyou havemultiple id(s)you can make asingle call byglueing themtogether with |or , ( examples:if you need toget the mediafor id(s) 1, 7 and120 you can useentity_id =1|7|120 orentity_id =1,7,120 ). Bydefault themethod willreturn themedias for thecurrent entity.


search_media no int

The searchstring for themedia name.The search willbe performedonly in thecurrent orspecifiedentity_id.

search_media=intro

string

If you havemultiple medias,you can make asingle call byglueing them

media no string together with |or , By defaultthe method willreturn themedias for thecurrent entity.

media=med_intro, med_dual

limit no intLimit the numberof results forpagination(s).

limit=10

offset no int

The offset fromwhere the limitshould beapplied ( if youdisplay 10medias per pageand you need toget the 3rd pageyou should setoffset to 20 andlimit to 10 ). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

offset=20

group_by no string

Group by. If thevalue is"LR_API_NULL",the grouping willbe cleared.

group_by=LR_API_NULL

group_by_name no enum

Specify if thegrouping will bedone by name.The possiblevalues are "yes"| "no". Defaultvalue is "no".

group_by_name=yes

Return <liverailapi requested="/summary/media/list" api_version="x.y.z"> <medias> <list> <media> <media>The media name</media> </media> ... </list> </medias> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /summary/partner/list

Method Description

List the partner(s) summary for the current or specified entity(es).

Parameters





entity_id no string

The numericID of theentity(es) forwhich theinformationwill bereturned. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need toget thepartners forid(s) 1, 7 and120 you canuse entity_id= 1|7|120 orentity_id =1,7,120 ). Theparameter isoptional andby default themethod willreturn thepartners forthe currententity.


The numericID of thepartner(es)for which theinformationwill bereturned. If

partner_id no string

returned. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need toget the infofor id(s) 1, 7and 120 youcan usepartner_id =1|7|120 orpartner_id =1,7,120 ).

partner_id=25, 476

search_partner no int

The searchstring for thepartner name.The searchwill beperformedonly in thecurrent orspecifiedentity_id.

search_partner=intro


limit=10

offset no int

The offsetfrom wherethe limitshould beapplied ( ifyou display10 partnersper page andyou need toget the 3rdpage youshould setoffset to 20and limit to 10). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

offset=20

Return <liverailapi requested="/summary/partner/list" api_version="x.y.z">

<partners> <list> <partner> <partner_id>The numeric ID of the partner</partner_id> <partner>The partner name</partner> </partner> ... </list> <count>The number of returned results</count> </partners> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /summary/vertical/list

Method Description

List the vertical(s) summary for the current or specified entity.

Parameters





entity_id no string


entity_id=6084

search_vertical no int

The searchstring for thevertical name.The searchwill beperformedonly in thecurrent orspecifiedentity_id. Ifyou havemultiple id(s)you can makea single callby gluingthem togetherwith | or , (examples: ifyou need toget the infofor id(s) 1, 7and 120 youcan usevertical_id =1|7|120 orvertical_id =1,7,120 )

search_vertical=intro


limit=10

offset no int

The offsetfrom wherethe limitshould beapplied ( ifyou display10 verticalsper page andyou need toget the 3rdpage youshould setoffset to 20and limit to 10). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

offset=20

Return <liverailapi requested="/summary/vertical/list" api_version="x.y.z"> <verticals> <list> <vertical> <vertical_id>The numerical ID of the vertical</vertical_id> <vertical_name>The vertical name</vertical_name> </vertical> ... </list> <count>Number of returned verticals</count> </verticals> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason22 January 2013 Added method in documentation. Align with API tester

Method Name: /summary/order/list

Method Description

List the order(s) summary for the current or specified entity.

Parameters





entity_id no string


entity_id=6084

search_order no int

The searchstring for theorder name.The searchwill beperformedonly in thecurrent orspecifiedentity_id. Ifyou havemultiple id(s)you can makea single callby gluingthem togetherwith | or , (examples: ifyou need toget the infofor id(s) 1, 7and 120 youcan useorder_id =1|7|120 ororder_id =1,7,120 )

search_order=intro


limit=10

offset no int

The offsetfrom wherethe limitshould beapplied ( ifyou display10 orders perpage and youneed to getthe 3rd pageyou shouldset offset to20 and limit to10 ). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

offset=20

Return <liverailapi requested="/summary/order/list" api_version="x.y.z"><order_lies> <order_line> <order_line_id>The order line ID</order_line_id> <order_id>The Order ID</order_id> <publisher_id>The publisher ID</publisher_id> <network_id>The Network ID</network_id> <position>the position</position> <cost_advertiser>cost for advertiser</cost_advertiser> <cost_publisher>cost for publisher</cost_publisher> <cost_publisher_bid>cost for publisher bid</cost_publisher_bid> <impression>The number of impressions</impression> <clickthru>The number of clickthroughs</clickthru> <view100>Number of view100</view100> <accept>Accept value</accept> <cost_fees>cost fees</cost_fees> </order_line> ... </order_lines> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /summary/order/line/list

Method Description

List the order line(s) summary for the current or specified entity.

Parameters





entity_id no string


entity_id=6084

search_order no int

The searchstring for theorder name.The searchwill beperformedonly in thecurrent orspecifiedentity_id. Ifyou havemultiple id(s)you can makea single callby gluingthem togetherwith | or , (examples: ifyou need toget the infofor id(s) 1, 7and 120 youcan useorder_id =1|7|120 ororder_id =1,7,120 )

search_order=intro


limit=10

The offset

offset no int

from wherethe limitshould beapplied ( ifyou display10 orders perpage and youneed to getthe 3rd pageyou shouldset offset to20 and limit to10 ). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

offset=20

Return <liverailapi requested="/summary/order/line/list" api_version="x.y.z"><order_lies> <order_line> <order_line_id>The order line ID</order_line_id> <order_id>The Order ID</order_id> <publisher_id>The publisher ID</publisher_id> <network_id>The Network ID</network_id> <position>the position</position> <cost_advertiser>cost for advertiser</cost_advertiser> <cost_publisher>cost for publisher</cost_publisher> <cost_publisher_bid>cost for publisher bid</cost_publisher_bid> <impression>The number of impressions</impression> <clickthru>The number of clickthroughs</clickthru> <view100>Number of view100</view100> <accept>Accept value</accept> <cost_fees>cost fees</cost_fees> </order_line> ... </order_lines> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /summary/creative/list

Method Description

List the creative(s) summary for the current or specified entity.

Parameters



token yes stringAuthenticationsession token(received after /login).


entity_id no stringThe numeric ID of theentity for which theinformation will bereturned.

entity_id=6084

creative_id no string

The numeric ID of thecreative(s) for whichthe information will bereturned. If you havemultiple id(s) you canmake a single call bygluing them togetherwith | or , ( examples:if you need to get theinfo for id(s) 1, 7 and120 you can usecreative_id = 1|7|120or creative_id =1,7,120 )

creative_id=1,7,120 or creative_id=1|7|120

creative_campaign_id no string

The numerical ID ofthe creativecampaign(s) forwhich the info will bereturned. If you havemultiple id(s) you canmake a single call bygluing them togetherwith | or , ( examples:if you need to get theinfo for id(s) 1, 7 and120 you can usecreative_campaign_id= 1|7|120 orcreative_campaign_id= 1,7,120 )

creative_campaign_id=1,7,120 orcreative_campaign_id=1|7|120

search_creative no int

The search string forthe creative name.The search will beperformed only in thecurrent or specifiedentity_id.

search_creative=intro

limit no intLimit the number ofresults forpagination(s).

limit=10

The offset fromwhere the limit should

offset no int

be applied ( if youdisplay 10 creativesper page and youneed to get the 3rdpage you should setoffset to 20 and limitto 10 ). Thisparameter shouldn'tbe given withoutgiving the limitparameter as well.

offset=20

Return <liverailapi requested="/summary/creative/list" api_version="x.y.z"> <creatives> <list> <creative> <creative_id>The creative ID</creative_id> <impression>Number of impressions</impression> <clickthru>Number of clickthroughs</clickthru> <title>The title</title> </creative> ... </list> <count>Number of returned creatives</count> </creatives> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /summary/creative/campaign/list

Method Description

List the creative campaign(s) summary for the current or specified entity.

Parameters





entity_id no string


entity_id=6084

creative_campaign_id no string

The numericID of thecreativecampaign forwhich theinformationwill bereturned.

entity_id=6084

search_creative_campaign no int

The searchstring for thecreativename. Thesearch will beperformedonly in thecurrent orspecifiedentity_id. Thisparameter isoptional.

search_creative=intro


limit=10

offset no int

The offsetfrom wherethe limitshould beapplied ( ifyou display10 creativesper page andyou need toget the 3rdpage youshould setoffset to 20

offset=20

and limit to 10). Thisparametershouldn't begiven withoutgiving the limitparameter aswell.

Return <liverailapi requested="/summary/creative/campaign/list" api_version="x.y.z"> <creative_campaigns> <list> <creative_campaign> <creative_campaign_id>The creative campaign ID</creative_campaign_id> <impression>Number of impressions</impression> <clickthru>Number of clickthroughs</clickthru> <creative_campaign_name>The campaign name</creative_campaign_name> </creative_campaign> ... </list> <count>Number of returned creative campaigns</count> </creative_campaigns> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


CREATIVES

A creative can only exist within a single creative campaign group. A creative contains severalelements:

A name;A defined type from the following list:

Linear In-stream (Pre/Mid/Post-Roll)Overlay with TakeoverOverlay without TakeoverText OverlayLinear VPAIDNon-linear VPAID

An uploaded asset, such as an FLV, which will be transcoded automatically by LiveRail intomultiple formats and bit rates; a URL can be provided if the asset is hosted on another server;A click-thru URL;A VAST tag trafficked from another ad server can be inputted instead of an asset and a click-thruURL;Optional companion banner(s) containing a creative asset and clickthru; if a VAST tag is beingtrafficked, then this optional is controlled within the VAST tag and not available for modification;3rd party trackers, meant for integrating trackers or pixels from tools such as a 3rd party ad serversuch as an Atlas or DFA. Thus, creatives are always attached to a creative campaign group;therefore, ensure that a creative campaign group exists before creating a creative.

CreativesThese are the methods used to handle Creatives:

/creative/add/creative/duplicate/creative/edit/creative/list/creative/list/owned/orders/creative/delete/creative/resolve/name/creative/set/archived

Video creatives/creative/video/add/creative/video/edit/creative/video/list/creative/video/upload/creative/video/delete

Overlay creatives/creative/overlay/add/creative/overlay/edit/creative/overlay/list/creative/overlay/upload/creative/overlay/delete

Companions/creative/companion/add/creative/companion/edit

/creative/companion/list/creative/companion/upload/creative/companion/delete

Trackers/creative/tracker/add/creative/tracker/edit/creative/tracker/list/creative/tracker/delete

Creative Advertisers/creative/advertiser/add/creative/advertiser/list/creative/advertiser/delete

Method Name: /creative/list

Method Description

Displays the information related to a creative. Also, it can be used to list thecreatives attached to a creative group (campaign).

Parameters





creative_id no integer

The numeric ID of thecreative for which theinformation will bereturned. The numericID of the creative forwhich the informationwill be returned. If youhave multiple id(s) youcan make a single callby glueing themtogether with | or ,This parameter isrequired if nocreative_campaign_id,entity_id ororder_line_id isspecified.

creative_id=999, 784

creative_campaign_id no integer

The numeric ID of thecreative group(campaign) for whichthe list of thecreatives will bereturned. If you havemultiple id(s) you canmake a single call byglueing them togetherwith | or , Thisparameter is requiredif no creative_id,entity_id ororder_line_id isspecified.

creative_campaign_id=543, 548


The numeric ID of theentity for which theinformation will bereturned. If you havemultiple id(s) you canmake a single call byglueing them togetherwith | or , Thisparameter is requiredif nocreative_campaign_id,creative_id ororder_line_id isspecified.


order_line_id no string

Return only thecreatives that areassigned to this orderline. If you havemultiple id(s) you canmake a single call byglueing them togetherwith | or , Thisparameter is requiredif nocreative_campaign_id,

order_line_id=o8877666, o630087

creative_id orentity_id is specified.

ad_unit_type no string

Return only thecreatives of this adunit type. Theaccepted ad unittypes are: in, ov-take,ov-bug, ov-text, vpaid-in, vpaid-ov. If youhave multiple typesyou can make a singlecall by glueing themtogether with | or ,

ad_unit_type=in, ov-take

status no enum

Search based on thestatus of the creative.Possible values are:active, archived,pending, encoding. Ifyou have multipletypes you can make asingle call by glueingthem together with | or,

status=pending

search_string no stringReturn only thecreatives that have atitle matching thegiven search string.

search_string=music

Return <liverailapi requested="/creative/list" api_version="x.y.z"> <creatives> <creative> <creative_id>creative's ID</creative_id> <creative_campaign_id>creative group's (campaign) ID</creative_campaign_id> <ad_unit_type>ad unit type of the creative</ad_unit_type> <creation_time>creative creation full date (YYYY-MM-DD HH:MM:SS)</creation_time> <title>creative title</title> <description>creative description</description> <url_text>creative URL link</url_text> <clickthru>creative's clickthrough URL, defaults to null on creative creation</clickthru> <adtag>the adtag</adtag> <status>active, archive, pending, encoding</status> <timestamp>internal use</timestamp> <destination_url>The creative's destination url</destination_url> <advertiser_id>the advertiser ID</advertiser_id> <skip_offset>Skip Offset value</skip_offset> <skip_offset_type>seconds/percentage</skip_offset_type> <security_code>internal use</security_code> <preview_security_code>internal use</preview_security_code> </creative> ... </creatives> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


15 June 2012 Added more status values, updated severalparamethers.

Align withAPI.

05 July 2012 Added destination_url. Align withAPI.

11 September2012 Added more parameters. Align with

API.

15 January 2013 Added more XML values Align withAPI.

Method Name: /creative/resolve/name

Method Description

Simple method that returns the title of a given creative ID or a given list of creativeIDs, separated by comma (,).

Parameters





creative_id yes integer

The numericID of thecreative forwhich the titlewill bereturned.

creative_id=11

Return <liverailapi requested="/creative/resolve/name" api_version="X.Y.Z"><creatives> <creative> <creative_id>The numeric ID of the creative</creative_id> <title>The title</title> </creative> ... </creatives> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/add

Method Description

Add a new creative to an existing creative group (campaign).

Parameters





creative_campaign_id yes integer

The numeric IDof the creativegroup(campaign) towhich the newlycreated creativewill beattached.

creative_campaign_id=999

ad_unit_type yes string

The type of thecreative; in -instream, ov-bug - overlaywithout take-over, ov-take -overlay withtake-over, ov-text - textoverlay, vpaid-in - VPAID liniar,vpaid-ov -VPAID non-linear.

ad_unit_type=in

title yes stringThe title of thenewly createdcreative.

title=New

description yes stringThe descriptionof the newlycreatedcreative.

description=cartoon

url_text yes string The URL textfor the creative. url_text=http://www.test.com

clickthru no stringThe click-through URL forthe creative.

clickthru=www.test.com

Optional, thestatus of thecreative.Possible valuesare: "active" (foractivecreatives),"archived" (for

status no enum

archivedcreatives),"pending" (forincompletecreative) or"encoding" (forcreatives forwhich you willupload an assetthrough thecreative'supload method.The defaultvalue is"active".

status=pending

timestamp no integerOptional, thetimestamp ofthe creative.

timestamp=25

adtag no string

Optional, thecreative AD tagfor creativestraffickedelsewhere.

adtag=??

destination_url no string

The destinationURL for thecreative. If"LR_API_NULL"is used, theparameter willbe cleared.

destination_url=www.test.com

skip_offset no integer

Optional, theskip offsetvalue for thecreative. Thedefault value is"null". If"LR_API_NULL"is used, theparameter willbe cleared.

skip_offset=22

skip_offset_type no enum

Optional, theskip offset typefor the creative.Possible valuesare: "seconds","percentage".The defaultvalue is"seconds".

skip_offset_type=percentage

Return <liverailapi requested="/creative/add" api_version="X.Y.Z"> <security_code>internal use only</security_code> <creative_id>the numeric ID of the newly created creative.</creative_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

</liverailapi>

Change History



Align withAPI.


05 December2012 Added skip_offset, skip_offset_type Align with

API.

Method Name: /creative/edit

Method Description

Edit an existing creative

Parameters





creative_id yes integerThe numeric IDof the creativeto be edited.

creative_id=999

ad_unit_type no enum

The new typeof the specifiedcreative; in -instream, ov-bug - overlaywithout take-over, ov-take -overlay withtake-over, ov-text - textoverlay, vpaid-in - VPAID liniar,vpaid-ov -VPAID non-linear. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway.

ad_unit_type=ov-take

title no string

The new title ofthe specifiedcreative. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway.

title=edited

The newdescription of

description no string

the specifiedcreative. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway.

description=music

url_text no string

The new URLtext for thespecifiedcreative. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway.

url_text=http://www.test.com

clickthru no string

The new click-through URL forthe specifiedcreative. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway. If"LR_API_NULL"is used, theclickthruparameter willbe cleared.

clickthru=www.test.com

status no enum

The new statusof the specifiedcreative.Possible valuesare: "active" (foractivecreatives),"pending" (forincompletecreative) or"encoding" (forcreatives forwhich you willupload an assetthrough thecreative'supload method.This parameteris optional,meaning that, if

status=pending

meaning that, ifnot given, theparametervalue is notaltered in anyway.

timestamp no integer

The newtimestamp ofthe creative.This parameteris optional,meaning that, ifnot given, theparametervalue is notaltered in anyway.

timestamp=25

adtag no string

The newcreative AD tagfor creativestraffickedelsewhere. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway.

adtag=??

destination_url no string

The destinationURL for thecreative. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway. If"LR_API_NULL"is used, theparameter willbe cleared.

destination_url=www.test.com

skip_offset no integer

The skip offsetvalue for thecreative. Thisparameter isoptional,meaning that, ifnot given, theparametervalue is notaltered in anyway. If"LR_API_NULL"is used, theparameter will

skip_offset=22

be cleared.

skip_offset_type no enum

The skip offsettype for thecreative.Possible valuesare: "seconds","percentage".This parameteris optional,meaning that, ifnot given, theparametervalue is notaltered in anyway.

skip_offset_type=percentage

Return <liverailapi requested="/creative/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History



Align withAPI.


05 December2012 Added skip_offset, skip_offset_type Align with

API.

Method Name: /creative/delete

Method Description

Delete one ore more existing creatives.

Parameters






The numericID(s) of thecreative(s) tobe deleted. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need todelete thecreatives withthe id(s) 1, 7and 120 youcan usecreative_id =1|7|120 orcreative_id =1,7,120 ).


Return <liverailapi requested="/creative/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/duplicate

Method Description

Duplicate an existing creative.

Parameters





creative_id yes integerThe numericID of thecreative to beduplicated.

creative_id=999

trackers no bool

Acceptedvalues are:"true" "false".Default valueis "false". Ifspecified as"true", thetrackers willbe duplicated.

trackers=1

media no bool

Acceptedvalues are:"true" "false".Default valueis "false". Ifspecified as"true", themedia will beduplicated.

media=1

companion no bool

Acceptedvalues are:"true" "false".Default valueis "false". Ifspecified as"true", thecompanionswill beduplicated.

companion=1

Return <liverailapi requested="/creative/duplicate" api_version="X.Y.Z"> <creative_id>The duplicate creative's ID</creative_id>

<user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason14 May2012

Added trackers, media, companions with newrules

Align with APItester

Method Name: /creative/set/archived

Method Description

Set a creative to archived.

Parameters





creative_id yes integerThe numericID of thecreative to bearchived.

creative_id=52145

is_archived yes enum

Set thecreative to bearchived. Theacceptedvalues are"yes" or "no".Cannot beused forinactivecreatives.

is_archived=yes

Return <liverailapi requested="/creative/set/archived" api_version="x.y.z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason15 January 2013 Added page into CHM Align with API

VIDEO CREATIVES

All the methods related to video creatives are displayed here.

/creative/video/add/creative/video/edit/creative/video/list/creative/video/upload/creative/video/delete

Method Name: /creative/video/list

Method Description

List the video asset(s) attached to a creative.

Parameters






The numericID of theexisting in-streamcreative forwhich thevideo data isretrieved.

creative_id=222

Return <liverailapi requested="/creative/video/list" api_version="X.Y.Z"> <creative> <videos> <video> <type>type of the video asset</type> <bitrate>bitrate of the video asset</bitrate> <width>width of the video asset</width> <height>height of the video asset</height> <duration>duration of the video asset</duration> <url>URL of the video asset</url> </video> ... </videos> </creative> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/video/add

Method Description

Add a video asset to an existing in-stream creative.

Parameters






The numeric IDof the existingin-streamcreative towhich thisvideo assetmust be added.

creative_id=222

type yes string

The MIME typeof the videofile; video/x-flvfor FLV files,video/x-ms-wmv for WMVfiles,video/mp4 forMP4 files, orany other validvideo MIMEtype.

type=video/x-ms-wmv

bitrate yes integerThe videobitrate, inkilobits/second.

bitrate=256

height yes integer The videoheight in pixels. height=300

width yes integer The videowidth in pixels. width=150

duration yes integerThe videoduration inseconds.

duration=10

url yes integer The video URLlocation.

url=www.video.com/watch?v=5znh58WITU8

Return <liverailapi requested="/creative/video/add" api_version="X.Y.Z"> <user> ... </user>

<auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/video/edit

Method Description

Edit a video asset. The edit method is applied when the creative_id, type, bitrateand duration are a match (the values are not to be edited). Otherwise, themethods will actually add a new video. In order to avoid this when you wish to editany of the 4 parameters mentioned before, delete the old video using/creative/video/delete and then add a new video with the new desired parameters.

Parameters






The numeric IDof the existingin-streamcreative towhich thisvideo assetwas alreadyadded.

creative_id=222

type yes string

The MIME typeof the videofile; video/x-flvfor FLV files,video/x-ms-wmv for WMVfiles,video/mp4 forMP4 files, orany other validvideo MIMEtype. Editingthis parameterwill actuallyadd a newvideo.

type=video/x-ms-wmv

bitrate yes integer

The videobitrate, inkilobits/second.Editing thisparameter willactually add anew video.

bitrate=256

integer

The videoduration inseconds.

duration yes integer Editing thisparameter willactually add anew video.

duration=10

height yes integer The videoheight in pixels. height=300

width yes integer The videowidth in pixels. width=150

url yes integer The video URLlocation.

url=www.video.com/watch?v=5znh58WITU8

Return <liverailapi requested="/creative/video/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/video/upload

Method Description

Upload an asset for an existing video creative. The HTTP POST variable for thefilename is "upload_file". Also, make sure to use HTTP content encoding type asmultipart/form-data.

Parameters






The numericID of theexisting in-streamcreative towhich youwant toupload avideo asset.

creative_id=222

Return <liverailapi requested="/creative/video/upload" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/video/delete

Method Description

Delete existing video assets attached to a creative. You can use a combination oftype and/or bitrate in order to narrow down the video asset(s) you want to delete.

Parameters






The numeric IDof the existingin-streamcreative towhich thisvideo assetadded. If thisparameter isthe only onespecified, willdelete all thevideo assetsattached to thecreative ID.

creative_id=222

type no string

The MIME typeof the videofile; video/x-flvfor FLV files,video/x-ms-wmv for WMVfiles,video/mp4 forMP4 files, orany other validvideo MIMEtype. Ifspecified, willdelete all thevideo assetswith thisparticular type.

type=video/x-ms-wmv

bitrate no integer

The videobitrate, inkilobits/second.If specified, willdelete all thevideo assets

bitrate=256

with thisbitrate.

Return <liverailapi requested="/creative/video/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


OVERLAY CREATIVES

All the methods related to overlay creatives are displayed here.

/creative/overlay/add/creative/overlay/edit/creative/overlay/list/creative/overlay/upload/creative/overlay/delete

Method Name: /creative/overlay/list

Method Description

List the overlay attached to an existing creative, if any.

Parameters






The numericID of thecreative forwhich theoverlay will beretrieved.

creative_id=222

Return <liverailapi requested="/creative/overlay/list" api_version="X.Y.Z"> <creative> <overlays> <overlay> <url>the URL of the overlay</url> <height>the height of the overlay, in pixels</height> <width>the width of the overlay, in pixels</width> </overlay> </overlays> </creative> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/overlay/add

Method Description

Add an overlay to an existing creative. Please note that a creative can have onlyone overlay attached to it.

Parameters






The numericID of thecreative forwhich theoverlay will beadded.

creative_id=222

url yes string The URL ofthe overlay. url=www.test.com

height yes integer

The height forthecompanionframe, inpixels.

height=300

width yes integer

The width forthecompanionframe, inpixels.

width=150

Return <liverailapi requested="/creative/overlay/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/overlay/edit

Method Description

Edit an existing overlay.

Parameters






The numericID of thecreative forwhich theoverlay will beadded.

creative_id=222

url no string The URL ofthe overlay. url=www.test.com

height no integer


height=300

width no integer


width=150

Return <liverailapi requested="/creative/overlay/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/overlay/upload

Method Description

Upload an asset for an existing overlay creative. This method returns an uploadURL to which you need to send the asset using HTTP POST. Before POST-ing,make sure you suffix the upload URL with the following:'&extension=<overlay_extension>' where <overlay_extension> can be jpg, png orgif for static images overlays or swf for Flash SWF based overlays. The HTTPPOST variable for the filename is "upload_file". Also, make sure to use HTTPcontent encoding type as multipart/form-data.

Parameters






The numericID of theexistingoverlaycreative towhich youwant toupload anasset.

creative_id=222

Return <liverailapi requested="/creative/overlay/upload" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <url>the upload URL to wich the overlay asset must be uploaded through HTTP POST, suffixed with &extension={jpg|png|gif|swf}</url> <error>error if status=fail, null otherwise</error></liverailapi>

Change History


Method Name: /creative/overlay/delete

Method Description

Delete an overlay already attached to a creative.

Parameters






The numericID of thecreativewhoseoverlay isbeing deleted.

creative_id=222

Return <liverailapi requested="/creative/overlay/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


COMPANIONS

All the methods related to creative companions are displayed here.

/creative/companion/add/creative/companion/edit/creative/companion/list/creative/companion/upload/creative/companion/delete

Method Name: /creative/companion/list

Method Description

List the companions attached to a creative.

Parameters






The numericID of thecreative towhich thecompanion isattached.

creative_id=222

creative_companion_id yes integer

The numericID of thecompanionattached tothe creative.Must bespecified if nocreative_id isspecified.

creative_companion_id=23654

Return <liverailapi requested="/creative/companion/list" api_version="X.Y.Z"> <creative> <companions> <companion> <creative_id>the numeric ID of the creative</creative_id> <creative_companion_id>the numeric ID of the companion</creative_companion_id> <width>the companion's frame width, in pixels</width> <height>the companion's frame height, in pixels</height> <type>the companion type (image, flash, js, iframe, plain)</type> <content>the companion's URL or content</content> <clickthru>clickthru URL for the companion</clickthru> <iframe>yes|no</iframe> </companion> ... </companions> </creative> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/companion/add

Method Description

Add a companion to a creative.

Parameters






The numericID of thecreative towhich thecompanionwill be added.

creative_id=222

height yes integer


height=300

width yes integer


width=150

type yes string

The type ofthecompanion;image - forimagecompanions,flash - forFlashanimations, js- forJavaScriptcompanions,iframe - forIFRAMEcompanions,plain - forplain HTMLcompanions.

type=js

content yes string

Thecompanion'sURL orcontent (js,iframe, plain).

content=js

iframe no enum

Specifywhether thecompanion isiframe or not.The acceptedvalues are"yes" | "no".The defaultvalue is "no".Thisparameter isoptional.

iframe=yes

clickthru no stringThecompanion'sclickthru URL.

clickthru=www.testing.com

Return <liverailapi requested="/creative/companion/add" api_version="X.Y.Z"> <creative_companion_id>the companion numeric ID for the newly added companion</creative_companion_id> <user> ... </user> <auth> ... </auth>

<status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/companion/edit

Method Description

Edit a creative companion.

Parameters





creative_companion_id yes integerThe numericID of thecompanion toedit.


height no integer


height=300

width no integer


width=150

type no string

The type ofthecompanion;image - forimagecompanions,flash - forFlashanimations, js- forJavaScriptcompanions,iframe - forIFRAMEcompanions,plain - forplain HTMLcompanions.

type=js

content no string

Thecompanion'sURL orcontent (js,iframe, plain).

content=js

Specifywhether thecompanion isiframe or not.The accepted

iframe no enum values are"yes" | "no".The defaultvalue is "no".Thisparameter isoptional.

iframe=yes

clickthru no stringThecompanion'sclickthru URL.

clickthru=www.testing.com

Return <liverailapi requested="/creative/companion/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/companion/upload

Method Description

Uploads an asset for a creative companion. The method will return the uploadURL to which you have to upload the asset for the creative companion usingclassical HTTP POST. Make sure that you suffix this URL with the following:'&extension=<companion_extension>' where <companion_extension> can be jpg,png or gif for creative companions created with type='image' or swf for creativecompanions created with type='flash'. The HTTP POST variable for the filenameis "upload_file". Also, make sure to use HTTP content encoding type asmultipart/form-data.

Parameters





creative_companion_id yes integer

The numericID of thecompanion forwhich theasset will beuploaded.


Return <liverailapi requested="/creative/companion/upload" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <url>the upload URL to which you need to upload the asset for the creative companion using HTTP POST</url> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/companion/delete

Method Description

Delete a creative companion.

Parameters





creative_id yes integerThe numeric ID of thecreative to which thecompanion is attached.

creative_id=222

creative_companion_id no integer

The numeric ID of thecompanion to bedeleted. If nocreative_companion_idis specified, all thecompanions attachedto creative_id will bedeleted.


Return <liverailapi requested="/creative/companion/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


TRACKERS

All the methods related to creative trackers are displayed here.

/creative/tracker/add/creative/tracker/edit/creative/tracker/list/creative/tracker/delete

Method Name: /creative/tracker/list

Method Description

List the trackers associated with a creative.

Parameters






The numeric ID ofthe creative forwhich the trackerswill be listed. Mustbe specified if nocreative_tracker_idis given. If youhave multiple id(s)you can make asingle call byglueing themtogether with | or ,

creative_id=222

creative_tracker_id yes integer

The numeric ID ofthe trackers to belisted. Must bespecified if nocreative_id isgiven. If you havemultiple id(s) youcan make a singlecall by glueingthem together with| or ,

creative_tracker_id=874687

order_line_id no integer

The numeric ID ofthe main order linefor which thetrackers will belisted.

order_line_id=o397547

Return <liverailapi requested="/creative/tracker/list" api_version="X.Y.Z"> <creative> <trackers> <tracker> <creative_tracker_id>The numeric ID of the tracker</creative_tracker_id> <creative_id>The numeric ID of the creative</creative_id> <event>the event of tracker</event> <url>the URL of the tracker</url> <redirect>yes/no</redirect> <order_line>The order line.</order_line> </tracker> ... </trackers> </creative> <user> ... </user>


Change History

Date Description Reason28 May2012

Added creative_tracker_id, order_line_id, updated xmlresponse

Align withAPI

Method Name: /creative/tracker/add

Method Description

Add a tracker to a creative.

Parameters





creative_id yes integerThe numeric ID of thecreative to which thetracker will be added.

creative_id=222

order_line_id yes string

The numeric ID of theorder line to which thetracker will be added.The correct formatstarts by letter "o"followed by theorderline ID.


event yes string

The tracker event:impression -impression, accept -accept invitation,clickthru - video click-through, view25 - firstquartile (25%watched), view50 -midpoint (50%watched), view75 -third quartile (75%watched), view100 -complete view (100%watched), pause -video paused, mute -video muted, minimize- minimize overlay,close - close,companion_impression- companionimpression, error -error, skip, custom1from custom8 - customevents that can besend from player

event=firstq

url yes string url for the tracker. url=http://www.youtube.com/watch?v=YPhhJHrxrCM

redirect yes enum

Redirect to 3rd partytrackers. Theaccepted values are:"yes" or "no". Thedefault value is "no".

redirect=yes

Return

<liverailapi requested="/creative/tracker/add" api_version="X.Y.Z"> <creative_tracker_id>the numeric ID of the new tracker</creative_tracker_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason11 July 2012 Changed event values Align with API11 September 2012 Added 'error' in event values Align with API

Method Name: /creative/tracker/edit

Method Description

Edit tracker for an existing creative. The unicity of a tracker is determined by thetuple (creative_id, event, url) thus you can have multiple trackers for the samecreative and for the same event but with different URLs.

Parameters





creative_id yes integerThe numeric ID of thecreative on which thetracker will be edited.

creative_id=222

creative_tracker_id yes integerThe numeric ID of thetracker that will beedited.



The numeric ID of theorder line for which thetracker is edited. Thecorrect format starts byletter "o" followed bythe orderline ID.


event no string

The new trackerevent: impression -impression, accept -accept invitation,clickthru - video click-through, fview25 - firstquartile (25%watched), view50 -midpoint (50%watched), view75 -third quartile (75%watched), view100 -complete view (100%watched), pause -video paused, mute -video muted, minimize- minimize overlay,close - close,companion_impression- companionimpression, error -error, skip, custom1from custom8 - customevents that can besend from player

event=accept

url no string The new URL of thetracker. url=www.trackernew.com

Return

<liverailapi requested="/creative/tracker/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/tracker/delete

Method Description

Delete a tracker for an existing creative.

Parameters






The numericID of thecreative fromwhich thetracker will bedeleted.

creative_id=222

creative_tracker_id no integer

The numericID of thetracker thatwill bedeleted.


Return <liverailapi requested="/creative/tracker/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


CREATIVE ADVERTISER

All the methods related to creative advertisers are displayed here.

/creative/advertiser/add/creative/advertiser/list/creative/advertiser/delete

Method Name: /creative/advertiser/list

Method Description

List the advertiser(s) attached to an existing creative(s), if any.

Parameters






The numericID of thecreative(s) forwhich theadvertiserswill beretrieved. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or ,

creative_id=444,999

advertiser_id no integerSearch basedon thenumeric ID ofthe advertiser.

advertiser_id=9542

Return <liverailapi requested="/creative/advertiser/list" api_version="X.Y.Z"> <advertisers> <advertiser> <advertiser_id>The numeric ID of the advertiser.</advertiser_id> <creative_id>The numeric ID of the creative.</creative_id> </advertiser> ...</advertisers><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History

Method Name: /creative/advertiser/add

Method Description

Add a new advertiser to an existing creative.

Parameters






The numericID of thecreative towhich theadvertiser willbe added.

creative_id=999

advertiser_id yes integer

The numericID of theadvertiser tobe added tothe creative. Ifthere areadvertiser atthe creativecampaignlevel, addingnewadvertisershere is notallowed.

advertiser_id=9542

Return <liverailapi requested="/creative/advertiser/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/advertiser/delete

Method Description

Delete an advertiser from an existing creative.

Parameters






The numericID of thecreative fromwhich theadvertiser willbe removed.

creative_id=999


The numericID of theadvertiser tobe removedfrom thecreative.Deletingadvertisers isnot possiblewhen thereareadvertisers atthe creativecampaignlevel.

advertiser_id=9542

Return <liverailapi requested="/creative/advertiser/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


CREATIVE ADVERTISING CATEGORY

All the methods related to creative advertising categories are displayed here.

/creative/advertising/category/add/creative/advertising/category/list/creative/advertising/category/delete

Method Name: /creative/advertising/category/list

Method Description

List the advertising category(es) attached to an existing creative(s), if any.

Parameters






The numericID of thecreative(s) forwhich theadvertisingcategories willbe retrieved.If you havemultiple id(s)you can makea single callby glueingthem togetherwith | or ,

creative_id=999,655

advertising_category_id no integer

Search basedon thenumeric ID oftheadvertisingcategory.

advertising_category_id=9542

Return <liverailapi requested="/creative/advertising/category/list" api_version="X.Y.Z"> <advertising_categories> <advertising_category> <advertising_category_id>The numeric ID of the advertising category.</advertising_category_id> <creative_id>The numeric ID of the creative.</creative_id> </advertising_category> ...</advertising_categories> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/advertising/category/add

Method Description

Add an advertising category to an existing creative.

Parameters






The numericID of thecreative towhich theadvertisingcategory willbe added.

creative_id=999

advertising_category_id yes integer

The numericID of theadvertisingcategory tobe added tothe creative.


Return <liverailapi requested="/creative/advertising/category/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/advertising/category/delete

Method Description

Delete an advertising category from an existing creative.

Parameters






The numericID of thecreative fromwhich theadvertisingcampaign willbe removed.

creative_id=999


The numericID of theadvertisingcategory tobe removedfrom thecreative.


Return <liverailapi requested="/creative/advertising/category/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


CREATIVE CAMPAIGNS

Create a creative campaign group to organize one group of creatives.

Creative Campaigns/creative/campaign/add/creative/campaign/edit/creative/campaign/list/creative/campaign/delete/creative/campaign/resolve/name

Method Name: /creative/campaign/list

Method Description

Displays the information related to a creative. Also, it can be used to list thecreatives attached to a creative group (campaign).

Parameters






The id of the entity forwhich you want to get thelist of creativecampaigns. If not given,this parameter willautomatically get thevalue of the currententity.

entity_id=999

creative_campaign_id no integer

One or more creativecampaign id(s). If youhave multiple id(s) youcan make a single call byglueing them togetherwith | or ,

campaign_creative_id = 1|7|120 orcampaign_creative_id = 1,7,120

advertiser_id no integer

Use this parameter toreturn only the creativegroups assigned to oneor more advertiser(s). Ifyou have multiple id(s)you can make a singlecall by glueing themtogether with | or ,

advertiser_id = 1|7|120 orcampaign_creative_id = 1,7,120

status no stringSearch based on thestatus of the campaign.Possible values are:active or archived.

status=archived


The call will return onlythe creative campaignsthat have a name thatmatches the searchstring and the creativecampaigns that areasigned to an advertiserwhose name matches thesearch string.

search_string=music

limit no integer Limit the number ofresults for pagination(s). limit=10

offset no integer

The offset from wherethe limit should beapplied ( if you display 10groups per page and youneed to get the 3rd pageyou should set offset to20 and limit to 10). Thisparameter must be usedtogetjher with limit andshouldn't be givenwithout giving the limitparameter as well.

offset=20

order_by no string

The order by criteria thatshould be applied for thelist. The supportedvalues are: order_by=creation_time

creative_campaign_nameand creation_time.

order_type no string

The order type thatshould be applied. Thesupported values are:asc and desc. Thisparameter shouldn't beused without settingorder_by as well.

order_type=asc

Return <liverailapi requested="/creative/campaign/list" api_version="X.Y.Z"> <campaigns> <campaign> <creative_campaign_id>creative group's ID</creative_campaign_id> <entity_id>entity's ID</entity_id> <creation_time>creative group creation full date (YYYY-MM-DD HH:MM:SS)</creation_time> <creative_campaign_name>the name of the creative group</creative_campaign_name> <advertiser_id>advertiser's ID</advertiser_id> <status>active and/or archived</advertiser_id> <name>advertiser's name</name> </campaign> ... <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason15 June 2012 Added status. Align with API.

Method Name: /creative/campaign/resolve/name

Method Description

Obtain the creative group (campaign) name for a given creative group (campaign)numeric ID.

Parameters






The creativegroup(campaign)for which thecreativegroup(campaign)name will bereturned.Multiplecreativegroups(campaigns)ID areallowed,separated bycomma (,).

creative_campaign_id=999, 666

Return <liverailapi requested="/creative/campaign/resolve/name" api_version="X.Y.Z"> <campaigns> <campaign> <creative_campaign_id>creative group (campaign) numeric ID</creative_campaign_id> <creative_campaign_name>creative group (campaign) name</creative_campaign_name> </campaign> .... </campaigns> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /creative/campaign/add

Method Description

Add a new creative group (campaign) and attaches to the current entity.

Parameters





creative_campaign_name yes stringThe name ofthe creativegroup.

creative_campaign_name=testing


The numeric IDof theadvertiser. If"LR_API_NULL"is used, theadvertiser_idwill be cleared.

advertiser_id=875

Return <liverailapi requested="/creative/campaign/add" api_version="X.Y.Z"> <creative_campaign_id>the numeric ID of the newly created creative group</creative_campaign_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason15 June 2012 Added advertiser_id. Align with API.

Method Name: /creative/campaign/edit

Method Description

Edit a creative group (campaign).

Parameters





creative_campaign_id yes integerThe numeric IDof the creativegroup to beedited


creative_campaign_name no stringThe new nameof the creativegroup.

creative_campaign_name=testing1


The numeric IDof theadvertiser. If"LR_API_NULL"is used, theadvertiser_idwill be cleared.

advertiser_id=875

status no string

The status ofthe group.Possible valuesare: "active" (foractive groups),"archived" (forarchivedgroups). Thedefault value is"active"

status=archived

Return <liverailapi requested="/creative/campaign/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason15 June 2012 Added advertiser_id, status. Align with API.

Method Name: /creative/campaign/delete

Method Description

Delete an existing creative group (campaign).

Parameters






The numericID of thecreativegroup to bedeleted.


Return <liverailapi requested="/creative/campaign/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ORDER NUMBERS

All the methods related to the order numbers are displayed here.

/order/number/list/order/number/resolve/name/order/number/resolve/name/from/order

Method Name: /order/number/list

Method Description

Returns the order numbers for an entity ( either explicitly given or the current one).

Parameters





order_number_id no string

The ordernumber ID(s).If you havemultiple ID(s)you can makea single callby glueingthem togetherwith | or ,

order_number_id = 1|7|120 ororder_number_id = 1,7,120

entity_id no string

TThe id ofthe entity forwhich youwant toretrieve thelist of ordernumber(s). Ifnot given, thisparameter willautomaticallyget the valueof the currententity.

entity_id=533


Return onlythe ordernumbers thatcontains thegiven searchstring.

search_string=22

Return <liverailapi requested="/order/number/list" api_version="X.Y.Z"> <order_numbers> <order_number> <id>The id if the order number</id> </order_number>

... </order_numbers> <user> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/number/resolve/name

Method Description

Returns the values for a list of order_number_id(s). This method should be usedwhen dimension[1,2,3] from statistics was order_number_id and you need to knowthe actual order number for the retrieved id(s).

Parameters





order_number_id yes string

Theorder_number_id(s)for which you needto retrieve the ordernumber. If you havemultiple ID(s) youcan make a singlecall by glueingthem together with| or ,

order_number_id = 1|7|120 ororder_number_id = 1,7,120

Return <liverailapi requested="/order/number/resolve/name" api_version="X.Y.Z"> <order_numbers> <order_number> <order_number_id>the id if the order number</order_number_id> <order_number>the order number</order_number> </order_number> ... </order_numbers> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/number/resolve/name/from/order

Method Description

Returns the order names for a list of order ID(s).

Parameters





order_id yes string

The orderID(s). If youhave multipleID(s) you canmake a singlecall by glueingthem togetherwith | or , (examples: ifyou need toget the ordernames fororder numberID(s) 1, 7 and120 you canuse order_id =1|7|120 ororder_id =1,7,120 )

order_id = 1|7|120 or order_id = 1,7,120

Return <!--<liverailapi requested="/order/name/resolve/name/from/order" api_version="X.Y.Z"> <orders> <order> <order_id>the order ID</order_id> <order_name>the order name</order_name> </order> ... </orders> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

ORDER PACKAGES

Preparing order packages for submission to LiveRail’s system is straightforward and highlycustomizable. Each order package contains one or more order lines, or differential deliverysettings for an Order. An order package has a one-to-many relationship with order lines. Namingorders can follow any convention.

/order/package/add/order/package/edit/order/package/list/order/package/list/stop/order/package/delete/order/package/resolve/name/order/package/archive/order/package/staging/order/package/integration/list/order/package/get/vast

Method Name: /order/package/list

Method Description

Return the information for an order package or for all order packages attached tothe current entity.

Parameters





order_id no string

The ID of theorder for whichthe details will bereturned. If null(not given), willreturn all ordersowned/targetedto the currententity.

order_id=77654 or order_id=55432


Return only theorder packagesthat have thename, ordernumber ororder_idmatching the%search_string%

search_string=camp

publisher_id no string

Return onlyorders targetedto this publisher.If null (not given),will return allordersowned/targetedto the currententity

publisher_id=3334

status no string

Return onlyorders with thisstatus. Values:active, inactive,completed. If null(not given), willreturn all ordersowned/targetedto the currententity

status=completed

has_waiting no string

Return onlyorders with thisstatus. Values: 0,1. If null (notgiven), will returnall ordersowned/targetedto the currententity

has_waiting=1

has_refused no string


has_refused=0

is_archived no string


is_archived=1

staging no string

Return onlyorders with thisstatus. Values: 0,1. If null (notgiven), will returnall orders

staging=0

owned/targetedto the currententity

limit no integerLimit the numberof the returnedresults.

kimit=20

offset no integer Specify where tostart the list from. offset=1

owned no string

The acceptedvalues are:yes|no|null. Ifyes, only ownedorders will beretuned, if no,only targetedorders will beretuned, if null,all the orders,both owned andtargeted to thecurrent entity willbe returned.

owned=yes

hide_archived no enum

Hide the archivedorders. Theaccepted valuesare "yes" or "no".The default valueis "yes".

hide_archived=no

flight_time_start no string

Return onlyorders with thisflight time start. Ifnull (not given),will return allordersowned/targetedto the currententity

flight_time_start=2012-07-17 22:00:00


Return onlyorders with thisflight time end. Ifnull (not given),will return allordersowned/targetedto the currententity

flight_time_end=2013-01-17 22:00:00

time_start no string

Return onlyorders with thistime start. If null(not given), willreturn all ordersowned/targetedto the currententity

time_start=2012-12-17 22:00:09

order_number_id no integer The order order_number_id=876645342

Return <liverailapi requested="/order/package/list" api_version="x.y.z"> <orders> <order> <order_id>Order Id.</order_id> <order_ownership>owned|targeted</order_ownership> <name>Order Name</name> <comments>Order Comments</comments> <cost_model>cpm|cpc</cost_model> <ad_unit_type>ad unit type as defined in /order/package/add</ad_unit_type> <order_number_id>Order Number Id</order_number_id> <order_number>Order Number</order_number> <creation_time>YYYY-MM-DD H:i:s</creation_time> <time_start>YYYY-MM-DD H:i:s</time_start> <time_end>YYYY-MM-DD H:i:s the max end_time for the lines attached to this order</time_end> <network_id>Id for the entity that owns/targeted the order.</network_id> <organization></organization> <is_archived>0|1</is_archived> <is_staging>0|1</is_staging> <has_waiting>0|1</has_waiting> <has_refused>0|1</has_refused> <order_status>completed|active|inactive</order_status> <order_status_details>Details</order_status_details> <priority>0|20|50|80|100</priority> <random_sequencing>1|0 if the order lines in this order are selected randomly or not.</random_sequencing> <number_of_lines>how many lines are attached to this order</number_of_lines> <publishers> <publisher>publisher_id</publisher> </publishers> </order> ... </orders> <count>number of order packages in the reply without any limit</count> <user> ... </user>


Change History

Date Description Reason21 June 2012 Added 3 new parameters Align with API30 July 2012 Added 1 more parameter Align with API

Method Name: /order/package/add

Method Description

Add a new order package.

Parameters





name yes string The name of thenew package name=test

ad_unit_type no string

The type of theorder package.The accepedvalues are: in -instream, ov-bug- overlay withouttake-over, ov-take - overlaywith take-over,ov-text - textoverlay, vpaid-in- VPAID liniar,vpaid-ov -VPAID non-linear. Oncespecified, itcannot bechanged via editmethod.

ad_unit_type=ov

cost_model no string

The cost modelof the orderpackage. Theaccepted valuesare: cpc - costper click, cpm -cost perthousands

cost_model=cpc

priority no integer

The priority ofthe package.Possible valuesare:0,20,50,80,100.

priority=20

random_sequencing no set

Order Lines inthis order will beselectedrandomly,ignoringsequencing,after targetingrules areapplied. Theaccepted valuesare: "0" or "1".Default value is"0".

random_sequencing=1

aperture_enabled no set

Enable aperture.The acceptedvalues are: "yes"or "no". Defaultvalue is "no"

aperture_enabled=yes

inte_adxpose_id no string

Specify theAdXposenumerical ID.The defaultvalue is null. Ifthe specifiedvalue is"LR_API_NULL",

inte_adxpose_id=785

the integrationwill be cleared.

inte_vizu_campaign_id no string

Specify the Vizunumericalcampaign ID.The defaultvalue is null. Ifthe specifiedvalue is"LR_API_NULL",the integrationwill be cleared.

inte_vizu_campaign_id=77

inte_vizu_agency_enabled no string

Specify if VizuAgency isenabled or not.The acceptedvalues are "yes"| "no". Thedefault value is"no".

inte_vizu_agency_enabled=yes

inte_doubleverify_client_id no string

Specify theDoubleVerifynumerical clientID. The defaultvalue is null. Ifthe specifiedvalue is"LR_API_NULL",the integrationwill be cleared.

inte_doubleverify_client_id=745

inte_doubleverify_campaign_id no string

Specify theDoubleVerifynumericalcampaign ID.The defaultvalue is null. Ifthe specifiedvalue is"LR_API_NULL",the integrationwill be cleared.


inte_doubleverify_behavior no enum

Specify theDoubleVerifybehavior. Theaccepted valuesare "R", "B" and"RB" (Reportingor Blocking).The defaultvalue is "R".This parameteris optional.

inte_doubleverify_behavior=RB

order_number no string

Specify theorder number.The defaultvalue is null. Ifthe specifiedvalue is"LR_API_NULL",the integrationwill be cleared.

order_number=72285

inte_safecount_campaign_id no string

Specify theSafecountnumericalcampaign ID.The defaultvalue is null. Ifthe specifiedvalue is"LR_API_NULL",the integrationwill be cleared.

inte_safecount_client_id=334

inte_safecount_in_enabled no enum

Specify if theSafecountintegration isenabled or not.The acceptedvalues are "yes"| "no". The

inte_safecount_in_enabled=yes

default value is"no".

inte_affine_line_item_id no string

Specify thenumerical ID forthe Affine 3rdpartyintegration. Thedefault value isnull. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.

inte_affine_line_item_id=2346

inte_nielsen_campaign_id no string

Specify theNielsenCampaign ID.This parameteris optional.

inte_nielsen_campaign_id=2346

inte_nielsen_start_age no string

Specify thelowest age limitfor the Nielsenage rangereport. Thisparameter isoptional.

inte_nielsen_start_age=2

inte_nielsen_end_age no string

Specify thehighest age limitfor the Nielsenage rangereport. Thisparameter isoptional.

inte_nielsen_end_age=99

inte_nielsen_alpha_code no string

Specify theNielsen alphacode. Thisparameter isoptional.

inte_nielsen_alpha_code=A

Return <liverailapi requested="/order/package/add" api_version="X.Y.Z"> <order_id>the ID of the order</order_id> <order_number_id>Order number id if a new order number was created. Can be null</order_number_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason20 March 2012 Added dv_behavior parameter Align with API tester21 July 2012 Added 3 more parameters Align with API30 July 2012 Added 1 more parameter Align with API10 September 2012 Added 1 more parameter Align with API15 January 2013 Added new params. Align with API

Method Name: /order/package/edit

Method Description

Edit the details of an order package.

Parameters





order_id yes stringThe numericalID of the orderto be edited.

order_id=77654

name no string

The new nameof the package.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way.

name=test

priority no integer

The priority ofthe package.Possible valuesare:0,20,50,80,100.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way.

priority=20

random_sequencing no set

Order Lines inthis order will beselectedrandomly,ignoringsequencing,after targetingrules areapplied. Theaccepted valuesare: "0" or "1".This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way.

random_sequencing=1

Specify theorder number.This parameteris optional,meaning that, if

order_number no stringnot given, theparameter valueis not altered inany way. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.

order_number=72285

inte_adxpose_id no string

Specify theAdXposenumerical ID.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.

inte_adxpose_id=785

inte_vizu_campaign_id no string

Specify the Vizunumericalcampaign ID.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way.

inte_vizu_campaign_id=77

inte_vizu_agency_enabled no string

Specify if VizuAgency isenabled or not.The acceptedvalues are "yes"| "no". Thisparameter isoptional,meaning that, ifnot given, theparameter valueis not altered inany way.

inte_vizu_agency_enabled=yes

inte_doubleverify_client_id no string

Specify theDoubleVerifynumerical clientID. Thisparameter isoptional,meaning that, ifnot given, theparameter valueis not altered inany way. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.


Specify theDoubleVerifynumericalcampaign ID.

inte_doubleverify_campaign_id no string

This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.


inte_doubleverify_behavior no enum

Specify theDoubleVerifybehavior. Theaccepted valuesare "R", "B" and"RB" (Reportingor Blocking).This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way.

inte_doubleverify_behavior=RB

order_number no string

Specify theorder number.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.

order_number=72285

inte_safecount_campaign_id no string

Specify theSafecountnumericalcampaign ID.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.

inte_safecount_client_id=334

inte_safecount_in_enabled no enum

Specify if theSafecountintegration isenabled or not.The acceptedvalues are "yes"| "no". Thisparameter isoptional,meaning that, ifnot given, the

inte_safecount_in_enabled=yes

parameter valueis not altered inany way.

inte_affine_line_item_id no string

Specify thenumerical ID forthe Affine 3rdpartyintegration. Thisparameter isoptional,meaning that, ifnot given, theparameter valueis not altered inany way. If thespecified valueis"LR_API_NULL",the integrationwill be cleared.

inte_affine_line_item_id=2346

inte_nielsen_campaign_id no string

Specify theNielsenCampaign ID.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way.

inte_nielsen_campaign_id=2346

inte_nielsen_start_age no string

Specify thelowest age limitfor the Nielsenage rangereport. Thisparameter isoptional,meaning that, ifnot given, theparameter valueis not altered inany way.

inte_nielsen_start_age=2

inte_nielsen_end_age no string

Specify thehighest age limitfor the Nielsenage rangereport. Thisparameter isoptional,meaning that, ifnot given, theparameter valueis not altered inany way.

inte_nielsen_end_age=99

inte_nielsen_alpha_code no string

Specify theNielsen alphacode. Thisparameter isoptional,meaning that, ifnot given, theparameter valueis not altered inany way.

inte_nielsen_alpha_code=A

Add commentsregarding the

comments no string

order package.This parameteris optional,meaning that, ifnot given, theparameter valueis not altered inany way.

comments=test package.

Return <liverailapi requested="/order/package/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason20 March 2012 Added dv_behavior parameter Align with API tester21 July 2012 Added 3 more parameters Align with API30 July 2012 Added 1 more parameter Align with API10 September 2012 Added 1 more parameter Align with API15 January 2013 Added new params. Align with API

Method Name: /order/package/delete

Method Description

Delete an owned order package and all the order lines attached to it.

Parameters





order_id yes stringThe numericalID of the orderpackage to bedeleted.

order_id=77654

Return <liverailapi requested="/order/package/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/package/get/vast

Method Description

Retrieve the VAST for a specific publisher.

Parameters






The numericID of thepublishercorrespondingto theorder_id forwhich theVAST isgenerated.Thisparametermust bespecified if noorder_id ororder_line_idis given. Ifyou havemultiple id(s)you can makea single callby gluingthem togetherwith | or , (examples: ifyou need toget theinformation forid(s) 1, 7 and120 you canusepublisher_id =1|7|120 orpublisher_id =1,7,120 ).

publisher_id=1,7,120

The numericID of theorder. Thisparametermust be

order_id no string

must bespecified if nopublisher_idororder_line_idis given. Ifyou havemultiple id(s)you can makea single callby gluingthem togetherwith | or , (examples: ifyou need toget theinformation forid(s) 1, 7 and120 you canuse order_id= 1|7|120 ororder_id =1,7,120 ). Theorders mustbe all eitherowned ortargeted, acombinationof the twoorder types isnot accepted.

order_id=1,7,120


TThe numericID of theorder line.Thisparametermust bespecified if nopublisher_idor order_id isgiven. If youhave multipleid(s) you canmake a singlecall by gluingthem togetherwith | or , (examples: ifyou need toget theinformation forid(s) 1, 7 and120 you canuseorder_line_id= 1|7|120 ororder_line_id= 1,7,120 ).The order

order_line_id=1,7,120

lines must beall eitherowned ortargeted, acombinationof the twoorder linetypes is notaccepted.

Return <liverailapi requested="/order/package/get/vast" api_version="X.Y.Z"> <tags> <tag>URL of the VAST</tag> ... </tags> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/package/archive

Method Description

Sets the archived status for one or more order(s).

Parameters





order_id yes integer

The numericID of theorder(s) to bearchived. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need tomodify theorders withthe id(s) 1, 7and 120 youcan useorder_id =1|7|120 ororder_id =1,7,120 ).

order_id=1,7,120


Set the orderline to bearchived. Theacceptedvalues are"yes" or "no".Cannot beused foractive orderlines.

is_archived=yes

Return <liverailapi requested="/order/package/archive" api_version="X.Y.Z"> <user> ... </user>


Change History

Date Description Reason21 June 2012 Added page into CHM Align with API

Method Name: /order/package/staging

Method Description

Sets one or more order(s) as staging.

Parameters






The numericID of theorder(s) to beset to staging.If you havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need tomodify theorders withthe id(s) 1, 7and 120 youcan useorder_id =1|7|120 ororder_id =1,7,120 ).

order_id=1,7,20

is_staging yes enum

Set the orderline to be setto staging.The acceptedvalues are"yes" or "no".The defaultvalue is "yes".

is_staging=yes

Return <liverailapi requested="/order/package/staging" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status>

<error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/package/integration/list

Method Description

Return the integration information for an order packagage.

Parameters






The ID of theorder(s) forwhich thedetails will bereturned. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need toget the ordernames forid(s) 1, 7 and120 you canuse order_id= 1|7|120 ororder_id =1,7,120 ).

order_id=1,7,120

Return <liverailapi requested="/order/package/integration/list" api_version="x.y.z"> <orders> <order> <order_id>The order ID</order_id> <inte_vizu_campaign_id>integration value</inte_vizu_campaign_id> <inte_vizu_agency_enabled>yes|no</inte_vizu_agency_enabled> <inte_adxpose_id>integration value</inte_adxpose_id> <inte_doubleverify_client_id>integration value</inte_doubleverify_client_id> <inte_doubleverify_campaign_id>integration value</inte_doubleverify_campaign_id> <inte_doubleverify_behavior>integration value</inte_doubleverify_behavior> <inte_aperture_enabled>yes|no</inte_aperture_enabled> <inte_safecount_campaign_id>integration value</inte_safecount_campaign_id> <inte_safecount_in_enabled>yes|no</inte_safecount_in_enabled> <inte_affine_line_item_id>integration value</inte_affine_line_item_id> <inte_evidon_client_id>integration value</inte_evidon_client_id> <inte_evidon_campaign_id>integration valueL</inte_evidon_campaign_id> <inte_truste_id>integration value</inte_truste_id> <inte_nielsen_campaign_id>integration value</inte_nielsen_campaign_id> <inte_nielsen_start_age>integration value</inte_nielsen_start_age> <inte_nielsen_end_age>integration value</inte_nielsen_end_age> <inte_nielsen_alpha_code>integration value</inte_nielsen_alpha_code> </order> ... </orders> <user> ... </user> <auth> ... </auth> <status>success or fail</status>

<error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/package/resolve/name

Method Description

Returns the order names for a list of order id(s). This method should be usedwhen dimension[1,2,3] from statistics was order_id and you need to know theactual names for the retrieved id(s).

Parameters





order_id yes string

The numericalID of the orderpackage forwhich thename will bereturned.

order_id=77654

Return <liverailapi requested="/order/package/resolve/name" api_version="X.Y.Z"> <orders> <order> <order_id>the order id</order_id> <name>the order name</name> </order> ... </orders> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ORDER LINES

A LiveRail ad campaign consists of one or several order lines in an order package. A campaign’sdelivery settings are defined in each order line. An order line contains the required deliverysettings, including:

Flight period: start and end calendar date, hour, and minute.;Frequency cappingStop policyOver-delivery policyCreatives assignedCosting informationSite (Publisher, Partner, Network, Marketplace) SelectionTargeting

Order LinesThese are the methods used to handle Order Lines:

/order/line/add/order/line/edit/order/line/list/order/line/list/stop/order/line/delete/order/line/staging/order/line/min/start/date/order/line/max/end/date/order/line/resolve/name/order/line/marketplace/attach/order/line/network/status/set/order/line/publisher/status/set/order/line/creative/list/order/line/publisher/list

Attaching Creatives/order/line/creative/attach/order/line/creative/detach

Attaching Sites/order/line/site/attach/order/line/site/detach

Targeting/order/line/targeting/set/order/line/targeting/list/order/line/targeting/delete

Marketplace Targeting/order/line/marketplace/targeting/set/order/line/marketplace/targeting/list/order/line/marketplace/targeting/delete

Frequency Capping/order/line/frequency/set/order/line/frequency/list

/order/line/frequency/delete

Method Name: /order/line/list

Method Description

Get a list with owned/targeted order lines. Order ID OR Order Line ID are required.

Parameters





order_id yes string

Must bespecified if noorder_line_idvalue isprovided.returns all theorder linescorrespondingto thespecifiedorder_id.

order_id=o987365


Must bespecified if noorder_id valueis provided.returns thedetailscorrespondingto thespecifiedorder_line_id.


cost_model no stringReturn onlyorder lineswith thiscost_model.

cost_model=cpc

ad_unit_type no stringReturn onlyorder lineswith thisad_unit_type.

ad_unit_type=


Order lineflight start fulldate. Formatis: YYYY-MM-DDHH:MM:SS

flight_time_start=2011-12-01 12:00:00

flight_time_end no string

Order lineflight end fulldate. Formatis: YYYY-MM-DDHH:MM:SS

flight_time_end=2011-12-09 12:00:00

publisher_id no integerReturn onlyorderstargeted tothis publisher.

publisher_id=34645

network_id no integerReturn onlyorderstargeted bythis network.

network_id=6777

stop no integerThe possiblevalues are"yes", "no".

stop=yes

Return <liverailapi requested="/order/line/list" api_version="X.Y.Z"> <lines> <line> <line_type>The type of the order line</line_type> <line_ownership>Status of the order line (owned/targeted)</line_ownership> <line_id>Line Id.</line_id> <order_id>Order Id</order_id> <network_id>The numerical ID of the network/entity.</network_id> <network_name>The name of the network/entity</network_name> <order_line_name>The name of the Order Line</order_line_name> <is_template>Template OL (yes/no)</is_template> <time_start>YYYY-MM-DD H:m:s</time_start> <time_end>YYYY-MM-DD H:m:s</time_end> <timezone>float</timezone> <order_line_index>integer</order_line_index> <creation_time>YYYY-MM-DD H:m:s</creation_time> <creative_rotation_type>string</creative_rotation_type> <position>The position of the order line, with returned value as bit mask.</position> <ad_unit_type>string</ad_unit_type> <line_status>active|inactive|completed|waiting|refused. This is the full status for all the lines.</line_status> <global_status>N/A|inactive. If the line is received from someone that received the line from someone else. Eg, at your level the line is active, but higher up the tree the line is paused.</global_status> <daytimes>char array</daytimes> <stop_by>budget/impression</stop_by> <dynamic_price></dynamic_price> <over_delivery>yes|no</over_delivery>

<uniform_pacing>yes|no</uniform_pacing> <uniform_pacing_value>Float value</uniform_pacing_value> <optimize_by>none|clicks|complete_rate|25_rate|50_rate|75_rate.</optimize_by> <settings> <stop_method>string</stop_method> <stop></stop> <stop_type></stop_type> <buffer></buffer> <marketplace_bid_type>cpm</marketplace_bid_type> <marketplace_max_bid_value>55.00</marketplace_max_bid_value> <over_delivery>yes/no</over_delivery> </settings> <publishers> all publishers attached to this line. If you forwarded this line (eg you also received it) your entity will be among the publishers and the values from that entry are the settings you received the line with. <publisher> <publisher_id>integer</publisher_id> <publisher_name>string</publisher_name> <stop_method>string</stop_method> <stop>integer</stop> <stop_type>string</stop_type> <buffer>float</buffer> <cost_method>string</cost_method> <publisher_cost>float</publisher_cost> <gross_rate>float</gross_rate> <cost_model>cpm|cpc</cost_model> <line_site_status>active|inactive|completed|waiting|refused. This is the status for this publisher</line_site_status> <resumable>1|0 if not auto_paused or completed</resumable> <over_delivery>yes|no</over_delivery> <uniform_pacing>yes|no</uniform_pacing> <uniform_pacing>Float value</uniform_pacing> <pacing_value>If uniform_pacing is not enabled, the value for this is always 1. If uniform_pacing is enabled, the value reflects the state of the delivery.</pacing_value> </publisher> <statistics_order_line_id>string</statistics_order_line_id> <statistics_order_id>string</statistics_order_id> <resumable>0|1</resumable> <delivery_completed>0|1</delivery_completed> ... </publishers> <marketplaces> <marketplace> <publisher_id>The numerical ID of the publisher</publisher_id> <publisher_name>The publisher's ID</publisher_name> <stop_method>string</stop_method> <stop>float</stop> <stop_type>string</stop_type> <buffer>float</buffer> <marketplace_bid_type>cpm|cpc</marketplace_bid_type> <marketplace_max_bid_value>float</marketplace_max_bid_value> <pacing_value>If uniform_pacing is not enabled, the value for this is always 1. </pacing_value> <line_site_status>active|inactive|completed|waiting|refused</line_site_status> <statistics_order_line_id>Order Line ID</statistics_order_line_id> <statistics_order_id>Order ID</statistics_order_id> <resumable>1/0</resumable> </marketplace> ... </marketplaces> <creatives> <creative> <creative_id>integer</creative_id> <title>string</title> <creative_campaign_id>integer</creative_campaign_id> <creative_rotation_weight>float</creative_rotation_weight> <status>string</status> <adtag>string</adtag> <clickthru>the clickthru for the line-creative attachment.</clickthru> <creative_click_rate>float</creative_click_rate> <creative_complete_rate>float</creative_complete_rate> </creative> ... </creatives> </line> ... </lines> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/add

Method Description

Add a new order line to an existing order package - more text is needed

Related Methods


/advertiser/list

/creative/list

Parameters




order_id yes stringThe order package ID towhich this order line will beattached.

order_id=o987365

time_start yes stringOrder line flight start full date.Format is: YYYY-MM-DDHH:MM:SS

time_start=2011-12-01 12:00:00

time_end yes stringOrder line flight end full date.Format is: YYYY-MM-DDHH:MM:SS

time_end=2011-12-09 12:00:00

timezone yes float|integer Timezone for the order lineflight start and full date. timezone=2.5

order_line_name yes string The name for the new orderline. order_line_name=testline

stop no integer

The Stop type. Must bespecified whenline_type=marketplace.Default value isLR_API_NULL.

stop=876

line_type no enum

Specify as "marketplace" ifyou want to attach theorderline to amarketplace/LRC (possiblevalues: "site", "marketplace").Default value is "site". Thisparameter cannot be editedonce specified here.

line_type=marketplace

gross_rate no float|integerOrder line CPM price for cpmorders or CPC price for cpcorders.

gross_rate=xyz

net_to_site no float|integerPublisher's rate for this orderline, CPM price for cpm ordersor CPC price for cpc orders.

net_to_publisher=12.8

max_bid no float|integer

This parameter should beused when a marketplace isattached. Only positive valuesare accepted. Must bespecified ifline_type=marketplace.Default value is "null".

max_bid=4.2

order_line_index no integerPosition of the order line inrelation with the other orderlines from the currentpackage.

order_line_index=7

stop_level no enumThe stop level. The possiblevalues are: line_level, stop_method=site_level

stop_level no enum site_level. Default value is:line_level.

stop_method=site_level

stop_period no enumThe order line's stop period.The possible values are: daily,total. The default value istotal.

stop_type=daily

stop_by no enum

The order line's stopcondition. The possible valuesare: impressions, budget. Thedefault value is impressions.This parameter cannot beedited once specified here.

stop_by=budget

over_delivery no enumSpecify if over delivery isallowed. The possible valuesare: yes, no.

over_delivery=no

over_delivery_percent no percent Specify the percent for overdelivery, if over_delivery=yes. over_delivery_percent=75

uniform_pacing no enumSpecify if there is uniformpacing. The possible valuesare: yes, no.

uniform_pacing=yes

uniform_pacing_value no floatAcceptes values: any floatnumber from 0 to 100. Defaultvalue is 0.

uniform_pacing_value=4.2

optimize_by no enum

Optimization criteria. Theacccepted value is none, andif the following parameter isspecified as"line_type=marketplace", thefollowing values will beaccepted as well: clicks,complete_rate, 25_rate,50_rate, 75_rate. The defaultvalue is "none".

optimize_by=clicks

daytimes no string

7*24 long character array foreach hour of the week. 1 -shows ads in that hour, 0 - donot show ads in that hour.Default = 1...1

daytimes=22222223333333

creative_rotation_type no enum

The creatives' rotation logic.The possible values are:"random", "weighted delivery""optimized_by_ctr","optimized_by_complete_rate".The default value is "random".

creative_rotation_type=optimize_by_ctr

position no enum

The position of the order line,with accepted values as bitmask: 1(PRE), 2(MID),4(POST). The default value is'null' It becomes mandatorywhen "ad_unit_type=in" for theorder package. To check thevalue of "ad_unit_type" in theOP use /order/package/list.

position=2

Return <liverailapi requested="/order/line/add" api_version="X.Y.Z"> <order_line_id>the ID of the newly added order line</order_line_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/edit

Method Description

Edit an owned order line.

Related Methods


/advertiser/list

/creative/list

Parameters


Name optuired Type Overview Example


order_line_id no stringThe numerical ID of the orderline to be edited, the samereturned by /order/line/list.


time_start no stringOrder line flight start full date.Format is: YYYY-MM-DDHH:MM:SS

time_start=2011-12-01 12:00:00

time_end no stringOrder line flight end full date.Format is: YYYY-MM-DDHH:MM:SS

time_end=2011-12-09 12:00:00

timezone no float|integer Timezone for the order lineflight start and full date. timezone=o987365


gross_rate=2.5

order_line_name no string The name for the new orderline. order_line_name=testline

stop no integerThis parameter is optional,meaning that, if not given, theparameter value is not alteredin any way.

stop=876


gross_rate=xyz

net_to_site no float|integerPublisher's rate for this orderline, CPM price for cpm ordersor CPC price for cpc orders.

net_to_site=12.8

max_bid no float

Only positive values areaccepted. This parameter isoptional, meaning that, if notgiven, the parameter value isnot altered in any way.

max_bid=7.3

order_line_index no integerPosition of the order line inrelation with the other orderlines from the currentpackage.

order_line_index=7

creative_rotation_type no enum

The creatives' rotation logic.The possible values are:"random", "weighted delivery","optimized_by_ctr","optimized_by_complete_rate".This parameter is optional,meaning that, if not given, theparameter value is not alteredin any way.

creative_rotation=random

The postition of the order line,

position no integer

with accepted values as bitmask: 1(PRE), 2(MID),4(POST). This parameter isoptional, meaning that, if notgiven, the parameter value isnot altered in any way.

position=2

stop_level no enum

The order line's stop method.The possible values are:line_level, site_level. Thisparameter is optional,meaning that, if not given, theparameter value is not alteredin any way.

stop_level=site_level

stop_type no enum

The order line's stop type. Thepossible values are: daily,total. This parameter isoptional, meaning that, if notgiven, the parameter value isnot altered in any way.

stop_type=total

over_delivery no enum

Specify if over delivery isallowed. The possible valuesare: yes, no. This parameter isoptional, meaning that, if notgiven, the parameter value isnot altered in any way.

over_delivery=no

over_delivery_percent no percent

Specify the percent for overdelivery, if over_delivery=no.This parameter is optional,meaning that, if not given, theparameter value is not alteredin any way.

over_delivery_percent=75

uniform_pacing no enum

Specify if there is uniformpacing. The possible valuesare: yes, no. This parameter isoptional, meaning that, if notgiven, the parameter value isnot altered in any way.

uniform_pacing=no

uniform_pacing_value no float

Acceptes values: any floatnumber from 0 to 100. Thisparameter is optional,meaning that, if not given, theparameter value is not alteredin any way.

uniform_pacing_value=4.2

optimize_by no enum

Optimization criteria. Theacccepted value is none, andif the following parameter isspecified as"line_type=marketplace", thefollowing values will beaccepted as well: clicks,complete_rate, 25_rate,50_rate, 75_rate. The defaultvale is "none".

optimize_by=clicks

daytimes no string

7*24 long character array foreach hour of the week. 1 -shows ads in that hour, 0 - donot show ads in that hour.Default = 1...1

daytimes=22222223333333...

Return

Change History


Method Name: /order/line/delete

Method Description

Delete an order line.

Related Methods

There is 1 related method for this method:

/order/line/add

Parameters






The numericalID of the orderline to bedeleted (thesame asreturned from/order/line/add).


Return <liverailapi requested="/order/line/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/list/stop

Method Description

Get a list with Booked impressions. Order Line ID is required.

Parameters






Returns thedetailscorrespondingto thespecifiedorder_line_id.


Return <liverailapi requested="/order/line/list" api_version="X.Y.Z"> <order_line_stops> <order_line_stop> <stop>0</stop> </order_line_stop> </order_line_stops> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/list/min/start/date

Method Description

List the minimum start date for the order lines.

Parameters





creative_id yes string

The numericID of thecreative.Required if noorder_id,publisher_idororder_line_idis provided.Multiple IDscan be used,separated bycomma (,)

creative_id=3421

order_id yes string

The numericID of theorder.Required if nocreative_id,publisher_idororder_line_idis provided.Multiple IDscan be used,separated bycomma (,)

order_id=o987365

publisher_id yes string

The numericID of thepublisher.Required if noorder_id,creative_id ororder_line_idis provided.Multiple IDscan be used,separated bycomma (,)

publisher_id=665


The numericID of theorder line.Required if noorder_id,publisher_idor creative_idis provided.Multiple IDscan be used,separated bycomma (,)


Return <liverailapi requested="/order/line/list/min/start/date" api_version="X.Y.Z"> <min_start_date>Date and time of the minimum start date in format: YYYY-MM-DD HH:MM:SS</min_start_date> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error></liverailapi>

Change History

Method Name: /order/line/list/max/end/date

Method Description

List the maximum end date for the order lines.

Parameters





creative_id yes string

The numericID of thecreative.Required if noorder_id,publisher_idororder_line_idis provided.Multiple IDscan be used,separated bycomma (,)

creative_id=3421

order_id yes string

The numericID of theorder.Required if nocreative_id,publisher_idororder_line_idis provided.Multiple IDscan be used,separated bycomma (,)

order_id=o987365

publisher_id yes string

The numericID of thepublisher.Required if noorder_id,creative_id ororder_line_idis provided.Multiple IDscan be used,separated bycomma (,)

publisher_id=665


The numericID of theorder line.Required if noorder_id,publisher_idor creative_idis provided.Multiple IDscan be used,separated bycomma (,)


Return <liverailapi requested="/order/line/list/max/end/date" api_version="X.Y.Z"> <max_end_date>Date and time of the maximum end date in format: YYYY-MM-DD HH:MM:SS</max_end_date> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error>

</liverailapi>

Change History


Method Name: /order/line/publisher/list

Method Description

Get all publishers for an order line.

Parameters





order_line_id yes stringThenumerical IDof the orderline.


Return <liverailapi requested="/order/line/publisher/list" api_version="X.Y.Z"> <publishers> <publisher> <order_line_id>The order line ID</order_line_id> <publisher_id>The publisher ID</publisher_id> <net_to_site_method></net_to_site_method> <net_to_site>Float value</net_to_site> <max_bid>Max bid value</max_bid> <stop>Stop time</stop> <stop_period>Stop period</stop_period> <line_site_status>Line site status</line_site_status> <line_site_status_details>Line site status details</line_site_status_details> <over_delivery_percent>Percent value</over_delivery_percent> <pacing_value>float value</pacing_value> </publisher> </publishers> <count>Number of returned publishers</count> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

Change History


Method Name: /order/line/resolve/name

Method Description

Returns the order line names for a list of order line id(s). This method should beused when dimension[1,2,3] from statistics was order_line_id and you need toknow the actual names for the retrieved id(s).

Parameters






The order lineid(s). If youhave multipleid(s) you canmake a singlecall byglueing themtogether with| or ,

order_line_id = 1|7|120 or order_line_id =1,7,120

Return <liverailapi requested="/order/line/resolve/name" api_version="X.Y.Z"> <order_lines> <order_line> <order_line_id>the id of the order line</order_line_id> <order_line_name>the name of the order line</order_line_name> </order_line> ... </order_lines> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/network/status/set

Method Description

Sets the order line and publisher level status. Only the network with the accessrights on the order can change the status.

Parameters






order_line_id=794564

status yes enum

The status ofthe order line.The possiblevalues are:"active","passive"

status=active


Thepublisher'snumerical ID.Thisparameter isoptional withdefault value"null".

publisher_id=2453

Return <liverailapi requested="/order/line/network/status/set" api_version="x.y.z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error>

<warnings> <warning> <message>The reason why the status can't be changed for a publisher.</message> <code></code> </warning> <warning> <message>If the line status changed successful, the reason why the line status is still inactive.</message> <code></code> </warning> ... </warnings> ...</liverailapi>

Change History


Method Name: /order/line/publisher/status/set

Method Description

Sets the order line and publisher level status. Only the publisher with the accessrights on the order can change the status.

Parameters






The order linenumerical ID. Toretrieve its publisher,use/order/line/publisher/list


status yes enumThe status of the orderline. The possiblevalues are: "active","passive"

status=active

Return <liverailapi requested="/order/line/publisher/status/set" api_version="x.y.z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error></liverailapi>

Change History


Method Name: /order/line/staging

Method Description

Sets the status for an order line to Staging or Production.

Parameters





order_line_id yes integer

The numericID of theorder line(s)for which thestatus ischanged. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need tomodify theorder lineswith the id(s)1, 7 and 120you can useorder_line_id= 1|7|120 ororder_line_id= 1,7,120 ).


is_staging yes enum

Set the orderline to bestaged. Theacceptedvalues are"yes" or "no" (if no is used,the OL will beset asProduction ).Cannot beused for orderlines with"archived"status.

is_staging=yes

status.

Return <liverailapi requested="/order/line/staging" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason21 June 2012 Added page into CHM Align with API

Method Name: /order/line/marketplace/attach

Method Description

Attach an order line to a marketplace.

Parameters






Thenumerical IDof theorderline tobe attachedto themarketplace.



Thenumerical IDof thepublisher towhich the OLwill beattached. Thepublishermust be amarketplace,no other typewill function.

publisher_id=365

Return <liverailapi requested="/order/line/marketplace/attach" api_version="X.Y.Z"> <emails> <email></email> </emails> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/creative/list

Method Description

List all the available creatives.

Parameters






The numericID of theorder line forwhich theinformationwill bereturned. Ifyou havemultiple ID(s)you can makea single callby glueingthem togetherwith | or ,

order_line_id = 1|7|120 or order_line_id =1,7,120

Return <liverailapi requested="/order/line/creative/list" api_version="X.Y.Z"><creatives> <creative> <creative_id>the numercical ID of the creative</creative_id> <order_line_id>the numerical ID of the order line</order_line_id> <title>creative title</title> <creative_campaign_id>the numercical ID of the creative campaign</creative_campaign_id> <creative_rotation_weight>the rotation weight</creative_rotation_weight> <status>the status</status> <adtag>the adtag</adtag> <clickthru>The clickthrough URL</clickthru> <creative_click_rate>click rate</creative_click_rate> <creative_complete_rate>complete rate</creative_complete_rate> </creative></creatives><count>Number of returned publishers</count><user>...</user><auth>...</auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History

Date Description Reason24 January 2013 Method added in chm Align with API

Method Name: /order/line/integration/list

Method Description

Get a list with the integrations available for an order line. Only the entity with theaccess rights on the order can retrieve this info.

Parameters






If you havemultiple id(s)you can makea single callby glueingthem togetherwith | or , (examples: ifyou need toget theintegrationsfor id(s) 1, 7and 120 youcan useorder_line_id= 1|7|120 ororder_line_id= 1,7,120 )


Return <!--<liverailapi requested="/order/line/integration/list" api_version="x.y.z"> <lines> <line> <order_line_id>The order line ID/order_line_id> <inte_nielsen_placement_id>Value of the integration</inte_nielsen_placement_id> </line> </lines> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

ATTACHING CREATIVES

These are the methods related to attaching creatives

/order/line/creative/attach/order/line/creative/detach

Method Name: /order/line/creative/attach

Method Description

Attach a creative to an order line.

Parameters





order_line_id yes stringThe numerical ID ofthe order line towhich the creativewill be attached.


creative_id yes integerThe numerical ID ofthe creative to beattached to theorder line.

creative_id=365

weight no float

This parameter onlymakes sense whenthe order line'srotation is"weighted_delivery".In all other cases,this parameter isignored. Delivery isaccomplishedaccording to thenumber of creativesand their weight: forexample, if 2creatives have 40weight (20 each),delivery will bedone 50% for each.

weight=2.5

Return <liverailapi requested="/order/line/creative/attach" api_version="X.Y.Z"> <user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


Date Description Reason02

Method Name: /order/line/creative/detach

Method Description

Detach a creative from an order line.

Parameters






Thenumerical IDof the orderline fromwhich thecreative willbe detached.



Thenumerical IDof thecreative fromwhich theorder line willbe detached.

creative_id=365

Return <liverailapi requested="/order/line/creative/detach" api_version="X.Y.Z"> <user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


ATTACHING SITES

These are the methods related to attaching sites

/order/line/site/attach/order/line/site/detach

Method Name: /order/line/site/attach

Method Description

Attaches owned/forwarded line to a site.

Parameters





order_line_id yes string The numerical ID ofthe order line. order_line_id=o794564

publisher_id yes string The numerical ID ofthe publisher. publisher_id = 2453

cost_method no string

How the cost iscalculated for thissite. The possiblevalues are:"line","site","custom".The default value iscustom. line - usenet_to_publisherfrom /order/line/addor/order/line/forward.site - use value from/site/settings/set.custom - use valuefrom cost field.

cost_method=line

cost no floatThis value is usedwhen cost_methodis custom.

cost=22.5

stop no set

The order line's stoptype. The possiblevalues are: daily,total. The defaultvalue is total.

stop=total

stop_type no string

This value is usedwhen /order/line/addor/order/line/forwardstop_method is"site_level". Defaultvalue: "null". Thisparameter isrequired when/order/line/addstop_by is "budget".

stop_type=???

over_delivery_percent no float Specify theoverdelivery cap. over_delivery_percent=5.5

Return <liverailapi requested="/order/line/site/attach" api_version="X.Y.Z"> If the user(s) attached to the publisher have a role of "cust-ro" and they accept emails, the list with emails. <emails> <email>email address</email> ... </emails> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/set/detach

Method Description

Detach a site from an owned/forwarded line.

Parameters







publisher_id yes stringThenumerical IDof thepublisher.

publisher_id = 2453

Return <liverailapi requested="/order/line/site/detach" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error></liverailapi>

Change History


TARGETING

These are the methods related to targeting

/order/line/targeting/set/order/line/targeting/list/order/line/targeting/delete

Method Name: /order/line/targeting/list

Method Description

Get all the rules for an order line.

Parameters






The order lineID(s) forwhich the infowill bereturned. Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or ,


Return <liverailapi requested="/order/line/targeting/list" api_version="X.Y.Z"> <rules> <rule> <order_line_id></order_line_id> <rule>current level rule</rule> </rule> </rules> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/targeting/set

Method Description

Set the targeting rule for an order line.

Parameters






Thenumerical IDof the orderline for whichthe capping ismodified.


rule yes string The rule to beset (PDF)

period=(( |multi_in|(`tags`, array('default'))|*| |!multi_in|(`antitags`, array('default'))))

Return <liverailapi requested="/order/line/targeting/set" api_version="X.Y.Z"><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


Method Name: /order/line/targeting/delete

Method Description

Delete a rule for an owned order line.

Parameters





parent_rule_id yes stringParent rule idor rule id ifyou own theline.

parent_rule_id=7533

order_line_id no stringThenumerical IDof the orderline


Return <liverailapi requested="/order/line/targeting/delete" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


MARKETPLACE TARGETING

These are the methods related to marketplace targeting

/order/line/marketplace/targeting/set/order/line/marketplace/targeting/list/order/line/marketplace/targeting/delete

Method Name: /order/line/marketplace/targeting/list

Method Description

Get all rules for an order line.

Parameters







Return <liverailapi requested="/order/line/marketplace/targeting/list" api_version="X.Y.Z"> <rules> <rule> <marketplace_rule_id>The numerical ID of the marketplace rule</marketplace_rule_id> <order_line_id>The numerical ID of the order line.</order_line_id> <entity_id>The numerical ID of the entity</entity_id> <rule>The marketplace's rule</rule> </rule> </rules> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/marketplace/targeting/set

Method Description

Set the targeting rule for a marketplace.

Parameters







entity_id yes stringThenumerical IDof the entity.

entity_id=554

rule yes string The rule to beset (PDF)

period=(( |multi_in|(`tags`, array('default'))|*| |!multi_in|(`antitags`, array('default'))))

Return <liverailapi requested="/order/line/marketplace/targeting/set" api_version="X.Y.Z"><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


Method Name: /order/line/marketplace/targeting/delete

Method Description

Remove a marketplace targeting rule from an order line.

Parameters






Thenumerical IDoforder_line_idfrom whichthemarketplacetargeting isdeleted.


entity_id no stringOptionally,the numericalID of thepublisher.

entity_id=866

Return <liverailapi requested="/order/line/marketplace/targeting/delete" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


FREQUENCY CAPPING

These are the methods related to frequency capping

/order/line/frequency/set/order/line/frequency/list/order/line/frequency/delete

Method Name: /order/line/frequency/list

Method Description

Return the frequency cappings for an order line.

Parameters






Thenumerical IDof the orderline for whichthe cappingswill be listed.


only_inherited no set

Specifywhether toreturn onlythe inheriteddata or not.The acceptedvalues are: 0and 1

only_inherited=1

Return <liverailapi requested="/order/line/frequency/list" api_version="X.Y.Z"> <cappings> <capping> <order_line_id></order_line_id> <period></period> <total></total> <inherited>1|0</inherited> </capping> ... </cappings> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/frequency/set

Method Description

Set an order line frequency capping.

Parameters






Thenumerical IDof the orderline for whichthe capping ismodified.


period yes integer The period inseconds period=3600

total yes integer

The maximumnumber ofimpressionsfor thespecifiedperiod.

total=10

Return <liverailapi requested="/order/line/frequency/set" api_version="X.Y.Z"><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


Method Name: /order/line/frequency/delete

Method Description

Remove an order line frequency capping.

Parameters






Thenumerical IDof the orderline fromwhich thecapping isremoved.


period no integer The period inseconds period=3600

Return <liverailapi requested="/order/line/frequency/delete" api_version="X.Y.Z"><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


PARTNERS

All the methods related to partners are displayed here.

PartnersThese are the methods used to handle Partners

/partner/available/partner/add/partner/edit/partner/list/partner/delete/partner/resolve/name/partner/resolve/id

Revenue Share/revenue-share/add/revenue-share/edit/revenue-share/list/revenue-share/delete

Method Name: /method/name/here

Method Description

This is the method's template. Please provide a full description of this method.

Related Methods

Related methods go in here.

this is a test link

Parameters


Name Required Type Overview ExampleRequiredparameter yes sample




Optionalparameter no sample


Return <liverailapi requested="/connection/resolve/name" api_version="X.Y.Z"> <connections> <connection> <connection_id>the id of the connection</connection_id> <name>the name of the connection</name> </connection> ...

<connections> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reasonbla bla 1 bla bla 2 bla bla 2bla bla 1 bla bla 2 bla bla 2

Method Name: /partner/available

Method Description

Verify the number of available partners remaining for this entity.

Parameters





entity_id no string

Specify theEntity ID. Thisparameter isoptional, and ifit is not given,the informationwill bereturned forthe currententity.

entity_id=9876

Return <liverailapi requested="/partner/available" api_version="X.Y.Z"> <available>The available partners number remaining for the entity.</available> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /partner/list

Method Description

List all the available partners.

Parameters






The numeric ID ofthe entity(es) forwhich the partnerinformation will bereturned. MultipleIDs can be bindtogether by "|" or","

entity_id=8866,5534

partner_id no integer

The numeric ID(s)of the partner(s)to be listed.Multiple IDs canbe bind togetherby "|" or ","

partner_id=844,654

name no stringThe name of thepartner to belisted.

name=FishBowl

like_name no string

Return only thepartners with thename that areLIKE%search_string%.

like_name=Fish

Return <liverailapi requested="/partner/list" api_version="X.Y.Z"> <partners> <partner> <partner_id>the numeric ID of the partner</partner_id> <entity_id>the numeric ID of the entity</entity_id> <name>the name of the partner</name> </partner> .... </partners> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error>

...</liverailapi>

Change History


Method Name: /partner/resolve/name

Method Description

Resolve a numeric partner(s) ID to its name.

Parameters





partner_id yes integer

The numericID of thepartner forwhich thename will bereturned.Separatemultiplevalues withcomma (,).

partner_id=886453

Return <liverailapi requested="/partner/resolve/name" api_version="X.Y.Z"> <partners> <partner> <partner_id>The numeric ID of the partner</partner_id> <name>The name of the partner</name> </partner> ... </partners> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /partner/add

Method Description

Add a new partner.

Parameters





name yes string The name of thepartner to add. name=testpart

Return <liverailapi requested="/partner/add" api_version="X.Y.Z"> <partner_id>the numeric ID for the new added partner</partner_id> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /partner/edit

Method Description

Edit an existing partner.

Parameters





partner_id yes integerThe numericID of thepartner to beedited.

partner_id=886643

name yes stringThe newname of thepartner.

name=testpart22

Return <liverailapi requested="/partner/edit" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /partner/delete

Method Description

Delete an existing partner.

Parameters





partner_id yes integer

The numericID of thepartner to bedeleted.Multiple IDscan be bindtogether by "|"or ","

partner_id=886643

Return <liverailapi requested="/partner/delete" api_version="X.Y.Z"><user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


REVENUE SHARE

All the methods related to revenue shares are displayed here.

/revenue-share/add/revenue-share/edit/revenue-share/list/revenue-share/delete

Method Name: /revenue-share/add

Method Description

Add the revenue share parameter for a given partner.

Parameters





partner_id yes string

Thenumerical IDof the partnerfor which youwant to addthe revenueshareparameter.

partner_id=6235

share yes floatThe value ofthe partner'sshare.

share=7.5

type yes set

The type ofthe partner'sshare. Theacceptedvalues are:"fixed" - afixedammount , "p-net" -percentagefrom net, "p-gross" -percentagefrom gross

type=p-net


Thenumerical IDof the entityfor which therevenueshareparameter willbe added. Ifnot given, itwill default tothe currententity.

entity_id=8756

Return <liverailapi requested="/revenue-share/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /revenue-share/edit

Method Description

Edit the revenue share parameter for a given partner.

Parameters






Thenumerical IDof the partnerfor which youwant to editthe revenueshareparameter.

partner_id=6235

share yes floatThe newvalue of thepartner'sshare.

share=7.5

type yes set

The new typeof thepartner'sshare. Theacceptedvalues are:"fixed" - afixedammount , "p-net" -percentagefrom net, "p-gross" -percentagefrom gross

type=p-net


Thenumerical IDof the entityfor which therevenueshareparameter willbe edited. Ifnot given, itwill default tothe current

entity_id=8756

entity.

Return <liverailapi requested="/revenue-share/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /revenue-share/delete

Method Description

Delete the revenue share parameter for a given partner.

Parameters






Thenumerical IDof the partnerfrom whichyou want toremove therevenueshareparameter.

partner_id=6235


Thenumerical IDof the entityfrom whichthe revenueshareparameter willbe deleted. Ifnot given, itwill default tothe currententity.

entity_id=8756

Return <liverailapi requested="/revenue-share/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ADVERTISERS

All the methods related to advertisers are displayed here.

/advertiser/add/advertiser/list/advertiser/resolve/name/advertiser/resolve/name/from/creative

Method Name: /advertiser/list

Method Description

Get the list of advertiser(s).

Parameters





advertiser_id no string

TheadvertiserID(s). If youhave multipleID(s) you canmake a singlecall byglueing themtogether with| or ,

advertiser_id = 1|7|120 or advertiser_id =1,7,120


The ID of theentity forwhich youwant to getthe list ofadvertisers.Thisparameter isoptional. If notgiven, thisparameter willautomaticallyget the valueof the currententity.

entity_id=545

Return

<liverailapi requested="/advertiser/list" api_version="X.Y.Z"> <advertisers> <advertiser> <advertiser_id>The ID of the advertiser</advertiser_id> <name>The name of the advertiser</name> </advertiser> ... </advertisers> <user>...</user> <auth>...</auth>


Change History


Method Name: /advertiser/add

Method Description

Add an advertiser.

Parameters





name yes string The name ofthe advertiser. name=test123


The ID of theentity forwhich youwant to addthe advertiser.If not given,thisparameter willautomaticallyget the valueof the currententity.

entity_id=545

Return

<liverailapi requested="/advertiser/add" api_version="X.Y.Z"> <advertiser_id>The ID of the newly added advertiser</advertiser_id> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ... </liverailapi>

Change History


Method Name: /advertiser/resolve/name

Method Description

Returns the values for a list of advertiser ID(s). This method should be used whendimension[1,2,3] from statistics was advertiser_id and you need to know the actualadvertiser name for the retrieved ID(s).

Parameters








Return

<liverailapi requested="/advertiser/resolve/name" api_version="X.Y.Z"> <advertisers> <advertiser> <advertiser_id>The ID of the advertiser</advertiser_id> <entity_id>The ID of the entity</entity_id> <name>The name of the advertiser</name> </advertiser> ... </advertisers> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /advertiser/resolve/name/from/creative

Method Description

Resolves the advertiser names from a list of creative IDs.

Parameters






The creativeID(s). If youhave multipleID(s) you canmake a singlecall byglueing themtogether with| or ,

creative_id = 1|7|120 or creative_id =1,7,120




Return

<liverailapi requested="/advertiser/resolve/name/from/creative" api_version="X.Y.Z">

<advertisers>

<advertiser>

<creative_id>The ID of the creative</creative_id>

<name>The name of the advertising</name>

</advertiser>

...

</advertisers>

<user>...</user>

<auth>...</auth>

<status>success or fail</status>

<error>error if status=fail, null otherwise</error>

...

</liverailapi>

Change History

Date Description Reason30 August 2012 Method added into chm. Align with API14 November 2012 Added advertiser_id Align with API

ADVERTISING CATEGORIES

All the methods related to advertiser categories are displayed here.

/advertising/category/list/advertising/category/creative/list/advertising/category/resolve/name/advertising/category/resolve/name/from/creative

Method Name: /advertising/category/list

Method Description

List all the available advertising categories.

Parameters





advertising_category_id no integer

The numeric ID ofthe advertisingcategory forwhich theinformation will bereturned. If youhave multiple id(s)you can make asingle call byglueing themtogether with | or ,

advertising_category_id = 1|7|120 oradvertising_category_id = 1,7,120

advertising_category_name no stringSearch based onthe advertisingcategory fullname.

advertising_category_name = Testcategory


limit=50

offset no integer

The offset fromwhere the limitshould be applied( if you display 10results per pageand you need toget the 3rd pageyou should setoffset to 20 andlimit to 10 ). Donot use withoutspecifying thelimit parameter aswell.

offset=5


Return onlyadvertisingcategorys with thename that areLIKE%search_string%.

search_string=test

Return <liverailapi requested="/advertising/category/list" api_version="X.Y.Z"> <advertising_categories> <list> <advertising_category> <advertising_category_id>The numeric ID of the advertising category</advertising_category_id> <advertising_category_name>string: the advertising category name</advertising_category_name> </advertising_category> ... </list> ... </advertising_categories> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason31 July 2012 Method added into chm. Align with API

Method Name: /advertising/category/list

Method Description

List all the available advertising categories.

Parameters






TheadvertisingcategoryID(s). If youhave multipleID(s) you canmake a singlecall byglueing themtogether with| or ,

advertising_category_id = 1|7|120 oradvertising_category_id = 1,7,120

Return <liverailapi requested="/advertising/category/creative/list" api_version="X.Y.Z"> <advertising_categories> <advertising_category> <advertising_category_id>The numeric ID of the advertising category.</advertising_category_id> <creative_id>The numeric ID of the creative.</creative_id> </advertising_category> ...</advertising_categories> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


CONNECTIONS

All the methods related to connections are displayed here.

ConnectionsThese are the methods used to handle connections

/connection/add/connection/edit/connection/list/connection/delete/connection/resolve/name/connection/set/archived

Connections Trackers/connection/tracker/add/connection/tracker/edit/connection/tracker/list/connection/tracker/delete

Method Name: /connection/list

Method Description

List the available connections.

Parameters





including_myself yes integer

Flag that controlsif the "MyCampaigns"connection ( theconnectionbetween an entityand itself ) shouldbe returned ornot. Set it to 1 toreturn thisconnection or setit to 0 to hide thisconnection. Thedefault value is 0.

including_myself=1

including_exchange yes integer

Flag that controlsif the LiveRailCentralconnectionsshould bereturned or not.Set it to 1 toreturn theseconnection or setit to 0 to hidethem. The defaultvalue is 0.

including_exchange=1

order_by no string

The order bycriteria. Thesupported valuesare network,publisher,connection,connection_id. Itdefaults toconnection_id.

order_by=network

managed no enum

Filter theconnectionsbased on themanagementstatus. Thesupported valuesare: yes ( theconnection ismanaged ) and no( the connectionis direct ).

managed=yes

direction no string

Filter theconnectionsbased on thedirection. Thesupported valuesare: INCOMING (the current entityacts as publisher) and OUTGOING( the current entityacts as a network).

direction=OUTGOING

enabled_publisher no integer

Return only theconnections thatare have thisspecific flag value( 0 ( theconnection isdisabled ) and 1 (the connection isenabled ) ).

enabled_publisher=1

enabled_network no integer

Return only theconnections thatare have thisspecific flag value( -1 ( theconnection isrefused ), 0 ( theconnection isdisabled ) and 1 (the connection isenabled ) ).

enabled_network=1

connection_id no integer

Return only theconnections thatmatch the givenID(s). If you havemultiple ID(s) youcan make a singlecall by gluingthem togetherwith | or ,

connection_id = 1|7|120 or connection_id= 1,7,120


The ID of theentity for whichthe connectionsare returned. Ifnot given, it willdefault to thecurrent entity.

entity_id=123

entity_filter no integer

The ID of theentity for whichthe connection(s)with the entity_idare returned. Ifyou have multipleID(s) you canmake a single callby gluing themtogether with | or ,

entity_filter = 1|7|120 or entity_filter =1,7,120

hide_archived no enum

yes|no: Thedefault value is"yes". If set to"no", it will displaythe archivedconnections.

hide_archived=no


Return only thenetworkorganizations orconnections withthe name that areLIKE%search_string%.

search_string=trala

Return <liverailapi requested="/connection/list" api_version="X.Y.Z"> <total>the number of connections</total> <connections> <connection> <connection_id>the id of the connection</connection_id> <publisher_id>the id of the publisher entity</publisher_id> <network_id>the id of the network entity</network_id> <enabled_network>the network "enabled" flag</enabled_network> <enabled_publisher>the publisher "enabled" flag</enabled_publisher> <enabled_in>if the connection supports IN orders</enabled_in> <enabled_ov>if the connection supports OV orders</enabled_ov> <net_to_site_method>connection's method</net_to_site_method> <net_to_site_value>the value</net_to_site_value> <weight>Integer value between 0 and 50 (must be the Publisher in the connection to have this parameter displayed)</weight> <parameters>the connection parameters</parameters> <login_username>the login username ( this is not the username for a LiveRail account, but for the account you have on the networks site )</login_username> <login_password>the login password ( this is not the password for a LiveRail account, but for the account you have on the networks site )</login_password> <login_info>login info</login_info> <via_connect>if the connection is done via LiveRail ( in which case it has a 1 value ) or not ( in which case it has a 0 value )</via_connect> <performance_in>the connection performance for IN orders</performance_in> <performance_ov>the connection performance for OV orders</performance_ov> <name>the connection name</name> <is_marketplace>"yes" | "no"</is_marketplace> <bid_optimization>enabled | disabled </bid_optimization> <managed>"yes" | "no"<managed> <is_archived>"yes" | "no"<is_archived> <archived_by></archived_by> <daily_impression_cap>The daily impression cap. (must be the Publisher in the connection to have this parameter displayed).</daily_impression_cap> <status>active | checking | completed</status> <rtb_enabled>yes|no</rtb_enabled> <buy_type></buy_type> <network_organization>the organization name of the network</network_organization> <network_description>the description of the network</network_description> <network_perspective>the perspective of the network; P for Publisher, N for Network, A for Advertiser</network_perspective> <publisher_organization>the organization name of the publisher</publisher_organization> <publisher_description>the description of the publisher</publisher_description> <publisher_perspective>the perspective of the publisher; P for Publisher, N for Network, A for Advertiser</publisher_perspective> <network_is_parent_for_publisher>flag for tells you if the network is a direct parent for the publisher ( in which case it has a "yes" value ) or not ( in which case it has a "no" value )</network_is_parent_for_publisher> <network_type>The network type.</network_type> <is_exchange>flag for tells you if this connection is with LRC ( in which case it has a "yes" value ) or not ( in which case it has a "no" value )</is_exchange> <gross_rate>the cost</gross_rate> <impression>The impression count for the connection.</impression>

</connection> ... </connections> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason28 May 2012 Added bid_optimization Align with API10 August 2012 Added managed Align with API10 September 2012 Added hide_archived Align with API08 January 2013 Added rtb_enabled, buy_type, network_type Align with API

Method Name: /connection/resolve/name

Method Description

Returns the values for a list of advertiser id(s). This method should be used whendimension[1,2,3] from statistics was connection_id and you need to know theactual connection names for the retrieved id(s).

Parameters





connection_id yes integer

Return onlytheconnectionsthat match thegiven id(s). Ifyou havemultiple id(s)you can makea single callby glueingthem togetherwith | or ,

connection_id = 1|7|120 or connection_id= 1,7,120

Return <liverailapi requested="/connection/resolve/name" api_version="X.Y.Z"> <connections> <connection> <connection_id>the id of the connection</connection_id> <name>the name of the connection</name> </connection> ... <connections> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /connection/add

Method Description

Adds a new connection between two entities, where one acts as a network andthe other one as a publisher.

Parameters




entity_id yes integerThe numerical ID of the entity towhich the current entity should beconnected.

entity_id=123

direction yes string

The direction of the connection.The supported values are:INCOMING ( the current entityacts as publisher and the givenentity_id will be its network ) andOUTGOING ( the current entityacts as a network for the givenentity_id ).

direction=OUTGOING

name yes string The name of the connection name=conn1

bid_optimization no enum

When the connection is"is_marketplace", specify thestatus of the bid optimization forthe entity. The accepted valuesare "enabled" and "disabled", withthe default value being"disabled".

bid_optimization=enabled

via_connect no string

Specify if the connection is donevia LiveRail ( in which caseshould have value "1" ) or not ( inwhich case should have value "0")

via_connect=0

gross_rate no float The cost of the connection. gross_rate=5.2

net_to_site_method no string Accepted values are: "custom","site", "gross". net_to_site_method=custom

net_to_site_value no float

Whennet_to_site_method=custom, theconnection value is specified bythe user. Otherwise,net_to_site_method=site, theconnection value is the site's flatrate.

net_to_site_value=7.5

enabled_in no enum

If the connection supports INorders. The supported valuesare: 0 ( IN orders are notsupported ) and 1 ( IN orders aresupported ). If not given, itdefaults to 1.

enabled_in=1

enabled_ov no enum

If the connection supports OVorders. The supported valuesare: 0 ( OV orders are notsupported ) and 1 ( OV ordersare supported ). If not given, itdefaults to 1.

enabled_ov=1

managed no enum

Specify if the connection ismanaged by LiveRail or not. Thesupported values are: "yes"(connection is managed by LR)and "no". The default value is"no". This parameter can only beused by root-entities.

managed=yes

parameters no string

The connection parameters. Theparameters should be given as aGET string. The networkparameters can be retrieved byusing the/entity/network/type/parameter/listcall.

DESCRIPTION=my%20description&MY_PARAMETER_1=value1&MY_PARAMETER_2=value2

weight no integerSpecify the connection weight.Accepted values: integerbetween 0 and 50.

weight=22

daily_impression_cap no integer Specify the daily impression cap. daily_impression_cap=25

login_username no stringThe login username for theaccount created on the networksplatform.

login_username=test

login_passwordt no stringThe login password for theaccount created on the networksplatform.

login_password=ggg

login_info no string The login info login_info=the desired info

rtb_enabled no enum

Control the Real Time Bidding.The accepted values are "yes"and "no". The default valuematches that of the entity's. If notgiven, the parameter value is notaltered in any way. Thisparameter is available only to theroot users.

rtb_enabled=no

buy_type no enumSpecify the buy type. Theaccepted values are "rtb" and"fixed". The default value is"fixed".

buy_type=rtb

Return <liverailapi requested="/connection/add" api_version="X.Y.Z"> <connection_id>the id of the newly added connection</connection_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason28 May 2012 Added bid_optimization Align with API10 August 2012 Added managed Align with API08 January 2013 Added rtb_enabled, buy_type Align with API

Method Name: /connection/edit

Method Description

Edit a connection between two entities.

Parameters




connection_id yes integer The numerical ID of the connection tobe edited. connection_id=123

name no string The new name of the connection name=conn2

bid_optimization no enum

When the connection is"is_marketplace", specify the statusof the bid optimization for the entity.The accepted values are "enabled"and "disabled". This parameter isoptional, meaning that, if not given,the parameter value is not altered inany way.

bid_optimization=enabled

gross_rate no float The cost of the connection. gross_rate=5.2

net_to_site_method no string Accepted values are: "custom", "site","gross". net_to_site_method=custom

net_to_site_value no float

When net_to_site_method=custom,the connection value is specified bythe user. Otherwise,net_to_site_method=site, theconnection value is the site's flat rate.

net_to_site_value=7.5

enabled_in no enum

If the connection supports IN orders.The supported values are: 0 ( INorders are not supported ) and 1 ( INorders are supported ). Thisparameter is optional, meaning that, ifnot given, the parameter value is notaltered in any way.

enabled_in=1

enabled_ov no enum

If the connection supports OV orders.The supported values are: 0 ( OVorders are not supported ) and 1 ( OVorders are supported ). Thisparameter is optional, meaning that, ifnot given, the parameter value is notaltered in any way.

enabled_ov=1

managed no enum

Specify if the connection is managedby LiveRail or not. The supportedvalues are: "yes" (connection ismanaged by LR) and "no". Thisparameter is optional, meaning that, ifnot given, the parameter value is notaltered in any way. This parametercan only be used by root-entities.

managed=yes

parameters no string

The connection parameters. Theparameters should be given as aGET string. The network parameterscan be retrieved by using the/entity/network/type/parameter/listcall. If "LR_API_NULL" is used, theparameter will be cleared.

DESCRIPTION=my%20description&MY_PARAMETER_1=value1&MY_PARAMETER_2=value2

weight no integerSpecify the connection weight.Accepted values: integer between 0and 50.

weight=22

daily_impression_cap no integer Specify the daily impression cap. daily_impression_cap=25

login_username no string The login username for the accountcreated on the networks platform. login_username=test

login_password no string The login password for the accountcreated on the networks platform. login_password=ggg

login_info no string The login info login_info=the desired info

enabled_publisher no enum

If the connection is enabled on thepublisher's side. The supportedvalues are: 0 ( the connection isdisabled ) and 1 ( the connection isenabled ). Only the entity acting as apublisher can modify this flag.

enabled_publisher=1

enabled_network no enum

If the connection is enabled on thenetwork's side. The supported valuesare: 0 ( the connection is disabled )and 1 ( the connection is enabled ).Only the entity acting as a networkcan modify this flag.

enabled_network=1

rtb_enabled no enum

Control the Real Time Bidding. Theaccepted values are "yes" and "no".The default value matches that of theentity's. If not given, the parametervalue is not altered in any way. Thisparameter is available only to the rootusers.

rtb_enabled=no

buy_type no enum

Change the buy type (the change isallowed only if "rtb_enabled=yes").The accepted values are "rtb" and"fixed". This parameter is optional,meaning that, if not given, theparameter value is not altered in any

buy_type=rtb

way.

Return <liverailapi requested="/connection/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason28 May 2012 Added bid_optimization Align with API10 August 2012 Added managed Align with API08 January 2013 Added rtb_enabled, buy_type Align with API

Method Name: /connection/delete

Method Description

Delete a connection between two entities.

Parameters






Thenumerical IDof theconnection tobe deleted.

connection_id = 120

Return <liverailapi requested="/connection/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /order/line/set/status

Method Description

Set/unset a conection as archived.

Parameters






Specify thenumeric ID oftheconnection tobe set/unsetas archived.

connection_id=4564


Specify if theconnection isarchived ornot. Thesupportedvalues are:yes ( theconnection isarchived )and no ( theconnection isnot archived). Only theentity actingas a publishercan modifythis flag.

is_archived=yes

Return <liverailapi requested="/connection/set/archived" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error>

<warnings> <warning> <message>The reason why the status can't be changed for a publisher.</message> <code></code> </warning> <warning> <message>If the connection status changed successful, the reason why the connection is still not archived.</message> <code></code> </warning> ... </warnings> ...</liverailapi>

Change History

Date Description Reason20 August 2012 Method added in chm Align with API.

CONNECTION TRACKERS

All the methods related to connection trackers are displayed here.

/connection/tracker/add/connection/tracker/edit/connection/tracker/list/connection/tracker/delete

Method Name: /connection/tracker/list

Method Description

List the trackers associated with a connection.

Parameters






The numericID of theconnection forwhich thetrackers willbe listed.

connection_id=876

connection_tracker_id no integerThe numericID of thetracker thatwill be listed.

connection_tracker_id=8

Return <liverailapi requested="/connection/tracker/list" api_version="X.Y.Z"><connection> <trackers> <tracker> <connection_tracker_id>the numeric ID of the tracker</connection_tracker_id> <connection_id>the numeric ID of the connection</connection_id> <event>the event of tracker</event> <url>the URL of the tracker</url> </tracker> ... </trackers> </connection> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /connection/tracker/add

Method Description

Add a tracker to a connection. The unicity of a tracker is determined by the tuple(connection_id, event, url) thus you can have multiple trackers for the sameconnection and for the same event but with different URLs.

Parameters





connection_id yes integerThe numeric ID of theconnection to whichthe tracker will beadded.

connection_id=876

event yes string

The tracker event:impression -impression, accept -accept invitation,clickthru - video click-through, view25 - firstquartile (25%watched), view50 -midpoint (50%watched), view75 -third quartile (75%watched), view100 -complete view (100%watched), pause -video paused, mute -video muted, minimize- minimize overlay,close - close,companion_impression- companionimpression, error -error, skip, custom1from custom8 - customevents that can besend from player

event=view75

url yes string The URL of thetracker. url=www.test.com

Return <liverailapi requested="/connection/tracker/add" api_version="X.Y.Z"> <connection_tracker_id>the numeric ID of the new tracker</connection_tracker_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /connection/tracker/edit

Method Description

Edit a tracker for a connection. The unicity of a tracker is determined by the tuple(connection_id, event, url) thus you can have multiple trackers for the sameconnection and for the same event but with different URLs.

Parameters





connection_tracker_id yes integer The numeric ID of thetracker to be edited. connection_tracker_id=8

event no string

The new trackerevent: impression -impression, accept -accept invitation,clickthru - video click-through, view25 - firstquartile (25%watched), view50 -midpoint (50%watched), view75 -third quartile (75%watched), view100 -complete view (100%watched), pause -video paused, mute -video muted, minimize- minimize overlay,close - close,companion_impression- companionimpression, error -error, skip, custom1from custom8 - customevents that can besend from player

event=complete

url no string The new URL of thetracker. url=www.test1.com

Return <liverailapi requested="/connection/tracker/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


11 July 2012 Changed event values Align with API11 September 2012 Added 'error' in event values Align with API

Method Name: /connection/tracker/list

Method Description

List the trackers associated with a connection. At least one parameter must bespecified.

Parameters






The numericID of theconnectionwhosetrackers willbe deleted. Ifspecified, allthe trackersattached toconection_idwill bedeleted.

connection_id=876

connection_tracker_id no integer

The numericID of thetracker to bedeleted.Specify if youwant to deletea certaintracker.

connection_tracker_id=8

event no integer

The eventtype of thetrackers to bedeleted. Ifspecified, allthe trackershaving thespecifiedevent will bedeleted.

event=complete

Return <liverailapi requested="/connection/tracker/delete" api_version="x.y.z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...

</liverailapi>

Change History


PRICE FLOOR

All the methods related to price floors are displayed here.

/site/settings/list/site/settings/set

Method Name: /site/settings/list

Method Description

Returns the list of publisher ( site ) settings for the current entity.

Parameters






The publisherid(s) for whichwe want toretrieve thesettings. Youcan sendmultiple id(s)by glueingthem togetherwith "|" or with","

publisher_id = 1|7|120 or publisher_id =1,7,120

Return <liverailapi requested="/site/settings/list" api_version="X.Y.Z"> <site_settings> <site_setting> <network_id>the id of the current entity</network_id> <publisher_id>the id of the publisher entity</publisher_id> <cost_cpc>the cpc cost</cost_cpc> <cost_cpm>the cpm cost</cost_cpm> <percentage>the percentage</percentage> <publisher_name>the organization name of the publisher</publisher_name> </site_setting> ... </site_settings> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /site/settings/set

Method Description

Sets the site ( publisher ) settings for the current entity.

Parameters






The publisherid(s) for whichwe want toretrieve thesettings. Youcan sendmultiple id(s)by glueingthem togetherwith "|" or with","

publisher_id = 1|7|120 or publisher_id =1,7,120

cost_cpm no floatThe defaultCPM cost forthe givenpublisher.

cost_cpm=8.65

cost_cpc no floatThe defaultCPC cost forthe givenpublisher.

cost_cpc=4.65

percent no integerThepercentageapplied to thegross rate.

percent=50

Return <liverailapi requested="/site/settings/list" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

PRICING FLOOR RULES

All the methods related to pricing floor rules are displayed here.

/pricing/floor/rule/add/pricing/floor/rule/edit/pricing/floor/rule/list/pricing/floor/rule/delete

Method Name: /pricing/floor/rule/add

Method Description

Add a pricing floor rule.

Parameters





name yes string The name ofthe pricing rule. name=testrule

apply yes set

The type(s) forwhich the ruleapply. Possiblevalues:ov|pre|mid|post.You can sendmultiple id(s) byglueing themtogether with |or with ,

set=ov,pre

rule yes stringBoolean LogicSpecs forfurther details.(PDF)

rule=rule=(( |multi_in|(`tags`,array('default')) |*| |!multi_in|(`antitags`,array('default'))))

floor yes float

The amountspecified for thepricing rule.Does not allowmore than 2decimals.

floor=4.3

is_default no enum

Specify if thepricing rule isdefault or not.The possiblevalues are "0" |"1". The defaultvalue is "0".

is_default=yes

is_disabled no enum

Specify if thepricing rule isdisabled or not.The possiblevalues are "0" |"1". The defaultvalue is "0".

is_disabled

Return <liverailapi requested="/pricing/floor/rule/add" api_version="X.Y.Z"> <pricing_rule_id>the id of the newly created pricing rule.</pricing_rule_id> <user>...</user> <auth>...</auth>


Change History


Method Name: /pricing/floor/rule/edit

Method Description

Edit a pricing floor rule.

Parameters





pricing_rule_id yes stringThe numeric IDof the rule to beedited.

name=testrule

name no string The new nameof the rule. name=testrule

apply no set

The type(s) forwhich the ruleapply. Possiblevalues:ov|pre|mid|post.You can sendmultiple id(s) byglueing themtogether with |or with ,

set=ov,pre

rule no stringBoolean LogicSpecs forfurther details.(PDF)

rule=rule=(( |multi_in|(`tags`,array('default')) |*| |!multi_in|(`antitags`,array('default'))))

floor no float

The amountspecified for thepricing rule.Does not allowmore than 2decimals.

floor=4.3

is_default no enum

Specify if thepricing rule isdefault or not.The possiblevalues are "0" |"1". The defaultvalue is "0".

is_default=yes

is_disabled no enum

Specify if thepricing rule isdisabled or not.The possiblevalues are "0" |"1". The default

is_disabled

value is "0".

Return <liverailapi requested="/pricing/floor/rule/edit" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /pricing/floor/rule/list

Method Description

List the pricing floor rules.

Parameters





pricing_rule_id yes string

Search basedon thenumeric ID ofthe pricingrule.

pricing_rule_id=2223

limit no string

Limit thenumber ofresults forpagination(s).Thisparameter isoptional.

limit=20

Return <liverailapi requested="/pricing/floor/rule/list" api_version="X.Y.Z"> <pricing_rules> <pricing_rule> <pricing_rule_id>the numeric ID of the pricing rule</pricing_rule_id> <entity_id>the current entity ID</entity_id> <name>the rule name</name> <apply>the rule's application</apply> <position>the rule's position</position> <rule>Boolean format</rule> <floor>float value</floor> <is_default>0 | 1 </is_default> <is_disabled>0 | 1 </is_disabled> <is_deleted>0 | 1 </is_deleted> </pricing_rule> ... </pricing_rules> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /pricing/floor/rule/delete

Method Description

Delete a pricing floor rule.

Parameters





pricing_rule_id yes stringThe numericID of the ruleto be deleted.

pricing_rule_id=6653

Return <liverailapi requested="/pricing/floor/rule/delete" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


PUBLISHERS

All the methods related to Publishers are displayed here.

Tags/publisher/tag/add/publisher/tag/available/publisher/tag/list/publisher/tag/delete

Frequency/publisher/frequency/add/publisher/frequency/list/publisher/frequency/delete

PUBLISHER TAGS

All the methods related to Publisher tags are listed here.

/publisher/tag/add/publisher/tag/available/publisher/tag/list/publisher/tag/delete

Method Name: /publisher/tag/available

Method Description

Verify the number of available tags remaining for this publisher.

Parameters





entity_id no int Optional, theentity ID. entity_id=965

Return <liverailapi requested="/publisher/tag/available" api_version="x.y.z"> <available>The available tags number remaining for the publisher.</available> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /publisher/tag/list

Method Description

Return the tag list for an entity.

Parameters






The numerical IDof the entity forwhich the tags willbe returned. If notgiven, it willdefault to thecurrent entity.

entity_id=8756

tag no stringThe tag thatshould bereturned.

tag=music

search_string no stringReturn only tagswith the namethat are LIKE%search_string%.

search_string=mus

limit no integer Limit the numberof results. limit=5

Return <liverailapi requested="/publisher/tag/list" api_version="X.Y.Z"> <tags> <tag>the tag</tag> ... <tags> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason31 July 2012 Added 2 new parameters Align with API

Method Name: /publisher/tag/add

Method Description

Adds a publisher tag entry.

Parameters





tag yes stringThe tag thatshould be addedfor the currententity.

tag=music

Return <liverailapi requested="/publisher/tag/add" api_version="X.Y.Z"> <tag_name>The exact tag that was added in the database. If the tag name contains illegal characters, will be sanitized and causing the name to be displayed differently from the value initially sent. </tag_name> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /publisher/tag/delete

Method Description

Delete a publisher tag.

Parameters





tag yes stringThe tag thatshould bedeleted

tag=music

Return <liverailapi requested="/publisher/tag/delete" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


PUBLISHER FREQUENCY

All the methods related to Publisher frequency are listed here.

/publisher/frequency/add/publisher/frequency/list/publisher/frequency/delete

Method Name: /publisher/frequency/list

Method Description

Lists the frequency cappings.

Parameters





Return <liverailapi requested="/publisher/frequency/list" api_version="X.Y.Z"> <frequency> <capping> <type>the type</type> <interval>the interval ( in seconds )</interval> <count>the capping</count> <partner_id>the partner; if null, it's a global capping</partner_id> <divider>Value in seconds</divider> </capping> ... </frequency> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason10 August 2012 Added divider. Align with API

Method Name: /publisher/frequency/add

Method Description

Adds a publisher frequency entry.

Parameters





type yes string

The type of theorder ( in or ov )for which thecapping shouldwork.

type=ov

interval yes integer

The interval forwhich thecapping is set ( itshould be givenin seconds - forexample: if youwant a 1 dayinterval youshould send86400 ).

interval=86400

count yes integer

The number ofimpressions afterwhich thedelivery issuspended untilthe intervalpasses.

count=2525


The numerical IDof the partner forwhich thiscapping willwork. If notspeicfied, it is aglobal capping.

partber_id=7856

divider no integer

This parameter isbe used only byUI, while theperiod will remainlisted in seconds.It can take thefollowing values:1,60,3600,86400.The default value

-

is null.

Return <liverailapi requested="/publisher/frequency/add" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason10 August 2012 Added divider. Align with API

Method Name: /publisher/frequency/delete

Method Description

Delete a publisher frequency entry.

Parameters





type yes string

The type ofthe order ( inor ov ) forwhich wewant to deletethe capping.Thisparametermust bespecified if no"interval" isgiven.

type=ov

interval yes integer

The intervalfor which wewant to deletethe capping (it should begiven inseconds - forexample: ifyou want a 1day intervalyou shouldsend 86400 ).Thisparametermust bespecified if no"interval" isgiven.

interval=86400


Thenumerical IDof the partnerfor which thiscapping willbe deleted. Ifnot given, itwill deleteonly theglobalcapping

partber_id=7856

matching thegiven intervaland type.

Return <liverailapi requested="/publisher/frequency/delete" api_version="X.Y.Z"> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


ALLOCATION RULES

All the methods related to allocation rules are displayed here.

Allocation rules/allocation/add/allocation/edit/allocation/list/allocation/delete/allocation/duplicate

Group/allocation/group/add/allocation/group/edit/allocation/group/list/allocation/group/delete

Source/allocation/source/add/allocation/source/edit/allocation/source/list/allocation/source/delete

Method Name: /allocation/list

Method Description

List the allocation rule(s).

Parameters





allocation_id no string

Thenumerical IDof theallocation tobe listed.Multiple IDscan be bindtogether by "|"or ","

allocation_id=6084,6085

limit no int The limit forthe results limit=5

Return <liverailapi requested="/allocation/edit" api_version="X.Y.Z"> <allocation> <rule> <allocation_id>the id of the allocation</id> <code>the code of the allocation</code> <name>the name of the allocation</name> <description>the description of the allocation</description> <is_default> Return values: yes | no. The default allocation rule ( the one that is created when the user creates the entity ) has this flag set on yes. This particular allocation rule cannot be deleted.</is_default> <position>The position of the allocation.</position> <name>the name of the allocation</name> <apply>ov|pre|mid|post</apply> <targeting_rule>The boolean specification</targeting_rule> <disabled>yes|no</disabled> </rule> ... </allocation> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason17 May 2012 Edit XML response Align with API tester

Method Name: /allocation/add

Method Description

Add an allocation.

Parameters





name yes string The name ofthe allocation name=test123

apply yes string

The type forwhich the ruleapply. Possiblevalues:ov|pre|mid|post.

apply=pre

targeting_rule yes string

Boolean Logic.Consult thefollowingdocument forfurther details.(PDF)

targeting_rule=(( |multi_in|(`tags`,array('default')) |*| |!multi_in|(`antitags`,array('default'))))

description no string Description ofthe allocation. description=your description

position no integer

Specify theallocationpositioncompared to theotherallocations ofthe entity.

position=77

Return <liverailapi requested="/allocation/add" api_version="X.Y.Z"> <allocation_id>The id of the newly added allocation</allocation_id> .... <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Change History

Date Description Reason07 June 2012 Updated paramethers. Align with API tester

Method Name: /allocation/edit

Method Description

Edit an allocation.

Parameters

Each API call contains optuired and optional parameters. Here is an overview of theparameters you can add to this particular API optuest, where optuired parameters arewritten in orange:

Name optuired Type Overview Example



allocation_id yes stringThe numericalID of theallocation to beedited.

allocation_id=6084

apply no string

The type forwhich the ruleapply. Possiblevalues:ov|pre|mid|post.

apply=pre

targeting_rule no string

Boolean Logic.Consult thefollowingdocument forfurther details.(PDF)

targeting_rule=(( |multi_in|(`tags`,array('default')) |*| |!multi_in|(`antitags`,array('default'))))

description no string Description ofthe allocation. description=your description

position no integer

Specify theallocationpositioncompared to theotherallocations ofthe entity.

position=77

status no enum

Specify theallocation'sstatus. Theaccepted valuesare "active" |"archived".Default value is"active".

status=archived

Return <liverailapi requested="/allocation/edit" api_version="X.Y.Z">

.... <status>success or fail</status> <error>error if status=fail, null otherwise</error> ... <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason07 June 2012 Updated paramethers. Align with API tester

Method Name: /allocation/delete

Method Description

Delete an allocation.

Parameters





allocation_id yes string

Thenumerical IDof theallocation tobe deleted.

allocation_id=6084

Return <liverailapi requested="/allocation/delete" api_version="X.Y.Z"> .... <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /allocation/duplicate

Method Description

Duplicates allocation.

Parameters





allocation_id yes string

Thenumerical IDof theallocation tobe duplicated.

allocation_id=6084

Return <liverailapi requested="/allocation/duplicate" api_version="X.Y.Z"> <allocation_id>The newly allocation ID created by duplication</allocation_id> <user>...</user> <auth>...</auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason17 May 2012 Added method in the help file Align with API

GROUPS

All the methods related to allocation groups are displayed here.

/allocation/group/add/allocation/group/edit/allocation/group/list/allocation/group/delete

Method Name: /allocation/group/list

Method Description

List the allocation group(s).

Parameters





allocation_group_id no int

Thenumerical IDof theallocationgroup.

allocation_group_id=47758

allocation_id no intThenumerical IDof theallocation.

allocation_id=6084

priority no int The priority ofthe group. priority=2

Return <liverailapi requested="/allocation/group/list" api_version="X.Y.Z"> <allocation_groups> <group> <group_id>The id of the allocation group.</group_id> <allocation_id>The id of the allocation.</allocation_id> <priority>Priority of the group.</group> </group> </allocation_groups> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /allocation/group/add

Method Description

Add an allocation group.

Parameters





allocation_id yes intThenumerical IDof theallocation.

allocation_id=6084

priority yes int The priority ofthe group. priority=1

Return <liverailapi requested="/allocation/group/add" api_version="X.Y.Z"> <allocation_group_id>The id of the created allocation group</allocation_group_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /allocation/group/edit

Method Description

Edit an allocation group.

Parameters





allocation_group_id yes int



priority yes intThe newpriority of thegroup.

priority=2

Return <liverailapi requested="/allocation/group/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /allocation/group/delete

Method Description

Delete an allocation group.

Parameters






Thenumerical IDof theallocationgroup to bedeleted.


allocation_id no intThenumerical IDof theallocation.

allocation_id=6084

Return <liverailapi requested="/allocation/group/delete" api_version="X.Y.Z"> .... <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


SOURCE

All the methods related to allocation sources are displayed here.

/allocation/source/add/allocation/source/edit/allocation/source/list/allocation/source/delete

Method Name: /allocation/source/list

Method Description

List the allocation sources.

Parameters








connection_id no intThenumerical IDof theconnection.

connection_id=11

Return <liverailapi requested="/allocation/source/list" api_version="X.Y.Z"> <allocation_sources> <source> <allocation_group_id>The id of the allocation group.</allocation_group_id> <connection_id>The id of the connection.</connection_id> <name>Connection name.</name> </source> </allocation_sources> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /allocation/source/add

Method Description

Add an allocation source.

Parameters








connection_id yes intThenumerical IDof theconnection.

connection_id=11

Return <liverailapi requested="/allocation/source/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /allocation/source/edit

Method Description

Edits an allocation source, by updating the connection_id for the givenallocation_group_id / old_connection_id pair.

Parameters








old_connection_id yes intThenumerical IDof the oldconnection.

old_connection_id=11

new_connection_id yes intThenumerical IDof the newconnection.

new_connection_id=27

Return <liverailapi requested="/allocation/source/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /allocation/source/delete

Method Description

Delete an allocation source.

Parameters








connection_id yes intThenumerical IDof theconnection.

connection_id=11

Return <liverailapi requested="/allocation/source/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


CUSTOM MACRO MANAGEMENT

All the methods related to custom macro management are displayed here.

/custom/macro/list/custom/macro/add/custom/macro/edit/custom/macro/delete/custom/macro/attach/custom/macro/detach/custom/macro/edit/attach

Method Name: /custom/macro/list

Method Description

List the existing macros.

Parameters





custom_macro_id no integer

Returns thespecifiedcustommacro(s).Multiple IDscan be gluedtogether by "|"

custom_macro_id=44|45

target_custom_macro_id no integer

Returns onlythe values setfor publishersfor thespecifiedcustommacro(s).Multiple IDscan be gluedtogether by"|". If a custommacro doesn'thave anyvalues forpublishers, itwill not bereturned. If acustom macrohas values forseveralpublishers,one XML nodewill bereturned foreach of thesevalues.

target_custom_macro_id=424|425


Returns onlythe custommacro(s)owned by thespecifiedpublisher(s).Multiple IDscan be gluedtogether by"|".

entity_id=5424|5425


Returns onlythe custommacro(s) with search_string=sample macro 2

matchingmacro_names.

Return <liverailapi requested="/custom/macro/list" api_version="X.Y.Z"> <custom_macros> <custom_macro> <custom_macro_id>the id of the custom macro</custom_macro_id> <entity_id>the id of the entity for which it was created</entity_id> <macro_name>the macro name</macro_name> <comments>the comments for the macro</comments> </custom_macro> ... </custom_macros> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /custom/macro/add

Method Description

Adds a custom macro for an entity.

Parameters





macro_name yes string The name forthe macro. name=sample macro

comments no stringComments forthe custommacro, if any.

comments=to be used

Return <liverailapi requested="/custom/macro/add" api_version="X.Y.Z"> <custom_macro_id>the id of the newly added custom macro</custom_macro_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /custom/macro/edit

Method Description

Edit a custom macro for an entity.

Parameters





custom_macro_id yes integer

Thenumerical IDof the custommacro to beedited.

custom_macro_id=44

macro_name no stringThe newname for themacro.

name=sample macro 2

comments no string Edit thecomments. comments=to be used also

Return <liverailapi requested="/custom/macro/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /custom/macro/delete

Method Description

Delete a custom macro from an entity.

Parameters






Thenumerical IDof the custommacro to bedeleted.

custom_macro_id=44

Return <liverailapi requested="/custom/macro/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /custom/macro/attach

Method Description

Attaches the macro to an entity.

Parameters






Thenumerical IDof the custommacro to bedeleted.

custom_macro_id=44


Thenumerical IDof thepublisher(entity) themacro will beattached to.

publisher_id=7744

macro_value yes integer The value ofthe macro macro_value=4

Return <liverailapi requested="/custom/macro/attach" api_version="X.Y.Z"> <custom_macro_j_entity_id>id of the newly created attachment</custom_macro_j_entity_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /custom/macro/edit/atttach

Method Description

Edits a macro attchment value

Parameters





custom_macro_j_entity_id yes integer

Thenumerical IDof the custommacroattachementto bedetached.

custom_macro_j_entity_id=77

macro_value yes integerThe newvalue of themacro.

macro_value=5

Return <liverailapi requested="/custom/macro/edit/attach" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /custom/macro/detach

Method Description

Detach a macro from an entity.

Parameters





custom_macro_j_entity_id yes integer

Thenumerical IDof the custommacroattachementto bedetached.

custom_macro_j_entity_id=77

Return <liverailapi requested="/custom/macro/detach" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


LOCATION

All the methods relatod to location are listed here.

/location/list

Method Name: /location/list

Method Description

List all the available geographical locations.

Parameters





location_id no stringSearch basedon the ID ofthe location.

location_id=AU_0_0_0


Return asearch basedon a givenstring. thesearch willtake place inallparameters.

search_string=testing

limit no integer

Limit thenumber ofresults forpagination(s).Thisparameter isoptional. Thedefault valueis 500.

limit=50

offset no string

The offsetfrom wherethe limitshould beapplied ( ifyou display10 results perpage and youneed to getthe 3rd pageyou shouldset offset to20 and limit to10 ). Thisparameter isoptional andshouldn't begiven without

offset=20

giving the limitparameter aswell.

only_country no enum

Search withinand returnonly thecountry. Theacceptedvalues are:"yes", "no".The defaultvalue is "no".

only_country=yes

Return <liverailapi requested="/location/list" api_version="X.Y.Z"><locations> <list> <location> <location_id>location ID</location_id> <country>location country or description</country> <region>location available regions or null</region> <metro>location available areas or null</metro> <city>location available city or null</city> </location> ... </list> <count>The total number of locations listed</count></locations><user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason25 June 2012 Added parameters. Align with API.

STATISTICS

All the methods related to statistics and report generation are displayed here.

Statistics/statistics

Reports Portfolio/reports/portfolio/add/reports/portfolio/edit/reports/portfolio/list/reports/portfolio/delete

Schedules/reports/portfolio/schedule/add/reports/portfolio/schedule/edit/reports/portfolio/schedule/list/reports/portfolio/schedule/delete

Method Name: /statistics

Method Description

Retrives statistics from the data warehouse.

Parameters





aggregation no enum

The availableaggregations are: all (counts the entries thatmatch the given criteria,grouped by the givendimension(s) ), unqiue (counts the uniqueentries that match thegiven criteria, groupedby the given dimensions)cost_advertiser_revenue( the amount of $ that anentity has earned whenacting as an advertiser ),cost_publisher_revenue( the amount ot $ that anentity has earned as apublisher ),cost_publisher_spending( the amount of $ that anentity should pay thepublishers that showedits ads ). Defaults to 'all'.

aggregation=cost_publisher_revenue

dimension1 yes string

The availabledimensions are: timedimensions: hour ( Hour), day ( Day ), week (Week ), month ( Month ),publisher_id ( Site ),connection_id ( Adsource ), partner_id (Partner ),creative_campaign_id (Creative Group ),creative_id ( Creative ),category_id ( Category ),segment_id (Segment),location_country (Country ), domain_name( Domain ),order_number_id ( OrderNumber ), order_id (Order ), order_line_id (Order Line ), network_id( Network ). For thelocation_region (State/Region ),location_metro ( Metroarea ), location_city (City ),video_publisher_video (Media ID ),video_am_video (Fingerprint ID ), ...

item_name ( Content tag), browser_name (Browser ), os_name (Operating system ),autoplay_id (autoplay ID- 0 ( unknown ), 1 ( Clickto Play ), 2 ( Auto Play )),muted_id (muted ID 0 (unknown ), 1 ( Sound on), 2 ( Sound off )),playersize_id (playersizeID 0 ( unknown ), 1 (small ), 2 ( medium ), 3 (large )),content_type_name(Content Type Name),content_type_id(Content Type ID),autoplay_name(Autoplay Name),muted_name (MutedName), playersize_name(Playersize Name),zipcode (Zip Code).These dimensions mustbe used for a scheduledreport portfolio. Youneed to specifydimension1 in order toget a result.

dimension2 no string

The availabledimensions are: timedimensions: hour ( Hour), day ( Day ), week (Week ), month ( Month ),publisher_id ( Site ),connection_id ( Adsource ), partner_id (Partner ),creative_campaign_id (Creative Group ),creative_id ( Creative ),category_id ( Category ),segment_id (Segment),location_country (Country ), domain_name( Domain ),order_number_id ( OrderNumber ), order_id (Order ), order_line_id (Order Line ), network_id( Network ). For thelocation_region (State/Region ),location_metro ( Metroarea ), location_city (City ),video_publisher_video (Media ID ),video_am_video (Fingerprint ID ),item_name ( Content tag), browser_name (Browser ), os_name (Operating system ),autoplay_id (autoplay ID- 0 ( unknown ), 1 ( Clickto Play ), 2 ( Auto Play )),muted_id (muted ID 0 (unknown ), 1 ( Sound on), 2 ( Sound off )),playersize_id (playersizeID 0 ( unknown ), 1 (

...

small ), 2 ( medium ), 3 (large )),content_type_name(Content Type Name),content_type_id(Content Type ID),autoplay_name(Autoplay Name),muted_name (MutedName), playersize_name(Playersize Name),zipcode (Zip Code).These dimensions mustbe used for a scheduledreport portfolio.


The availabledimensions are: timedimensions: hour ( Hour), day ( Day ), week (Week ), month ( Month ),publisher_id ( Site ),connection_id ( Adsource ), partner_id (Partner ),creative_campaign_id (Creative Group ),creative_id ( Creative ),category_id ( Category ),segment_id (Segment),location_country (Country ), domain_name( Domain ),order_number_id ( OrderNumber ), order_id (Order ), order_line_id (Order Line ), network_id( Network ). For thelocation_region (State/Region ),location_metro ( Metroarea ), location_city (City ),video_publisher_video (Media ID ),video_am_video (Fingerprint ID ),item_name ( Content tag), browser_name (Browser ), os_name (Operating system ),autoplay_id (autoplay ID- 0 ( unknown ), 1 ( Clickto Play ), 2 ( Auto Play )),muted_id (muted ID 0 (unknown ), 1 ( Sound on), 2 ( Sound off )),playersize_id (playersizeID 0 ( unknown ), 1 (small ), 2 ( medium ), 3 (large )),content_type_name(Content Type Name),content_type_id(Content Type ID),autoplay_name(Autoplay Name),muted_name (MutedName), playersize_name(Playersize Name),zipcode (Zip Code).These dimensions mustbe used for a scheduledreport portfolio.

...


The availabledimensions are: timedimensions: hour ( Hour), day ( Day ), week (Week ), month ( Month ),publisher_id ( Site ),connection_id ( Adsource ), partner_id (Partner ),creative_campaign_id (Creative Group ),creative_id ( Creative ),category_id ( Category ),segment_id (Segment),location_country (Country ), domain_name( Domain ),order_number_id ( OrderNumber ), order_id (Order ), order_line_id (Order Line ), network_id( Network ). For thelocation_region (State/Region ),location_metro ( Metroarea ), location_city (City ),video_publisher_video (Media ID ),video_am_video (Fingerprint ID ),item_name ( Content tag), browser_name (Browser ), os_name (Operating system ),autoplay_id (autoplay ID- 0 ( unknown ), 1 ( Clickto Play ), 2 ( Auto Play )),muted_id (muted ID 0 (unknown ), 1 ( Sound on), 2 ( Sound off )),playersize_id (playersizeID 0 ( unknown ), 1 (small ), 2 ( medium ), 3 (large )),content_type_name(Content Type Name),content_type_id(Content Type ID),autoplay_name(Autoplay Name),muted_name (MutedName), playersize_name(Playersize Name),zipcode (Zip Code).These dimensions mustbe used for a scheduledreport portfolio.

...

The availabledimensions are: timedimensions: hour ( Hour), day ( Day ), week (Week ), month ( Month ),publisher_id ( Site ),connection_id ( Adsource ), partner_id (Partner ),creative_campaign_id (Creative Group ),creative_id ( Creative ),category_id ( Category ),segment_id (Segment),location_country (


Country ), domain_name( Domain ),order_number_id ( OrderNumber ), order_id (Order ), order_line_id (Order Line ), network_id( Network ). For thelocation_region (State/Region ),location_metro ( Metroarea ), location_city (City ),video_publisher_video (Media ID ),video_am_video (Fingerprint ID ),item_name ( Content tag), browser_name (Browser ), os_name (Operating system ),autoplay_id (autoplay ID- 0 ( unknown ), 1 ( Clickto Play ), 2 ( Auto Play )),muted_id (muted ID 0 (unknown ), 1 ( Sound on), 2 ( Sound off )),playersize_id (playersizeID 0 ( unknown ), 1 (small ), 2 ( medium ), 3 (large )),content_type_name(Content Type Name),content_type_id(Content Type ID),autoplay_name(Autoplay Name),muted_name (MutedName), playersize_name(Playersize Name),zipcode (Zip Code).These dimensions mustbe used for a scheduledreport portfolio.

...


The availabledimensions are: timedimensions: hour ( Hour), day ( Day ), week (Week ), month ( Month ),publisher_id ( Site ),connection_id ( Adsource ), partner_id (Partner ),creative_campaign_id (Creative Group ),creative_id ( Creative ),category_id ( Category ),segment_id (Segment),location_country (Country ), domain_name( Domain ),order_number_id ( OrderNumber ), order_id (Order ), order_line_id (Order Line ), network_id( Network ). For thelocation_region (State/Region ),location_metro ( Metroarea ), location_city (City ),video_publisher_video (Media ID ),video_am_video ( ...

Fingerprint ID ),item_name ( Content tag), browser_name (Browser ), os_name (Operating system ),autoplay_id (autoplay ID- 0 ( unknown ), 1 ( Clickto Play ), 2 ( Auto Play )),muted_id (muted ID 0 (unknown ), 1 ( Sound on), 2 ( Sound off )),playersize_id (playersizeID 0 ( unknown ), 1 (small ), 2 ( medium ), 3 (large )),content_type_name(Content Type Name),content_type_id(Content Type ID),autoplay_name(Autoplay Name),muted_name (MutedName), playersize_name(Playersize Name),zipcode (Zip Code).These dimensions mustbe used for a scheduledreport portfolio.

time_start yes string

he start time for thereport. It is given as astring ( yyyy-mm-ddhh:ii:ss ); if the "time"component ( hh:ii:ss ) ismissing, it will beautomatically replacedwith 00:00:00. Examples:"2010-12-08" ( it isautomatically convertedto 2010-12-08 00:00:00), "2010-12-0823:59:59". Iffilters[timezone] is notspecified, the system willautomatically use thetimezone for the currentuser.

...

time_end yes string

The end time for thereport. It is given as astring ( yyyy-mm-ddhh:ii:ss ); if the "time"component ( hh:ii:ss ) ismissing, it will beautomatically replacedwith 00:00:00. Examples:"2010-12-08" ( it isautomatically convertedto 2010-12-08 00:00:00), "2010-12-0823:59:59". Iffilters[timezone] is notspecified, the system willautomatically use thetimezone for the currentuser.

...

An array containing statistic filters. Theavailable filters are: publisher_id ( Site ),connection_id ( Ad source ), partner_id (Partner ), creative_campaign_id ( CreativeGroup ), creative_id ( Creative ),category_id ( Category ), location_country (Country ), domain_name ( Domain ),order_number_id ( Order Number )order_id ( Order ), order_line_id ( Order

filters yes string Accepts 2 types of data:Serialized Array | JSON.

Line ), network_id ( Network ), metric (Metric ), position ( Position ), timezone (Timezone ). If you need more advancedfilters such as location_region (State/Region ), location_metro ( Metro area), location_city ( City ),video_publisher_video ( Media ID ),video_am_video ( Fingerprint ID ),item_name ( Content tag ), browser_name (Browser ), browser_id ( Browser ID ),os_name ( Operating system ), os_id (Operating system ID ), autoplay_id(autoplay ID - 0 ( unknown ), 1 ( Click toPlay ), 2 ( Auto Play )), muted_id (muted ID0 ( unknown ), 1 ( Sound on ), 2 ( Soundoff )), playersize_id (playersize ID 0 (unknown ), 1 ( small ), 2 ( medium ), 3 (large )), content_type_name (Content TypeName), content_type_id (Content Type ID),autoplay_name (Autoplay Name),muted_name (Muted Name),playersize_name (Playersize Name),zipcode (Zip Code).If you want to give several possible valuesfor a filter, you can concatenate them usingthe ## separator ( if you need to get all theentries with position 1 or 0 sendfilters[postion] = 1##0 )The supported metrics are: slot,impression, view25, view50, view75,view100, clickthru, accept, pause, resume,mute, unmute, minimize, maximize, close,companion, conversion, uniqueadslot,cclickthru, fullscreen, leaveFullscreen,custom1, custom2, custom3, custom4,custom5, custom6, custom8.The supported positions are: in, ov, full, 1,0, 50, 100 ( in = ( 0, 50, 100 ); ov = ( 1 );full = ( 1, 0, 50, 100 ) ).The supported browser_id / browser_nameare: 0 / Other, 10 / MSIE, 15 / MSIE, 16 /MSIE, 17 / MSIE, 18 / MSIE, 20 / Firefox,21 / Firefox, 22 / Firefox, 23 / Firefox, 30 /Opera, 39 / Opera, 40 / Chrome, 41 /Chrome, 42 / Chrome, 43 / Chrome, 50 /Safari, 60 / Silk.TThe supported os_id / os_name are: 0 /Other, 10 / Windows Other, 11 / Windows2000, 12 / Windows XP, 13 / Windows2003, 14 / Windows Vista, 15 / Windows 7,16 / Windows 8, 20 / Mac OS, 30 / Linux,40 / SymbianOS, 50 / iOS iPhone/iPod, 51/ iOS iPad, 60 / Windows Phone, 70 /Android, 80 / Blackberry.The supported content_type_name /content_type_id are: Video / 6 , Game / 5 ,Music / 4 , Application / 3 , Text / 2 , Other /1 , Unknown\Undefined / 0Limitations:you cannot specify multiple "timezone"(s)you cannot specify multiple "metric"(s)if you need more extensive dimensions orfilters you have to created a scheduledreport portfolio

Return <liverailapi requested="/statistics" api_version="X.Y.Z"> <report> <row> <dimension1>the value for dimensions1</dimension1> <dimension2>the value for dimensions2 ( if dimension2 was given )</dimension2>

<dimension3>the value for dimensions3 ( if dimension3 was given )</dimension3> <dimension4>the value for dimensions4 ( if dimension4 was given )</dimension4> <dimension5>the value for dimensions5 ( if dimension5 was given )</dimension5> <dimension6>the value for dimensions6 ( if dimension6 was given )</dimension6> <data>a numeric value representing the requested aggregation</data> </row> ... </report> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason21 August 2012 Added Content Type Align with API14 September 2012 Removed Advertiser ID Align with API

REPORT PORTFOLIOS

All the methods related to report portfolios are displayed here.

/reports/portfolio/add/reports/portfolio/edit/reports/portfolio/list/reports/portfolio/delete

Method Name: /reports/portfolio/add

Method Description

Add a new report to the report portfolio.

Parameters





name yes string Portfolio reportname name=test

description yes string Portfolio reportdescription. description=music

start_period_type yes enum

The type of thereport's start timeperiod. "fixed"means that thatthe start point ofthe time period willbe fixed and notmodify over time."rolling" meansthat the start pointof the time periodwill incrementevery day.

start_period_type=fixed

start yes DateTimeThe start time ofthe report's timeperiod.

start=2011-12-22 00:00:00

end_period_type yes enum

The type of thereport's end timeperiod. "fixed"means that thatthe end point ofthe time period willbe fixed and notmodify over time."rolling" meansthat the end pointof the time periodwill incrementevery day.

end_period_type=rolling

end yes stringThe end time ofthe report's timeperiod.

end=2011-12-25 00:00:00

visibility yes enum

The visibility ofthe report. Itaccepts 2 values:"public" or"private". If youset this to privateonly the user thatcreated it canaccess it. If it'spublic all usersthat can accessthat entity canaccess the reportportfolio.

visibility=public

last_update_time yes DateTimeThe last updatetime of the report. last_update_time=2011-12-25 00:00:00

root_report yes enum

Specify the typeof the report. Theaccepted valuesare:"normal"|"forecast-in"|"forecast-ov".The default value

root_report=forecast-in

is "normal".A php serialized array containing (theJSON object structure must be identical tothe array one): The dimensions array cancontain: dimension1, dimension2,dimension3, dimension4, dimension5 anddimension6. For the available valuesplease look at /statistics.The filters array must contain: from_date (the start date yyyy-mm-dd format, forexample 2009-11-01 ), from_time ( the starttime in hh:ii format, for example 23:59 ),to_date( the end date yyyy-mm-dd format,for example 2009-11-01 ), to_time ( the endtime in hh:ii format, for example 23:59 ).Filters can also contain the following keys:publisher_id ( Site ), connection_id ( Adsource ), partner_id ( Partner ),creative_campaign_id ( Creative Group ),creative_id ( Creative ), advertiser_id (Advertiser ), location_country ( Country ),domain_name ( Domain ), order_id ( Order), order_line_id ( Order Line ), network_id (Network ), timezone ( Timezone ),location_region ( State/Region ),location_metro ( Metro area ), location_city( City ), video_publisher_video ( Media ID ),video_am_video ( Fingerprint ID ),item_name ( Content tag ), browser_id (Browser ID ), os_id ( Operating system ID ),autoplay_id (autoplay ID - 0 ( unknown ), 1( Click to Play ), 2 ( Auto Play )), muted_id(muted ID 0 ( unknown ), 1 ( Sound on ), 2 (Sound off )), playersize_id (playersize ID 0( unknown ), 1 ( small ), 2 ( medium ), 3 (large )), content_type_name (Content TypeName), content_type_id (Content Type ID),autoplay_name (Autoplay Name),muted_name (Muted Name),playersize_name (Playersize Name),zipcode (Zip Code). For each of this keys (except for timezone ) you need to give anarray ( even if there's actually a singlevalue, for example if you want to apply afilter for connection_id and you want asingle value ( 150 ), you still have to definefilters[connection_id] = array( 150 ) ).The columns array must contain at leastone column. The available columns are:accept-invite ( Accepts ), air ( Accept rate ),c-clicks ( Companion Click-Through ), c-imprs ( Companion Impressions ), clicks (Click-thru's ), clicks-mid ( Click-thru's (mid)), clicks-post ( Click-thru's (post) ), clicks-pre ( Click-thru's (pre) ), close-rate ( Closerate ), closes ( Closes ), complete-rate (Complete Rate ), ctr ( CTR ), ctr-companion ( Companion CTR ), ctr-mid (CTR (mid) ), ctr-post ( CTR (post) ), ctr-pre( CTR (pre) ), custom1 ( Custom 1 ),custom2 ( Custom 2 ), custom3 ( Custom 3), custom4 ( Custom 4 ), custom5 ( Custom5 ), custom6 ( Custom 6 ), custom7 (Custom 7 ), custom8 ( Survey ), ecpm (Revenue eCPM ), ecpm-for-publisher (Spending eCPM ), imprs ( Impressions ),imprs-mid ( Impressions (mid) ), imprs-post( Impressions (post) ), imprs-pre (Impressions (pre) ), in-clicks ( Click-thru's(i) ), in-ctr ( CTR (i) ), in-ecpm ( RevenueeCPM (i) ), in-ecpm-for-publisher (Spending eCPM (i) ), in-imprs (Impressions (i) ), in-revenue-advertiser (Revenue (i) ), in-revenue-publisher (Spending (i) ), min-rate ( Minimize Rate ),minimizes ( Minimizes ), mute-rate ( MuteRate ), mutes ( Mutes ), ov-clicks ( Click-thru's (o) ), ov-ctr ( CTR (o) ), ov-ecpm (Revenue eCPM (o) ), ov-ecpm-for-

report_definition yes enumAccepts 2 types ofdata: SerializedArray | JSON.

publisher ( Spending eCPM (o) ), ov-imprs( Impressions (o) ), ov-revenue-advertiser (Revenue (o) ), ov-revenue-publisher (Spending (o) ), pause-rate ( Pause Rate ),pauses ( Pauses ), revenue-advertiser (Revenue ), revenue-publisher ( Spending ),u-imprs ( Unique Impressions ), u-in-imprs (Unique Impressions (i) ), u-ov-imprs (Unique Impressions (o) ), video-ad-plays (Ad Starts ), watched-100 ( Watched 100%), watched-25 ( Watched 25% ), watched-50 ( Watched 50% ), watched-75 (Watched 75% ), inventory ( Inventory ),inventory-in ( Inventory (i) ), inventory-ov (Inventory (o) ), inventory-pre ( Inventory(pre) ), inventory-mid ( Inventory (mid) ),inventory-post ( Inventory (post) ),inventory-fill ( Inventory Fill ), inventory-fill-in ( Inventory Fill (i) ), inventory-fill-ov (Inventory Fill (o) ), inventory-fill-pre (Inventory Fill (pre) ), inventory-fill-mid (Inventory Fill (mid) ), inventory-fill-post (Inventory Fill (post) ), ad-requests ( AdRequests ), ad-requests-in ( Ad Requests(i) ), ad-requests-ov ( Ad Requests (o) ),ad-requests-pre ( Ad Requests (pre) ), ad-requests-mid ( Ad Requests (mid) ), ad-requests-post ( Ad Requests (post) ), ad-requests-fill ( Ad Requests Fill ), ad-requests-fill-in ( Ad Requests Fill (i) ), ad-requests-fill-ov ( Ad Requests Fill (o) ), ad-requests-fill-pre ( Ad Requests Fill (pre) ),ad-requests-fill-mid ( Ad Requests Fill (mid)), ad-requests-fill-post ( Ad Requests Fill(post) ).The supported browser_id / browser_nameare: 0 / Other, 10 / MSIE, 15 / MSIE, 16 /MSIE, 17 / MSIE, 18 / MSIE, 20 / Firefox,21 / Firefox, 22 / Firefox, 23 / Firefox, 30 /Opera, 39 / Opera, 40 / Chrome, 41 /Chrome, 42 / Chrome, 43 / Chrome, 50 /Safari, 60 / Silk.The supported os_id / os_name are: 0 /Other, 10 / Windows Other, 11 / Windows2000, 12 / Windows XP, 13 / Windows2003, 14 / Windows Vista, 15 / Windows 7,16 / Windows 8, 20 / Mac OS, 30 / Linux,40 / SymbianOS, 50 / iOS iPhone/iPod, 51/ iOS iPad, 60 / Windows Phone, 70 /Android, 80 / Blackberry.The supported content_type_name /content_type_id are: Video / 6 , Game / 5 ,Music / 4 , Application / 3 , Text / 2 , Other /1 , Unknown\Undefined / 0**If you have order_id and/ororder_line_id specified anywhere, thefollowing columns are not accepted:"slots","in-slots","ov-slots","slots-pre","slots-mid","slots-post", "fill-rate-pre","fill-rate-mid","fill-rate-post","fill-rate","slots-unique","in-slots-unique","ov-slots-unique","in-rate","ov-rate","rate-unique", "in-rate-unique","ov-rate-unique","ad-requests","ad-requests-in", "ad-requests-ov","ad-requests-pre","ad-requests-mid", "ad-requests-post","inventory-1","inventory-2","inventory","inventory-1-in", "inventory-2-in","inventory-in","inventory-1-ov","inventory-2-ov","inventory-ov","inventory-1-pre","inventory-2-pre","inventory-pre","inventory-1-mid","inventory-2-mid","inventory-mid","inventory-1-post","inventory-2-post","inventory-post","u-inventory-1","u-inventory-2","u-inventory", "u-inventory-1-in","u-inventory-2-in","u-inventory-in","u-inventory-1-ov", "u-inventory-2-ov","u-inventory-ov","u-inventory-1-pre","u-inventory-2-pre", "u-inventory-pre","u-

inventory-1-mid","u-inventory-2-mid","u-inventory-mid", "u-inventory-1-post","u-inventory-2-post","u-inventory-post","inventory-fill", "inventory-fill-in","inventory-fill-ov","inventory-fill-pre","inventory-fill-mid", "inventory-fill-post".

Return <liverailapi requested="/reports/portfolio/add" api_version="X.Y.Z"> <report_portfolio_id>the numeric ID of the report added to the portfolio</report_portfolio_id> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason21 August 2012 Added Content Type Align with API11 September 2012 Added non-valid parameters Align with API

Method Name: /reports/portfolio/list

Method Description

List the reports defined in the report portfolio.

Parameters






Return onlythe reportsowned by thespecifiedentity(s). Youcan send asingle ID or alist of IDs byglueing themtogether with"|". By defaultthe methodwill return thereports for thecurrent entity.

entity_id=735

report_portfolio_id no integer

Return onlythe reportsfrom thespecifiedreport profolio.You can senda single ID ora list of IDs byglueing themtogether with"|".

report_portfolio_id=75

limit no integerLimit thenumber ofrecordsreturned.

limit=24

offset no string

Do not returnthe first 'offset'number ofrecords (the'limit'parametermust bespecified).

offset=music

status no set

Return onlythe reportsthat are'active' or'paused'.

status=active

running no set

Return onlythe reportsthat arecurrentlyrunning or notrunning.

running=no

output no set

Return thedata in thespecifiedformat.Possiblevalues are:"array", "json"

output=json

canned_report no set

Return theportfolios thatare eithercanned or not.The portfoliosthat havecanned_report= yes cannotbe deleted oredited.

canned_report=yes

Return <liverailapi requested="/reports/portfolio/list" api_version="X.Y.Z"><portfolios> <list> <portfolio> <report_portfolio_id>the numeric ID of the report in the report portfolio</report_portfolio_id> <user_id>the numeric ID of the user who created the report</user_id> <entity_id>the numeric ID of the entity for which the report was created</entity_id> <name>the name of the report</name> <description>the description of the report</description> <visibility>the visibility of the report ('public' | 'private')</visibility> <creation_time>the time at which the report was created</creation_time> <last_update_time>the time at which the report was last updated</last_update_time> <start_period_type>the type of the period start ('fixed' | 'rolling')</start_period_type> <start>the start time of the period</start> <end_period_type>the type of the period end ('fixed' | 'rolling')</end_period_type> <end>the end time of the period</end> <report_definition> serialized definition of the report e.g. for array: a:4:{s:10:"dimensions";a:2:{s:10:"dimension1";s:13:"advertiser_id";}s:7:"filters";a:1:{s:8:"timezone";s:1:"1";}s:11:"filter_vals";a:0:{}s:7:"columns";a:5:{i:0;s:8:"in-imprs";i:1;s:6:"in-ctr";i:2;s:8:"ov-imprs";i:3;s:9:"ov-clicks";i:4;s:6:"ov-ctr";}} e.g. for json: {"dimensions":{"dimension1":"day","dimension2":"creative_id"},"filters":{"timezone":"2","creative_campaign_id":["xxxx"]},"filter_vals":{"creative_campaign_id":["xxxx"]},"columns":["u-imprs","u-clicks","u-ctr"]} </report_definition> <canned_report>yes | no</canned_report> <url_callback></url_callback> <root_report>yes/no</root_report> <report_type>normal/forecast-in/forecast-ov</report_type> -- report distribution definition -- <to>recipient's email addresses (separated by ||)</to> <subject>email subject</subject> <frequency>report frequency (daily | weekly | monthly | asap)</frequency> <hour>the hour at which the report to be sent</hour> -- for daily frequency -- <day>not relevant</day> -- for weekly frequency -- <day>the day of the week (1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday) </day> -- for monthly frequency -- <day>the day of the month (1 - 31)</day> <message>aditional message sent inside the email</message> <status>status of the report (active | paused)</status> <running>the report is currently being generated</running> <run_start_timestamp>the time at which the report started generating</run_start_timestamp> <run_end_timestamp>the time at which the report ended generating</run_end_timestamp> <export_format>the export format (csv|xls|xlsx)</export_format> <delayed_timestamp>...<delayed_timestamp/> <delayed_end_timestamp>...<delayed_end_timestamp/> <until>0000-00-00 00:00:00</until> </portfolio> ... </list> <count>number of report portfolios</count> </portfolios> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /reports/portfolio/edit

Method Description

Edits an existing report from the report portfolio.

Parameters





report_portfolio_id yes integerThe numerical IDof the reportportfolio to beedited


name no string Portfolio reportname name=test

description no string Portfolio reportname description. description=music

start_period_type no set

The type of thereport's start timeperiod. It accepts2 values: "fixed"means that thatthe start point ofthe time period willbe fixed and notmodify over time,and "rolling"means that thestart point of thetime period willincrement everyday.

start_period_type=fixed

start no DateTimeThe start time ofthe report's timeperiod.

start=2011-12-22 00:00:00

end_period_type no set

The type of thereport's end timeperiod. It accepts2 values: "fixed"means that thatthe end point ofthe time period willbe fixed and notmodify over time,and "rolling"means that theend point of thetime period willincrement everyday

end_period_type=rolling

end no stringThe end time ofthe report's time end=2011-12-25 00:00:00

period.

visibility no set

The visibility ofthe report. Itaccepts 2 values:"public" or"private". If youset this to privateonly the user thatcreated it canaccess it. If it'spublic all usersthat can accessthat entity canaccess the reportportfolio.

visibility=public

last_update_time no DateTimeThe last updatetime of the report. last_update_time=2011-12-25 00:00:00

root_report no enum

Specify the typeof the report. Theaccepted valuesare:"normal"|"forecast-in"|"forecast-ov".The default valueis "normal".

root_report=forecast-in

A php serialized array containing (theJSON object structure must to be identicalto the array one): The dimensions arraycan contain: dimension1, dimension2,dimension3, dimension4, dimension5 anddimension6. For the available valuesplease look at /statistics.The filters array must contain: from_date (the start date yyyy-mm-dd format, forexample 2009-11-01 ), from_time ( the starttime in hh:ii format, for example 23:59 ),to_date( the end date yyyy-mm-dd format,for example 2009-11-01 ), to_time ( the endtime in hh:ii format, for example 23:59 ).Filters can also contain the following keys:publisher_id ( Site ), connection_id ( Adsource ), partner_id ( Partner ),creative_campaign_id ( Creative Group ),creative_id ( Creative ), advertiser_id (Advertiser ), location_country ( Country ),domain_name ( Domain ), order_id ( Order), order_line_id ( Order Line ), network_id (Network ), timezone ( Timezone ),location_region ( State/Region ),location_metro ( Metro area ), location_city( City ), video_publisher_video ( Media ID ),video_am_video ( Fingerprint ID ),item_name ( Content tag ), browser_id (Browser ID ), os_id ( Operating system ID ),autoplay_id (autoplay ID - 0 ( unknown ), 1( Click to Play ), 2 ( Auto Play )), muted_id(muted ID 0 ( unknown ), 1 ( Sound on ), 2 (Sound off )), playersize_id (playersize ID 0( unknown ), 1 ( small ), 2 ( medium ), 3 (large )), content_type_name (Content TypeName), content_type_id (Content Type ID),autoplay_name (Autoplay Name),

report_definition no setAccepts 2 types ofdata: SerializedArray | JSON.

muted_name (Muted Name),playersize_name (Playersize Name),zipcode (Zip Code). For each of this keys (except for timezone ) you need to give anarray ( even if there's actually a singlevalue, for example if you want to apply afilter for connection_id and you want asingle value ( 150 ), you still have to definefilters[connection_id] = array( 150 ) ).The columns array must contain at leastone column. The available columns are:accept-invite ( Accepts ), air ( Accept rate ),c-clicks ( Companion Click-Through ), c-imprs ( Companion Impressions ), clicks (Click-thru's ), clicks-mid ( Click-thru's (mid)), clicks-post ( Click-thru's (post) ), clicks-pre ( Click-thru's (pre) ), close-rate ( Closerate ), closes ( Closes ), complete-rate (Complete Rate ), ctr ( CTR ), ctr-companion ( Companion CTR ), ctr-mid (CTR (mid) ), ctr-post ( CTR (post) ), ctr-pre( CTR (pre) ), custom1 ( Custom 1 ),custom2 ( Custom 2 ), custom3 ( Custom 3), custom4 ( Custom 4 ), custom5 ( Custom5 ), custom6 ( Custom 6 ), custom7 (Custom 7 ), custom8 ( Survey ), ecpm (Revenue eCPM ), ecpm-for-publisher (Spending eCPM ), imprs ( Impressions ),imprs-mid ( Impressions (mid) ), imprs-post( Impressions (post) ), imprs-pre (Impressions (pre) ), in-clicks ( Click-thru's(i) ), in-ctr ( CTR (i) ), in-ecpm ( RevenueeCPM (i) ), in-ecpm-for-publisher (Spending eCPM (i) ), in-imprs (Impressions (i) ), in-revenue-advertiser (Revenue (i) ), in-revenue-publisher (Spending (i) ), min-rate ( Minimize Rate ),minimizes ( Minimizes ), mute-rate ( MuteRate ), mutes ( Mutes ), ov-clicks ( Click-thru's (o) ), ov-ctr ( CTR (o) ), ov-ecpm (Revenue eCPM (o) ), ov-ecpm-for-publisher ( Spending eCPM (o) ), ov-imprs( Impressions (o) ), ov-revenue-advertiser (Revenue (o) ), ov-revenue-publisher (Spending (o) ), pause-rate ( Pause Rate ),pauses ( Pauses ), revenue-advertiser (Revenue ), revenue-publisher ( Spending ),u-imprs ( Unique Impressions ), u-in-imprs (Unique Impressions (i) ), u-ov-imprs (Unique Impressions (o) ), video-ad-plays (Ad Starts ), watched-100 ( Watched 100%), watched-25 ( Watched 25% ), watched-50 ( Watched 50% ), watched-75 (Watched 75% ), inventory ( Inventory ),inventory-in ( Inventory (i) ), inventory-ov (Inventory (o) ), inventory-pre ( Inventory(pre) ), inventory-mid ( Inventory (mid) ),inventory-post ( Inventory (post) ),inventory-fill ( Inventory Fill ), inventory-fill-in ( Inventory Fill (i) ), inventory-fill-ov (Inventory Fill (o) ), inventory-fill-pre (Inventory Fill (pre) ), inventory-fill-mid (Inventory Fill (mid) ), inventory-fill-post (

Inventory Fill (post) ), ad-requests ( AdRequests ), ad-requests-in ( Ad Requests(i) ), ad-requests-ov ( Ad Requests (o) ),ad-requests-pre ( Ad Requests (pre) ), ad-requests-mid ( Ad Requests (mid) ), ad-requests-post ( Ad Requests (post) ), ad-requests-fill ( Ad Requests Fill ), ad-requests-fill-in ( Ad Requests Fill (i) ), ad-requests-fill-ov ( Ad Requests Fill (o) ), ad-requests-fill-pre ( Ad Requests Fill (pre) ),ad-requests-fill-mid ( Ad Requests Fill (mid)), ad-requests-fill-post ( Ad Requests Fill(post) ).The supported browser_id / browser_nameare: 0 / Other, 10 / MSIE, 15 / MSIE, 16 /MSIE, 17 / MSIE, 18 / MSIE, 20 / Firefox,21 / Firefox, 22 / Firefox, 23 / Firefox, 30 /Opera, 39 / Opera, 40 / Chrome, 41 /Chrome, 42 / Chrome, 43 / Chrome, 50 /Safari, 60 / Silk.The supported os_id / os_name are: 0 /Other, 10 / Windows Other, 11 / Windows2000, 12 / Windows XP, 13 / Windows2003, 14 / Windows Vista, 15 / Windows 7,16 / Windows 8, 20 / Mac OS, 30 / Linux,40 / SymbianOS, 50 / iOS iPhone/iPod, 51/ iOS iPad, 60 / Windows Phone, 70 /Android, 80 / Blackberry.The supported content_type_name /content_type_id are: Video / 6 , Game / 5 ,Music / 4 , Application / 3 , Text / 2 , Other /1 , Unknown\Undefined / 0**If you have order_id and/ororder_line_id specified anywhere, thefollowing columns are not accepted:"slots","in-slots","ov-slots","slots-pre","slots-mid","slots-post", "fill-rate-pre","fill-rate-mid","fill-rate-post","fill-rate","slots-unique","in-slots-unique","ov-slots-unique","in-rate","ov-rate","rate-unique", "in-rate-unique","ov-rate-unique","ad-requests","ad-requests-in", "ad-requests-ov","ad-requests-pre","ad-requests-mid", "ad-requests-post","inventory-1","inventory-2","inventory","inventory-1-in", "inventory-2-in","inventory-in","inventory-1-ov","inventory-2-ov","inventory-ov","inventory-1-pre","inventory-2-pre","inventory-pre","inventory-1-mid","inventory-2-mid","inventory-mid","inventory-1-post","inventory-2-post","inventory-post","u-inventory-1","u-inventory-2","u-inventory", "u-inventory-1-in","u-inventory-2-in","u-inventory-in","u-inventory-1-ov", "u-inventory-2-ov","u-inventory-ov","u-inventory-1-pre","u-inventory-2-pre", "u-inventory-pre","u-inventory-1-mid","u-inventory-2-mid","u-inventory-mid", "u-inventory-1-post","u-inventory-2-post","u-inventory-post","inventory-fill", "inventory-fill-in","inventory-fill-ov","inventory-fill-pre","inventory-fill-mid", "inventory-fill-post".

Return <liverailapi requested="/reports/portfolio/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History

Date Description Reason21 August 2012 Added Content Type Align with API11 September 2012 Added non-valid parameters Align with API

Method Name: /reports/portfolio/delete

Method Description

Delete a report from report portfolio.

Parameters





report_portfolio_id yes integer

The numericID of thereportportfolio to bedeleted.


Return <liverailapi requested="/reports/portfolio/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


REPORT PORTFOLIO SCHEDULES

All the methods related to report portfolios schedules are displayed here.

/reports/portfolio/schedule/add/reports/portfolio/schedule/edit/reports/portfolio/schedule/list/reports/portfolio/schedule/delete

Method Name: /reports/portfolio/schedule/list

Method Description

List the report schedule (if any) of (a) report(s) from the report portfolio.

Parameters






The numericID of thereportportfolio. Youcan send asingle ID or alist of IDs byglueing themtogether with"|"


Return <liverailapi requested="/reports/portfolio/schedule/list" api_version="X.Y.Z"> <schedules> <schedule> <report_portfolio_id>the numeric ID of the report in the report portfolio</report_portfolio_id> <to>recipient's email addresses (separated by ||)</to> <subject>email subject</subject> <frequency>report frequency (daily | weekly | monthly | asap)</frequency> <hour>the hour at which the report to be sent</hour> -- for daily frequency -- <day>not relevant</day> -- for weekly frequency -- <day>the day of the week (1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday) </day> -- for monthly frequency -- <day>the day of the month (1 - 31)</day> <message>aditional message sent inside the email</message> <status>status of the report (active | paused)</status> <running>the report is currently being generated</running> <run_start_timestamp>the time at which the report started generating</run_start_timestamp> <run_end_timestamp>the time at which the report ended generating</run_end_timestamp> <export_format>the export format (csv|xls|xlsx)</export_format> <url_callback>the POST URL for callback (optional)</url_callback> <delayed_timestamp>...<delayed_timestamp/> <delayed_end_timestamp>...<delayed_end_timestamp/> <until>0000-00-00 00:00:00</until> </schedule> ... </schedules> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /reports/portfolio/schedule/add

Method Description

Add a report portfolio schedule.

Parameters




report_portfolio_id yes integerThe numerical ID of the reportportfolio for which the scheduleis added.


to yes string

The email address to which thereport should be sent. More thanone email address can bespecified by glueing themtogether with "|"

[email protected]

subject yes string The subject to be used in theemail, subject=report

frequency yes enum

The frequency of the reportgeneration. The possible valuesare:"daily"|"weekly"|"monthly"|"asap".if frequency = daily --> timeduration of report can only be 1day max or month to date(exception to the rule)if frequency = weekly --> timeduration of report can only be 7days maxif frequency = monthy --> timeduration of report can only be 31days max

frequency=daily

hour yes DateTimeThe time of sending the report. hour=12

day yes enum

For daily frequency the value isnot relevant. For weeklyfrequency the value representsthe day of the week (1 - Monday,2 - Tuesday, 3 - Wednesday ).For monthly frequency the valuerepresents the day of the month(1 - 31)

day=7

status yes enum The report's status. The possiblevalues are: "active", "paused" status=active

until yes DateTime

Specify for "start_period_type"fixed and "end_period_type""rolling". When the 'Until' date ismet, the report will automaticallybe 'Paused'. Must be shorterthan 1 year. If both"start_period_type" and"end_period_type" are "fixed","until" does not have anyfunction. If both"start_period_type" and"end_period_type" are "rolling","until" is optional. If"start_period_type" is fixed and"end_period_type" is "rolling","until" is mandatory.

until=2012-06-15 00:00:00

An URL callback where the

url_callback yes string

scheduler will call ( via POST )when the report is completed.The POST fields will belr_export_file ( the URL fromwhere the export file can bedownloaded ) andlr_report_portfolio_id ( thenumerical ID of the reportportfolio )

url_callback=

Return <liverailapi requested="/reports/portfolio/schedule/add" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


Method Name: /reports/portfolio/schedule/edit

Method Description

Edit a report portfolio schedule.

Parameters




report_portfolio_id yes integerThe numerical ID of the reportportfolio for which the scheduleis edited.


to no string

The email address to which thereport should be sent. More thanone email address can bespecified by glueing themtogether with "|"

[email protected]

subject no string The subject to be used in theemail, subject=report

frequency no set

The frequency of the reportgeneration. The possible valuesare:"daily"|"weekly"|"monthly"|"asap".if frequency = daily --> timeduration of report can only be 1day max or month to date(exception to the rule)if frequency = weekly --> timeduration of report can only be 7days maxif frequency = monthy --> timeduration of report can only be 31days max

frequency=daily

hour no DateTimeThe time of sending the report. hour=12

day no set

For daily frequency the value isnot relevant. For weeklyfrequency the value representsthe day of the week (1 - Monday,2 - Tuesday, 3 - Wednesday ).For monthly frequency the valuerepresents the day of the month(1 - 31)

day=7

status no set

The report's status. The possiblevalues are: "active", "paused".Be aware that when theschedule status is set to paused,it will not perform anything elseanymore.

status=active

until no DateTime

Specify for "start_period_type"fixed and "end_period_type""rolling". When the 'Until' date ismet, the report will automaticallybe 'Paused'. Must be shorterthan 1 year. If both"start_period_type" and"end_period_type" are "fixed","until" does not have anyfunction. If both"start_period_type" and"end_period_type" are "rolling","until" is optional. If

until=2012-06-15 00:00:00

"start_period_type" is fixed and"end_period_type" is "rolling","until" is mandatory.

url_callback no string

An URL callback where thescheduler will call ( via POST )when the report is completed.The POST fields will belr_export_file ( the URL fromwhere the export file can bedownloaded ) andlr_report_portfolio_id ( thenumerical ID of the reportportfolio )

url_callback=

Return <liverailapi requested="/reports/portfolio/schedule/edit" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


10.01.2012 The behaviour of the status has been changed whenset to "paused"

To ensure thefull...

Method Name: /reports/portfolio/schedule/delete

Method Description

Delete a report portfolio schedule.

Parameters






TThenumerical IDof the reportportfolio fromwhich theschedule isdeleted.


Return <liverailapi requested="/reports/portfolio/schedule/delete" api_version="X.Y.Z"> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


COMSCORE

All the methods related to ComScore are displayed here.

/comscore/target/list/comscore/domain/list

Method Name: /comscore/target/list

Method Description

Returns the list of comscore targets.

Parameters





Return

<liverailapi requested="/comscore/target/list" api_version="x.y.z"><targets> <target> <target_id></target_id> <target_name></target_name> </target> ...</targets><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


Method Name: /comscore/domain/list

Method Description

Returns the list of comscore domains.

Parameters





target_id yes integer

The id of the target.Multiple IDs can bebind together by "|"or ",". Retrieve thetarget_id from/comscore/target/list


Return

<liverailapi requested="/comscore/domain/list" api_version="x.y.z"><domains> <domain> <domain_index></domain_index> <domain_name></domain_name> </domain> ...</domain><user> ... </user><auth> ... </auth><status>success or fail</status><error>error if status=fail, null otherwise</error>...</liverailapi>

Change History


3RD PARTY INTEGRATION

All the methods related to 3rd party integration are listed here.

/contextual/segments/get

Method Name: /contextual/segments/get

Method Description

List all the contextual data for segments.

Parameters





segment_source no string

Search based onthe segmentsource. Thepossible valuesare: "adsafe" ,"proximic"

segment_source=adsafe


Return only thesegments with thename that areLIKE%search_string%.

search_string=ads

limit no integer

Limit the numberof results forpagination(s).This parameter isoptional.

limit=10

offset no string

The offset fromwhere the limitshould be applied( if you display 10items per pageand you need toget the 3rd pageyou should setoffset to 20 andlimit to 10 ). Thisparameter isoptional andshouldn't be givenwithout giving thelimit parameter aswell.

offset=20

Return <liverailapi requested="/contextual/segment/get" api_version="x.y.x"> <contextual_segment_list> <contextual_segment> <segment_id>The numeric ID of the segment</segment_id> <segment_source>The numeric ID of the segment data</segment_data_id>

<segment_code>string: the segment code</segment_code> <segment_name>segment name</segment_name> <segment_type>segment type</type> <segment_price>float: segment price</segment_price> </segment_segment> ... </contextual_segment_list> ... <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


QC ADVERTISER

All the methods related to QC Advertiser are listed here.

/qc/advertiser/list

Method Name: /qc/advertiser/list

Method Description

List all the available QC advertisers.

Parameters





qc_advertiser_id no integer

The numeric ID ofthe QC Advertiserfor which theinformation will bereturned. If youhave multiple id(s)you can make asingle call byglueing themtogether with | or ,

qc_advertiser_id = 1|7|120 orqc_advertiser_id = 1,7,120

qc_advertiser_name no stringSearch based onthe QC Advertiserfull name.

qc_advertiser_name = Test Advertiser


limit=50

offset no integer

The offset fromwhere the limitshould be applied( if you display 10results per pageand you need toget the 3rd pageyou should setoffset to 20 andlimit to 10 ). Donot use withoutspecifying thelimit parameter aswell.

offset=5


Return only QCAdvertisers withthe name that areLIKE%search_string%.

search_string=test

Return <liverailapi requested="/qc/advertiser/list" api_version="X.Y.Z"> <qc_advertisers> <list> <qc_advertiser> <qc_advertiser_id>The numeric ID of the QC Advertiser</qc_advertiser_id> <qc_advertiser_name>string: the QC Advertiser name</qc_advertiser_name> </qc_advertiser>

... </list> ... </qc_advertisers> <user> ... </user> <auth> ... </auth> <status>success or fail</status> <error>error if status=fail, null otherwise</error> ...</liverailapi>

Change History


LiveRail API

Documents

Transcript of LiveRail API