Справочная система

Содержание справки
 

CreateProject
Создание нового проекта.

Входные данные

Структура данных в формате JSON для переменной param:
{
   "ProjectName": (string),
   "DirectoryID": (int),
   "ProjectCheckMode": (int),
   "ProjectCheckDay": (string),
   "ProjectCheckHour": (int),
   "GroupName": (string),
   "Domains": [
      (string)
      ...
   ],
   "Searchers": [
      (string)
      ...
   ],
   "Phrases": [
      (string)
      ...
   ]
}

Описание параметров:
ПараметрОписаниеОбязательный
ProjectName Название проекта. Если параметр передан пустым, название будет создано автоматически. Да
DirectoryID Идентификатор раздела. При указании данного параметра, проект будет прикреплен к указанному разделу. Список разделов можно получить при помощи GetDirectoryList. Нет
ProjectCheckMode Режим проверки:
• 1 - каждый день;
• 2 - еженедельно;
• 0 - только по требованию.
Да
ProjectCheckDay Содержит номера дней недели в которые нужно запускать проверку, например "13457". Номера должны быть расположены по возрастанию. Используется только для режима еженедельной проверки, в остальных режимах этот параметр должен передаваться пустым. Да
ProjectCheckHour Время проверки. Доступны значения с 1 до 20 часов. Для проверки по требованию данный параметр должен быть равен нулю. Да
GroupName Название группы. Если параметр передан пустым, название будет создано автоматически. Да
Domains Массив доменов проверяемого сайта. Первый домен - основной (обязательно), второй и далее - алиасы (необязательно). Да
Searchers Массив поисковых систем и регионов. Каждый элемент массива представляет собой строку типа "[домен поисковой системы] - [регион]". Да
Phrases Массив поисковых фраз. Да

Пример структуры переменной param для PHP:
array(
   "ProjectName" => "Новый проект",
   "DirectoryID" => 1543,
   "ProjectCheckMode" => 2,
   "ProjectCheckDay" => "12345",
   "ProjectCheckHour" => 11,
   "GroupName" => "Новая группа",
   "Domains" => array(
      "site.com",
      "site.ru"
   ),
   "Searchers" => array(
      "Yandex.ru - Москва",
      "Yandex.ru - Санкт-Петербург"
   ),
   "Phrases" => array(
      "поисковая фраза 1",
      "поисковая фраза 2",
      "и еще одна поисковая фраза"
   )
)

Результирующие данные

При успешном выполнении, метод возвращает объект в формате JSON. Структура результирующих данных:
{
   "data": {
         "ProjectID": (int),
         "Result": (string),
         "Description": (string)
   },
   "error": 0
}

Описание параметров:
ПараметрОписание
ProjectID Идентификатор проекта.
Result Результат создания проекта:
• success - проект создан;
• error - проект не создан.
Description Текстовое описание результата создания проекта.
 
» Остались вопросы?
Обратиться в службу поддержки
Наверх   
Наверх