Startseite | Jobs | FAQ | Impressum | AGB | Datenschutz
PUBLISHERADVERTISERAGENTURENPARTNERPROGRAMMEAPPS & APISPRESSEÜBER UNS

API-Beschreibung - Publisher Statistik WebServices

1     Inhaltsverzeichnis

1 Inhaltsverzeichnis
2 Einleitung
3 Generieren eines Webservice-Passworts
4 Publisher Statistik Webservices
4.1 Result-Object
4.2 Einzelne Funktionsdienste
4.2.1 getStatisticsDaily()
4.2.2 getStatisticsMonthly()
4.2.3 getStatisticsByProgram()
4.2.4 getStatisticsByAdPlatform()
4.2.5 getStatisticsByAdMedia()

 

2     Einleitung

Die belboon WebServices (SOAP-Protokoll) ermöglichen es Ihnen automatisiert mit unserem Affiliate-Netzwerk zu arbeiten ohne dass Sie sich über die Web-Oberfläche in Ihr Account einloggen müssen.

 

WebService-URL:        http://api.belboon.com/?wsdl

 

 

3     Generieren eines Webservice-Passworts

Die belboon Webservices ermöglichen es Ihnen, auch ohne Account-Login auf die Daten von
belboon zu zugreifen.

 

Im Menu-Punkt „Tools & Services > Webservices" finden Sie die Möglichkeit, Ihr Webservice-Passwort initial zu generieren. Danach werden Sie dies an dieser Stelle stets nachlesen können.

Der Usernamen für die Nutzung der Webservices ist identisch mit Ihrem Publisher-Account-Benutzernamen.

 

 

4     Publisher Statistik Webservices

4.1    Result-Object

Beim Aufruf einer Funktion des Webservices werden die Daten über ein einheitliches Result-Object zurückgeliefert. Dieses Objekt enthält einige Metadaten wie z.B. Fehlermeldungen sowie die eigentlichen Nutzdaten.

 

Result-Object

EigenschaftTypBeschreibung

processor

Object

s.u.

handler

Object

s.u.

 

processor

Hinter der Eigenschaft processor verbirgt sich ein Objekt, welches Informationen über die durchgeführte Transaktion speichert.

 

EigenschaftTypBeschreibung

code

Integer

Transaktions-Code

message

String

Nachricht entsprechend des Transaktions-Codes

rid

Integer

ID des SOAP-Requests

testmode

Integer

Gibt Auskunft darüber, ob die Transaktion im Testmodus durchgeführt wurde.

 

handler

Die Eigenschaft handler beherbergt eine einzige Eigenschaft, deren Name, Typ und Inhalt sich aus der aufgerufenen Operation des Webservice ergeben. Diese Information muss für jeden Einzelfall in Kapitel 4.2 nachgeschlagen werden. Der Inhalt dieser Eigenschaft sind die eigentlichen Nutzdaten.

4.2    Einzelne Funktionsdienste

4.2.1           getStatisticsDaily()

Liefert die Tages-Statistiken des aktuellen Monats zurück.

 

Request-Parameter

NameTypDefaultBeschreibung

currency

String

EUR

 

adPlatformId

Integer

 

 

groupByProgram

Boolean

false

 

groupByAdPlatform

Boolean

false

 

groupByEventStatus

Boolean

false

 

groupByAdMedia

Boolean

false

 

groupBySubId

Boolean

false

 

orderBy

String[]
(Array)

array('eventdate' => 'DESC')

Sortiert die Rückgabe nach dem übergebenen Spaltennamen mit gewünschter Orientierung (ASC = aufsteigend, DESC= absteigend)

limit

Integer

null

Begrenzt die Anzahl der Ergebnisse auf max. diesen Wert

offset

Integer

0

Listet Suchergebnisse erst ab diesem Wert

 

 

Response

Hinter der Eigenschaft handler des Result-Objekts verbirgt sich ein Objekt mit einer einzigen, öffentlich sichtbaren Eigenschaft, die den Namen statistics trägt. Sie enthält ein numerisch indiziertes Array mit 0 oder mehr Zeilen (Arrays), von denen jede wie folgt strukturiert ist:

