com.atenis.rankingspy.web.webservice

Class RankingSpyService

java.lang.Object

com.atenis.rankingspy.web.webservice.RankingSpyService

All Implemented Interfaces:

java.io.Serializable

public class RankingSpyService
extends java.lang.Object
implements java.io.Serializable

SOAP Web-Service Schnittstelle von ranking-spy.com

Hier können Sie Ihre Subsystem von ranking-spy verwalten.

Übersicht über die Klassenstruktur:

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RankingSpyService()

Method Summary

Modifier and Type	Method and Description
void	activateChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId) Aktiviert einen Channel, der zuvor deaktiviert wurde.
void	addKeyword(java.lang.String username, java.lang.String password, java.lang.Long channelId, java.lang.String keyword) Fügt zu einer Überwachung / einem Channel ein zusätzliches Keyword hinzu.
void	changeLicenceType(java.lang.String username, java.lang.String password, java.lang.Long channelId, java.lang.Long licenceTypeId) Ändert den LicenceType eines Channels / einer Überwachung
java.lang.Long	createChannel(java.lang.String username, java.lang.String password, java.lang.Long userId, java.lang.Long licenceTypeId, java.lang.Long googleLocationId, java.lang.String url, java.lang.String[] keywords, boolean activated, java.lang.String note) Erzeugt eine neue Überwachung.
java.lang.Long	createNewUser(java.lang.String username, java.lang.String password, CustomerInfo customer) Erstellt einen neuen Benutzer / Mandanten im ranking-spy System
void	deactivateChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId) Deaktiviert einen Channel.
void	deleteChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId) Löscht einen Channel / eine Überwachung vollständig.
void	deleteKeyword(java.lang.String username, java.lang.String password, java.lang.Long keywordId) Löscht ein Keyword aus einer Überwachung / Channel.
void	deleteUserByExternalKey(java.lang.String username, java.lang.String password, java.lang.String externalKey) Löscht einen User anhand des externen Schlüssels.
void	deleteUserById(java.lang.String username, java.lang.String password, java.lang.Long id) Löscht einen User anhand der ID.
java.lang.String	echo(java.lang.String s) Testmethode
java.lang.String	echo(java.lang.String username, java.lang.String password) Testmethode
GoogleLocationInfo[]	getAvailableGoogleLocations(java.lang.String username, java.lang.String password, java.lang.String tld) Gibt alle verfügbaren Google-Location für ein Land (tld) aus.
LicenceTypeInfo[]	getAvailableLicenceTypes(java.lang.String username, java.lang.String password) Gibt alle verfügbaren LicenceTypes an, die steuern, welche Suchmaschinen in welchen Intervallen abgefragt werden.
QuickCheckLogData[]	getQuickCheckLog(java.lang.String username, java.lang.String password, java.util.Date from, java.util.Date to)
ReportData[]	getRecentReports(java.lang.String username, java.lang.String password, java.lang.Long keywordId) Gibt die aktuellsten Überwachungsergbnisse (Messungen) für ein Keyword zurück
ReportData[]	getRecentReportsByChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId) Gibt die aktuellsten Überwachungsergbnisse (Messungen) für einen gesamten Channel zurück. für ein Keyword/Suchmaschinen-Paar wird jeweils der aktuellste Messpunkt ermittelt.
ReportData[]	getReports(java.lang.String username, java.lang.String password, java.lang.Long keywordId) Convenient for getReports(user, password, keywordId, null, null, null)
ReportData[]	getReports(java.lang.String username, java.lang.String password, java.lang.Long keywordId, java.util.Date from, java.util.Date to) Convenient for getReports(user, password, keywordId, null, from, to)
ReportData[]	getReports(java.lang.String username, java.lang.String password, java.lang.Long keywordId, java.lang.Long searchEngineId, java.util.Date from, java.util.Date to) Gibt Überwachungsergbnisse (Messungen) für ein Keyword zurück
ReportData[]	getReportsByChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId) convenient for getReportsByChannel(user, password, channelId, null, null)
ReportData[]	getReportsByChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId, java.util.Date from, java.util.Date to) Gibt Überwachungsergbnisse (Messungen) für einen gesamten Channel zurück
void	lockUser(java.lang.String username, java.lang.String password, java.lang.Long customerId) Sperrt einen Benutzer.
SearchEngineResult	performSearch(java.lang.String username, java.lang.String password, java.lang.Long searchEngineId, java.lang.Long googleLocationId, java.lang.String url, java.lang.String searchString) Fragt ein Ranking für ein Suchstring auf einer Suchmaschine ab.
SearchRunData	performSearchRun(java.lang.String username, java.lang.String password, java.lang.Long searchEngineId, java.lang.Long googleLocationId, java.lang.String searchString, int maxHoursCached) Live-Abfrage über 10 Unterseiten: Kurzform für performSearchRun(username, password, searchEngineId, googleLocationId, searchString, maxHoursCached, 10) Dieser Aufruf ist nicht für Massenabfragen geeignet!
SearchRunData	performSearchRun(java.lang.String username, java.lang.String password, java.lang.Long searchEngineId, java.lang.Long googleLocationId, java.lang.String searchString, int maxHoursCached, int searchPageDepth) Fragt live ein Suchergebnis(Position 1-100) für ein Suchstring auf einer Suchmaschine ab.
SearchEngineResult	performSearchWithoutCache(java.lang.String username, java.lang.String password, java.lang.Long searchEngineId, java.lang.Long googleLocationId, java.lang.String url, java.lang.String searchString, int searchPageDepth) Fragt live und ohne Zugriff auf den ranking-spy Cache ein Ranking für ein Suchstring auf einer Suchmaschine ab.
CustomerInfo[]	retrieveAllUsers(java.lang.String username, java.lang.String password) Liefert eine Liste aller im System registrierten Benutzer.
SearchRunData	retrieveSearchRun(java.lang.String username, java.lang.String password, java.lang.Long id) Metadaten über einen Suchvorgang Bei größeren Datenmengen kann auch die Methode retrieveSearchRuns(String, String, Long[]) verwendet werden
java.lang.Long[]	retrieveSearchRunIdsByUserId(java.lang.String username, java.lang.String password, java.lang.Long userId, java.util.Date from, java.util.Date to) Ids der Metadaten über Suchvorgänge für einen Benutzer in einem Zeitraum
SearchRunData[]	retrieveSearchRuns(java.lang.String username, java.lang.String password, java.lang.Long[] ids) Metadaten über einen Suchvorgang als Bulk-Abfrage
SearchEngineInfo[]	retrieveSupportedSearchEngines() Liefert eine übersicht über alle momentan in ranking-spy.com zur Verfügung stehenden Suchmaschinen.
CustomerInfo	retrieveUserByExternalKey(java.lang.String username, java.lang.String password, java.lang.String externalKey) Lädt einen Benutzer anhand des externen Schlüssels.
CustomerInfo	retrieveUserById(java.lang.String username, java.lang.String password, java.lang.Long id) Lädt einen Benutzer anhand der ID.
void	unlockUser(java.lang.String username, java.lang.String password, java.lang.Long userId) Entsperrt einen Benutzer.
void	updateNoteForChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId, java.lang.String newNote) Ändert das Notizfeld für einen Channel / eine Überwachung.
void	updateReportEmailSettings(java.lang.String username, java.lang.String password, java.lang.Long customerId, boolean sendEmails, ReportAttachmentInfo reportAttachmentInfo, IntervalInfo intervalInfo) Setzt die Versandoptionen der Email-Reports für einen Kunden
void	updateUrlForChannel(java.lang.String username, java.lang.String password, java.lang.Long channelId, java.lang.String newUrl) Ändert die URL für einen Channel / eine Überwachung.
void	updateUserExternalKey(java.lang.String username, java.lang.String password, java.lang.Long customerId, java.lang.String newExternalKey) Ändert den externen Schlüssel eines Benutzers.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RankingSpyService

