TargetingAttributeService Types

TargetingAttributeService WSDL

Used for administration of targeting attributes.
This service is stateless.

getAttributetop

Description



TargetingAttribute getAttribute(int $attribute_id)

Parameters

int $attribute_id

Return Values

TargetingAttribute

getCounttop

Description



int getCount()

Return Values

int

getSoaCollectionPagetop

Description

Gets a single SoaCollection page.

For valid filters and qualifiers see getValidSoaCollectionFilters().

TargetingAttributeList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration $configuration

Return Values

TargetingAttributeList

getValidModestop

Description



StringList getValidModes()

Return Values

StringList

getValidOperationstop

Description



StringList getValidOperations()

Return Values

StringList

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

removeAttributetop

Description



boolean removeAttribute(int $attribute_id)

Parameters

int $attribute_id

Return Values

boolean True on success, otherwise false

saveAttributetop

Description

Requires admin rights.

int saveAttribute(TargetingAttribute $attribute)

Parameters

TargetingAttribute $attribute

Return Values

int attribute ID

Faults

ValidationErrorMessageList

DataManagementPlatformAttributetop

Definition

object DataManagementPlatformAttribute extends TargetingAttribute {
}

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

}

TaggingAttributetop

Definition

object TaggingAttribute extends TargetingAttribute {
- string $mode

required

- int $minSecondsBetweenTags

required

- int $maxHistoryEntries

required

- string $operation

required

}

TargetingAttributetop

Definition

Inheriting types:
- TaggingAttribute
- DataManagementPlatformAttribute

object abstractTargetingAttribute {
- int $id

optional

- string $name

required

- string $key

required

- string $description

optional

- int $expireDays

required

- boolean $active

required

- string $createdAt

required

- string $updatedAt

required

- int $networkId

required

}

TargetingAttributeListtop

Definition

object TargetingAttributeList {
- Array <TargetingAttribute> $attributes

optional

- Array <NamedStringValue> $lastKeySet

optional

}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

Console