ADITION technologies - API Documentation

VastTemplateService WSDL

This service is stateless.

getAudioVastTemplatetop

Description

AudioVastTemplate getAudioVastTemplate(int $id)

Parameters

int

$id

Return Values

AudioVastTemplate

getDoohVastTemplatetop

Description

DoohVastTemplate getDoohVastTemplate(int $id)

Parameters

int

$id

Return Values

DoohVastTemplate

getSoaCollectionPagetop

Description

Gets a single SoaCollection page.

For valid filters and qualifiers see getValidSoaCollectionFilters().

TemplateList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration

$configuration

Return Values

TemplateList

getValidSoaCollectionFilterstop

Description

Gets valid soa collection search filters and their qualifier name / values

SoaCollectionValidFilterList getValidSoaCollectionFilters()

Return Values

SoaCollectionValidFilterList

getVideoVastTemplatetop

Description

VideoVastTemplate getVideoVastTemplate(int $id)

Parameters

int

$id

Return Values

VideoVastTemplate

logintop

Description

Initializes a new session with given information

boolean login(string $user, string $pass, int $network)

Parameters

string	$user	Username
string	$pass	Password
int	$network	$network Network ID

Return Values

boolean

true on success, false on fail

logouttop

Description

Destroys the active session, logging out the user.

boolean logout()

Return Values

boolean

true on success, false on fail

removeVastTemplatetop

Description

boolean removeVastTemplate(int $template_id)

Parameters

int

$template_id

Return Values

boolean

True on success, otherwise false

saveAudioVastTemplatetop

Description

int saveAudioVastTemplate(AudioVastTemplate $template_complex_type)

Parameters

AudioVastTemplate

$template_complex_type

Return Values

int	$templateId

saveDoohVastTemplatetop

Description

int saveDoohVastTemplate(DoohVastTemplate $template_complex_type)

Parameters

DoohVastTemplate

$template_complex_type

Return Values

int	$templateId

saveVideoVastTemplatetop

Description

int saveVideoVastTemplate(VideoVastTemplate $template_complex_type)

Parameters

VideoVastTemplate

$template_complex_type

Return Values

int	$templateId

Adverificationtop

Definition

object Adverification {

- int $id

optional

- string $vendor

required

- boolean $browserOptional

optional

- string $javascriptUrl

required

- string $javascriptApiFramework

optional

- string $verificationNotExecutedUrl

optional

- string $verificationParams

optional

}

AudioVastTemplatetop

Definition

object AudioVastTemplate extends Template {

- string $vastType

optional

Deprecated since 2019-11-20

- Array <AudioVastTemplateEncoding> $encodings

optional

- boolean $isScalable

optional

Deprecated since 2019-11-20

- boolean $isAspectRatioMaintained

optional

Deprecated since 2019-11-20

- boolean $isSkippable

optional

Deprecated since 2019-11-20

- string $vastExension

optional

Deprecated since 2019-12-16 due to typo. Use vastExtension property instead.

- string $vastExtension

optional

- boolean $hasMezzanine

optional

}

AudioVastTemplateEncodingtop

Definition

object AudioVastTemplateEncoding {

- int $id

optional

- int $bitRate

required

- int $sortOrder

required

- string $mimeType

required

}

CustomTrackingUrltop

Definition

object CustomTrackingUrl {

- int $id

optional

- string $url

required

}

DoohVastTemplatetop

Definition

object DoohVastTemplate extends Template {

- boolean $isScalable

optional

- boolean $isAspectRatioMaintained

optional

- string $vastType

optional

Deprecated since 2019-11-20

- Array <DoohVastTemplateEncoding> $encodings

optional

- string $vastExtension

optional

}

DoohVastTemplateEncodingtop

Definition

object DoohVastTemplateEncoding {

- int $id

optional

- int $bitRate

required

- int $height

required

- int $width

required

- int $sortOrder

required

- string $mimeType

required

}

KeySetPagedSoaCollectionConfigurationtop

Definition

object KeySetPagedSoaCollectionConfiguration {

- Array <SoaCollectionFilter> $filters

optional

See SoaCollection::addQualifiedFilter()

- int $pageSize

required

- Array <NamedStringValue> $lastKeySet

optional

Read-only specification of the last collection element for key-set based paging.
The value is an implementation detail and must only be used for passing it directly
to getSoaCollectionPage() in order to navigate to the next collection page.
The value must be retrieved from the "lastKeySet" property of the previous getSoaCollectionPage() call.
To be left empty for the very first getSoaCollectionPage() call (default).

- boolean $useReplication

optional

Enables usage of replicated data increasing the performance and stability of search operations.

Regardless of this setting live data will be used instead in case of replication having
a lag of more than a couple of seconds.

}

NamedStringValuetop

Definition

object NamedStringValue {

- string $name

required

- string $value

required

}

SoaCollectionFiltertop

Definition

See SoaCollection::addQualifiedFilter().

object SoaCollectionFilter {

- string $target

required

- string $value

required

- int $qualifier

required

}

SoaCollectionFilterQualifiertop

Definition

Describes the possible qualifiers for a filter target

object SoaCollectionFilterQualifier {

- string $name

required

- int $value

required

}

SoaCollectionValidFiltertop

Definition

Describes the possible qualifiers for a filter target

object SoaCollectionValidFilter {

- string $target

required

- Array <SoaCollectionFilterQualifier> $qualifiers

optional

}

SoaCollectionValidFilterListtop

Definition

A list of valid filters and their qualifiers

object SoaCollectionValidFilterList {

- Array <SoaCollectionValidFilter> $validFilters

optional

}

Templatetop

Definition

Inheriting types:
- AudioVastTemplate
- DoohVastTemplate
- VideoVastTemplate

object abstractTemplate {

- int $id

optional

- VastVersion $vastVersion

optional

Deprecated since 2021-11-30

- string $name

required

- Viewability $viewability

optional

- Array <Adverification> $adverifications

optional

- Array <TemplateVastEventTracking> $vastEventTrackings

optional

- string $adParameter

optional

}

TemplateListtop

Definition

object TemplateList {

- Array <Template> $templates

optional

- Array <NamedStringValue> $lastKeySet

optional

}

TemplateVastEventTrackingtop

Definition

object TemplateVastEventTracking {

- int $id

optional

- string $vastEventName

required

- string $bannerEventName

optional

- Array <CustomTrackingUrl> $customTrackingUrls

optional

}

VastVersiontop

Definition

object VastVersion {

- int $id

optional

- string $name

required

Must be vast2, vast4 or vast4.1

}

VideoVastTemplatetop

Definition

object VideoVastTemplate extends Template {

- boolean $isScalable

optional

- boolean $isAspectRatioMaintained

optional

- boolean $isSkippable

optional

- string $vastExension

optional

Deprecated since 2019-12-16 due to typo. Use vastExtension property instead.

- string $vastType

optional

Deprecated since 2019-11-20

- Array <VideoVastTemplateEncoding> $encodings

optional

- string $vastExtension

optional

- boolean $hasMezzanine

optional

}

VideoVastTemplateEncodingtop

Definition

object VideoVastTemplateEncoding {

- int $id

optional

- int $bitRate

required

- int $height

required

- int $width

required

- int $sortOrder

required

- string $mimeType

required

}

Viewabilitytop

Definition

object Viewability {

- int $id

optional

- string $viewableUrl

optional

- string $notViewableUrl

optional

- string $viewUndeterminedUrl

optional

}