IndexTypBeschreibung

eventdate

Date

(YYYY-MM-DD)

Tracking-Datum

programid*

Integer

ID des beteiligten Partnerprogramms

programname*

String

Name des beteiligten Partnerprogramms

adplatformid*

Integer

ID der beteiligten Werbeplattform

adplatformname*

String

Name der beteiligten Werbeplattform

eventstatus*

String

{ACCEPTED, PENDING, REJECTED}

Status des Events

subid*

String

Sub-Website-ID

admediaid*

Integer

ID des beteiligten Werbemittels

admedianame*

String

Name des beteiligten Werbemittels

eventcurrency

String

Währung

clicks

Integer

Anzahl Klicks

clickcommission

Float

Provision durch Klicks (in abgefragter Währung)

views

Integer

Anzahl Views

viewscommission

Float

Provision durch Views

leads

Integer

Anzahl Leads

leadcommission

Float

Provision durch Leads

sales

Integer

Anzahl Sales

salecommission

Float

Provision durch Sales

totalcommission

Float

Provision gesamt

clickthroughrate

Float

Click-Through-Rate (CTR)

leadconversionrate

Float

Konvertierungsrate (CR) Leads

saleconversionrate

Float

Konvertierungsrate (CR) Sales

 

Die mit einem * gekennzeichneten Felder sind nur dann in der Ausgabe enthalten, wenn im Funktionsaufruf (Request) eine entsprechende Gruppierung vorgenommen wurde. So erfordert bspw. die Ausgabe von programid und programname eine Gruppierung nach Programm mittels des Request-Parameters groupByProgram. Dies sollte ebenfalls bei der Sortierung berücksichtigt werden. Die Felder clicks, clickcommission, views, viewcommission sowie clickthroughrate, leadconversionrate und saleconversionrate können u.U. NULL-Werte hervorbringen.

 

Beispiel:

<?php

 

define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');

 

// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php)

$config = array(

'login' => 'YOUR_LOGIN_NAME',

      'password' => 'YOUR_WEBSERVICE_PASSWORD',

'trace' => true

);

 

try {

$client = new SoapClient(WSDL_SERVER, $config);

$result = $client->getStatisticsDaily(

            'EUR', // currency

            null, // adPlatformId

            false, // groupByProgram

            false, // groupByAdPlatform

            true, // groupByEventStatus

            false, // groupByAdMedia

            false, // groupBySubId

            array('eventdate' => 'DESC') // orderBy

);

 

echo '<pre>';

print_r($result);

 

} catch( Exception $e ) {

// Error handling here...

}

 

4.2.2           getStatisticsMonthly()

Liefert die Monats-Statistiken des gewählten Zeitraums zurück.

 

Request-Parameter

NameTypDefaultBeschreibung

startMonth

Date

(YYYY-MM)

 

 

endMonth

Date

(YYYY-MM)

 

 

currency

String

EUR

 

adPlatformId

Integer

 

 

groupByProgram

Boolean

false

 

groupByAdPlatform

Boolean

false

 

groupByEventStatus

Boolean

false

 

groupByAdMedia

Boolean

false

 

groupBySubId

Boolean

false

 

orderBy

String[]
(Array)

array('eventdate' => 'DESC')

Sortiert die Rückgabe nach dem übergebenen Spaltennamen mit gewünschter Orientierung (ASC = aufsteigend, DESC= absteigend)

limit

Integer

null

Begrenzt die Anzahl der Ergebnisse auf max. diesen Wert

offset

Integer

0

Listet Suchergebnisse erst ab diesem Wert

 

 

Response

Hinter der Eigenschaft handler des Result-Objekts verbirgt sich ein Objekt mit einer einzigen, öffentlich sichtbaren Eigenschaft, die den Namen statistics trägt. Sie enthält ein numerisch indiziertes Array mit 0 oder mehr Zeilen (Arrays), von denen jede wie folgt strukturiert ist:

IndexTypBeschreibung

eventdate

Date

(YYYY-MM)

