Sie sind auf Seite 1von 23

Dokumentation

HEIAS 2.1 API

Stand: Juni 2012

Inhalt
Informationen per API abrufen ................................................................ 3 Start-Request an die API:....................................................................... 4 API Blind-Network: ............................................................................... 5 Detail-Request an die API ....................................................................... 6 Kundendetails (API910) ......................................................................... 6 Kundenkontakt (API920) ........................................................................ 7 Aktive und inaktive Kampagnen (API1010)................................................ 8 Kampagnendetails (API1020) .................................................................. 9 Kampagnenbuchungsdetails (API1030) ....................................................10 Kampagnenbannerdetails (API1040) .......................................................11 Kampagnenlieferstatistik (API1110) ........................................................12 Kampagnen Lead-/Sale-Statistik (API1120)..............................................13 PPX Statistik (API1170) ........................................................................14 berwachte Partnernetzwerke (API800)...................................................15 Hosts aus berwachtem Partnernetzwerk (API810) ....................................16 Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Tagesbasis (API820) ............................................................................................17 Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Kampagnenbasis (API830) ....................................................................18 Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Werbemittelbasis (API840) ....................................................................19 Statistikwerte eines Bereichs gruppiert nach bergebener SubID (API1150) ..20 Statistikwerte eines Bereichs gruppiert nach bergebener SubID mit Leistungswerten nach Kampagne (API1160) .............................................21 euroDX (API2010) ................................................................................22 Kontakt und Informationen ber adnologies .............................................23

Bitte beachten Sie, dass durch die Nutzung der API Kosten entstehen knnen. Die aktuellen Preise entnehmen Sie bitte der Preisliste!

Informationen per API abrufen


Die HEIAS API bietet Ihnen die Mglichkeit Informationen aus Ihrem Netzwerk in einer XML Struktur gezielt abzurufen. Bitte beachten Sie, dass lediglich Informationen angezeigt werden knnen, die ber das Frontend angelegt worden sind. Folgende Informationen knnen Abgerufen werden: Kundeninfos Kundenkontakte Aktive / Inaktive Kampagnen Kampagnendetails Kampagnenbuchungsdetails Kampagnenstatistik

Der Aufbau einer URL zur Abfrage der API ist wie folgt: http://api.heias.com/XXX/?user=[HASH]&request=apiYYY&customer_id=ZZZZ 1 1. xxx (ADM/CMP/STAT) Ist zu ersetzen durch ADM, CMP oder STAT. Je nach Anfrage an die API haben diese Abkrzungen verschiedene Bedeutungen: ADM: Abkrzung fr Admanagement CMP: Abkrzung fr Campaignmanagement STAT: Abkrzung fr Statistik BLN: Abkrzung fr Blind-Network 2. [HASH] Ist zu ersetzen durch den Wert, welchen wir Ihnen mitteilen. Der Hash ist als persnlicher Schlssel anzusehen. Dazu wenden Sie sich bitte per Email an support@adnologies.com 3. apiYYY Ist zu ersetzen je nach Bedarf. Detaillierte Informationen erhalten Sie in den Detailabfragen in dieser Dokumentation. 4. ZZZZ Ist zu ersetzen durch die Kunden ID aus HEIAS. 2 3 4

Start-Request an die API:


Die API kann Ihnen wie bereits beschrieben verschiedene Informationen zur Verfgung stellen. Sie knnen direkt auf die bentigten Informationen zugreifen oder eine Start URL als Request an die API nehmen. Aus diesem Start-Request knnen Sie auf die notwendigen Informationen zugreifen. Beispiel START request: http://api.heias.com/ADM/?user=[HASH]&request=api900

ADM/?user=[HASH]&request=api900 Kundenliste

ADM/?user=[HASH]&request=api910 Kundendetails

ADM/?user=[HASH]&request=api920 Kunden Kontaktdetails

KUNDEN-EBENE
CMP/?user=[HASH]&request=api1010 Aktive Kampagnen CMP/?user=[HASH]&request=api1010 Inaktive Kampagnen

CMP/?user=[HASH]&request=api1030 Kampagnen Buchungsdetails

CMP/?user=[HASH]&request=api1040 Kampagnen Bannerdetails

STAT/?user=[HASH]&request=api1110 Kampagnen Lieferstatistik

STAT/?user=[HASH]&request=api1120 Kampagnen Lead/Salestatistik

KAMPAGNENEBENE

API Blind-Network:

BLN/?user=[HASH]&request=api800 Blind-Network-bersicht

BLN/?user=[HASH]&request=api810&user_id=[I D-Bereich] Informationen auf Vermarkterebene

