addMonitoringKeywords

Fügt Keywords zum Monitoring hinzu.

Route /keywords/addMonitoringKeywords[/:key[/:format]]
Erforderliche Parameter projhash
domains
searchengines
devices
checkdays
keywords
Optionale Parameter ignoreUSearch
createNote
date
labelids 
Rückgabewerte  name
Querschnittverbindungen getProjects (projhash, domains)
getSearchengines (serchengines)
getLabels (labelids)
Hinweise Parameter, die nicht in der Route enthalten sind, werden per POST versendet.

Parameter

Bezeichnung Beschreibung Wertebereich Standardwert
 projhash  Enthält eine Projektid. (siehe getProjects)  (a-z|0-9){32}  –
 domains  Enthält ein array von domain-hashes. (siehe getProjects)  (a-z|0-9)+  –
 searchengines  Enthält ein array mit searchengine-ids. (siehe getSearchengines)  (0-9)+  –
 devices  Enthält ein array mit device-ids.
1 – PC
2 – Tablet
3 – Handy
 –
 checkdays Enthält ein array mit den Wochentagen, an denen gecrawled werden soll. (mo|tu|we|th|fr|sa|su)  –
 keywords
Enthält ein array mit Keywords, die gecrawled werden sollen.  (A-Z|a-z|0-9)+  –
 ignoreUSearch Aktiviert bei Übergabe ignoreUSearch.  true (wird der parameter nicht gesetzt, entspricht das einem false)  false
 createNote Versendet bei Übergabe eine Nachricht an den Xovi Kalender   true (wird der parameter nicht gesetzt, entspricht das einem false)  false
 date Datum, an dem das crawling beginnen soll.  YYYY-MM-DD sofort
 labelids Enthält ein array mit den ids der Labels, die mit dem crawling assoziiert werden sollen. (siehe getLabels).
Es können nur Labels der Kategorie ‚keywords‘ angehängt werden.
 (a-z|0-9)+  –

Rückgabewerte

Bezeichnung Beschreibung Wertebereich
name Enthält die Bezeichnung des angelegten Keywords. (A-Z|a-z|0-9)+

Meldungen

Nachricht Beschreibung
no permission Mit diesem Schlüssel ist der Zugriff auf die Funktion nicht erlaubt.
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.
crawl limit reached Es können keine Keywords mehr angelegt werden, weil nicht genügend Monitoring Credits vorhanden sind.

Beispielcode

$root = 'https://suite.xovi.net/api/';

$arrayPath = array(
'service' =>'keywords',
'method' =>'addMonitoringKeywords',
'key' =>'myApiKey',
'format' => 'json',
);
$pathString = implode('/', $arrayPath);
$requestURL = $root.$pathString;

//build POST query
$arrayParams = array(
       'projhash' => '1234567bafc4295231f897911fb44731',
       'domains' => array('123456708a6843e0'),
       'searchengines' => array(1),
       'devices' => array( 1, 2),
       'checkdays' => array( 'mo', 'tu'),
       'keywords' => array ( 'myKeyword'),
	   'date' => '2999-12-12',
	   'labelids' => Array
        (
            0 => 'asdfkaaa',
            1 => 'asdfkbbb'
       )
);
$paramsString = http_build_query($arrayParams);

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);
//setup POST
curl_setopt($ch,CURLOPT_POST, count($arrayParams));
curl_setopt($ch,CURLOPT_POSTFIELDS, $paramsString);

$output = curl_exec($ch);

curl_close($ch);

echo $output;

Beispielergebnisse

JSON

{
    "apiErrorCode":0,
    "apiErrorMessage":"0k.",
    "apiResult":[
        {
            "name":"myKeyword"
        }]
}

XML

<?xml version="1.0"?>
<result>
    <apiErrorCode>0</apiErrorCode>
    <apiErrorMessage>0k.</apiErrorMessage>
    <apiResult>
        <projects>
            <project>
                <name>myKeyword</name>
            </project>
        </projects>
    </apiResult>
</result>