Tracking-Datum

programid*

Integer

ID des beteiligten Partnerprogramms

programname*

String

Name des beteiligten Partnerprogramms

adplatformid*

Integer

ID der beteiligten Werbeplattform

adplatformname*

String

Name der beteiligten Werbeplattform

eventstatus*

String

{ACCEPTED, PENDING, REJECTED}

Status des Events

subid*

String

Sub-Website-ID

admediaid*

Integer

ID des beteiligten Werbemittels

admedianame*

String

Name des beteiligten Werbemittels

eventcurrency

String

Währung

clicks

Integer

Anzahl Klicks

clickcommission

Float

Provision durch Klicks (in abgefragter Währung)

views

Integer

Anzahl Views

viewscommission

Float

Provision durch Views

leads

Integer

Anzahl Leads

leadcommission

Float

Provision durch Leads

sales

Integer

Anzahl Sales

salecommission

Float

Provision durch Sales

totalcommission

Float

Provision gesamt

clickthroughrate

Float

Click-Through-Rate (CTR)

leadconversionrate

Float

Konvertierungsrate (CR) Leads

saleconversionrate

Float

Konvertierungsrate (CR) Sales

Die mit einem * gekennzeichneten Felder sind nur dann in der Ausgabe enthalten, wenn im Funktionsaufruf (Request) eine entsprechende Gruppierung vorgenommen wurde. So erfordert bspw. die Ausgabe von programid und programname eine Gruppierung nach Programm mittels des Request-Parameters groupByProgram. Dies sollte ebenfalls bei der Sortierung berücksichtigt werden. Die Felder clicks, clickcommission, views, viewcommission sowie clickthroughrate, leadconversionrate und saleconversionrate können u.U. NULL-Werte hervorbringen.

 

Beispiel:

<?php

 

define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');

 

// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php)

$config = array(

'login' => 'YOUR_LOGIN_NAME',

      'password' => 'YOUR_WEBSERVICE_PASSWORD',

'trace' => true

);

 

try {

$client = new SoapClient(WSDL_SERVER, $config);

$result = $client->getStatisticsMonthly(

            '2010-01', // startMonth

            date('Y-m'), // endMonth

            null, // currency

            true, // adPlatformId

            false, // groupByProgram

            true, // groupByAdPlatform

            false, // groupByEventStatus

            false, // groupByAdMedia

            false, // groupBySubId

            array('eventdate' => 'DESC',

'adplatformname' => 'ASC'), // orderBy

            25 // limit

);

 

echo '<pre>';

print_r($result);

 

} catch( Exception $e ) {

// Error handling here...

}

 

 

 

4.2.3           getStatisticsByProgram()

Liefert die Statistiken des gewählten Zeitraums, gruppiert nach Partnerprogramm zurück.

 

Request-Parameter

NameTypDefaultBeschreibung

startDate

Date

(YYYY-MM-DD)

Erster Tag des aktuellen Monats

 

endDate

Date

(YYYY-MM-DD)

Heutiges Tagesdatum

 

programId

Integer

 

 

currency

String

EUR

 

groupByMonth

Boolean

true

 

groupByAdPlatform

Boolean

false

 

groupByEventStatus

Boolean

false

 

groupByAdMedia

Boolean

false

 

groupBySubId

Boolean

false

 

orderBy

String[]
(Array)

array('eventdate' => 'DESC')

Sortiert die Rückgabe nach dem übergebenen Spaltennamen mit gewünschter Orientierung (ASC = aufsteigend, DESC= absteigend)

limit

Integer

null

Begrenzt die Anzahl der Ergebnisse auf max. diesen Wert

offset

Integer

0

Listet Suchergebnisse erst ab diesem Wert

 

 

Response

Hinter der Eigenschaft handler des Result-Objekts verbirgt sich ein Objekt mit einer einzigen, öffentlich sichtbaren Eigenschaft, die den Namen statistics trägt. Sie enthält ein numerisch indiziertes Array mit 0 oder mehr Zeilen (Arrays), von denen jede wie folgt strukturiert ist:

IndexTypBeschreibung

