AutoReportService Types

AutoReportService WSDL

AutoReport SOAP Service
This service is stateless.

doComplexCalltop

Description

Execute a complex call.
For further information read the API-User documentation.

string doComplexCall(string $xmlstr)

Parameters

string $xmlstr XML of Complex Statements

Return Values

string The output produced by the statements

getAreaTypestop

Description



StringList getAreaTypes()

Return Values

StringList

getAutoReporttop

Description



AutoReport getAutoReport(int $auto_report_id)

Parameters

int $auto_report_id

Return Values

AutoReport $autoReport

getAutoReportIdsForAreatop

Description



IntegerList getAutoReportIdsForArea(string $area_type, int $area_id)

Parameters

string $area_type
int $area_id

Return Values

IntegerList

getChartTypestop

Description



StringList getChartTypes()

Return Values

StringList

getCompanyRolestop

Description



StringList getCompanyRoles()

Return Values

StringList

getFileTypestop

Description



StringList getFileTypes()

Return Values

StringList

getIntervalsForAreatop

Description



StringList getIntervalsForArea(string $area_type, int $area_id)

Parameters

string $area_type
int $area_id

Return Values

StringList

getLanguagestop

Description



StringList getLanguages()

Return Values

StringList

getNetworktop

Description

Returns the current network id

int getNetwork()

Return Values

int Network ID

getNetworkIdtop

Deprecated 2011-01-01

This method will be removed in upcoming releases.

Description

Returns the current network id. Alias for getNetwork()

int getNetworkId()

Return Values

int Network ID

getProfileColumnstop

Description

Returns available profile columns in the same order as defined in the network

StringList getProfileColumns()

Return Values

StringList

getReportPartsForAreaTypetop

Description

Gets available report parts including available sort columns and orders for a given area type

AvailableReportPartList getReportPartsForAreaType(string $area)

Parameters

string $area

Return Values

AvailableReportPartList

getTokentop

Description

Gets the session token. Can be used for single-sign-on.

string getToken()

Return Values

string

getTypestop

Description

Gets the available report types

StringList getTypes()

Return Values

StringList

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

loginSmartPhonetop

Deprecated 2014-12-22

This method will be removed in upcoming releases.

Was only useful for the mobile app, which is not supported anymore.

Description

Login method

boolean loginSmartPhone(string $user, string $pass, int $network, string $client)

Parameters

string $user Username
string $pass Password
int $network $network Network ID
string $client Client token e.g. "apn" token of iPhone

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

removetop

Description



boolean remove(int $auto_report_id)

Parameters

int $auto_report_id

Return Values

boolean True on success, otherwise false

saveAutoReporttop

Description



int saveAutoReport(AutoReport $auto_report)

Parameters

AutoReport $auto_report

Return Values

int AutoReport ID

Faults

ValidationErrorMessageList

AutoReporttop

Definition

Inheriting types:
- CampaignAutoReport
- OrderAutoReport
- CompanyAutoReport
- WebsiteAutoReport
- CampaignControlAutoReport

object abstractAutoReport {
- int $id

optional

- boolean $active

required

- string $name

required

- Array <string> $intervals

required

- string $language

required

- string $fileType

required

- Array <int> $recipientContactIds

optional

See: ContactService

- Array <int> $recipientUserIds

optional

See: UserService

- Array <int> $recipientFtpAccountIds

optional

See: FtpAccountService

- Array <string> $recipientEmails

optional

- ShortEmailTemplate $emailTemplate

optional

See: EmailTemplateService

}

AvailableReportParttop

Definition

object AvailableReportPart {
- string $name

required

- Array <string> $availableSortColumns

required

- Array <string> $availableSortOrders

required

}

AvailableReportPartListtop

Definition

object AvailableReportPartList {
- Array <AvailableReportPart> $availableReportParts

required

}

CampaignAutoReporttop

Definition

object CampaignAutoReport extends AutoReport {
- int $campaignId

required

- boolean $showCalendarWeek

optional

- string $chartType

optional

- boolean $hideGraphs

optional

- boolean $showClickUrl

optional

- boolean $showBannerClusters

optional

- boolean $showExternalId

optional

- boolean $hideViews

optional

- boolean $hideClicks

optional

- boolean $hideClickRate

optional

- boolean $hideNetworkLogo

optional

- boolean $showSettings

optional

- boolean $showParents

optional

- boolean $showCampaignPrice

optional

- boolean $showConversion

optional

- boolean $groupOrders

optional

- boolean $showCosts

optional

- boolean $showReturnOnInvestment

optional

- boolean $hideShare

optional

- string $distributionKey

optional

- boolean $showPostTracking

optional

- boolean $sumUpPostTracking

optional

- Array <string> $costTypes

optional

- string $campaignPriceBase

optional

- string $postTrackingPeriod

optional

- string $calculationBase

required

- Array <ReportPart> $reportParts

optional

- boolean $showAdditionalInfo

optional

- boolean $showDeliveryInformation

optional

- Array <string> $profileColumns

optional

- int $postTrackingPeriodCustom

optional

Custom posttracking period in days.
Only applicable when postTrackingPeriod is set to 'custom'.

- boolean $showViewGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $hideViews is false

Default: value of $showDeliveryInformation

- boolean $showClickGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $hideClicks is false

Default: value of $showDeliveryInformation

- boolean $showVisibilityGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $showVisibility is true
- and the reported campaign supports the related goal

- boolean $showBannerEventGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $showBannerEvents is true
- and the reported campaign supports the related goal

- boolean $showSuccessSpotGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $showSuccessSpots is true
- and the reported campaign supports the related goal

- boolean $showVisibility

optional

- boolean $showBannerEvents

optional

- boolean $showSuccessSpots

optional

}