public RankingSpyService()

Method Detail

activateChannel

public void activateChannel(java.lang.String username,
                            java.lang.String password,
                            java.lang.Long channelId)
                     throws RankingSpyException

Aktiviert einen Channel, der zuvor deaktiviert wurde. Alle Überwachungsläufe werden sofort ausgeführt. Auf einen bereits aktiven Channel hat dieser Aufruf die Auswirkung, dass ein Zwischenlauf für die Überwachungsläufe gestartet wird.

Parameters:

channelId - ID des Channels

Throws:

RankingSpyException

See Also:

deactivateChannel(java.lang.String, java.lang.String, java.lang.Long)

addKeyword

public void addKeyword(java.lang.String username,
                       java.lang.String password,
                       java.lang.Long channelId,
                       java.lang.String keyword)
                throws RankingSpyException

Fügt zu einer Überwachung / einem Channel ein zusätzliches Keyword hinzu. Die Suchmaschinen und Intervalle ergeben sich aus den Einstellungen der bestehenden Überwachung / des Channels. Das neue Keyword ist sofort aktiv und wird fortan mit ausgeführt.

Parameters:

channelId - ID des Channels zu dem das Keyword hinzugeFügt werden soll

keyword - das Keyword

Throws:

RankingSpyException

changeLicenceType