BLN/?user=[HASH]&request=api820&user_i d=[ID-Bereich]&host_id=[HOST-ID] Informationen auf Hostebene nach Tag

BLN/?user=[HASH]&request=api840& user_id=[ID-Bereich]&host_id=[HOST-ID] Informationen auf Hostebene nach Werbemittel

BLN/?user=[HASH]&request=api830& user_id=[ID-Bereich]&host_id=[HOST-ID] Informationen auf Hostebene nach Kampagne

BLINDNETWORKEBENE

Detail-Request an die API Kundendetails (API910)


Hier knnen Sie folgende Informationen abrufen: Kunden ID Name des Kunden Land Ort PLZ Strae Telefon Fax Webseite

Beispiel: ADM und API910 http://api.heias.com/ADM/?user=[HASH]&request=api910&customer_id=XXXX

Kundenkontakt (API920)
Hier knnen Sie folgende Informationen abrufen: Kunden ID Name des Ansprechpartners Vorname des Ansprechpartners Email des Ansprechpartners

Beispiel: ADM und API920 http://api.heias.com/ADM/?user=[HASH]&request=api920&customer_id=XXXX

Aktive und inaktive Kampagnen (API1010)


Hier knnen Sie folgende Informationen abrufen: Kunden ID Name des Kunden ID der Kampagne Name der Kampagne Kampagnendetails

Beispiel: CPM und API1010 + Zusatz am Ende der URL Aktive Kampagnen: &active=1 http://api.heias.com/CMP/?user=[HASH]&request=api1010&customer_id=XXXX &active=1 Inaktive Kampagnen: &active=0 http://api.heias.com/CMP/?user=[HASH]&request=api1010&customer_id=XXXX &active=0

Kampagnendetails (API1020)
Hier knnen Sie folgende Informationen abrufen: Kampagnen ID Kampagnenname Kunden ID Kundenbestellnummer Start- & Enddatum Kampagnentyp Preis Volumen Art der Buchung ROS/ROC/RON

Beispiel: CMP und API1020 http://api.heias.com/CMP/?user=[HASH]&request=api1020&customer_id=&cam paign=XXXX

Kampagnenbuchungsdetails (API1030)
Hier knnen Sie folgende Informationen abrufen: Kampagnen ID Kampagnenname Platzierung der Kampagne (ID) Platzierung der Kampagne (Name)

Beispiel: CMP und API1030 http://api.heias.com/CMP/?user=[HASH]&request=api1030&customer_id=&cam paign=XXXX

Kampagnenbannerdetails (API1040)
Hier knnen Sie folgende Informationen abrufen: ID der Kampagne Name der Kampagne Werbemittel ID (Banner ID) ID des Werbeformats (Contentunit) Name des Werbeformats (Contentunit) Script (bei Redirect Werbemitteln) Originalname der Datei (bei physischen Werbemitteln) Deeplink (bei physischen Werbemitteln) Pfad des Werbemittel auf Server (bei physischen Werbemitteln) Status des Werbemittel (1=Aktiv, 0=Inaktiv)

Beispiel: CMP und API1040 (fr Bannerdetails) http://api.heias.com/CMP/?user=[HASH]&request=api1040&customer_id=&cam paign=XXXX

Kampagnenlieferstatistik (API1110)
Hier knnen Sie folgende Informationen abrufen: Kampagnen ID Name der Kampagne Platzierung (Startdatum) Platzierung (ID) Platzierung (Name) Platzierung (Werbemittel ID) Platzierung (Werbemittelformat) Platzierung (Werbemittelformatname) Platzierung (AIs) Platzierung (Clicks) Platzierung (CTR) Platzierung (Leads/Sales; Anzahl Sales aufgezeichnet (netto), 0= keine Sales vorhanden) Beispiel: STAT und API1110 (fr Lieferstatistik) http://api.heias.com/STAT/?user=[HASH]&request=api1110&customer_id=&cam paign=XXXX&start=YYYY-MM-DD&end=YYYY-MM-DD

Kampagnen Lead-/Sale-Statistik (API1120)


Hier knnen Sie folgende Informationen abrufen: Datum des Lead/Sale Erstellungsdatum des Cookie Bereich-ID in welcher der Lead/Sale erzeugt wurde Bereich-Name in welcher der Lead/Sale erzeugt wurde Werbemittel-ID zu welcher der Lead/Sale zugeordnet wurde Werbemittelformat-ID zu welcher der Lead/Sale zugeordnet wurde Werbemittel-Name zu welcher der Lead/Sale zugeordnet wurde Gesamtwert der Vergtung Lead/Sale Typ Bestellnummer Gesamtwert des Lead/Sale Bestellte Artikel Anzahl der bestellten Artikel Einzelpreise der bestellten Artikel Hostname Host-ID

