Contaxe API PHP Class

naden — Fri, 09 Nov 2007 16:53:25 +0000

Contaxe hat vor einigen Tagen eine XML-Api veröffentlicht, mit der Publisher auf den Bestand an Werbemitteln zugreifen können. Um das aus PHP heraus komfortabel zu bewältigen, habe ich eine Wrapper Class geschrieben, die sämtliche Funktionen der Contaxe-Api kapselt und anhand diverser Beispiele erleutert.

Das besondere an der Contaxe-Api ist, das optional kontextsensitive Werbung ausgeliefert wird, man also kein konkretes Keyword vergeben muß. Dazu wird die Seite von einem Crawler besucht und einem Thema zugeordnet.

Eine weitere sinnvolle Option ist der Backfill. Werden zu einem Keyword 10 Ergebnisse abgefragt, die Datenbank von Contaxe enthält zu dieser Anfrage aber nur 3 Einträge, so kann man optional 7 zufällige Einträge zusätzlich erhalten. Diese sind allerdings nicht mehr kontextsensitiv.

Code

Die simpelste Abfrage besteht aus wenigen Zeilen:

include_once( 'contaxe.class.php' );
 
$ContaxeApi = new ContaxeApi();
$ContaxeApi->GetTextAds(
	array(
		'query' => 'auto', /// keyword
		'len' => 10 /// Anzahl der Ergebnisse
	)
);

Gesucht wird nach dem Keyword “auto”. Es sollen 10 Ergebnisse geliefert werden. Content-Detection ist nicht verlangt und zufälliger Backfill auch nicht.
Die Ergebnisse werden gleich auf dem Screen ausgegeben. Der optionale Parameter ‘print’ steht per Default auf true.
Über die mitgeliferte “contaxe.css” können die Ergebnisse an die eigenen Layout-Wünsche Angepasst werden.

Alle weiteren Methoden verlangen die gleichen Paramater;

$ContaxeApi = new ContaxeApi();
 
$ContaxeApi->GetTextAds( array(...) );
 
$ContaxeApi->GetImageAds( array(...) );
 
$ContaxeApi->GetImageTextAds( array(...) );
 
$ContaxeApi->GetFlashAds( array(...) );

Alle Paramater und deren Default-Werte

Die Namensgebung hat Contaxe verbrochen also bitte bei denen beschweren.

Contaxe – Prameter
Name	Type	Default	Beschreibung
query	String		Keyword
len	Integer	3	Anzahl der Ergebnisse. Möglich: (1-15)
format	Enum	txt	Format der Werbemitte. Möglich: txt, img, imgtxt, flash
c	Integer	2332	Contaxe-Channel ID
cty	Enum	de	Location. Möglich: de,at,ch
incharset	String	utf-8	Codierung der Request-Daten
outcharset	String	utf-8	Codierung der Response-Daten
rnd	Boolean	1	Zufälliger Backfill.
ofs	Integer	0	Offset der Ergebnisse
tsi	String	Contaxe_API_PHP_Class _VERSION	Sub-ID, bel. belegbar
nocrawl	Boolean	1	Crawler Aus

Class – Prameter
Name	Type	Default	Beschreibung
default	String		Wird gezeigt, wenn kein Ergebnis
pp	String		Prepend HTML
ap	String		Append HTML
mask	String	%s %s %s	Ergebnismaske
print	Boolean	true	Ausgabe auf Bildschirm
reflink	Boolean	true	Zeige reflink

Demos:

Image-Werbemittel sind so gut wie nie vorhanden. ~~Sehr oft liefern die Image-Url’s auch einen 404-Error.~~ Fehler wurde von Contaxe behoben.
Flash habe ich noch nicht implementiert, da ich über die API nie Ergebnisse gekommen habe.

Demo aller Werbemitte von Contaxe

Suchbox mit Backfill von Contaxe

Suchbox über Ajax mit Backfill von Contaxe

Werbung von Contaxe mit Content Detection

Download:

Download der Contaxe Api inklusive aller Beispiele: Download v1.0

Die Class benötigt PHP 5 und das Modul SimpleXml.

Die API Class ist ein recht schneller Hack, Verbesserungsvorschläge etc. sind also gerne willkommen und sicherlich nötig.

Links

Contaxe