AssetService Types

AssetService WSDL


This service is stateless.

enqueueAssetForEncodingForVastBannerSettingstop

Description

Encoding progress can be polled via getAssetEncodingProgressForVastBannerSettings()

boolean enqueueAssetForEncodingForVastBannerSettings(CustomVastSettings $custom_vast_banner_settings)

Parameters

CustomVastSettings $custom_vast_banner_settings

Return Values

boolean True on success, otherwise false

enqueueAssetForEncodingForVastPublisherTemplatetop

Deprecated 2019-07-03

This method will be removed in upcoming releases.

Use enqueueAssetForEncodingForVastBannerSettings()

Description

Currently only video assets can be encoded.
Encoding progress can be polled via getAssetEncodingProgressForVastPublisherTemplate()

boolean enqueueAssetForEncodingForVastPublisherTemplate(int $asset_id, int $vast_publisher_template_id)

Parameters

int $asset_id
int $vast_publisher_template_id

Return Values

boolean True on success, otherwise false

getAssettop

Description



Asset getAsset(int $asset_id)

Parameters

int $asset_id

Return Values

Asset

getAssetEncodingProgressForVastBannerSettingstop

Description

Currently only video/dooh assets can be encoded.

AssetEncodingProgress getAssetEncodingProgressForVastBannerSettings(CustomVastSettings $custom_vast_banner_settings)

Parameters

CustomVastSettings $custom_vast_banner_settings

Return Values

AssetEncodingProgress

getAssetEncodingProgressForVastPublisherTemplatetop

Deprecated 2019-07-03

This method will be removed in upcoming releases.

Use getAssetEncodingProgressForVastBannerSettings()

Description

Currently only video assets can be encoded.

AssetEncodingProgress getAssetEncodingProgressForVastPublisherTemplate(int $asset_id, int $vast_publisher_template_id)

Parameters

int $asset_id
int $vast_publisher_template_id

Return Values

AssetEncodingProgress

getCounttop

Description



int getCount()

Return Values

int

getSoaCollectionPagetop

Description

Gets a single SoaCollection page.
Requires administrator permissions.

For valid filters and qualifiers see getValidSoaCollectionFilters().

AssetList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration $configuration

Return Values

AssetList

getValidSoaCollectionFilterstop

Description

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

SoaCollectionValidFilterList getValidSoaCollectionFilters()

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

uploadNewAssettop

Description



int uploadNewAsset(string $original_file_name, string $base64_encoded_file_content)

Parameters

string $original_file_name
string $base64_encoded_file_content

Return Values

int asset ID

Assettop

Definition

Inheriting types:
- ImageAsset
- VideoAsset
- AudioAsset

object abstractAsset {
- int $id

optional

- string $originalFileName

required

- int $byteSize

required

- string $createdAt

required

}

AssetEncodingProgresstop

Definition

object AssetEncodingProgress {
- string $status

required

Possible values:
- missing
- waiting
- processing
- finished
- error

- int $percentage

required

}

AssetListtop

Definition

object AssetList {
- Array <Asset> $assets

optional

- Array <NamedStringValue> $lastKeySet

optional

}

AudioAssettop

Definition

object AudioAsset extends Asset {
- int $durationInSeconds

required

}

AudioVastBannerSettingstop

Definition

object AudioVastBannerSettings extends CustomVastSettings {
- int $bannerId

optional

- string $vastType

optional

Deprecated since 2019-12-16

- VastVersion $vastVersion

required

- Array <AudioVastEncoding> $encodings

optional

- string $vastExtension

optional

}

AudioVastEncodingtop

Definition

object AudioVastEncoding {
- int $id

required

- int $bitRate

required

- int $sortOrder

required

- string $mimeType

required

}

BooleanTemplateBannerPlaceholdertop

Definition

object BooleanTemplateBannerPlaceholder extends TemplateBannerPlaceholder {
- boolean $value

required

}

CustomVastSettingstop

Definition

Inheriting types:
- VideoVastBannerSettings
- AudioVastBannerSettings
- DoohVastBannerSettings

object abstractCustomVastSettings extends VastBannerSettings {
}

DoohVastBannerSettingstop

Definition

object DoohVastBannerSettings extends CustomVastSettings {
- int $bannerId

optional

- boolean $scalable

optional

- boolean $aspectRatioMaintained

optional

- string $vastType

optional

Deprecated since 2019-12-16

- VastVersion $vastVersion

required

- Array <DoohVastEncoding> $encodings

optional

- boolean $skippable

optional

DOOH vast banners are always not-skippable. Any value provided in this field will be ignored. (Read-only)

- string $vastExtension

optional

}

