FilterService Types

FilterService WSDL


This service is stateless.

getAvailableGraphsListtop

Description

Gets the available graphs.

GraphInfoList getAvailableGraphsList()

Return Values

GraphInfoList

getBidFactorFilterLinkByCampaignIdAndFilterIdtop

Description



CampaignBidFactorFilterLink getBidFactorFilterLinkByCampaignIdAndFilterId(int $campaign_id, int $filter_id)

Parameters

int $campaign_id
int $filter_id

Return Values

CampaignBidFactorFilterLink

getBidFactorFilterLinksByCampaignIdtop

Description



BidFactorFilterLinkList getBidFactorFilterLinksByCampaignId(int $campaign_id)

Parameters

int $campaign_id

Return Values

BidFactorFilterLinkList

getCounttop

Description

Requires administrator permissions.

int getCount()

Return Values

int

getFiltertop

Description



Filter getFilter(int $filter_id)

Parameters

int $filter_id

Return Values

Filter

getSoaCollectionPagetop

Description

Gets a single SoaCollection page of concrete filter types or their GenericFilter substitutes.
Requires administrator permissions.

For relation specific information see getFilterRelationSoaCollectionPage().
For valid filters and qualifiers see getValidSoaCollectionFilters().

FilterList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration, FilterCollectionConfiguration $filter_collection_configuration)

Parameters

KeySetPagedSoaCollectionConfiguration $configuration
FilterCollectionConfiguration $filter_collection_configuration

Return Values

FilterList

Faults

ValidationErrorMessageList

getValidSoaCollectionFilterstop

Description

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

SoaCollectionValidFilterList getValidSoaCollectionFilters()

Return Values

SoaCollectionValidFilterList

linkBidFactorFiltertop

Description

Links an inventoried bid factor filter to an entity.

boolean linkBidFactorFilter(BidFactorFilterLink $bid_factor_filter_link)

Parameters

BidFactorFilterLink $bid_factor_filter_link

Return Values

boolean True on success, otherwise false

Faults

ValidationErrorMessageList

linkFiltertop

Description

Links an inventoried filter to an entity.

boolean linkFilter(FilterLink $filter_link)

Parameters

FilterLink $filter_link

Return Values

boolean True on success, otherwise false

Faults

ValidationErrorMessageList

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

removeFiltertop

Description



boolean removeFilter(int $filter_id)

Parameters

int $filter_id

Return Values

boolean True on success, otherwise false

saveFiltertop

Description



int saveFilter(Filter $filter)

Parameters

Filter $filter

Return Values

int filter ID

Faults

ValidationErrorMessageList

unlinkBidFactorFiltertop

Description

Unlinks an inventoried bid factor filter from an entity.

boolean unlinkBidFactorFilter(BidFactorFilterLink $bid_factor_filter_link)

Parameters

BidFactorFilterLink $bid_factor_filter_link

Return Values

boolean True on success, otherwise false

unlinkFiltertop

Description

Unlinks an inventoried filter from an entity.

boolean unlinkFilter(FilterLink $filter_link)

Parameters

FilterLink $filter_link

Return Values

boolean True on success, otherwise false

BannerFiltertop

Definition

Private filter of a banner.

object BannerFilter extends Filter {
- int $bannerId

required

}

CampaignFiltertop

Definition

Private filter of a campaign.

object CampaignFilter extends Filter {
- int $campaignId

required

}

CappingFilterSettingstop

Definition

object CappingFilterSettings extends TypeSpecificFilterSettings {
- int $requests

required

- int $time

required

- string $bannerEventKey

optional

}

CompanyFilterTemplatetop

Definition

Private filter template of a company used to create an actual, private campaign filter
when saving a new campaign belonging to an order of the respective company.

object CompanyFilterTemplate extends Filter {
- int $companyId

required

}

ContentunitFilterSettingstop

Definition

object ContentunitFilterSettings extends TypeSpecificFilterSettings {
- Array <FilteredContentunit> $filteredContentunits

optional

}

Filtertop

Definition

Inheriting types:
- CampaignFilter
- BannerFilter
- OrphanedFilter
- CompanyFilterTemplate
- InventoriedFilter
- SubFilter
- PiggyBackContainerLinkFilter

