Описание
Sape.ru Xml-RpcНаш xml-rpc интерфейс доступен по адресу http://api.sape.ru/xmlrpc/. Обращаться нужно по 80-му порту, тело xml-запроса класть в POST_DATA. Всё общение происходит полностью в кодировке UTF-8. Кроме того, можно работать по https по адресу https://api.sape.ru/xmlrpc/.
Если Вы ещё ничего не знаете про XML-RPC, то рекомендуем почитать на сайте www.xmlrpc.com:
- Реализация протокола для Вашего любимого языка программирования.
- Для любителей PHP рекомендуем Zend Framework
Функции
Описание
Авторизация в системе, необходимо вызывать в начале каждой сессии. Далее при каждом следующем запросе нужно передавать все вернувшиеся cookie. Результатом выполнения функции является id пользователя. Для генерации токена для своегоаккаунта перейдите на эту страницу.
Аргументы
Имя | Тип | Обязательно | Описание |
login | string | Да | Логин |
token | string | Да | Токен |
Возвращаемое значение
Тип | Описание |
int | ID пользователя |
Описание
Информация о пользователе.
Возвращаемое значение
Тип | Описание |
array | Информация о пользователе:
|
Описание
Текущий баланс пользователя, включая заблокированные средства.
Возвращаемое значение
Тип | Описание |
float | Текущий баланс пользователя, включая заблокированные средства. |
Описание
Доступный баланс пользователя.
Возвращаемое значение
Тип | Описание |
float | Доступный баланс пользователя. |
Описание
Текущий баланс с детализацией блокировок. Результат содержит информацию по балансу.
Возвращаемое значение
Тип | Описание |
array |
|
Описание
Данные по датам зачисления/поступления денег в разрезе каждого счета, по умолчанию выводятся счета аккаунтов привязанных к юрлицу, если такая связь есть, если нужно получить счета по конкретному аккаунту, то необходимо установить параметр user_id, если user_id == true, то выводится информация по текущему пользователю.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
year | int | Да | - | Год выборки |
month | int | Нет | null | Месяц выборки |
day | int | Нет | null | День выборки |
user_id | int | Нет | null | ID пользователя |
Возвращаемое значение
Тип | Описание |
array |
|
Описание
Список сайтов пользователя.
Аргументы
Имя | Тип | Обязательно | Описание |
opts | array | Нет | opts может содержать следующие параметры:
|
Возвращаемое значение
Тип | Описание |
array | Структура ответа:
|
Описание
Список регионов сайта.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
Возвращаемое значение
Тип | Описание |
array | Список регионов сайта. |
Описание
Cвойства страницы сайта.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
page_id | int | Да | ID страницы |
Возвращаемое значение
Тип | Описание |
Array | Cвойства страницы сайта. |
Описание
Возвращает список страниц сайта.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
opts | array | Нет | opts может содержать следующие параметры:
|
Возвращаемое значение
Тип | Описание |
array | Cписок страниц сайта. Структура ответа:
|
Описание
Активация страниц сайта.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
site_id | int | Да | - | ID сайта |
page_ids | int|array | Нет | - | ID страниц |
flag_context | bool | Нет | false | Если указано true, то будет активирована контекстная страница. В противном случае - обычная. |
Возвращаемое значение
Тип | Описание |
int | Количество активированных страниц. |
Описание
Исключение страниц сайта.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
site_id | int | Да | - | ID сайта |
page_ids | int|array | Да | - | ID страниц |
flag_context | bool | Нет | false | Если указано true, то будет активирована контекстная страница. В противном случае - обычная. |
Возвращаемое значение
Тип | Описание |
int | Количество исключенных страниц. |
Описание
Удаление страниц сайта.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
site_id | int | Да | - | ID сайта |
page_ids | int|array | Да | - | ID страниц |
flag_context | bool | Нет | false | Если указано true, то будет активирована контекстная страница. В противном случае - обычная. |
Возвращаемое значение
Тип | Описание |
int | Количество удаленных страниц. |
Описание
Ссылки сайта.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
opts | array | Нет | Может содержать следующие параметры:
|
Возвращаемое значение
Тип | Описание |
array | Список ссылок сайта. Структура ответа:
|
Описание
Количество ссылок по сайтам.
Аргументы
Имя | Тип | Обязательно | Описание |
status | string | Нет | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом. Возможные значения:
|
Возвращаемое значение
Тип | Описание |
array | Количество ссылок по сайтам. |
Описание
Количество страниц по сайтам.
Аргументы
Имя | Тип | Обязательно | Описание |
status | string | Нет | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом. Возможные значения:
|
Возвращаемое значение
Тип | Описание |
array | Количество страниц по сайтам. |
Описание
Количество страниц по одному сайту.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
status | string | Нет | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом. Возможные значения:
|
Возвращаемое значение
Тип | Описание |
int | Количество страниц по одному сайту. |
Описание
Количество контекстных страниц по сайтам.
Аргументы
Имя | Тип | Обязательно | Описание |
status | string | Нет | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом. Возможные значения:
|
Возвращаемое значение
Тип | Описание |
array | Количество контекстных страниц по сайтам. |
Описание
Количество контекстных страниц по одному сайту.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
status | string | Нет | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом. Возможные значения:
|
Возвращаемое значение
Тип | Описание |
int | Количество контекстных страниц по одному сайту. |
Описание
Статистика доходов по сайту.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
year | int | Нет | Год выборки |
month | int | Нет | Месяц выборки |
day | int | Нет | День выборки |
Возвращаемое значение
Тип | Описание |
array | Статистика доходов по сайту. |
Описание
Список проектов пользователя.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
show_deleted | bool|hash | Нет | - | Показывать удаленные. |
pn | int | Нет | 0 | Номер страницы (для пагинации). |
ps | int | Нет | 10000 | Количество элементов для вывода на странице (для пагинации). |
Возвращаемое значение
Тип | Описание |
array | Возможна передача параметров в виде хеша:
|
Описание
Параметры проекта пользователя.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
Возвращаемое значение
Тип | Описание |
array | Параметры проекта пользователя:
|
Описание
Изменение настроек проекта в соответствии с переданными параметрами.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
project_params | hash | Да | Возможные параметры:
|
Возвращаемое значение
Тип | Описание |
bool | Изменение настроек проекта в соответствии с переданными параметрами. |
Описание
Информация о УРЛе (включая удалённые).
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
url_id | int | Да | - | ID УРЛа |
show_deleted | bool | Нет | false | Если show_deleted == true, результат содержит:
|
Возвращаемое значение
Тип | Описание |
array | Информация о УРЛе (включая удалённые). |
Описание
Список УРЛов проекта (включая удалённые).
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
project_id | int | Да | - | ID проекта |
show_deleted | bool | Нет | false | Если show_deleted == true, каждый элемент содержит:
|
opts | array | Нет | - | Может содержать следующие параметры:
|
Возвращаемое значение
Тип | Описание |
array | Список УРЛов проекта (включая удалённые). |
Описание
Список ссылок УРЛ(a/ов).
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
url_id | int|array | Да | - | ID УРЛа |
status | string | Нет | - |
|
date_start | timestamp | Нет | - | Дата начала |
date_stop | timestamp | Нет | - | Дата окончания |
pn | int | Нет | 0 | Номер страницы (для пагинации). |
Возвращаемое значение
Тип | Описание |
array |
|
Описание
Список ID площадок, на которых куплены ссылки.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
Возвращаемое значение
Тип | Описание |
array | Список ID площадок, на которых куплены ссылки. |
Описание
Список ссылок проекта.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
project_id | int|array | Да | - | ID проекта |
status | string | Нет | - | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом. Возможные значения:
|
date_start | timestamp | Нет | - | Дата начала |
date_stop | timestamp | Нет | - | Дата окончания |
pn | int | Нет | 0 | Номер страницы (для пагинации). |
Возвращаемое значение
Тип | Описание |
array | Список ссылок проекта, каждый элемент содержит:
|
Описание
Количество ссылок по урлам.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int|array | Да | ID проекта |
status | string | Нет | Статус ссылки. При передаче в результатах отображается только ссылки с определённым статусом. |
date_start | timestamp | Нет | Дата начала |
date_stop | timestamp | Нет | Дата окончания |
Возвращаемое значение
Тип | Описание |
array | Количество ссылок по урлам. |
Описание
Список анкоров УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
Возвращаемое значение
Тип | Описание |
array | Список анкоров УРЛа, каждый элемент содержит:
|
Описание
Количество анкоров УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
Возвращаемое значение
Тип | Описание |
int | Количество анкоров УРЛа. |
Описание
Список количества анкоров по всем УРЛам.
Аргументы
Имя | Тип | Обязательно | Описание |
params | hash | Да | Возможные параметры вызова:
|
Возвращаемое значение
Тип | Описание |
array | Список количества анкоров по всем УРЛам. Результат содержит:
|
Описание
Текущий статус ссылки по ID.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
id | string | Да | - | ID ссылки |
check_sleep_balance | bool | Нет | false | Если указан флаг check_sleep_balance, то будет возвращён массив со следующими полями:
|
Возвращаемое значение
Тип | Описание |
string|array | Текущий статус ссылки по ID. |
Описание
Статистика расходов по УРЛу.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
year | int | Нет | Год выборки |
month | int | Нет | Месяц выборки |
day | int | Нет | День выборки |
Возвращаемое значение
Тип | Описание |
array | Статистика расходов по УРЛу. |
Описание
Статистика расходов по проекту.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
year | int | Нет | Год выборки |
month | int | Нет | Месяц выборки |
day | int | Нет | День выборки |
Возвращаемое значение
Тип | Описание |
array | Статистика расходов по проекту. |
Описание
Статистика расходов по всем проектам.
Аргументы
Имя | Тип | Обязательно | Описание |
year | int | Да | Год выборки |
month | int | Нет | Месяц выборки |
day | int | Нет | День выборки |
Возвращаемое значение
Тип | Описание |
array | Статистика расходов по всем проектам. |
Описание
Статистика изменений баланса.
Аргументы
Имя | Тип | Обязательно | Описание |
year | int | Да | Год выборки |
month | int | Нет | Месяц выборки |
day | int | Нет | День выборки |
Возвращаемое значение
Тип | Описание |
array | Статистика изменений баланса. |
Описание
Массив категорий сайтов.
Возвращаемое значение
Тип | Описание |
array | Массив категорий сайтов. |
Описание
Массив доменных зон.
Возвращаемое значение
Тип | Описание |
array | Массив доменных зон. |
Описание
Массив регионов.
Возвращаемое значение
Тип | Описание |
array | Массив доменных зон. |
Описание
Массив категорий YACA.
Возвращаемое значение
Тип | Описание |
array | Массив категорий YACA. |
Описание
Массив списков избранного.
Возвращаемое значение
Тип | Описание |
array | Массив списков избранного. |
Описание
Выбор сообщений по параметрам, указанным в ассоциированном массиве filter.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
pn | int | Нет | 0 | Номер страницы |
ps | int | Нет | 100 | Кол-во сообщений на странице. Может принимать следующие значения: 10,50,100,250,500,1000. |
filter | hash | Да | - | Возможные фильтры:
|
Возвращаемое значение
Тип | Описание |
array | Выбор сообщений по параметрам, указанным в ассоциированном массиве filter. Если что-то нашлось, то возвращается массив:
|
Описание
Одобрение ссылок вебмастером. Необходимо одобрять ссылки в статусе WAIT_WM. Массив не больше 100 элементов.
Аргументы
Имя | Тип | Обязательно | Описание |
ids | array | Да | ID ссылок |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество успешно одобренных. |
Описание
Получение новых цен ссылок проекта.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
project_id | int | Да | 0 | Если project_id == 0, активируется получение новых цен ссылок всех проектов. |
project_id | int | Нет | 30 | Кол-во дней, в течение которых цены были изменены. |
Возвращаемое значение
Тип | Описание |
array | Новые цены ссылок проекта. Возвращается массив, каждый элемент которого содержит:
|
Описание
Возвращается массив, каждый элемент которого содержит:
- ID проекта
- ID раздела
- название раздела
Возвращаемое значение
Тип | Описание |
array |
|
Описание
Возвращается массив, каждый элемент которого содержит:
- ID сайта
- ID раздела
- название раздела
Возвращаемое значение
Тип | Описание |
array |
|
Описание
Изменение настроек сайта в соответствии с переданными параметрами.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
site_params | hash | Да | Возможные параметры:
|
Возвращаемое значение
Тип | Описание |
array | Изменение настроек сайта в соответствии с переданными параметрами. |
Описание
Перенос проекта в другой раздел.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
folder_id | int | Да | ID директории |
Возвращаемое значение
Тип | Описание |
bool | Перенос проекта в другой раздел. |
Описание
Перенос сайта в другой раздел.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
folder_id | int | Да | ID директории |
Возвращаемое значение
Тип | Описание |
bool | Перенос сайта в другой раздел. |
Описание
Получение заявок на смену текста.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Нет | Если задан site_id, то только для сайта, иначе для всех сайтов пользователя. |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив, каждый элемент которого содержит:
|
Описание
Удаление ссылки по ID.
Аргументы
Имя | Тип | Обязательно | Описание |
id | string | Да | ID ссылки |
Возвращаемое значение
Тип | Описание |
bool | Удаление ссылки по ID |
Описание
Удаление ссылок по массиву ID.
Аргументы
Имя | Тип | Обязательно | Описание |
ids | array | Да | Массив ID |
Возвращаемое значение
Тип | Описание |
array | Возвращает массив ID успешно удалённых. Массив не больше 100 элементов. |
Описание
Одобрение заявок на смену текста.
Аргументы
Имя | Тип | Обязательно | Описание |
pl_ids | array | Да | список ID ссылок |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив с ID новых ссылок в том же порядке как и на входе. |
Описание
Отклонение заявок на смену текста.
Аргументы
Имя | Тип | Обязательно | Описание |
pl_ids | array | Да | список ID ссылок |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив с ID новых ссылок в том же порядке как и на входе. |
Описание
Поиск сайтов и страниц для УРЛа url_id по параметрам, указанным в ассоциированном массиве filter.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
url_id | int | Да | - | ID УРЛа |
filter | hash | Да | - | Возможные фильтры:
|
pn | int | Нет | 0 | Номер страницы (для пагинации). |
ps | int | Нет | 100 | Кол-во сообщений на странице. |
Возвращаемое значение
Тип | Описание |
array | Если что-то нашлось, то возвращается массив, каждый элемент которого содержит:
|
Описание
Размещение новой ссылки.
Аргументы
Имя | Тип | Обязательно | Описание |
page_id | int | Да | ID страницы |
url_id | int | Да | ID УРЛа |
anchor | string | Да | Если anchor число, то выбирается текст из БД текстов по ID==anchor. Если anchor==0, то берётся следующий неиспользованный текст. |
params | hash | Нет | Возможные параметры:
|
Возвращаемое значение
Тип | Описание |
string | Размещение новой ссылки. |
Описание
Размещение новых ссылок.
Аргументы
Имя | Тип | Обязательно | Описание |
placements | hash | Да | Массив placements (не больше 100 элементов) надо составлять следующим образом:
|
Возвращаемое значение
Тип | Описание |
array | В случае успеха возвращается массив с ID ссылок или описаниями ошибок. |
Описание
Изменение URL ссылки. Перенос ссылок возможен только между URL-ами одного домена.
Аргументы
Имя | Тип | Обязательно | Описание |
id | string | Да | ID ссылки |
url_id | int | Да | ID УРЛа |
Возвращаемое значение
Тип | Описание |
int | Изменение URL ссылки. Перенос ссылок возможен только между URL-ами одного домена. |
Описание
Обновление текста ссылки.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
ID | string | Да | - | ID ссылки |
anchor | string | Да | - | Если anchor число, то выбирается текст из БД текстов по ID==anchor. Если anchor==0, то берётся следующий неиспользованный текст. |
action_reject | int | Нет | 1 | Действие при отказе вебмастера сменить текст: 1 - оставить ссылку, 2 - снять ссылку. |
Возвращаемое значение
Тип | Описание |
text|bool | В случае успеха возвращает ID ссылки с новым текстом или true если добавлена заявка на смену текста. |
Описание
Фоновое обновление текстов ссылок.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
pl_anchor | hash | Да | - | pl_anchor — ключами данного массива должны быть идентификаторы ссылок в виде строки, а значениями тексты или идентификаторы анкоров:array ((string) pl_id => (string) anchor, ...); |
action_reject | int | Нет | 1 | Действие при отказе вебмастера сменить текст: 1 - оставить ссылку, 2 - снять ссылку. |
Возвращаемое значение
Тип | Описание |
string | Возвращает указатель на задание (handler). |
Описание
Одобрение ссылки оптимизатором. Необходимо одобрять ссылки в статусе WAIT_SEO.
Аргументы
Имя | Тип | Обязательно | Описание |
id | string | Да | ID ссылки |
Возвращаемое значение
Тип | Описание |
bool | Одобрение ссылки оптимизатором |
Описание
Одобрение ссылок оптимизатором. Необходимо одобрять ссылки в статусе WAIT_SEO.
Аргументы
Имя | Тип | Обязательно | Описание |
ids | array | Да | Массив ID ссылок. Массив не больше 100 элементов. |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив, каждый элемент которого содержит:
|
Описание
Заморозка всех ссылок УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив со статистикой:
|
Описание
Заморозка всех ссылок всех УРЛов проекта.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
Возвращаемое значение
Тип | Описание |
bool | Заморозка всех ссылок всех УРЛов проекта. |
Описание
Разморозка всех ссылок УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает количество успешно размороженных ссылок. |
Описание
Заморозка ссылки или группы ссылок.
Аргументы
Имя | Тип | Обязательно | Описание |
placement_ids | array|string | Да | ID ссылки или группы ссылок. |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает количество успешно замороженных ссылок. |
Описание
Разморозка ссылки или группы ссылок.
Аргументы
Имя | Тип | Обязательно | Описание |
placement_ids | array|string | Да | ID ссылки или группы ссылок. |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает количество успешно размороженных ссылок. |
Описание
Отказ от всех ссылок УРЛа (если не указан статус, будут удалены все).
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
status | string | Нет | Если не указан статус, будут удалены все |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает количество успешно удалённых заявок. |
Описание
Отказ от всех WAIT ссылок УРЛа (WAIT_SEO и WAIT_WM).
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает количество успешно удалённых заявок. |
Описание
Одобрение новых цен ссылок в конце срока.
Аргументы
Имя | Тип | Обязательно | Описание |
pl_ids | array | Да | ID ссылок |
Возвращаемое значение
Тип | Описание |
bool | Одобрение новых цен ссылок в конце срока. |
Описание
Отклонение новых цен ссылок в конце срока.
Аргументы
Имя | Тип | Обязательно | Описание |
pl_ids | array | Да | ID ссылок |
Возвращаемое значение
Тип | Описание |
bool | Отклонение новых цен ссылок в конце срока. |
Описание
Создание нового проекта.
Аргументы
Имя | Тип | Обязательно | Описание |
name | string | Да | Имя проекта |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает ID созданного проекта. |
Описание
Удаление проекта.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
Возвращаемое значение
Тип | Описание |
bool | Удаление проекта. |
Описание
Добавление в проект нового УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
url | string | Да | URL |
name | string | Нет | Имя УРЛа |
keyword | string | Нет | Ключевое слово |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает ID созданного УРЛа. |
Описание
Изменение настроек УРЛа в соответствии с переданными параметрами.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
params | hash | Да | Возможные параметры:
|
Возвращаемое значение
Тип | Описание |
bool | Изменение настроек УРЛа. |
Описание
Удаление УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
Возвращаемое значение
Тип | Описание |
bool | Удаление УРЛа. |
Описание
Добавление для УРЛа нового текста.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
anchor | string | Да | Анкор |
params | hash | Нет | Возможные параметры:
|
Возвращаемое значение
Тип | Описание |
string | В случае успеха возвращает ID нового текста, который можно в дальнейшем использовать при создании новых ссылок и смене текстов. |
Описание
Добавление для УРЛа новых текстов.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
anchor | array | Да | Анкоры |
params | hash | Нет | Возможные параметры:
|
Возвращаемое значение
Тип | Описание |
array | Возвращает массив ID успешно добавленных текстов или массив с ID и Ошибками (см. параметр return_errors), которые можно в дальнейшем использовать при создании новых ссылок и смене текстов. |
Описание
Удаление текста из базы текстов УРЛа (можно указывать id или непосредственно строку).
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
anchor | string | Да | Анкор |
Возвращаемое значение
Тип | Описание |
bool | В случае успеха возвращает true, если такого текста нет — ошибка. |
Описание
Удаление всех текстов (или заданных текстов, если задан anchor_ids) из базы текстов УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
anchor_ids | array | Нет | Массив id анкоров в виде строк. |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает количество удалённых текстов. |
Описание
Изменение режима модерации УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
url_id | int | Да | ID УРЛа |
flag_auto | bool | Да | flag_auto == false — ручной, (flag_auto == true && flag_require_confirm == false) — автоматический, (flag_auto == true && flag_require_confirm == true) — полуавтоматический. |
flag_require_confirm | bool | Да | flag_auto == false — ручной, (flag_auto == true && flag_require_confirm == false) — автоматический, (flag_auto == true && flag_require_confirm == true) — полуавтоматический. |
Возвращаемое значение
Тип | Описание |
bool | Изменение режима модерации УРЛа. |
Описание
Добавление доменов в черный список проекта. Возвращает количество успешно добавленных.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
project_id | int | Да | - | ID проекта |
domains | array | Да | - | Домены |
auto_remove_placements | bool | Нет | true | Удалять ли ссылки с этим доменом после помещения домена в ГБЛ |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество успешно добавленных доменов в черный список проекта. |
Описание
Удаление доменов из черного списка проекта.
Аргументы
Имя | Тип | Обязательно | Описание |
project_id | int | Да | ID проекта |
domains | array | Да | Домены |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество успешно удаленных. |
Описание
Получение доменов черного списка проекта.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
project_id | int | Да | - | ID проекта |
pn | int | нет | 0 | Номер страницы (для пагинации). |
ps | int | нет | 100 | Количество элементов для вывода на странице (для пагинации). |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив, каждый элемент которого содержит:
|
Описание
Добавление доменов в глобальный черный список.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
domains | array | Да | - | Домены |
auto_remove_placements | bool | Нет | true | Удалять ли ссылки с этим доменом после помещения домена в ГБЛ |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество успешно добавленных. |
Описание
Удаление доменов из глобального черного списка.
Аргументы
Имя | Тип | Обязательно | Описание |
domains | array | Да | Домены |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество успешно удаленных. |
Описание
Получение доменов ГБЛ.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
pn | int | Нет | 0 | Номер страницы (для пагинации). |
ps | int | Нет | 100 | Количество элементов для вывода на странице (для пагинации). |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив, каждый элемент которого содержит:
|
Описание
Добавление доменов в раздел/разделы избранного.
Аргументы
Имя | Тип | Обязательно | Описание |
domains | array | Да | Домены |
wl_ids | int/array | Да | ID раздела/разделов избранного |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество успешно добавленных. |
Описание
Удаление доменов из раздела/разделов избранного.
Аргументы
Имя | Тип | Обязательно | Описание |
domain_ids | array | Да | ID доменов |
wl_ids | int/array | Да | ID раздела/разделов избранного |
Возвращаемое значение
Тип | Описание |
bool | Удаление доменов из раздела/разделов избранного. |
Описание
Получение доменов раздела избранного.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
wl_id | int | Да | - | ID раздела избранного. |
pn | int | Нет | 0 | Номер страницы (для пагинации). |
ps | int | Нет | 100 | Количество элементов для вывода на странице (для пагинации). |
Возвращаемое значение
Тип | Описание |
array | Возвращается массив, каждый элемент которого содержит:
|
Описание
Добавление раздела избранного.
Аргументы
Имя | Тип | Обязательно | Описание |
domain | string | Да | Домен |
Возвращаемое значение
Тип | Описание |
int | В случае успеха возвращает ID нового раздела избранного. |
Описание
Удаление раздела избранного.
Аргументы
Имя | Тип | Обязательно | Описание |
wl_id | int | Да | ID списка избранного. |
Возвращаемое значение
Тип | Описание |
bool | Удаление раздела избранного. |
Описание
Получение статистики расходов по УРЛам за период времени. Ограничения:
- выборка статистики за период не более года (т.е. параметр yearнужно обязательно указывать);
- не более 500 идентификаторов УРЛов.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
url_ids | array | Да | - | ID УРЛов |
year | int | Да | - | Год |
month | int | Нет | null | Месяц |
day | int | Нет | null | Месяц |
Возвращаемое значение
Тип | Описание |
array | Возвращает массив статистики расходов, который имеет следующую структуру:
|
Описание
Добавление фильтра с параметрами указанными в ассоциированном массиве filter.
Аргументы
Имя | Тип | Обязательно | Описание |
filter_name | string | Да | Имя фильтра |
filter | hash | Да | Возможные фильтры:
|
Возвращаемое значение
Тип | Описание |
int | Если добавилось успешно, то возвращает ID фильтра. |
Описание
Изменение параметров фильтра.
Аргументы
Имя | Тип | Обязательно | Описание |
filter_id | int | Да | ID фильтра |
new_filter | hash | Да | см. выше, + filter_name; |
Возвращаемое значение
Тип | Описание |
bool | Изменение параметров фильтра. |
Описание
Удаление фильтра.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
filter_id | int | Да | - | ID фильтра |
filter_id | bool | Нет | false | Если параметр force_delete == true, то удаляет все автофильтры которые привязаны к фильтру, в противном случае выполняет проверку есть ли автофильтры и если есть, то не будет удалять фильтр. |
Возвращаемое значение
Тип | Описание |
bool | Удаление фильтра. |
Описание
Создание авто-фильтра для урла.
Аргументы
Имя | Тип | Обязательно | Описание |
filter_id | int | Да | ID фильтра |
url_id | int | Да | ID УРЛа |
quant | int | Да | Количество |
price | int | Да | Цена |
daily_quota | int | Да | Дневная квота |
Возвращаемое значение
Тип | Описание |
int | Если добавилось успешно, то возвращает ID авто-фильтра. |
Описание
Изменение авто-фильтра для УРЛа.
Аргументы
Имя | Тип | Обязательно | Описание |
filter_auto_id | int | Да | ID авто-фильтра |
quant | int | Да | Количество |
price | int | Да | Цена |
daily_quota | int | Да | Дневная квота |
Возвращаемое значение
Тип | Описание |
bool | Изменение авто-фильтра для УРЛа. |
Описание
Удаление авто-фильтра.
Аргументы
Имя | Тип | Обязательно | Описание |
filter_auto_id | int | Да | ID авто-фильтра |
Возвращаемое значение
Тип | Описание |
bool | Удаление авто-фильтра. |
Описание
Получение списка фильтров.
Аргументы
Имя | Тип | Обязательно | Описание |
opts | array | Нет | opts может содержать следующие параметры:
|
Возвращаемое значение
Тип | Описание |
array | Список фильтров, если указан параметр show_params, то возвращает параметры фильтра в виде хэша. |
Описание
Получение списка автофильтров для урла или списка урлов.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
url_id | int/array | Да | - | ID УРЛа/УРЛов |
show_budget | bool | Нет | false | Если show_budget = true, добавляются следующие поля:
|
Возвращаемое значение
Тип | Описание |
array | Возвращается массив, каждый элемент которого содержит:
|
Описание
Добавление списка доменов в BL или GBL.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
$domains | array | Да | - | Массив доменов, не более 100 элементов. |
site_id | int | Нет | 0 | Если site_id == 0 - добавление списка доменов в GBL. |
Возвращаемое значение
Тип | Описание |
int | Возвращает кол-во добавленных доменов. |
Описание
Удаление списка доменов в BL или GBL.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
$domains | array | Да | - | Массив доменов, не более 100 элементов. |
site_id | int | Нет | 0 | Если site_id == 0 - удаление списка доменов в GBL. |
Возвращаемое значение
Тип | Описание |
int | Возвращает кол-во удаленных доменов. |
Описание
Установка максимального количества ссылок. Увеличивать максимальное количество ссылок можно не чаще чем 1 раз в 2 недели.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
params | hash | Да | Возможные параметры:
|
Возвращаемое значение
Тип | Описание |
bool | Возвращает false если количество для всех уровней не изменилось и true в противоположном случае. |
Описание
Изменение цены страницы.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
site_id | int | Да | - | ID сайта |
page_id | int | Да | - | ID страницы |
price | float | Да | - | Цена |
force | float | Нет | false | Если force = true - обновятся цены на проданные ссылки. |
Возвращаемое значение
Тип | Описание |
bool | Изменение цены страницы. |
Описание
Изменение цены страницы.
Аргументы
Имя | Тип | Обязательно | Значение по умолчанию | Описание |
site_id | int | Да | - | ID сайта |
level | int | Да | - | Уровень вложенности |
pr | int | Да | - | Может принимать значение 'all' если необходимо установить одну цену для определенного уровня вложенности. |
price | float | Да | - | Цена |
force | float | Нет | false | Если force = true - обновятся цены на проданные ссылки. |
Возвращаемое значение
Тип | Описание |
bool | Изменение цены страницы. |
Описание
Фоновое удаление ссылок.
Аргументы
Имя | Тип | Обязательно | Описание |
pl_ids | array | Да | ID ссылок |
Возвращаемое значение
Тип | Описание |
string | Возвращает указатель на задание (handler). |
Описание
Получение статуса задания по указателю.
Аргументы
Имя | Тип | Обязательно | Описание |
handler | string | Да | Указатель на задание. |
Возвращаемое значение
Тип | Описание |
struct | Возвращает массив, содержащий следующие поля:
|
Описание
Удаление площадки из системы.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
Возвращаемое значение
Тип | Описание |
int | Удаленная площадка из системы. |
Описание
Получение списков стоп-слов пользователя.
Возвращаемое значение
Тип | Описание |
array | Возвращает массив хешей, содержащий следующие поля:
|
Описание
Получение массива идентификаторов списков стоп-слов сайта.
Аргументы
Имя | Тип | Обязательно | Описание |
site_id | int | Да | ID сайта |
Возвращаемое значение
Тип | Описание |
array | Массив идентификаторов списков стоп-слов сайта. |
Описание
Добавление списка стоп-слов.
Аргументы
Имя | Тип | Обязательно | Описание |
name | string | Да | Имя |
words | string | Да | Стоп-слова |
Возвращаемое значение
Тип | Описание |
int | Возвращает идентификатор созданного списка. |
Описание
Изменение списка стоп-слов.
Аргументы
Имя | Тип | Обязательно | Описание |
list_id | id | Да | ID списка |
name | string | Да | Имя списка |
words | string | Да | Стоп-слова |
Возвращаемое значение
Тип | Описание |
void | Изменение списка стоп-слов. |
Описание
Удаление списка стоп-слов.
Аргументы
Имя | Тип | Обязательно | Описание |
list_id | id | Да | ID списка |
Возвращаемое значение
Тип | Описание |
bool | Удаление списка стоп-слов. |
Описание
Добавление стоп-слов к списку.
Аргументы
Имя | Тип | Обязательно | Описание |
list_id | id | Да | ID списка |
words | string | Да | Стоп-слова |
Возвращаемое значение
Тип | Описание |
void | Добавление стоп-слов к списку. |
Описание
Удаление стоп-слов из списка.
Аргументы
Имя | Тип | Обязательно | Описание |
list_id | id | Да | ID списка |
words | string | Да | Стоп-слова |
Возвращаемое значение
Тип | Описание |
void | Удаление стоп-слов из списка. |
Описание
Привязка списков стоп-слов к сайту.
Аргументы
Имя | Тип | Обязательно | Описание |
list_ids | array | Да | ID списков стоп-слов |
site_id | int | Да | ID сайта |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество привязанных списков. |
Описание
Удаление связей списков стоп-слов и сайта.
Аргументы
Имя | Тип | Обязательно | Описание |
list_ids | array | Да | ID списков стоп-слов |
site_id | int | Да | ID сайта |
Возвращаемое значение
Тип | Описание |
int | Возвращает количество удаленных связей. |