public void changeLicenceType(java.lang.String username,
                              java.lang.String password,
                              java.lang.Long channelId,
                              java.lang.Long licenceTypeId)
                       throws RankingSpyException

Ändert den LicenceType eines Channels / einer Überwachung

Parameters:

channelId - ID des Channels der einen neuen LicenceType bekommen soll

licenceTypeId - ID des neuen LicenceTypeInfo

Throws:

RankingSpyException

createChannel

public java.lang.Long createChannel(java.lang.String username,
                                    java.lang.String password,
                                    java.lang.Long userId,
                                    java.lang.Long licenceTypeId,
                                    java.lang.Long googleLocationId,
                                    java.lang.String url,
                                    java.lang.String[] keywords,
                                    boolean activated,
                                    java.lang.String note)
                             throws RankingSpyException

Erzeugt eine neue Überwachung. Die Überwachung ist sofort aktiv und wird zum nächst freien Zeitpunkt ausgeführt.

Parameters:

userId - ID des Benutzers für den diese Überwachung eingestellt werden soll CustomerInfo.getId()

licenceTypeId - ID des zu verwendenden LicenceTypes

url - die URL die in den Suchmaschinen gefunden werden soll (egal ob mit http bzw. www oder ohne)

keywords - Liste von verschiedenen Keywords mit denen in den Suchmaschinen gesucht werden soll

activated - gibt an, ob diese Überwachung sofort aktiv sein soll (d.h. die Überwachung wird ausgeführt), falls ein Channel (Überwachung) mit activated=false angelegt wurde, so muss noch der Aufruf activateChannel(java.lang.String, java.lang.String, java.lang.Long) erfolgen

note - Notiz zu dieser Überwachung

googleLocationId - ID der GoogleLocation für die regionalisierte Suche bei Google oder NULL bzw. 0 für keine regionalisierte Suche

Returns:

ID des erzeugten Channels / der Überwachung

Throws:

RankingSpyException

See Also:

getAvailableLicenceTypes(java.lang.String, java.lang.String), getAvailableGoogleLocations(String, String, String)

createNewUser

public java.lang.Long createNewUser(java.lang.String username,
                                    java.lang.String password,
                                    CustomerInfo customer)
                             throws RankingSpyException

Erstellt einen neuen Benutzer / Mandanten im ranking-spy System

Returns:

die ID des neuen Benutzers

Throws:

RankingSpyException

deactivateChannel

public void deactivateChannel(java.lang.String username,
                              java.lang.String password,
                              java.lang.Long channelId)
                       throws RankingSpyException

Deaktiviert einen Channel. Diese Überwachung wird nun nicht mehr ausgeführt. Die historischen Überwachungsdaten bleiben aber erhalten. Ein inktiver Channel kann jederzeit über activateChannel(String, String, Long) wieder aktiviert werden.

Parameters:

channelId - ID des Channels

