getKeywords

Gibt alle Keywords einer Domain zurück unter denen Anzeigen geschaltet sind.

Route /sea/getKeywords[/:key[/:sengine[/:domain[/:format[/:limit[/:skip[/:date]]]]]]]
Erforderliche Parameter domain
sengine
Optionale Parameter format
limit (max:1000)

skip
date
Rückgabewerte keyword
position
Querschnittverbindungen getSearchengines()
Hinweise Limit: Das maximale Limit ist 1000. Um mehr Ergebnisse zu erhalten, benutzen Sie den Parameter Skip.
resultCount: Enthält die Anzahl des Ergebnisses ohne Filter. Wird z.B. bei der Paginierung benötigt.

Parameter

Bezeichnung Beschriebung Wertebereich Standardwert
domain Enthält einen qualifizierten Domainnamen. (www.)?(A-Z|a-z|0-9)+. (a-z)+
limit Legt fest, wie viele Ergebniszeilen zurückgegeben werden sollen. (max:1000) 0-1000 1
skip Legt fest, wie viele Seiten des Ergebnisarrays übersprungen werden sollen. Eine Seite entspricht dem Wert von limit. (0-9)+ 0
sengine Enthält eine von Xovi gecrawlte Suchmaschine. siehe getSearchengines()
date Legt einen Zeitpunkt fest an dem die Daten gesammelt wurden. Datum: YYYY-MM-DD aktuelles Datum
format Legt fest in welchem Format das Ergebnis zurückgeliefert werden soll. json|xml json

Rückgabewerte

Ein numerisches Array von Arrays folgenden Elementen

Bezeichnung Beschreibung Wertebereich
keyword Ein Keyword für das eine Anzeige geschaltet ist. (a-zA-Z)+
Position Die Position auf der sich die Anzeige befindet. (0-9)+

Meldungen

Nachricht Beschreibung
maximum limit exeeded Das maximale Limit wurde überschritten.
internal error Ein interner Fehler ist aufgetreten.
param missing Ein erforderlicher Parameter wurde nicht übergeben.
param invalid Der Wert eines übergebenen Parameters ist nicht gültig.
result empty Die Bearbeitung der Anfrage war erfolgreich, aber das Ergebnis ist leer.
cost error Der aktuelle Kreditumfang reicht nicht aus, um die Anfrage zu bearbeiten.
0k. Die Bearbeitung der Anfrage war erfolgreich.

Beispielcode

$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
 'service' =>'sea',
 'method' =>'getKeywords',
 'key' =>'myPersonalKey',
 'sengine' => 'google.de',
 'domain' => 'www.xovi.de',
 'format' =>'xml',
);
$GETparams = implode('/', $arrayParams);

$requestURL = $root.$GETparams;

if (!function_exists('curl_init')) die('cURL not available');

$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_URL, $requestURL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Download the given URL, and return output
$output = curl_exec($ch);

// Close the cURL resource, and free system resources
curl_close($ch);

echo $output;
?>

Beispielergebnisse

JSON

{
"apiErrorCode": 0,
"apiErrorMessage": "0k.",
"apiResult": [
    {
      "keyword": "abstrafung seo tool xovi",
      "position": "2"
    },
    {
      "keyword": "arbeiten mit xovi",
      "position": "1"
    },
]
}

XML

<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <keywords>
            <keyword>
                <keyword>abstrafung seo tool xovi</keyword>
                <position>2</position>
            </keyword>
            <keyword>
                <keyword>arbeiten mit xovi</keyword>
                <position>1</position>
            </keyword>
        </keywords>
    </apiResult>
</result>