Beispiel: STAT und API1120 (fr Lead/Sale Statistik auf Kampagnenebene) http://api.heias.com/STAT/?user=[HASH]&request=api1120&customer_id=&cam paign=[ID]&start=YYYY-MM-DD&end= YYYY-MM-DD

PPX Statistik (API1170)


Hier knnen Sie folgende Informationen abrufen: Anzahl der Pixel-Aufrufe im gesamten Netzwerk Anzahl der Pixel-Aufrufe fr jeden einzelnen Kunden

Die Parameter start, end und customer sind optional. Wenn start oder end frei gelassen werden, wird der aktuelle Tag ausgegeben. Wenn kein Eintrag fr customer vorgenommen wird, werden die Daten smtlicher Kunden im Netzwerk ausgeliefert. Beispiel: STAT und API1170 (fr Profiling Pixel Statistik) http://api.heias.com/STAT/?user=[HASH]&request=api1170&start=[DATE_STAR T]&end=[DATE_END]&customer=[CUSTOMER_ID]

berwachte Partnernetzwerke (API800)


Hier knnen Sie folgende Informationen abrufen: ID des Bereichs Name des Bereichs Anzahl aufgedeckten Hosts innerhalb des Bereichs

Beispiel: BLN und API800 (fr berwachte Partnernetzwerke) BLN/?user=[HASH]&request=api800&start= [YYYY-MM-DD]&end=[YYYY-MM-DD] ACHTUNG: start und end sind optionale Parameter welche bergeben werden knnen um den Zeitraum der Ausgabe zu bestimmen. Folgende Variationen sind mglich: Nur start Nur end start + end Weder start noch end -> -> -> -> Variable Start bis heute Nicht valide. Letzten Tage bis heute (Default) Zeitraum von Start bis Ende Zeitraum letzten 30 Tage bis heute (Default)

Hosts aus berwachtem Partnernetzwerk (API810)


Hier knnen Sie folgende Informationen abrufen: Host ID der aufgedeckten Seite Host Name der aufgedeckten Seite Letzter Kontakt zu Host ID der aufgedeckten Seite

Beispiel: BLN und API810 (fr Hosts innerhalb eines berwachten Partnernetzwerkes) BLN/?user=[HASH]&request=api810&user_id=[ID-Bereich]&start=[YYYY-MMDD]&end=[YYYY-MM-DD] ACHTUNG: start und end sind optionale Parameter welche bergeben werden knnen um den Zeitraum der Ausgabe zu bestimmen. Folgende Variationen sind mglich: Nur start Nur end start + end Weder start noch end -> -> -> -> Variable Start bis heute Nicht valide. Letzten Tage bis heute (Default) Zeitraum von Start bis Ende Zeitraum letzten 30 Tage bis heute (Default)

Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Tagesbasis (API820)


Hier knnen Sie folgende Informationen abrufen: AdImpressions auf dem Host ID der aufgedeckten Seite AdClicks auf dem Host ID der aufgedeckten Seite PostClickLeads/Sales auf dem Host ID der aufgedeckten Seite PostViewLeads/Sales auf dem Host ID der aufgedeckten Seite

Beispiel: BLN und API820 (Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Tagesbasis) BLN/?user=[HASH]&request=api820&user_id=[ID-Bereich]&host_id=[HOSTID]&start=[YYYY-MM-DD]&end=[YYYY-MM-DD] ACHTUNG: start und end sind optionale Parameter welche bergeben werden knnen um den Zeitraum der Ausgabe zu bestimmen. Folgende Variationen sind mglich: Nur start Nur end start + end Weder start noch end -> -> -> -> Variable Start bis heute Nicht valide. Letzten Tage bis heute (Default) Zeitraum von Start bis End Zeitraum letzten 30 Tage bis heute (Default)

Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Kampagnenbasis (API830)


Hier knnen Sie folgende Informationen abrufen: Kampagnen ID auf der Host ID der aufgedeckten Seite Kampagnenname auf der Host ID der aufgedeckten Seite AdImpressions der Kampagne auf der Host ID der aufgedeckten Seite AdClicks der Kampagne auf der Host ID der aufgedeckten Seite PostClickLeads/Sales der Kampagne auf der Host ID der aufgedeckten Seite PostViewLeads/Sales der Kampagne auf der Host ID der aufgedeckten Seite Beispiel: BLN und API830 (Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Kampagnenbasis) BLN/?user=[HASH]&request=api830&user_id=[ID-Bereich]&host_id=[HOSTID]&start=[YYYY-MM-DD]&end=[YYYY-MM-DD] ACHTUNG: start und end sind optionale Parameter welche bergeben werden knnen um den Zeitraum der Ausgabe zu bestimmen. Folgende Variationen sind mglich: Nur start -> Nur end -> start + end -> Weder start noch end -> Variable Start bis heute Nicht valide. Letzten Tage bis heute (Default) Zeitraum von Start bis End Zeitraum letzten 30 Tage bis heute (Default)

Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Werbemittelbasis (API840)