Throws:

RankingSpyException

See Also:

activateChannel(String, String, Long)

deleteChannel

public void deleteChannel(java.lang.String username,
                          java.lang.String password,
                          java.lang.Long channelId)
                   throws RankingSpyException

Löscht einen Channel / eine Überwachung vollständig. Es werden physikalisch alle Daten, einschließlich aller historischen Ergebnisse gelöscht!
Alternativ kann, um die historischen Ergebnisse zu erhalten deactivateChannel(String, String, Long) auf die Überwachung angewendet werden.

Parameters:

channelId - ID des Channels

Throws:

RankingSpyException

deleteKeyword

public void deleteKeyword(java.lang.String username,
                          java.lang.String password,
                          java.lang.Long keywordId)
                   throws RankingSpyException

Löscht ein Keyword aus einer Überwachung / Channel.
Achtung! Es werden auch alle historischen Überwachungswerte gelöscht.

Parameters:

keywordId - ID des Keywords

Throws:

RankingSpyException

deleteUserByExternalKey

public void deleteUserByExternalKey(java.lang.String username,
                                    java.lang.String password,
                                    java.lang.String externalKey)
                             throws RankingSpyException

Löscht einen User anhand des externen Schlüssels. Es werden physikalisch alle Benutzerdaten, einschließlich aller Überwachungen und historischen Ergebnisse gelöscht!
Alternativ kann, um die historischen Ergebnisse zu erhalten deactivateChannel(String, String,Long) auf alle Überwachungen angewendet werden.

Parameters:

externalKey - der externe Schlüssel

Throws:

RankingSpyException

deleteUserById

public void deleteUserById(java.lang.String username,
                           java.lang.String password,
                           java.lang.Long id)
                    throws RankingSpyException

Löscht einen User anhand der ID. Es werden physikalisch alle Benutzerdaten, einschließlich aller Überwachungen und historischen Ergebnisse gelöscht!
Alternativ kann, um die historischen Ergebnisse zu erhalten deactivateChannel(java.lang.String, java.lang.String, java.lang.Long) auf alle Überwachungen angewendet werden.

Parameters:

id - die ID

Throws:

RankingSpyException

echo

public java.lang.String echo(java.lang.String s)
                      throws RankingSpyException

Testmethode

Parameters:

s - Ein beliebiger String

Returns:

Echo: + der übergebene String

Throws:

RankingSpyException

echo

public java.lang.String echo(java.lang.String username,
                             java.lang.String password)
                      throws RankingSpyException

Testmethode

Parameters:

username -

password -

Returns:

"Hello "+username

Throws:

RankingSpyException - falls der Login fehlschlägt

getAvailableGoogleLocations

public GoogleLocationInfo[] getAvailableGoogleLocations(java.lang.String username,
                                                        java.lang.String password,
                                                        java.lang.String tld)
                                                 throws RankingSpyException

Gibt alle verfügbaren Google-Location für ein Land (tld) aus. Die ID der GoogleLocation kann beim erstellen eines Channels für die regionlisierte Suche bei Google hinterlegt werden.

Parameters:

username -

password -

tld - z.B. 'de'

Returns:

GoogleLactionInfo

Throws:

RankingSpyException

See Also:

#createChannel(String, String, Long, Long, String, String[], boolean, String)

getAvailableLicenceTypes

public LicenceTypeInfo[] getAvailableLicenceTypes(java.lang.String username,
                                                  java.lang.String password)
                                           throws RankingSpyException

Gibt alle verfügbaren LicenceTypes an, die steuern, welche Suchmaschinen in welchen Intervallen abgefragt werden. Bei der Erzeugung eines neuen Channels muss ein LicenceType per ID angegeben werden.

Returns:

Array von LicenceTypeInfo

Throws:

RankingSpyException

See Also:

createChannel(java.lang.String, java.lang.String, java.lang.Long, java.lang.Long, java.lang.Long, java.lang.String, java.lang.String[], boolean, java.lang.String)

getQuickCheckLog

