VastWrapperTemplateService Types

VastWrapperTemplateService WSDL


This service is stateless.

getSoaCollectionPagetop

Description

Gets a single SoaCollection page.

For valid filters and qualifiers see getValidSoaCollectionFilters().

WrapperTemplateList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration $configuration

Return Values

WrapperTemplateList

getValidSoaCollectionFilterstop

Description

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

SoaCollectionValidFilterList getValidSoaCollectionFilters()

Return Values

SoaCollectionValidFilterList

getVastWrapperTemplatetop

Description



WrapperTemplate getVastWrapperTemplate(int $id)

Parameters

int $id

Return Values

WrapperTemplate

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

removeVastWrapperTemplatetop

Description

Requires administrator permissions.

boolean removeVastWrapperTemplate(int $template_id)

Parameters

int $template_id

Return Values

boolean True on success, otherwise false

saveVastWrapperTemplatetop

Description

Requires administrator permissions.

int saveVastWrapperTemplate(WrapperTemplate $complex_type)

Parameters

WrapperTemplate $complex_type

Return Values

int

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

}

CustomTrackingUrltop

Definition

object CustomTrackingUrl {
- int $id

optional

- string $url

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

}

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

}

Viewabilitytop

Definition

object Viewability {
- int $id

optional

- string $viewableUrl

optional

- string $notViewableUrl

optional

- string $viewUndeterminedUrl

optional

}

WrapperTemplatetop

Definition

object WrapperTemplate {
- int $id

optional

- string $name

required

- boolean $followAdditionalWrappers

required

- boolean $allowMultipleAds

required

- boolean $fallbackOnNoAd

required

- string $vastExtension

required

- VastVersion $vastVersion

required

- Viewability $viewability

optional

- Array <Adverification> $adverifications

optional

- Array <TemplateVastEventTracking> $vastEventTrackings

optional

}

WrapperTemplateListtop

Definition

object WrapperTemplateList {
- Array <WrapperTemplate> $templates

optional

- Array <NamedStringValue> $lastKeySet

optional

}

Console