Hier knnen Sie folgende Informationen abrufen: Kampagnen ID auf dem Host ID der aufgedeckten Seite Werbemittel-ID auf dem Host ID der aufgedeckten Seite Werbemittel Name auf dem Host ID der aufgedeckten Seite AdImpressions des Werbemittel auf dem Host ID der aufgedeckten Seite AdClicks des Werbemittel auf dem Host ID der aufgedeckten Seite PostClickLeads/Sales des Werbemittel auf dem Host ID der aufgedeckten Seite PostViewLeads/Sales des Werbemittel auf dem Host ID der aufgedeckten Seite CTR des Werbemittel auf dem Host ID der aufgedeckten Seite

Beispiel: BLN und API840 (Statistikwerte eines Hosts aus berwachtem Partnernetzwerk auf Kampagnenbasis) BLN/?user=[HASH]&request=api840&user_id=[ID-Bereich]&host_id=[HOSTID]&start=[YYYY-MM-DD]&end=[YYYY-MM-DD] ACHTUNG: start und end sind optionale Parameter welche bergeben werden knnen um den Zeitraum der Ausgabe zu bestimmen. Folgende Variationen sind mglich: Nur start Nur end start + end Weder start noch end -> -> -> -> Variable Start bis heute Nicht valide. Letzten Tage bis heute (Default) Zeitraum von Start bis End Zeitraum letzten 30 Tage bis heute (Default)

Statistikwerte eines Bereichs gruppiert nach bergebener SubID (API1150)


Hier knnen Sie folgende Informationen abrufen: bergebene SubID AdImpressions bei dieser SubID AdClicks auf dieser SubID CTR auf dieser SubID

Beispiel: STAT und API1150 (Statistikwerte eines Bereichs gruppiert nach bergebener SubID) STAT/?user=[HASH]&request=api1150]&start=[YYYY-MM-DD]&end=[YYYY-MMDD]&site=[ID-Bereich]

Statistikwerte eines Bereichs gruppiert nach bergebener SubID mit Leistungswerten nach Kampagne (API1160)
Hier knnen Sie folgendes abrufen: bergebene SubID AdImpressions bei dieser SubID AdClicks auf dieser SubID CTR auf dieser SubID Ausgelieferte Kampagnen ID Passende Customer ID zu der Kampagnen ID

Beispiel: STAT und API1160 (Statistikwerte eines Bereichs gruppiert nach bergebener SubID mit Leistungswerten nach Kampagne) STAT/?user=[HASH]&request=api1160]&start=[YYYY-MM-DD]&end=[YYYY-MMDD]&site=[ID-Bereich]

euroDX (API2010)
Hier knnen Sie folgendes abrufen: Kunden IDs welche in euroDX eingebucht sind Kampagnen IDs welche in euroDX eingebucht sind Kostenaufstellung auf Kundenbasisbase welche in euroDX eingebucht sind

Beispiel: DX und API2010 (Statistikwerte von Kunden und Kampagnen welche in euroDX eingebucht sind) api.heias.com/DX/?user=USER_HASH&from=YYYY-MM-DD&to=YYYY-MMDD&request=api2010 Die oben genannte Abfrage gibt Ihnen einen berblick der Kunden, die in euroDX eingebucht sind + zwei weitere Optionen: campaign overview (Kampagnen-bersicht) cost report (Kostenaufstellung)

Diese Optionen geben Ihnen detaillierte Informationen ber die Kosten innerhalb eines Zeitraumes, welcher in der API2010 abgefragt wird.

Kontakt und Informationen ber adnologies

Ihr Kontakt zu uns:

Herr Andreas Schwibbe - Geschftsfhrer adnologies GmbH Neuer Wall 34 20354 Hamburg Tel: 040 209 311 310 Fax: 040 209 346 799 a.schwibbe@adnologies.com www.adnologies.com

ber adnologies
Die adnologies GmbH ist ein konzern- und verlagsunabhngiges Unternehmen. Diese Unabhngigkeit ist fr unsere Kunden ein wichtiges Kriterium, um ihre eigene Unabhngigkeit im Online-Werbemarkt zu wahren. Adnologies GmbH stellt allen Marktteilnehmern einen freien Zugang zu moderner AdServing-Technologie zu Verfgung.

HEIAS 2.1 Es wird Echtzeit.