public QuickCheckLogData[] getQuickCheckLog(java.lang.String username,
                                            java.lang.String password,
                                            java.util.Date from,
                                            java.util.Date to)
                                     throws RankingSpyException

Throws:

RankingSpyException

getRecentReports

public ReportData[] getRecentReports(java.lang.String username,
                                     java.lang.String password,
                                     java.lang.Long keywordId)
                              throws RankingSpyException

Gibt die aktuellsten Überwachungsergbnisse (Messungen) für ein Keyword zurück

Parameters:

keywordId - ID des Keywords (obligatorisch)

Returns:

Array von ReportData

Throws:

RankingSpyException

getRecentReportsByChannel

public ReportData[] getRecentReportsByChannel(java.lang.String username,
                                              java.lang.String password,
                                              java.lang.Long channelId)
                                       throws RankingSpyException

Gibt die aktuellsten Überwachungsergbnisse (Messungen) für einen gesamten Channel zurück. für ein Keyword/Suchmaschinen-Paar wird jeweils der aktuellste Messpunkt ermittelt.

Parameters:

channelId - Id der Überwachung / des Channels

Returns:

Array von ReportData

Throws:

RankingSpyException

getReports

public ReportData[] getReports(java.lang.String username,
                               java.lang.String password,
                               java.lang.Long keywordId)
                        throws RankingSpyException

Convenient for getReports(user, password, keywordId, null, null, null)

Parameters:

keywordId - ID des Keywords

Returns:

Array von ReportData

Throws:

RankingSpyException

getReports

public ReportData[] getReports(java.lang.String username,
                               java.lang.String password,
                               java.lang.Long keywordId,
                               java.util.Date from,
                               java.util.Date to)
                        throws RankingSpyException

Convenient for getReports(user, password, keywordId, null, from, to)

Parameters:

keywordId - ID des Keywords

Returns:

Array von ReportData

Throws:

RankingSpyException

getReports

public ReportData[] getReports(java.lang.String username,
                               java.lang.String password,
                               java.lang.Long keywordId,
                               java.lang.Long searchEngineId,
                               java.util.Date from,
                               java.util.Date to)
                        throws RankingSpyException

Gibt Überwachungsergbnisse (Messungen) für ein Keyword zurück

Parameters:

keywordId - ID des Keywords (obligatorisch)

searchEngineId - ID der SearchEngine - wirkt wie ein Filter (optional) oder null für alle

from - zeitliche Eingrenzung 'von' (optional) oder null

to - zeitliche Eingrenzung 'bis' (optional) oder null

Returns:

Array von ReportData

Throws:

RankingSpyException

getReportsByChannel

public ReportData[] getReportsByChannel(java.lang.String username,
                                        java.lang.String password,
                                        java.lang.Long channelId)
                                 throws RankingSpyException

convenient for getReportsByChannel(user, password, channelId, null, null)

Parameters:

channelId - Id der Überwachung / des Channels

Returns:

Array von ReportData

Throws:

RankingSpyException

getReportsByChannel

public ReportData[] getReportsByChannel(java.lang.String username,
                                        java.lang.String password,
                                        java.lang.Long channelId,
                                        java.util.Date from,
                                        java.util.Date to)
                                 throws RankingSpyException

Gibt Überwachungsergbnisse (Messungen) für einen gesamten Channel zurück

Parameters:

channelId - Id der Überwachung / des Channels

from - zeitliche Eingrenzung 'von' (optional) oder null

to - zeitliche Eingrenzung 'bis' (optional) oder null

Returns:

Array von ReportData

Throws:

RankingSpyException

lockUser

public void lockUser(java.lang.String username,
                     java.lang.String password,
                     java.lang.Long customerId)
              throws RankingSpyException

Sperrt einen Benutzer. Der Benutzer kann sich nicht mehr in ranking-spy einloggen. Das Sperren eines Benutzers hat keine Auswirkung auf die Ausführung der Überwachungen. Verwenden Sie dafür deactivateChannel(String, String, Long) oder activateChannel(String, String, Long)

Parameters:

customerId - die ID des Benutzers CustomerInfo.getId()

Throws:

RankingSpyException

