ForecastAdjustmentService Types

ForecastAdjustmentService WSDL


This service is stateless.

getForecastAdjustmentEventtop

Description



ForecastAdjustmentEvent getForecastAdjustmentEvent(int $id)

Parameters

int $id Unique identifier for ForecastAdjustmentEvent

Return Values

ForecastAdjustmentEvent

getSoaCollectionPagetop

Description

Gets a single SoaCollection page.
Requires administrator permissions.

For valid filters and qualifiers see getValidSoaCollectionFilters().

ForecastAdjustmentEventList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration $configuration

Return Values

ForecastAdjustmentEventList

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

removeForecastAdjustmentEventtop

Description

Removes an existing ForecastAdjustmentEvent by given unique identifier

boolean removeForecastAdjustmentEvent(int $id)

Parameters

int $id Unique identifier for ForecastAdjustmentEvent

Return Values

boolean True on success, otherwise false

saveForecastAdjustmentEventtop

Description

Creates or updates given ForecastAdjustmentEvent

int saveForecastAdjustmentEvent(ForecastAdjustmentEvent $adjustment)

Parameters

ForecastAdjustmentEvent $adjustment

Return Values

int Unique identifier of created/updated forecast adjustment.

Faults

ValidationErrorMessageList

AdditiveAbsoluteInventoryImpacttop

Definition

Represents an additive positive or negative inventory impact of a ForecastAdjustment.
Any absolute integer expect zero is allowed.

object AdditiveAbsoluteInventoryImpact extends InventoryImpact {
}

AdditiveRelativeInventoryImpacttop

Definition

Represents a positive or negative inventory impact relative to the existing inventory metrics, in percentage.
A value of 1 means 1%.

object AdditiveRelativeInventoryImpact extends InventoryImpact {
}

ContentunitBasedForecastAdjustmentEventtop

Definition

object ContentunitBasedForecastAdjustmentEvent extends ForecastAdjustmentEvent {
- Array <int> $contentunitIds

required

}

ForecastAdjustmentEventtop

Definition

Inheriting types:
- LearningTagBasedForecastAdjustmentEvent
- ContentunitBasedForecastAdjustmentEvent

object abstractForecastAdjustmentEvent {
- int $id

optional

Unique identifier

- string $name

required

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

- string $createdAt

optional

Creation date in Y-m-d format (read-only)

- string $updatedAt

optional

Last update date (read-only)

- string $startDate

required

Start date for the expected impact in Y-m-d format

- string $endDate

required

End date for the expected impact in Y-m-d format

- InventoryImpact $inventoryImpact

required

- string $performanceIndicator

required

The key performance indicator for the forecast adjustment.

Valid values:
- adrequests
- vastImpressions

- int $lastEditorUserId

optional

ID of the user that most recently modified the event (read-only).

- string $profileCode

optional

Profile filter code to adjust.

}

ForecastAdjustmentEventListtop

Definition

object ForecastAdjustmentEventList {
- Array <ForecastAdjustmentEvent> $forecastAdjustmentEvents

optional

- Array <NamedStringValue> $lastKeySet

optional

}

InventoryImpacttop

Definition

Inheriting types:
- AdditiveAbsoluteInventoryImpact
- AdditiveRelativeInventoryImpact
- ResetInventoryImpact

object abstractInventoryImpact {
- int $value

required

- string $period

required

Impact period on inventory:
- total
- daily

}

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.

}

LearningTagBasedForecastAdjustmentEventtop

Definition

object LearningTagBasedForecastAdjustmentEvent extends ForecastAdjustmentEvent {
- string $learningTagCode

required

}

NamedStringValuetop

Definition

object NamedStringValue {
- string $name

required

- string $value

required

}

ResetInventoryImpacttop

Definition

Represents a fixed impact value for inventory.

Any positive integer value including zero is allowed. Using zero (0) as value on a ResetInventoryImpact means
there will be no traffic on subject inventory.

Negative values are not allowed.

object ResetInventoryImpact extends InventoryImpact {
}

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

}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

Console