eventdate*

Date

(YYYY-MM)

Tracking-Datum

programid

Integer

ID des beteiligten Partnerprogramms

programname

String

Name des beteiligten Partnerprogramms

adplatformid*

Integer

ID der beteiligten Werbeplattform

adplatformname*

String

Name der beteiligten Werbeplattform

eventstatus*

String

{ACCEPTED, PENDING, REJECTED}

Status des Events

subid*

String

Sub-Website-ID

admediaid*

Integer

ID des beteiligten Werbemittels

admedianame*

String

Name des beteiligten Werbemittels

eventcurrency

String

Währung

clicks

Integer

Anzahl Klicks

clickcommission

Float

Provision durch Klicks (in abgefragter Währung)

views

Integer

Anzahl Views

viewscommission

Float

Provision durch Views

leads

Integer

Anzahl Leads

leadcommission

Float

Provision durch Leads

sales

Integer

Anzahl Sales

salecommission

Float

Provision durch Sales

totalcommission

Float

Provision gesamt

clickthroughrate

Float

Click-Through-Rate (CTR)

leadconversionrate

Float

Konvertierungsrate (CR) Leads

saleconversionrate

Float

Konvertierungsrate (CR) Sales

Die mit einem * gekennzeichneten Felder sind nur dann in der Ausgabe enthalten, wenn im Funktionsaufruf (Request) eine entsprechende Gruppierung vorgenommen wurde. So erfordert bspw. die Ausgabe von programid und programname eine Gruppierung nach Programm mittels des Request-Parameters groupByProgram. Dies sollte ebenfalls bei der Sortierung berücksichtigt werden. Die Felder clicks, clickcommission, views, viewcommission sowie clickthroughrate, leadconversionrate und saleconversionrate können u.U. NULL-Werte hervorbringen.

 

Beispiel:

<?php

 

define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');

 

// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php)

$config = array(

'login' => 'YOUR_LOGIN_NAME',

      'password' => 'YOUR_WEBSERVICE_PASSWORD',

'trace' => true

);

 

try {

$client = new SoapClient(WSDL_SERVER, $config);

$result = $client->getStatisticsByProgram(

            '2010-09-01', // startDate

            null, // endDate

            <YOUR_PROGRAM_ID>, // programId

            null, // currency

            false, // groupByMonth

            null, // groupByAdPlatform

            null, // groupByEventStatus

            null, // groupByAdMedia

            null, // groupBySubId

            array('programname' => 'ASC') // orderBy

);

 

echo '<pre>';

print_r($result);

 

} catch( Exception $e ) {

// Error handling here...

}

 

 

4.2.4           getStatisticsByAdPlatform()

Liefert die Statistiken des gewählten Zeitraums, gruppiert nach Werbeplattform zurück.

 

Request-Parameter

NameTypDefaultBeschreibung

startDate

Date

(YYYY-MM-DD)

Erster Tag des aktuellen Monats

 

endDate

Date

(YYYY-MM-DD)

Heutiges Tagesdatum

 

adPlatformId

Integer

 

 

currency

String

EUR

 

groupByMonth

Boolean

true

 

groupByAdPlatform

Boolean

false

 

groupByEventStatus

Boolean

false

 

groupByAdMedia

Boolean

false

 

groupBySubId

Boolean

false

 

orderBy

String[]
(Array)

array('eventdate' => 'DESC')

Sortiert die Rückgabe nach dem übergebenen Spaltennamen mit gewünschter Orientierung (ASC = aufsteigend, DESC= absteigend)

limit

Integer

null

Begrenzt die Anzahl der Ergebnisse auf max. diesen Wert

offset

Integer

0

Listet Suchergebnisse erst ab diesem Wert

 

 

Response

Hinter der Eigenschaft handler des Result-Objekts verbirgt sich ein Objekt mit einer einzigen, öffentlich sichtbaren Eigenschaft, die den Namen statistics trägt. Sie enthält ein numerisch indiziertes Array mit 0 oder mehr Zeilen (Arrays), von denen jede wie folgt strukturiert ist:

IndexTypBeschreibung