performSearch

public SearchEngineResult performSearch(java.lang.String username,
                                        java.lang.String password,
                                        java.lang.Long searchEngineId,
                                        java.lang.Long googleLocationId,
                                        java.lang.String url,
                                        java.lang.String searchString)
                                 throws RankingSpyException

Fragt ein Ranking für ein Suchstring auf einer Suchmaschine ab. Das Ergebnis dieser Abfrage wird in ranking-spy nicht gespeichert. Falls das Keywords auf der entsprechenden Suchmaschine in den letzten 16 Stunden bereits abgefragt wurde wird der Eintrag aus dem ranking-spy Cache gelesen.
Dieser Aufruf ist nicht für Massenabfragen geeignet!

Parameters:

searchEngineId - die ID der zu verwendenden Suchmaschinen retrieveSupportedSearchEngines() SearchEngineInfo.getId()

url - die URL, die gefunden werden soll (egal ob mit http bzw. www oder ohne)

searchString - der Suchbegriff, mit dem die Suchmaschine abgefragt werden soll

googleLocationId - ID der GoogleLocation für die regionalisierte Suche bei Google oder NULL bzw. 0 für keine regionalisierte Suche

Returns:

Die Position der zu findenden URL als SearchEngineResult

Throws:

RankingSpyException - falls bei der Abfrage ein unerwarteter Fehler auftritt oder für isTest false übergeben wurde, aber noch keine Registrierung für den Webservice bei ranking-spy.com eingegangen ist.

See Also:

getAvailableGoogleLocations(String, String, String)

performSearchRun

public SearchRunData performSearchRun(java.lang.String username,
                                      java.lang.String password,
                                      java.lang.Long searchEngineId,
                                      java.lang.Long googleLocationId,
                                      java.lang.String searchString,
                                      int maxHoursCached)
                               throws RankingSpyException

Live-Abfrage über 10 Unterseiten: Kurzform für performSearchRun(username, password, searchEngineId, googleLocationId, searchString, maxHoursCached, 10)
Dieser Aufruf ist nicht für Massenabfragen geeignet!

Throws:

RankingSpyException

See Also:

performSearchRun(String, String, Long, Long, String, int, int)

performSearchRun

public SearchRunData performSearchRun(java.lang.String username,
                                      java.lang.String password,
                                      java.lang.Long searchEngineId,
                                      java.lang.Long googleLocationId,
                                      java.lang.String searchString,
                                      int maxHoursCached,
                                      int searchPageDepth)
                               throws RankingSpyException

Fragt live ein Suchergebnis(Position 1-100) für ein Suchstring auf einer Suchmaschine ab.
Dieser Aufruf ist nicht für Massenabfragen geeignet!

Parameters:

searchEngineId - die ID der zu verwendenden Suchmaschinen retrieveSupportedSearchEngines() SearchEngineInfo.getId()

searchString - der Suchbegriff, mit dem die Suchmaschine abgefragt werden soll

maxHoursCached - maximales Alter der Suchabfrage in Stunden (aus dem Cache) - 0 erzwingt eine neue Suche

searchPageDepth - max. Anzahl der Unterseiten in den Suchergebnisseiten der Suchmaschine, die weiternavigiert werden soll, bis die URL gefunden wird (Werte zwischen 1 bis 10 erlaubt)

googleLocationId - ID der GoogleLocation für die regionalisierte Suche bei Google oder NULL bzw. 0 für keine regionalisierte Suche

Returns:

Details zur Suche mit Position 1-100

Throws:

RankingSpyException - falls bei der Abfrage ein unerwarteter Fehler auftritt oder für isTest false übergeben wurde, aber noch keine Registrierung für den Webservice bei ranking-spy.com eingegangen ist.

See Also:

getAvailableGoogleLocations(String, String, String)

performSearchWithoutCache

public SearchEngineResult performSearchWithoutCache(java.lang.String username,
                                                    java.lang.String password,
                                                    java.lang.Long searchEngineId,
                                                    java.lang.Long googleLocationId,
                                                    java.lang.String url,
                                                    java.lang.String searchString,
                                                    int searchPageDepth)
                                             throws RankingSpyException