object abstractFilter {
- int $id

optional

- string $createdAt

optional

- string $updatedAt

optional

- boolean $negated

optional

- string $contentPreview

optional

Read-only, human-readable, shortened preview of the filter content

- TypeSpecificFilterSettings $typeSpecificSettings

required

}

FilterCollectionConfigurationtop

Definition

object FilterCollectionConfiguration {
- Array <string> $filterTypesWithTypeSpecificInformation

optional

Only the filter with types mentioned here will include filter type specific information
(for example: profile code in ProfileFilter), making the result more detailed but also slower.
All other filters will be represented by GenericFilter (faster).

- boolean $includeInventoriedFilterLinks

optional

If set, IDs of objects linked with the inventoried filter, will be included in the result (slower).

Requires administrator permissions.

Default: false

}

FilterListtop

Definition

object FilterList {
- Array <Filter> $filters

optional

- Array <NamedStringValue> $lastKeySet

optional

}

FilteredBannerContentunittop

Definition

object FilteredBannerContentunit extends FilteredContentunit {
}

FilteredCampaignContentunittop

Definition

object FilteredCampaignContentunit extends FilteredContentunit {
- boolean $exclusive

optional

If true then the campaign owning the filter will deliver exclusively on this contentunit.
Default: null.
True if exclusive, otherwise null.

- int $weight

optional

Requires network feature activation.
Default: null
Null if not set or network feature not active.

}

FilteredContentunittop

Definition

A contentunit referenced in a contentunit filter.
Please see concrete subclasses depending on the parent element of the filter.


Inheriting types:
- FilteredBannerContentunit
- FilteredCampaignContentunit

object abstractFilteredContentunit {
- int $id

required

}

FrequencyCappingFilterSettingstop

Definition

object FrequencyCappingFilterSettings extends TypeSpecificFilterSettings {
- int $requests

required

- int $time

required

- string $bannerEventKey

optional

- Array <int> $providerIds

required

}

GenericFilterSettingstop

Definition

Used in read operations as an optimized substitute for any concrete filter type.

object GenericFilterSettings extends TypeSpecificFilterSettings {
- string $type

required

}

GraphInfotop

Definition

object GraphInfo {
- int $id

required

- string $displayName

required

- string $friendlyName

required

}

GraphInfoListtop

Definition

object GraphInfoList {
- Array <GraphInfo> $graphInfos

optional

}

InventoriedFiltertop

Definition

Filter that can be shared amongst multiple campaigns and banners.

object InventoriedFilter extends Filter {
- string $name

required

- string $description

required

- boolean $visible

required

- Array <int> $filterGroupIds

optional

- Array <int> $linkedBannerIds

optional

Read-only.
Populated only on demand.
Available only to users with administrator permissions.

- Array <int> $linkedCampaignIds

optional

Read-only.
Populated only on demand.
Available only to users with administrator permissions.

}

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.

}

MultiDeviceFrequencyCappingFilterSettingstop

Definition

object MultiDeviceFrequencyCappingFilterSettings extends CappingFilterSettings {
- int $graphId

optional

}

NamedStringValuetop

Definition

object NamedStringValue {
- string $name

required

- string $value

required

}

OrphanedFiltertop

Definition

Private filter for no parents

object OrphanedFilter extends Filter {
}

PiggyBackContainerLinkFiltertop

Definition

Private filter of a link between a piggyback and a piggyback container.

object PiggyBackContainerLinkFilter extends Filter {
- int $piggyBackContainerLinkId

required

}

ProfileFilterSettingstop

Definition

object ProfileFilterSettings extends TypeSpecificFilterSettings {
- string $code

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

}

SubFiltertop

Definition

Private filter of an inventoried tag filter that can be only used
in the code of the owning tag filter.

object SubFilter extends Filter {
- int $parentFilterId

required

- string $name

required

- string $description

required

}

TagFilterSettingstop

Definition

object TagFilterSettings extends TypeSpecificFilterSettings {
- string $code

required

}

TypeSpecificFilterSettingstop

Definition

Inheriting types:
- FrequencyCappingFilterSettings
- CappingFilterSettings
- ContentunitFilterSettings
- GenericFilterSettings
- ProfileFilterSettings
- MultiDeviceFrequencyCappingFilterSettings
- TagFilterSettings

object abstractTypeSpecificFilterSettings {
}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

Console