BannerTemplateService Types

BannerTemplateService WSDL

Provides information on banner templates and their versions.
See BannerService::saveBanner() and TemplateSettings for saving a template banner.
This service is stateless.

getBannerTemplateByVersionIdtop

Description

Gets the template and details on its newest version for a given template version ID.
Useful when editing a banner that is assigned to an older template version.

BannerTemplate getBannerTemplateByVersionId(int $version_id)

Parameters

int $version_id

Return Values

BannerTemplate

getBannerTemplateWithNewestVersiontop

Description

Gets the template and details on its newest version for a given template ID.
Useful for creating new or synchronizing existing banners.

BannerTemplate getBannerTemplateWithNewestVersion(int $id)

Parameters

int $id

Return Values

BannerTemplate

getShortBannerTemplateInfoListtop

Description

Gets basic information on all available banner templates.

ShortBannerTemplateInfoList getShortBannerTemplateInfoList()

Return Values

ShortBannerTemplateInfoList

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

AssetPlaceholdertop

Definition

object AssetPlaceholder extends Placeholder {
}

AssetUploadFormFieldtop

Definition

object AssetUploadFormField extends FormField {
- string $fieldType

required

- string $encodingType

required

- int $encodingBitRate

required

- int $encodingResolutionWidth

optional

- int $encodingResolutionHeight

optional

}

BannerTemplatetop

Definition

object BannerTemplate {
- int $id

required

- string $name

required

- string $description

optional

- boolean $active

required

- string $displayType

required

- string $contentType

optional

- BannerTemplateVersion $version

required

- int $format

optional

}

BannerTemplateVersiontop

Definition

object BannerTemplateVersion {
- int $id

required

- Array <string> $approvals

optional

Defines parts of a banner and related business objects available to banner managers in the GUI.

- TemplateBannerDefaults $bannerDefaults

optional

Default values for basic banner attributes filled out automatically in the GUI.

- string $templateCode

required

- string $formDefinition

required

Human-readable GUI form and placeholder definition in YAML format.

- Array <Placeholder> $placeholders

optional

Machine-readable placeholder definition.

}

BooleanPlaceholdertop

Definition

object BooleanPlaceholder extends Placeholder {
- boolean $defaultValue

optional

}

BooleanPlaceholderValidatortop

Definition

object BooleanPlaceholderValidator extends PlaceholderValidator {
}

CheckboxFormFieldtop

Definition

object CheckboxFormField extends FormField {
}

ComboBoxFormFieldtop

Definition

object ComboBoxFormField extends FormField {
- Array <NamedStringValue> $availableValuesAndDisplayValues

required

The display value (name of NamedStringValue) can be used for display in a GUI.
The value of NamedStringValue is the actual placeholder value that can be used in the template code.

}

EnumPlaceholderValidatortop

Definition

object EnumPlaceholderValidator extends PlaceholderValidator {
- Array <string> $values

required

}

FilePlaceholdertop

Definition

object FilePlaceholder extends Placeholder {
}

FormFieldtop

Definition

Definition of a GUI form field for a template code placeholder.


Inheriting types:
- CheckboxFormField
- ComboBoxFormField
- NumberFormField
- RadioGroupFormField
- TextAreaFormField
- TextFieldFormField
- UploadFormField
- AssetUploadFormField

object abstractFormField {
- string $label

required

- boolean $required

optional

}

IntegerPlaceholdertop

Definition

object IntegerPlaceholder extends Placeholder {
- int $defaultValue

optional

}

LengthPlaceholderValidatortop

Definition

object LengthPlaceholderValidator extends PlaceholderValidator {
- int $minLength

optional

- int $maxLength

optional

}

NamedStringValuetop

Definition

object NamedStringValue {
- string $name

required

- string $value

required

}

NumberFormFieldtop

Definition

object NumberFormField extends FormField {
}

Placeholdertop

Definition

Inheriting types:
- BooleanPlaceholder
- IntegerPlaceholder
- FilePlaceholder
- StringPlaceholder
- TextPlaceholder
- AssetPlaceholder

object abstractPlaceholder {
- string $name

required

- PlaceholderValidator $validator

optional

- FormField $formField

required

GUI form field definition

}

PlaceholderValidatortop

Definition

Inheriting types:
- BooleanPlaceholderValidator
- EnumPlaceholderValidator
- LengthPlaceholderValidator
- RangePlaceholderValidator
- RegexPlaceholderValidator

object abstractPlaceholderValidator {
}

RadioGroupFormFieldtop

Definition

object RadioGroupFormField extends FormField {
- Array <NamedStringValue> $availableValuesAndDisplayValues

required

The display value (name of NamedStringValue) can be used for display in a GUI.
The value of NamedStringValue is the actual placeholder value that can be used in the template code.

}

RangePlaceholderValidatortop

Definition

object RangePlaceholderValidator extends PlaceholderValidator {
- int $minValue

optional

- int $maxValue

optional

}

RegexPlaceholderValidatortop

Definition

object RegexPlaceholderValidator extends PlaceholderValidator {
- string $pattern

required

}

ShortBannerTemplateInfotop

Definition

object ShortBannerTemplateInfo {
- int $id

required

- string $name

required

- string $description

required

- boolean $active

required

}

ShortBannerTemplateInfoListtop

Definition

object ShortBannerTemplateInfoList {
- Array <ShortBannerTemplateInfo> $shortBannerTemplateInfos

optional

}

StringPlaceholdertop

Definition

object StringPlaceholder extends Placeholder {
- string $defaultValue

optional

Up to 255 bytes.

}

TemplateBannerDefaultstop

Definition

object TemplateBannerDefaults {
- int $width

optional

- int $height

optional

}

TextAreaFormFieldtop

Definition

object TextAreaFormField extends FormField {
}

TextFieldFormFieldtop

Definition

object TextFieldFormField extends FormField {
}

TextPlaceholdertop

Definition

object TextPlaceholder extends Placeholder {
- string $defaultValue

optional

Up to 4096 bytes.

}

UploadFormFieldtop

Definition

object UploadFormField extends FormField {
- boolean $syncDimensions

optional

}

Console