Fragt live und ohne Zugriff auf den ranking-spy Cache ein Ranking für ein Suchstring auf einer Suchmaschine ab. Das Ergebnis dieser Abfrage wird in ranking-spy nicht gespeichert.
Dieser Aufruf ist nicht für Massenabfragen geeignet!

Parameters:

searchEngineId - die ID der zu verwendenden Suchmaschinen retrieveSupportedSearchEngines() SearchEngineInfo.getId()

url - die URL, die gefunden werden soll (egal ob mit http bzw. www oder ohne)

searchString - der Suchbegriff, mit dem die Suchmaschine abgefragt werden soll

searchPageDepth - max. Anzahl der Unterseiten in den Suchergebnisseiten der Suchmaschine, die weiternavigiert werden soll, bis die URL gefunden wird (Werte zwischen 1 bis 10 erlaubt)

googleLocationId - ID der GoogleLocation für die regionalisierte Suche bei Google oder NULL bzw. 0 für keine regionalisierte Suche

Returns:

Die Position der zu findenden URL als SearchEngineResult

Throws:

RankingSpyException - falls bei der Abfrage ein unerwarteter Fehler auftritt oder für isTest false übergeben wurde, aber noch keine Registrierung für den Webservice bei ranking-spy.com eingegangen ist.

See Also:

getAvailableGoogleLocations(String, String, String)

retrieveAllUsers

public CustomerInfo[] retrieveAllUsers(java.lang.String username,
                                       java.lang.String password)
                                throws RankingSpyException

Liefert eine Liste aller im System registrierten Benutzer.
Achtung! - Die Benutzerliste ist 'flach' - d.h. die Channel - Informationen zu den einzelnen Benutzern ist nicht gefüllt.

Returns:

Array von CustomerInfo

Throws:

RankingSpyException

See Also:

retrieveUserByExternalKey(java.lang.String, java.lang.String, java.lang.String), retrieveUserById(java.lang.String, java.lang.String, java.lang.Long)

retrieveSearchRun

public SearchRunData retrieveSearchRun(java.lang.String username,
                                       java.lang.String password,
                                       java.lang.Long id)
                                throws RankingSpyException

Metadaten über einen Suchvorgang
Bei größeren Datenmengen kann auch die Methode retrieveSearchRuns(String, String, Long[]) verwendet werden

Parameters:

id -

Returns:

Metadaten für den Suchvorgang

Throws:

RankingSpyException

See Also:

ReportData.getSearchRunId()

retrieveSearchRunIdsByUserId

public java.lang.Long[] retrieveSearchRunIdsByUserId(java.lang.String username,
                                                     java.lang.String password,
                                                     java.lang.Long userId,
                                                     java.util.Date from,
                                                     java.util.Date to)
                                              throws RankingSpyException

Ids der Metadaten über Suchvorgänge für einen Benutzer in einem Zeitraum

Parameters:

userId - Benutzer ID CustomerInfo.getId()

from - zeitliche Eingrenzung 'von' (optional) oder null

to - zeitliche Eingrenzung 'bis' (optional) oder null

Returns:

Liste der IDs von SearchRunData

Throws:

RankingSpyException

retrieveSearchRuns

public SearchRunData[] retrieveSearchRuns(java.lang.String username,
                                          java.lang.String password,
                                          java.lang.Long[] ids)
                                   throws RankingSpyException

Metadaten über einen Suchvorgang als Bulk-Abfrage

Parameters:

ids -

Returns:

Metadaten für den Suchvorgang

Throws:

RankingSpyException

See Also:

ReportData.getSearchRunId()

retrieveSupportedSearchEngines

public SearchEngineInfo[] retrieveSupportedSearchEngines()
                                                  throws RankingSpyException

Liefert eine übersicht über alle momentan in ranking-spy.com zur Verfügung stehenden Suchmaschinen.

Returns:

Informationen über die Suchmaschinen als Array von SearchEngineInfo

Throws:

RankingSpyException

retrieveUserByExternalKey