CampaignControlAutoReporttop

Definition

object CampaignControlAutoReport extends AutoReport {
- string $filter

required

"user", "group" or "network"

- int $groupId

optional

Only applicable when filter == "group"
Use 0 for "all groups"

}

CompanyAutoReporttop

Definition

object CompanyAutoReport extends AutoReport {
- int $companyId

required

- string $companyRoles

optional

- boolean $showDaily

optional

- boolean $hideShare

optional

- boolean $hideDefaults

optional

- boolean $showShareCampaignPrice

optional

- boolean $showExcess

optional

- boolean $showCpmAndCpc

optional

- boolean $showCalendarWeek

optional

- string $chartType

optional

- boolean $hideGraphs

optional

- boolean $showClickUrl

optional

- boolean $showBannerClusters

optional

- boolean $showExternalId

optional

- boolean $hideViews

optional

- boolean $hideClicks

optional

- boolean $hideClickRate

optional

- boolean $hideNetworkLogo

optional

- boolean $showSettings

optional

- boolean $showParents

optional

- string $postTrackingPeriod

optional

- string $type

required

- string $calculationBase

required

- Array <ReportPart> $reportParts

optional

- boolean $showAdditionalInfo

optional

- Array <string> $profileColumns

optional

- int $postTrackingPeriodCustom

optional

Custom posttracking period in days.
Only applicable when postTrackingPeriod is set to 'custom'.

}

IntegerListtop

Definition

IntegerList for SoapServices.
You may want to use this to pass a list of integers (e.g. ids) as
parameter in you soap service.

object IntegerList {
- Array <int> $integers

optional

The integers

}

OrderAutoReporttop

Definition

object OrderAutoReport extends AutoReport {
- int $orderId

required

- boolean $showCalendarWeek

optional

- string $chartType

optional

- boolean $hideGraphs

optional

- boolean $showClickUrl

optional

- boolean $showBannerClusters

optional

- boolean $showExternalId

optional

- boolean $hideViews

optional

- boolean $hideClicks

optional

- boolean $hideClickRate

optional

- boolean $hideNetworkLogo

optional

- boolean $showSettings

optional

- boolean $showParents

optional

- boolean $showCampaignPrice

optional

- boolean $showConversion

optional

- boolean $groupOrders

optional

- boolean $showCosts

optional

- boolean $showReturnOnInvestment

optional

- boolean $hideShare

optional

- string $distributionKey

optional

- boolean $showPostTracking

optional

- boolean $sumUpPostTracking

optional

- Array <string> $costTypes

optional

- string $campaignPriceBase

optional

- string $postTrackingPeriod

optional

- string $calculationBase

required

- Array <ReportPart> $reportParts

optional

- boolean $showAdditionalInfo

optional

- boolean $showDeliveryInformation

optional

- Array <string> $profileColumns

optional

- int $postTrackingPeriodCustom

optional

Custom posttracking period in days.
Only applicable when postTrackingPeriod is set to 'custom'.

- boolean $showViewGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $hideViews is false

Default: value of $showDeliveryInformation

- boolean $showClickGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $hideClicks is false

Default: value of $showDeliveryInformation

- boolean $showVisibilityGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $showVisibility is true

- boolean $showBannerEventGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $showBannerEvents is true

- boolean $showSuccessSpotGoalInDeliveryInformation

optional

Only applicable if:
- $showDeliveryInformation is true
- and $showSuccessSpots is true

- boolean $showVisibility

optional

- boolean $showBannerEvents

optional

- boolean $showSuccessSpots

optional

}

ReportParttop

Definition

object ReportPart {
- string $name

required

- string $sortColumn

required

- string $sortOrder

required

}

ShortEmailTemplatetop

Definition

object ShortEmailTemplate {
- int $id

optional

- string $name

required

- string $description

optional

- string $subject

required

- string $language

required

- string $body

required

- string $replyTo

optional

- boolean $sendBcc

required

When true, an bcc mail will always be sent to the replyTo address

}

StringListtop

Definition

object StringList {
- Array <string> $strings

optional

The strings

}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

WebsiteAutoReporttop

Definition

object WebsiteAutoReport extends AutoReport {
- int $websiteId

required

- boolean $showDaily

optional

- boolean $hideShare

optional

- boolean $hideDefaults

optional

- boolean $showShareCampaignPrice

optional

- boolean $showExcess

optional

- boolean $showCpmAndCpc

optional

- boolean $showCalendarWeek

optional

- string $chartType

optional

- boolean $hideGraphs

optional

- boolean $showClickUrl

optional

- boolean $showBannerClusters

optional

- boolean $showExternalId

optional

- boolean $hideViews

optional

- boolean $hideClicks

optional

- boolean $hideClickRate

optional

- boolean $hideNetworkLogo

optional

- boolean $showSettings

optional

- boolean $showParents

optional

- string $postTrackingPeriod

optional

- string $type

required

- string $calculationBase

required

- Array <ReportPart> $reportParts

optional

- boolean $showAdditionalInfo

optional

- Array <string> $profileColumns

optional

- int $postTrackingPeriodCustom

optional

Custom posttracking period in days.
Only applicable when postTrackingPeriod is set to 'custom'.

}

Console