DoohVastEncodingtop

Definition

object DoohVastEncoding {
- int $id

required

- int $bitRate

required

- int $height

required

- int $width

required

- int $sortOrder

required

- string $mimeType

required

}

ImageAssettop

Definition

object ImageAsset extends Asset {
- int $pixelWidth

required

- int $pixelHeight

required

}

IntegerTemplateBannerPlaceholdertop

Definition

object IntegerTemplateBannerPlaceholder extends TemplateBannerPlaceholder {
- int $value

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.

}

MobileSdkSettingstop

Definition

object MobileSdkSettings {
- boolean $inAppClickUrlEnabled

optional

- string $placementType

required

Supported values: 'interstitial', 'inline'

}

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

}

StringTemplateBannerPlaceholdertop

Definition

object StringTemplateBannerPlaceholder extends TemplateBannerPlaceholder {
- string $value

required

Up to 255 bytes.

}

TemplateBannerPlaceholdertop

Definition

See Placeholder in BannerTemplateService for the placeholder name and restrictions on its value.



Inheriting types:
- BooleanTemplateBannerPlaceholder
- IntegerTemplateBannerPlaceholder
- StringTemplateBannerPlaceholder
- TextTemplateBannerPlaceholder

object abstractTemplateBannerPlaceholder {
- string $name

required

}

TemplateBannerSettingstop

Definition

object TemplateBannerSettings extends TypeSpecificBannerSettings {
- int $templateVersionId

required

See BannerTemplateService::getShortBannerTemplateInfoList() for a list of available templates.

Use the ID of ShortBannerTemplateInfo with BannerTemplateService::getBannerTemplateWithNewestVersion() to get the newest template version and its ID for creating a new or synchronizing an existing banner.

Use BannerTemplateService::getBannerTemplateByVersionId() for information on a possibly older template version when editing an existing banner.

- Array <TemplateBannerPlaceholder> $placeholders

optional

See BannerTemplateVersion in BannerTemplateService for a list of available placeholders.

- MobileSdkSettings $mobileSdkSettings

optional

Only relevant in case of a template with a "mobilesdk" display type.

}

TextTemplateBannerPlaceholdertop

Definition

object TextTemplateBannerPlaceholder extends TemplateBannerPlaceholder {
- string $value

required

Up to 4096 bytes.

}

TypeSpecificBannerSettingstop

Definition

Inheriting types:
- TemplateBannerSettings
- VastBannerSettings
- VastWrapperBannerSettings

object abstractTypeSpecificBannerSettings {
}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

VastBannerSettingstop

Definition

Inheriting types:
- VideoVastBannerSettings
- AudioVastBannerSettings
- DoohVastBannerSettings

object VastBannerSettings extends TypeSpecificBannerSettings {
- int $publisherTemplateId

optional

See VastPublisherTemplateService::getAllVastPublisherTemplates() for available publisher templates.

- int $assetId

required

- Array <VastEventTracking> $vastEventTrackings

optional

}

VastEventTrackingtop

Definition

object VastEventTracking {
- string $vastEventName

required

- string $bannerEventName

optional

Banner event key as configured on network level.
If null, a system banner event matching the vast event will be used automatically.
See BannerEventService::getValidSoaCollectionPage() for a list of available banner events.

- Array <string> $customTrackingUrls

optional

}

VastVersiontop

Definition

object VastVersion {
- int $id

optional

- string $name

required

Must be 'vast2'

}

VastWrapperBannerSettingstop

Definition

object VastWrapperBannerSettings extends TypeSpecificBannerSettings {
- Array <VastEventTracking> $vastEventTrackings

optional

}

VideoAssettop

Definition

object VideoAsset extends Asset {
- int $pixelWidth

required

- int $pixelHeight

required

- int $durationInSeconds

required

}

VideoVastBannerSettingstop

Definition

object VideoVastBannerSettings extends CustomVastSettings {
- int $bannerId

optional

- string $vastType

optional

Deprecated since 2019-12-16

- boolean $scalable

optional

- boolean $aspectRatioMaintained

optional

- boolean $skippable

optional

- string $vastExtension

optional

- VastVersion $vastVersion

required

- Array <VideoVastEncoding> $encodings

optional

}

VideoVastEncodingtop

Definition

object VideoVastEncoding {
- int $id

required

- int $bitRate

required

- int $height

required

- int $width

required

- int $sortOrder

required

- string $mimeType

required

}

Console