public CustomerInfo retrieveUserByExternalKey(java.lang.String username,
                                              java.lang.String password,
                                              java.lang.String externalKey)
                                       throws RankingSpyException

Lädt einen Benutzer anhand des externen Schlüssels. Das CustomerInfo-Objekt ist mit allen Channels und seinen Keywords vorbefüllt.

Parameters:

externalKey - der externe Schlüssel

Returns:

CustomerInfo voll befüllt mit ChannelInfo und KeywordInfo

Throws:

RankingSpyException

See Also:

retrieveUserById(java.lang.String, java.lang.String, java.lang.Long), retrieveAllUsers(java.lang.String, java.lang.String)

retrieveUserById

public CustomerInfo retrieveUserById(java.lang.String username,
                                     java.lang.String password,
                                     java.lang.Long id)
                              throws RankingSpyException

Lädt einen Benutzer anhand der ID. Das CustomerInfo-Objekt ist mit allen Channels und seinen Keywords vorbefüllt.

Parameters:

id - die ID

Returns:

CustomerInfo voll befüllt mit ChannelInfo und KeywordInfo

Throws:

RankingSpyException

See Also:

retrieveUserByExternalKey(java.lang.String, java.lang.String, java.lang.String), retrieveAllUsers(java.lang.String, java.lang.String)

unlockUser

public void unlockUser(java.lang.String username,
                       java.lang.String password,
                       java.lang.Long userId)
                throws RankingSpyException

Entsperrt einen Benutzer. Der Benutzer kann sich wieder in ranking-spy einloggen. Das Entsperren eines Benutzers hat keine Auswirkung auf die Ausführung der Überwachungen. Verwenden Sie dafür deactivateChannel(String, String, Long) oder activateChannel(String, String, Long)

Parameters:

userId - die ID des Benutzers

Throws:

RankingSpyException

updateNoteForChannel

public void updateNoteForChannel(java.lang.String username,
                                 java.lang.String password,
                                 java.lang.Long channelId,
                                 java.lang.String newNote)
                          throws RankingSpyException

Ändert das Notizfeld für einen Channel / eine Überwachung.

Parameters:

channelId - ID des Channels

newNote - die neue Notiz

Throws:

RankingSpyException

updateReportEmailSettings

public void updateReportEmailSettings(java.lang.String username,
                                      java.lang.String password,
                                      java.lang.Long customerId,
                                      boolean sendEmails,
                                      ReportAttachmentInfo reportAttachmentInfo,
                                      IntervalInfo intervalInfo)
                               throws RankingSpyException

Setzt die Versandoptionen der Email-Reports für einen Kunden

Parameters:

customerId - die ID des Benutzers CustomerInfo.getId()

sendEmails - gibt an, ob Report-Emails für diesen Kunden versendet werden sollen

reportAttachmentInfo - Pflichfeld falls sendEmails=true
Einstellungen zu den Email-Anhängen ReportAttachmentInfo

intervalInfo - Pflichfeld falls sendEmails=true
Einstellungen zum Versandinterval IntervalInfo

Throws:

RankingSpyException

updateUrlForChannel

public void updateUrlForChannel(java.lang.String username,
                                java.lang.String password,
                                java.lang.Long channelId,
                                java.lang.String newUrl)
                         throws RankingSpyException

Ändert die URL für einen Channel / eine Überwachung.

Parameters:

channelId - ID des Channels

newUrl - die neue URL

Throws:

RankingSpyException

updateUserExternalKey

public void updateUserExternalKey(java.lang.String username,
                                  java.lang.String password,
                                  java.lang.Long customerId,
                                  java.lang.String newExternalKey)
                           throws RankingSpyException

Ändert den externen Schlüssel eines Benutzers.

Parameters:

customerId - die ID des Benutzers CustomerInfo.getId()

newExternalKey - der neue externe Schlüssel, der dem Benutzer zugeordnet werden soll

Throws:

RankingSpyException

See Also:

retrieveUserById(java.lang.String, java.lang.String, java.lang.Long), retrieveAllUsers(java.lang.String, java.lang.String)