eventdate*

Date

(YYYY-MM)

Tracking-Datum

programid*

Integer

ID des beteiligten Partnerprogramms

programname*

String

Name des beteiligten Partnerprogramms

adplatformid

Integer

ID der beteiligten Werbeplattform

adplatformname

String

Name der beteiligten Werbeplattform

eventstatus*

String

{ACCEPTED, PENDING, REJECTED}

Status des Events

subid*

String

Sub-Website-ID

admediaid*

Integer

ID des beteiligten Werbemittels

admedianame*

String

Name des beteiligten Werbemittels

eventcurrency

String

Währung

clicks

Integer

Anzahl Klicks

clickcommission

Float

Provision durch Klicks (in abgefragter Währung)

views

Integer

Anzahl Views

viewscommission

Float

Provision durch Views

leads

Integer

Anzahl Leads

leadcommission

Float

Provision durch Leads

sales

Integer

Anzahl Sales

salecommission

Float

Provision durch Sales

totalcommission

Float

Provision gesamt

clickthroughrate

Float

Click-Through-Rate (CTR)

leadconversionrate

Float

Konvertierungsrate (CR) Leads

saleconversionrate

Float

Konvertierungsrate (CR) Sales

 

Die mit einem * gekennzeichneten Felder sind nur dann in der Ausgabe enthalten, wenn im Funktionsaufruf (Request) eine entsprechende Gruppierung vorgenommen wurde. So erfordert bspw. die Ausgabe von programid und programname eine Gruppierung nach Programm mittels des Request-Parameters groupByProgram. Dies sollte ebenfalls bei der Sortierung berücksichtigt werden. Die Felder clicks, clickcommission, views, viewcommission sowie clickthroughrate, leadconversionrate und saleconversionrate können u.U. NULL-Werte hervorbringen.

 

Beispiel:

<?php

 

define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');

 

// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php)

$config = array(

'login' => 'YOUR_LOGIN_NAME',

      'password' => 'YOUR_WEBSERVICE_PASSWORD',

'trace' => true

);

 

try {

$client = new SoapClient(WSDL_SERVER, $config);

$result = $client->getStatisticsByAdPlatform(

            '2010-09-01', // startDate

            null, // endDate

            <YOUR_AD_PLATFORM_ID>, // adPlatformId

            null, // currency

            null, // groupByMonth

            null, // groupByProgram

            null, // groupByEventStatus

            true, // groupByAdMedia

            null, // groupBySubId

            array('eventdate' => 'DESC',

'admedianame' => 'ASC'), // orderBy

            25 // limit

);

 

echo '<pre>';

print_r($result);

 

} catch( Exception $e ) {

// Error handling here...

}

 

 

4.2.5           getStatisticsByAdMedia()

Liefert die Statistiken des gewählten Zeitraums, gruppiert nach Werbemittel zurück.

 

Request-Parameter

NameTypDefaultBeschreibung

startDate

Date

(YYYY-MM-DD)

Erster Tag des aktuellen Monats

 

endDate

Date

(YYYY-MM-DD)

Heutiges Tagesdatum

 

adMediaId

Integer

 

 

currency

String

EUR

 

groupByMonth

Boolean

true

 

groupByProgram

Boolean

false

 

groupByAdPlatform

Boolean

false

 

groupByEventStatus

Boolean

false

 

groupBySubId

Boolean

false

 

orderBy

String[]
(Array)

array('eventdate' => 'DESC')

Sortiert die Rückgabe nach dem übergebenen Spaltennamen mit gewünschter Orientierung (ASC = aufsteigend, DESC= absteigend)

limit

Integer

null

Begrenzt die Anzahl der Ergebnisse auf max. diesen Wert

offset

Integer

0

Listet Suchergebnisse erst ab diesem Wert

 

 

Response

Hinter der Eigenschaft handler des Result-Objekts verbirgt sich ein Objekt mit einer einzigen, öffentlich sichtbaren Eigenschaft, die den Namen statistics trägt. Sie enthält ein numerisch indiziertes Array mit 0 oder mehr Zeilen (Arrays), von denen jede wie folgt strukturiert ist:

