CompanionService Types

CompanionService WSDL


This service is stateless.

getAvailableRenderingModestop

Description

Returns the list of available rendering modes for companion ads.

StringList getAvailableRenderingModes()

Return Values

StringList

getCompaniontop

Description



Companion getCompanion(int $id)

Parameters

int $id

Return Values

Companion

getCompanionListByBannerIdtop

Description



CompanionList getCompanionListByBannerId(int $banner_id)

Parameters

int $banner_id

Return Values

CompanionList

getCounttop

Description

Returns the total amount of available Companions.
Requires administrator permissions.

int getCount()

Return Values

int

getSoaCollectionPagetop

Description

Gets a single SoaCollection page.
Requires administrator permissions.

For valid filters and qualifiers see getValidSoaCollectionFilters().

CompanionList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration $configuration

Return Values

CompanionList

getValidSoaCollectionFilterstop

Description

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

SoaCollectionValidFilterList getValidSoaCollectionFilters()

Return Values

SoaCollectionValidFilterList

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

removeByIdtop

Description



boolean removeById(int $id)

Parameters

int $id

Return Values

boolean

saveCompaniontop

Description



int saveCompanion(Companion $companion_complex_type)

Parameters

Companion $companion_complex_type

Return Values

int companion ID

Faults

ValidationErrorMessageList

Companiontop

Definition

object Companion {
- int $id

optional

Unique identifier

- int $bannerId

required

Banner's unique identifier

- string $name

optional

Name of the companion. Max allowed length is 255 characters.

- string $altText

optional

Alt text to be displayed when companion is rendered in HTML environment. Max allowed length is 255 characters.

- int $width

required

Pixel dimensions of companion.

- int $height

required

Pixel dimensions of companion.

- int $expandedWidth

optional

Pixel dimensions of expanding companion ad when in expanded state.

- int $expandedHeight

optional

Pixel dimensions of expanding companion ad when in expanded state.

- string $tracking

optional

URI to track view of Companion.

- string $clickthrough

optional

URI to open as destination page when user clicks on the companion. Max allowed length is 255 characters.

- string $adParameters

optional

Data to be passed into the companion ads. Max allowed length is 255 characters.

- string $adSlotId

optional

Used to identify desired placement on a publisher’s page. Max allowed length is 36 characters.

- int $pixelRatio

optional

The pixel ratio for which the icon creative is intended. The pixel ratio is the ratio of physical pixels on
the device to the device-independent pixels. An ad intended for display on a device with a pixel ratio that
is twice that of a standard 1:1 pixel ratio would use the value "2". Default value is "1".
Max allowed length is a integer number with 8 characters.

- string $renderingMode

optional

Used to indicate when and where to use this companion ad.
If this field is empty or not given, “default” will be used.
For valid renderingModes see getAvailableRenderingModes().

- CompanionFile $companionFile

optional

}

CompanionFiletop

Definition

Abstract ComplexType to save and read file data.
To save or update file data use \Adition\SOA\ComplexTypes\Companion\CompanionFileBinary.

Inheriting types:
- CompanionFileBinary
- CompanionFileHash

object abstractCompanionFile {
- string $filename

required

}

CompanionFileBinarytop

Definition

Used to save and update binary file encoded in base64 algorithm.
The supported mimeType files are: 'image/jpeg', 'image/gif' and 'image/png'.

Class CompanionFileBinary

object CompanionFileBinary {
- string $base64EncodedFileContent

required

- string $filename

required

}

CompanionFileHashtop

Definition

Read-only specification to retrieve file details on load Companion.

object CompanionFileHash {
- string $hash

required

Cryptographic hash based on sha1

- string $filename

required

}

CompanionListtop

Definition

object CompanionList {
- Array <CompanionComplexType> $companions

optional

- Array <NamedStringValue> $lastKeySet

optional

}

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

}

StringListtop

Definition

object StringList {
- Array <string> $strings

optional

The strings

}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

Console