IndexTypBeschreibung

eventdate*

Date

(YYYY-MM)

Tracking-Datum

programid*

Integer

ID des beteiligten Partnerprogramms

programname*

String

Name des beteiligten Partnerprogramms

adplatformid*

Integer

ID der beteiligten Werbeplattform

adplatformname*

String

Name der beteiligten Werbeplattform

eventstatus*

String

{ACCEPTED, PENDING, REJECTED}

Status des Events

subid*

String

Sub-Website-ID

admediaid

Integer

ID des beteiligten Werbemittels

admedianame

String

Name des beteiligten Werbemittels

eventcurrency

String

Währung

clicks

Integer

Anzahl Klicks

clickcommission

Float

Provision durch Klicks (in abgefragter Währung)

views

Integer

Anzahl Views

viewscommission

Float

Provision durch Views

leads

Integer

Anzahl Leads

leadcommission

Float

Provision durch Leads

sales

Integer

Anzahl Sales

salecommission

Float

Provision durch Sales

totalcommission

Float

Provision gesamt

clickthroughrate

Float

Click-Through-Rate (CTR)

leadconversionrate

Float

Konvertierungsrate (CR) Leads

saleconversionrate

Float

Konvertierungsrate (CR) Sales

 

Die mit einem * gekennzeichneten Felder sind nur dann in der Ausgabe enthalten, wenn im Funktionsaufruf (Request) eine entsprechende Gruppierung vorgenommen wurde. So erfordert bspw. die Ausgabe von programid und programname eine Gruppierung nach Programm mittels des Request-Parameters groupByProgram. Dies sollte ebenfalls bei der Sortierung berücksichtigt werden. Die Felder clicks, clickcommission, views, viewcommission sowie clickthroughrate, leadconversionrate und saleconversionrate können u.U. NULL-Werte hervorbringen.

 

Beispiel:

<?php

 

define('WSDL_SERVER', 'http://api.belboon.com/?wsdl');

 

// SOAP options (http://de.php.net/manual/de/soapclient.soapclient.php)

$config = array(

'login' => 'YOUR_LOGIN_NAME',

      'password' => 'YOUR_WEBSERVICE_PASSWORD',

'trace' => true

);

 

try {

$client = new SoapClient(WSDL_SERVER, $config);

$result = $client->getStatisticsByAdMedia(

            '2010-07-15', // startDate

            date('Y-m-d'), // endDate

            <YOUR_AD_MEDIA_ID>, // adMediaId

            false, // groupByMonth

            false, // groupByProgram

            true, // groupByAdPlatform

            null, // groupByEventStatus

            null, // groupBySubId

            array('adplatformname' => 'ASC'), // orderBy

            25, // limit

            25 // offset

);

 

echo '<pre>';

print_r($result);

 

} catch( Exception $e ) {

// Error handling here...

}

 

 

 

 



Anhänge:
DE_Publisher_Handbuch_Webservices_PublisherStatistiken_V1_0.pdf - (Size 613kb)
 

Jetzt registrieren!

Werden Sie Teil unserer einzigartigen Erfolgsgeschichte

Publisher:  registrieren

Tel:  0049 (0)30-72 61 62 320
Fax: 0049 (0)30-72 61 62 311
Email: info@belboon.de

Advertiser: mehr

belboon-adbutler GmbH
Karl-Liebknecht-Str. 1
10178 Berlin
Deutschland

Tel: 0049 (0)30 72 61 62-320
Fax: 0049 (0)30 72 61 62-311
Email: info@belboon.de

Handelsregister:
AG Berlin (Charlottenburg), HRB 125210
USt-ID: DE220719614

Geschäftsführer: Manuel Kester

ROBERT VERHOEVE
Geschäftsführer
WebMerchant GmbH

"Seit Herbst 2005 haben wir verschiedene Anbieter bei belboon untergebracht, und die Anzahl der Bestellungen, die über das Netzwerk belboon zustande kommen, nimmt stetig zu![...]"

twitter xing facebook rss youtube flickr