all remove_links(array) => LinkfeedStruct::RemoveOut []

Удаляет ссылки на основе их идентификаторов

Метод принимает следующие аргументы

array:int[] - список идентификаторов (id) ссылок

all remove_links_async(links_ids) => LinkfeedStruct::StatusWithError

Асинхронно удаляет ссылки на основе их идентификаторов

Метод принимает следующие аргументы

links_ids:int[] - список идентификаторов (id) ссылок

all remove_links_with_reason(array) => LinkfeedStruct::RemoveOut []

Удаляет ссылки на основе их идентификаторов

Метод принимает следующие аргументы

array:LinkfeedStruct::LinkWithReason(link_id,reason_code)[] - список объектов типа LinkWithReason содержащих id ссылки и причину удаления текстом

settings get_balance => double

Возвращает баланс пользователя

Метод принимает следующие аргументы

Нет аргументов

settings get_currencies => LinkfeedStruct::Currency []

Возвращает список доступных в системе тем и их идентификаторы для указанного языка

Метод принимает следующие аргументы

Нет аргументов

settings get_languages => LinkfeedStruct::Language []

Возвращает список доступных в системе языков и их идентификаторы

Метод принимает следующие аргументы

Нет аргументов

settings get_themes(language_id) => LinkfeedStruct::Theme []

Возвращает список доступных в системе тем и их идентификаторы для указанного языка

Метод принимает следующие аргументы

language_id:int - идентификатор языка для которого возвращается список тем

settings get_user_transactions(begin_date, end_date) => LinkfeedStruct::UserTransactionOut

Получить транзакции пользователя.

Метод принимает следующие аргументы

begin_date:date - начало периода
end_date:date - конец периода

• Возвращается массив пользовательских транзакий

opt add_anchors(url_id, anchors_data, allow_duplicates) => LinkfeedStruct::Anchor []

Добавляет несколько анкоров к указанному URL площадки

Метод принимает следующие аргументы

url_id:int - идентификатор URL
anchors_data:LinkfeedStruct::AnchorData[] - параметры анкора
allow_duplicates:bool - разрешить создавать дубликаты анкоров

• Ничего не возвращает если URL не найден

opt add_anchors_async(url_id, anchors_data, allow_duplicates) => LinkfeedStruct::StatusWithError

Асинхронно добавляет несколько анкоров к указанному URL площадки

Метод принимает следующие аргументы

url_id:int - идентификатор URL
anchors_data:LinkfeedStruct::AnchorData [] - параметры анкора
allow_duplicates:bool - разрешить создавать дубликаты анкоров

• Возвращает “url not found” если указанный URL не существует

opt add_filter(struct) => integer

Создаёт новый фильтр для поиска площадок

Метод принимает следующие аргументы

struct:LinkfeedStruct::FilterIn - параметры фильтра

• Если фильтр создан успешно возвращается его идентификатор (id), в случае ошибки возвращается 0

opt add_project(struct) => integer

Создаёт новый проект в системе.

Метод принимает следующие аргументы

struct:LinkfeedStruct::ProjectIn - структура в которой находится информация необходимая для создания проекта

• Если проект создан успешно возвращается его идентификатор (id), в случае ошибки возвращается 0

opt add_url(project_id, uri) => integer

Добавляет URL в проект

Метод принимает следующие аргументы

project_id:int - идентификатор проекта
url:string - Добавляемый URL адрес (например http://linkfeed.ru)

• Возвращает идентификатор (id) добавленного URL или 0 если при добавлении возникла ошибка

opt add_url_filter(struct) => integer

Создание нового URL фильтра

Метод принимает следующие аргументы

filter:LinkfeedStruct::UrlFilterIn - структура с новыми параметрами URL фильтра

• Возвращается 0 в случае ошибки или идентификатор фильтра в случае успеха

opt add_url_with_name(project_id, uri, name) => integer

Добавляет URL проекта и название для него в проект

Метод принимает следующие аргументы

project_id:int - идентификатор (id) проекта
url:string - Добавляемый URL адрес (например http://linkfeed.ru)
name:string - Название URL адреса (например Биржа ссылок Linkfeed)

• Возвращает идентификатор (id) добавленного URL или 0 если при добавлении возникла ошибка

opt add_urls_async(project_id, urls) => LinkfeedStruct::StatusWithError

Асинхронно добавляет URL-ы в проект

Метод принимает следующие аргументы

project_id:int - идентификатор (id) проекта
urls:LinkfeedStruct::UrlData [] - массив с параметрами добавляемых URL

• Возвращает “project not found” если указанный проект не существует

opt approve_links(links) => LinkfeedStruct::StatusWithError

Асинхронно подтверждает указанные ссылки

Метод принимает следующие аргументы

links:string [] - массив идентификаторов ссылок

opt buy_links(array) => LinkfeedStruct::BuyOut

Покупает ссылки основываясь на их критериях передаваемых в аргументах и возвращает массив в котором содержится идентификатор ссылки и её статус

Метод принимает следующие аргументы

array:LinkfeedStruct::BuyIn - список параметров для поиска списка ссылок

Результаты работы

link_id > 0 && status == 'OK' - покупка прошла успешно
link_id == 0 && status != 'OK' - покупка не удалась, смотри виды статусов

Виды статусов

WRONG_PROJECT_ID - не правильный идентификатор проекта
WRONG_PAGE_ID - не правильный идентификатор страницы
WRONG_URL - не корректный url
WRONG_ANCHOR - не корректный анкор
DEARNESS - непозволительная цена (возникает, при указании параметра max_price при покупке и неожиданном увеличении цены выставленной веб мастером)

opt Доступ к данному методу ограничен см. раздел Методы с ограниченным доступом на главной странице для дополнительной информации

change_anchors(array) => LinkfeedStruct::AnchorOut []

Меняет параметры ссылок

Метод принимает следующие аргументы

array:LinkfeedStruct::AnchorIn [] - список идентификаторов (id) ссылок

opt create_platform_gbl(site) => LinkfeedStruct::StatusWithError

Добавляет URL платформы (новой или уже существующей) в список заблокированных платформ. В дальнейшем, платформы находящиеся в этом списке не будут участвовать поиске ссылок для всех ваших url. Добавление происходит асинхронно.

Метод принимает следующие аргументы

site:string - URL адрес платформы (например http://badsite.ru)

• Если пользователь пытается повторно добавить платформу которая уже имеется глобальном черном списке, то возвращается ошибка “platform is already created“
• Если URL адрес указан неверно возвращается ошибка “invalid sitename“
• Если пользователь не указал URL возвращается ошибка “sitename is blank“

opt create_platform_gbls(string[]) => LinkfeedStruct::StatusWithError

Добавляет URL платформы (новой или уже существующей) в список заблокированных платформ. В дальнейшем, платформы находящиеся в этом списке не будут участвовать поиске ссылок для всех ваших url. Добавление происходит асинхронно.

Метод принимает следующие аргументы

sites:string[] - URL адрес платформ (например array('badsite.ru'))

opt create_platform_lbl(site, url_id) => LinkfeedStruct::StatusWithError

Добавляет URL платформы (новой или уже существующей) в список заблокированных платформ. В дальнейшем, платформы находящиеся в этом списке не будут участвовать поиске ссылок для всех ваших url. Добавление происходит асинхронно.

Метод принимает следующие аргументы

site:string - URL адрес платформы (например http://badsite.ru)
url_id:int - id урла

• Если пользователь пытается повторно добавить платформу которая уже имеется локальном черном списке, то возвращается ошибка “platform is already created“
• Если URL адрес указан неверно возвращается ошибка “invalid sitename“
• Если пользователь не указал URL возвращается ошибка “sitename is blank“

opt create_platform_lbls(LinkfeedStruct::LblIn[]) => LinkfeedStruct::StatusWithError

LinkfeedStruct::LblIn описывает элемент с site и url_id

Добавляет URL платформы (новой или уже существующей) в список заблокированных платформ. В дальнейшем, платформы находящиеся в этом списке не будут участвовать поиске ссылок для всех ваших url. Добавление происходит асинхронно.

Метод принимает следующие аргументы

array:LblIn[] - массив url-site

opt create_platform_wl(site) => LinkfeedStruct::StatusWithError

Добавляет URL платформы (новой или уже существующей) в список избранных платформ. В дальнейшем, платформы находящиеся в этом списке, могут быть использованы как дополнительное ограничение при поиске площадок.

Метод принимает следующие аргументы

site:string - URL адрес платформы (например http://linkfeed.ru)

• Если пользователь пытается повторно добавить платформу которая уже имеется в избранном, то возвращается ошибка “platform is already created“
• Если URL адрес указан неверно возвращается ошибка “invalid sitename“
• Если пользователь не указал URL возвращается ошибка “sitename is blank“

opt create_platform_wl_group(name) => LinkfeedStruct::StatusWithError

Создает группу избранного

Метод принимает следующие аргументы

name:string - Имя группы избранного (например Избранное)

• Если пользователь пытается повторно добавить группу которая уже существует, то возвращается ошибка “group is already created“
• Если пользователь не указал имя группы возвращается ошибка “name is blank“

opt create_platform_wl_new(sites, group) => LinkfeedStruct::StatusWithError

Добавляет URL платформы (новой или уже существующей) в список избранных платформ. В дальнейшем, платформы находящиеся в этом списке, могут быть использованы как дополнительное ограничение при поиске площадок.

Метод принимает следующие аргументы

sites:string[] - URL адреса платформ (например http://linkfeed.ru)
group:string - Имя группы избранного (например Избранное)

• Если пользователь не указал URL возвращается ошибка “sitename is blank“
• Если пользователь не указал имя группы возвращается ошибка “groupname is blank“
• Если пользователь не указал имя несуществующей группы возвращается ошибка “no such group“

 Возвращает state=ERROR, если в качестве массива сайтов пришел неизвестный SOAP объект.

opt delete_filter(id, force) => string

Удаляет фильтр по его идентификатору

Метод принимает следующие аргументы

id:int - идентификатор (id) фильтра
force:bool - флаг позволяющий удалять фильтры даже если они используются

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

opt delete_url_filter(url_filter_id) => string

Удаляет URL фильтр по его идентификатору

Метод принимает следующие аргументы

url_filter_id:int - идентификатор URL фильтра

• Возвращается “ERROR” в случае ошибки (фильтр не найден или принадлежит другому пользователю) или “OK” в случае успеха

opt edit_filter(id, filter) => string

Изменение параметров фильтра

Метод принимает следующие аргументы

id:int - идентификатор (id) фильтра
filter:LinkfeedStruct::Filter - структура с новыми параметрами фильтра

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

opt edit_project(project_id, struct) => LinkfeedStruct::StatusWithError

Редактирует проект в системе.

Метод принимает следующие аргументы

project_id:int - идентификатор (id) проекта
struct:LinkfeedStruct::ProjectIn - структура в которой находятся параметры проекта

• Возвращает ошибку “project not found” если указанный проект не найден

opt Доступ к данному методу ограничен см. раздел Методы с ограниченным доступом на главной странице для дополнительной информации

edit_url(id, struct) => string

Изменяет параметры URL

Метод принимает следующие аргументы

id:int - идентификатор URL
struct:LinkfeedStruct::UrlForEdit - параметры URL

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

opt edit_url_filter(url_filter_id, struct) => string

Изменяет URL фильтр по его идентификатору

Метод принимает следующие аргументы

url_filter_id:int - идентификатор URL фильтра
struct:LinkfeedStruct::EditUrlFilterIn - структура с новыми параметрами URL фильтра

• Возвращается “ERROR” в случае ошибки (фильтр не найден или принадлежит другому пользователю) или “OK” в случае успеха

opt get_all_url_filters => LinkfeedStruct::UrlFilter []

Возвращает список всех URL фильтров

Метод принимает следующие аргументы

Нет аргументов

• Ничего не возвращает если URL или URL фильтр не найден

opt get_anchors(url_id) => LinkfeedStruct::GetAnchorOut []

Возвращает список анкоров (текстов для ссылки) связанных с указанным URL проекта

Метод принимает следующие аргументы

url_id:int - Идентификатор (id) URL проекта

• Ничего не возвращает если URL не найден или список анкоров пустой

opt get_anchors_count(url_id) => integer

Возвращает кол-во анкоров (текстов для ссылки) связанных с указанным URL проекта

Метод принимает следующие аргументы

url_id:int - Идентификатор (id) URL проекта

• Ничего не возвращает если URL не найден

opt get_filter_by_name => LinkfeedStruct::FilterFull []

Поиск фильтра по имени

Возвращает фильтр пользователя

Метод принимает следующие аргументы

name:string - Имя фильтра

opt get_filters => LinkfeedStruct::FilterFull []

Возвращает список фильтров пользователя

Метод принимает следующие аргументы

Нет аргументов

opt get_filters_briefly => LinkfeedStruct::FilterBrief []

Возвращает список фильтров пользователя которые содержат только краткую информацию о фильтре

Метод принимает следующие аргументы

Нет аргументов

opt get_links(struct) => LinkfeedStruct::Link

Возвращает массив ссылок на основе указанных параметров

Метод принимает следующие аргументы

struct: LinkfeedStruct::GetLinkIn - список параметров для поиска списка ссылок

opt get_links_by_ids(ids) => LinkfeedStruct::Link

Возвращает массив ссылок на основе указанных идентификаторов

Метод принимает следующие аргументы

array:string[] - список идентификаторов (id) ссылок

opt get_links_status_online(id) => LinkfeedStruct::StatusWithError

Возвращает статус ссылки

Метод принимает следующие аргументы

id:string [] - массив идентификаторов линков

opt get_links_to_approve => LinkfeedStruct::Link []

Возвращает список ссылок нуждающихся в подтверждении

Метод принимает следующие аргументы

Нет аргументов

opt get_links_with_cost_changes() => LinkfeedStruct::Link

Возвращает массив ссылок с измененными ценами

Метод принимает следующие аргументы

Нет аргументов

opt get_not_used_anchors_count(url_id) => integer

Возвращает кол-во неиспользованных анкоров (текстов для ссылки) связанных с указанным URL проекта.

Если анкор используется, то это означает что на каком-то сайте есть тег <A> содержащий текст из этого анкора и ссылку на URL проекта (формате ссылки на сайте такой left_text<A href="URL">anchor</A>right_text).

Метод принимает следующие аргументы

url_id:int - Идентификатор (id) URL проекта

• Ничего не возвращает если URL не найден

opt get_project => LinkfeedStruct::ProjectOut

Возвращает запрошенный проект

Метод принимает следующие аргументы

id:int - идентификатор проекта

opt get_project_links(project_id, limit, offset) => LinkfeedStruct::Link []

Возвращает массив ссылок содержащихся в проекте.

Метод принимает следующие аргументы

project_id:int - идентификатор (id) проекта
limit:int - Ограничение на кол-во возвращаемых ссылок (по умолчанию 1000)
offset:int - Смещение (для организации постраничной загрузки ссылок) (по умолчанию 0)

Дополнительная информация

По умолчанию лимит на кол-во возвращаемых ссылок равен 1000. Рекомендуется не превышать его без существенной необходимости, а в случае превышения согласовать это со службой поддержки.

opt get_projects => LinkfeedStruct::ProjectOut []

Возвращает список имеющихся у пользователя проектов

Метод принимает следующие аргументы

Нет аргументов

• Если проектов не найдено ничего не возвращается

opt get_sleep_links => LinkfeedStruct::Link []

Возвращает список ссылок в состоянии SLEEP

Метод принимает следующие аргументы

Нет аргументов

opt get_url(id) => LinkfeedStruct::Url []

Возвращает URL по иднетификационному номеру

Метод принимает следующие аргументы

id:int - идентификатор (id) URL’а

• Ничего не возвращается если URL не найден

opt get_url_filter(url_filter_id) => LinkfeedStruct::UrlFilter

Возвращает URL фильтр по его идентификатору

Метод принимает следующие аргументы

url_filter_id:int - идентификатор URL фильтра

• Ничего не возвращает URL фильтр не найден или найденный фильтр не принадлежит пользователю

opt get_url_filters(url_id) => LinkfeedStruct::UrlFilter []

Возвращает список URL фильтров по идентификатору URL

Метод принимает следующие аргументы

url_id:int - идентификатор URL

• Ничего не возвращает если URL или URL фильтр не найден

opt get_url_filters_by_filter(filter_id) => LinkfeedStruct::UrlFilter []

Возвращает список URL фильтров по идентификатору filter_id

Метод принимает следующие аргументы

filter_id:int - идентификатор filter_id

• Ничего не возвращает если filter или URL фильтр не найден

opt get_url_links(url_id) => LinkfeedStruct::Link

Возвращает массив ссылок для указанного URL платформы

Метод принимает следующие аргументы

url_id:int - идентификатор (id) URL проекта

opt get_url_links_to_approve(url_id) => LinkfeedStruct::Link[]

Возвращает список ссылок нуждающихся в подтверждении для урла

Метод принимает следующие аргументы

url_id:int - идентификатор (id) URL проекта

opt get_urls(project_id) => LinkfeedStruct::Url []

Возвращает список URL имеющихся у указанного проекта

Метод принимает следующие аргументы

project_id:int - идентификатор (id) проекта

• Ничего не возвращается если проект не найден или не найдено ни одного URL

opt list_platform_gbls => string[]

Возвращает список платформ (их URL) находящихся в глобальном черном списке.

Метод принимает следующие аргументы

Нет аргументов

• Если платформ нет возвращается пустой массив

opt list_platform_lbls => LinkfeedStruct::LblRecord []

Возвращает список платформ (их URL) находящихся в глобальном черном списке.

Метод принимает следующие аргументы

Нет аргументов

• Если платформ нет возвращается пустой массив

opt list_platform_wl => string[]

Возвращает список платформ (их URL) находящихся в списке избранных.

Метод принимает следующие аргументы

Нет аргументов

• Если платформ нет возвращается пустой массив

opt list_platform_wl_groups => string[]

Возвращает список имен групп избранного

Метод принимает следующие аргументы

Нет аргументов

• Если групп нет возвращается пустой массив

opt list_platform_wl_new(group) => string[]

Возвращает список платформ (их URL) находящихся в группе списка избранных.

Метод принимает следующие аргументы

group:string - Имя группы избранного (например: Избранное)

• Если платформ нет возвращается пустой массив
• Если пользователь не указал имя группы возвращается ошибка “group is blank“
• Если пользователь указал не существующую группу возвращается ошибка “no such group“

opt pays_for_project(project_id, begin_date, end_date) => float

Возвращает сумму транзакций по проекту за определённый интервал времени

Метод принимает следующие аргументы

project_id:int - идентификатор проекта
begin_date:date - начальная дата
end_date:date - конечная дата

Дополнительная информация

Даты передаются в формате ‘YYYY-MM-DD’

opt remove_anchors(url_id, anchors_ids) => LinkfeedStruct::StatusWithError

Удаляет заданные анкоры, на основе их идентификаторов, принадлежащие указанному url_id

Метод принимает следующие аргументы

url_id:int - идентификатор (id) URL
anchors_ids:int [] - идентификаторы (id) анкоров

• Возвращает сообщение об ошибке “url not found” если указанные URL не найден

opt remove_platform_gbl(site) => LinkfeedStruct::StatusWithError

Удаляет платформу из черного списка.

Метод принимает следующие аргументы

site:string - URL удаляемой платформы (например http://linkfeed.ru)

• Если пользователь указал не существующий URL и платформа не найдена, то возвращается ошибка “platform not found“
• Если URL адрес указан неверно возвращается ошибка “invalid sitename“
• Если пользователь не указал URL возвращается ошибка “sitename is blank“

opt remove_platform_lbl(site, url_id) => LinkfeedStruct::StatusWithError

Удаляет платформу из черного списка.

Метод принимает следующие аргументы

site:string - URL удаляемой платформы (например http://linkfeed.ru)
url_id:int - id урла

• Если пользователь указал не существующий URL и платформа не найдена, то возвращается ошибка “platform not found“
• Если URL адрес указан неверно возвращается ошибка “invalid sitename“
• Если пользователь не указал URL возвращается ошибка “sitename is blank“

opt remove_platform_wl(site) => LinkfeedStruct::StatusWithError

Удаляет платформу из списка избранных платформ

Метод принимает следующие аргументы

site:string - URL удаляемой платформы (например http://linkfeed.ru)

• Если пользователь указал не существующий URL и платформа не найдена, то возвращается ошибка “platform not found“
• Если URL адрес указан неверно возвращается ошибка “invalid sitename“
• Если пользователь не указал URL возвращается ошибка “sitename is blank“

opt remove_platform_wl_group(name) => LinkfeedStruct::StatusWithError

Удаляет группу избранного и ее содержимое

Метод принимает следующие аргументы

name:string - Имя группы избранного (например Избранное)

• Если пользователь пытается удалить группу которая не существует, то возвращается ошибка “no such group“
• Если пользователь не указал имя группы возвращается ошибка “name is blank“

opt remove_platform_wl_new(sites,group) => LinkfeedStruct::StatusWithError

Удаляет платформу из списка группы избранных платформ

Метод принимает следующие аргументы

sites:string[] - URL удаляемых платформ (например http://linkfeed.ru)
group:string - Имя группы избранного (например: Избранное)

• Если пользователь не указал URL возвращается ошибка “sitename is blank“
• Если пользователь не указал имя группы возвращается ошибка “group is blank“
• Если пользователь указал не существующую группу возвращается ошибка “no such group“

opt remove_projects(projects) => LinkfeedStruct::StatusWithError

Удаляет указанные проекты

Метод принимает следующие аргументы

projects:int [] - массив идентификаторов проектов

opt remove_url_anchors(url_id) => integer

Удаляет все анкоры которые имеются у указанного URL

Метод принимает следующие аргументы

url_id:int - идентификатор (id) URL

• Возвращает кол-во удалённых анкоров

opt remove_urls(urls) => LinkfeedStruct::StatusWithError

Удаляет указанные URL-ы

Метод принимает следующие аргументы

urls:int [] - массив идентификаторов URL

opt Доступ к данному методу ограничен см. раздел Методы с ограниченным доступом на главной странице для дополнительной информации

search(project_id,url_id,order,descending,offset,limit,struct) => LinkfeedStruct::SearchPage []

Выбирает страницы на основе указанного фильтра

Метод принимает следующие аргументы

project_id:int - идентификатор проекта
url_id:int - идентификатор URL
order:string - название поля по которому осуществляется сортировка
descending:bool - направление сортировки по полю (true == DESC)
offset:int - смещение
limit:int - ограничение на кол-во возвращаемых записей
struct:LinkfeedStruct::Filter - структура с параметрами фильтра

• Возвращается пустой массив если доступ к функциональности запрещён или если проект не найден или если URL не найден

opt set_url_filters(url_id, struct, remove) => string

Добавляет несколько URL фильтров к указанному URL

Метод принимает следующие аргументы

url_id:int - идентификатор URL
struct:LinkfeedStruct::UrlFilterHash [] - массив структур с новыми параметрами URL фильтра
remove:bool - удалять старые URL фильтры перед добавлением новых

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

opt sleep_links(links) => LinkfeedStruct::StatusWithError

Переводит указанные ссылки в SLEEP режим

Метод принимает следующие аргументы

links:string [] - массив идентификаторов ссылок

opt sleep_links_by_project(project_id) => LinkfeedStruct::StatusWithError

Асинхронно переводит все ссылки в указанном проекте в SLEEP режим

Метод принимает следующие аргументы

project_id:int - идентификатор проекта

opt sleep_links_by_url(url_id) => LinkfeedStruct::StatusWithError

Переводит все ссылки связанные с указанным URL в SLEEP режим

Метод принимает следующие аргументы

url_id:int - идентификатор URL

opt toggle_url(id, suspend) => LinkfeedStruct::StatusWithError

Переводит URL из активного состояния в неактивное и наоборот

Метод принимает следующие аргументы

id:int - идентификаторов URL
suspend:bool - true - отключить URL, false - включить URL

opt toggle_url_filter(id, suspend) => LinkfeedStruct::StatusWithError

Переводит фильтр из активного состояния в неактивное и наоборот

Метод принимает следующие аргументы

id:int - идентификаторов URL фильтра
suspend:bool - true - отключить фильтр, false - включить фильтр

opt unsleep_links(links) => LinkfeedStruct::StatusWithError

Переводит указанные ссылки из SLEEP режима в WAKE_UP

Метод принимает следующие аргументы

links:string [] - массив идентификаторов ссылок

opt unsleep_urls(urls) => LinkfeedStruct::StatusWithError

Переводит указанные урлы из SLEEP режима в WAKE_UP

Метод принимает следующие аргументы

urls:int [] - массив идентификаторов урлов

opt wipe_platform_wl => LinkfeedStruct::StatusWithError

Обнуляет избранное - удаляет все группы и содержащиеся в них URL

Метод принимает следующие аргументы

Нет аргументов

web activate_all_pages_on_site(site_id) => string

Активировать площадку(сайт) и все страницы. При этом все новые страницы (статус NEW) поменяют свой статус на OK и станут доступны при поиске площадок, а, также, автоматом проставятся цены средние по системе. После этого вы сможете управлять ценами через методы get_site_costs, set_site_costs

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

web activate_pages(ids) => string

Делает активными указанные страницы (и ставит им цены средние по системе) deprecated (вместо этого метода рекомендуется использовать activate_all_pages_on_site)

Метод принимает следующие аргументы

ids:int [] - массив идентификаторов страниц

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

web add_links_to_bls(link_ids) => LinkfeedStruct::StatusWithError

Добавляет ссылки (точнее их URL) в черный список

Метод принимает следующие аргументы

link_ids:string [] - массив идентификаторов ссылок

 Этот метод, похоже, не используется.
 См. link_orders_reject

web add_site(struct) => LinkfeedStruct::SiteOut

Добавляет новую площадку/сайт в систему (deprecated)

Метод принимает следующие аргументы

struct:LinkfeedStruct::AddSiteIn - структура с параметрами новой площадки

• Возвращает ошибку (status=“ERROR”) если при сохранении возникли проблемы или если площадка не прошла проверку

web add_site_async(struct) => LinkfeedStruct::SiteOut

Добавляет новую площадку/сайт в систему, с асинхронным запуском проверки кода биржи на странице и проверки сеопараметров. После создания площадки необходимо проверить статус площадки (check_site_status) через некоторое время (~1-10 мин)

Метод принимает следующие аргументы

struct:LinkfeedStruct::AddSiteIn - структура с параметрами новой площадки

• Возвращает status=“CHECKING”, если площадка добавлена и запущена проверка кода
• Возвращает ошибку status=“ERROR”, если при сохранении возникли проблемы или если площадка не прошла начальную проверку

web add_urls_to_bls(urls_bls) => LinkfeedStruct::StatusWithError

Добавляет URL-ы в черный список

Метод принимает следующие аргументы

urls_bls:string [] - массив URL-ов. Каждый из URL-ов должен начинаться с с http://, а сам массив должен содержать не более 500 элементов

web approve_requested_links(link_request_ids) => LinkfeedStruct::ApproveRequestsResult

Подтверждает заявки полученные в ходе обратного поиска

Метод принимает следующие аргументы

link_request_ids:int [] - массив с идентификаторами заявок

web check_site_status(site_id) => string

Проверяет статус созданной площадки, запускать через некоторое время после add_site_async

Метод принимает следующие аргументы

site_id:int - идентификатор площадки

• Возвращает “ERROR”, если прощадка не найдена
• Возвращает “CHECKING”, если площадка еще проходит модерацию
• Возвращает “CODE CHECKING FAILED”, если код биржи для указанной страницы площадки не найден
• Возвращает “MODERATION FAILED”, если площадка не прошла проверку
• Возвращает “OK”, если прощадка прошла проверку

web delete_forever_pages(ids) => string

Удаляет указанные страницы на всегда

Метод принимает следующие аргументы

ids:int [] - массив идентификаторов страниц

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

web delete_until_reindex_pages(ids) => string

Удаляет указанные страницы до пере-индексации

Метод принимает следующие аргументы

ids:int [] - массив идентификаторов страниц

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

web edit_site(site_id, params) => LinkfeedStruct::SiteOut

Редактировать площадку/сайт

Метод принимает следующие аргументы

site_id:int - идентификатор площадки
params:LinkfeedStruct::EditSiteIn - структура с параметрами площадки

• Возвращает ошибку (status=“ERROR”) если при сохранении возникли проблемы

web exclude_pages(ids) => string

Делает НЕ активными указанные страницы

Метод принимает следующие аргументы

ids:int [] - массив идентификаторов страниц

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

web get_links_for_site(platform_id) => LinkfeedStruct::Link []

Возвращает все ссылки площадки

Метод принимает следующие аргументы

platform_id:int - идентификатор площадки/сайта

web get_pages(site_id) => LinkfeedStruct::Page []

Возвращает список страниц с площадки/сайта пользователя по его идентификатору (id)

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки

• Ничего не возвращает в случае если платформа не найдена или если не найдено ни одной страницы

web get_site_cost_levels(platform_id) => LinkfeedStruct::CostLevel []

Возвращает стоимость страниц на площадке в зависимости от их уровня

Метод принимает следующие аргументы

platform_id:int - идентификатор площадки

• Возвращает пустой список если площадка не найдена

web get_site_income(site_id, year, month) => float

Возвращает доходы с площадки за указанный месяц

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки
year:int - год
month:int - месяц

web get_site_income_for_day(site_id, year, month, day) => float

Возвращает доходы с площадки за указанный день

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки
year:int - год
month:int - месяц
day:int - день

web get_site_links(site_id) => LinkfeedStruct::SiteLink []

Возвращает список ссылок с площадки/сайта пользователя по его идентификатору (id)

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки

• Ничего не возвращает в случае если не найдено ни одной ссылки

web get_site_profile(site_id) => LinkfeedStruct::Site

Возвращает площадку/сайт пользователя по его идентификатору (id)

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки

• Ничего не возвращает в случае если платформа не найдена

web get_sites => LinkfeedStruct::Site []

Возвращает список площадок/сайтов имеющихся у пользователя

Метод принимает следующие аргументы

Нет аргументов

• Ничего не возвращает в случае если платформа не найдена

web get_urls_from_bls => LinkfeedStruct::UrlBl []

Возвращает список URL-ов из черного списка

web link_orders_approve(ids) => LinkfeedStruct::Result []

Подтверждает ссылки оптимизатора

Метод принимает следующие аргументы

ids:string [] - массив идентификаторов страниц

Виды ошибок

• ids not set - в качестве входящего параметра пришел пустой массив. невалидные входящие данные.
  
• В случае невалидных входящих данных выводится массив с единственным элементом, содержащим данную ошибку в поле error
  
• not found - Ссылка с данным идентификационным номером - не найдена.
  
• update failed - Неизвестный внутренний сбой. Подтвердить ссылку не удалось.
  

web link_orders_list => LinkfeedStruct::Link []

Возвращает список ссылок ожидающих подтверждения вебмастера (как потвержденные оптимизатором, так и ожидающие подтверждения обоих)

Метод принимает следующие аргументы

Нет аргументов

web link_orders_list_of_waits => LinkfeedStruct::Link []

Возвращает список ссылок ожидающих подтверждения для размещения (которые уже потверждены оптимизатором)

Метод принимает следующие аргументы

Нет аргументов

web link_orders_reject(ids, reason) => LinkfeedStruct::Result []

Отказывает в подтверждение ссылок оптимизатора

Метод принимает следующие аргументы

ids:int [] - массив идентификаторов ссылок
reason:string - описание причины отказа. Может принимать значения “remove_web“, “remove_and_add_to_bl_web“, “remove_wrong_topic“ “remove_wrong_text“, “bad page”, “remove_no_free_places“, “remove_too_long_text“

Виды ошибок

• ids not set - в качестве входящего параметра пришел пустой массив. невалидные входящие данные.
  
• В случае невалидных входящих данных выводится массив с единственным элементом, содержащим данную ошибку в поле error
  
• wrong reason - данный ответ оптимизатору недопустим
  
• not found - Ссылка с данным идентификационным номером - не найдена.
  
• update failed - Неизвестный внутренний сбой. Подтвердить ссылку не удалось.
  

web link_orders_reject_async(ids, reason) => LinkfeedStruct::StatusWithError

Асинхронно отказывает в подтверждение ссылок оптимизатора

Метод принимает следующие аргументы

ids:int [] - массив идентификаторов страниц
reason:string - описание причины отказа. Может принимать значения “remove_web“, “remove_and_add_to_bl_web“, “remove_wrong_topic“ “remove_wrong_text“, “bad page”, “remove_no_free_places“, “remove_too_long_text“

Похоже, что этот метод не используется. См. link_orders_reject

web link_orders_reject_to_bls(ids, reason) => LinkfeedStruct::Result []

Отказывает в подтверждение ссылок оптимизатора и добавляет их в чёрный список

Метод принимает следующие аргументы

ids:int [] - массив идентификаторов страниц
reason:string - описание причины отказа. Может принимать значения “remove_web“, “remove_and_add_to_bl_web“, “remove_wrong_topic“ “remove_wrong_text“, “bad page”, “remove_no_free_places“, “remove_too_long_text“

Виды ошибок

• ids not set - в качестве входящего параметра пришел пустой массив. невалидные входящие данные.
  
• В случае невалидных входящих данных выводится массив с единственным элементом, содержащим данную ошибку в поле error
  
• wrong reason - данный ответ оптимизатору недопустим
  
• not found - Ссылка с данным идентификационным номером - не найдена.
  
• update failed - Неизвестный внутренний сбой. Подтвердить ссылку не удалось.
  

Похоже, этот метод не используется См. link_orders_reject

web link_platform_orders_list => LinkfeedStruct::Link []

Возвращает список ссылок ожидающих подтверждения вебмастера (как потвержденные оптимизатором, так и ожидающие подтверждения обоих)

  для платформы

Метод принимает следующие аргументы

platform_id:int [] - id платформы

web link_platform_orders_list_of_waits => LinkfeedStruct::Link []

Возвращает список ссылок ожидающих подтверждения для размещения (которые уже потверждены оптимизатором)

  для платформы

Метод принимает следующие аргументы

platform_id:int [] - id платформы

web recheck_out_links_on_site(site_id) => string

Поставить площадку/сайт в очередь на пересчёт внешних ссылок

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

web recheck_yap_gop(platform_id) => LinkfeedStruct::StatusWithError

Перепроверяет индексацию страниц для указанной площадки в Яндексе и Google

Метод принимает следующие аргументы

platform_id:int - идентификатор сайта/площадки

• Возвращает “platform isn’t found” если платформа не найдена
• Возвращает “can’t recheck YAP and GOP” в случае ошибки при постановке площадки на перепроверку индексации в Яндексе или Google

web reindex_site(site_id) => string

Поставить площадку/сайт в очередь на индексацию

Метод принимает следующие аргументы

site_id:int - идентификатор (id) площадки

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

web reject_requested_links_to_bls(link_request_ids) => LinkfeedStruct::StatusWithError

Отклоняет заявки полученные в ходе обратного поиска и помещает их URL-ы в чёрный список

Метод принимает следующие аргументы

link_request_ids:int [] - массив с идентификаторами заявок

См. links_orders_reject

web remove_site(platform_id) => LinkfeedStruct::StatusWithError

Удаляет площадку/сайт из системы

Метод принимает следующие аргументы

site_id:int - идентификатор площадки

• Возвращает ошибку “site isn’t found” если площадка не найдена
• Возвращает ошибку “site can’t be deleted” если площадка не может быть удалена в настоящий момент

web remove_urls_from_bls(url_bls_ids) => LinkfeedStruct::Result []

Удаляет URL-ы из черного списка

Метод принимает следующие аргументы

url_bls_ids:integer [] - массив идентификаторов URL-ов.

web reverse_search(platform_id, search_params) => LinkfeedStruct::ReverseSearchResult

Обратный поиск (поиск заявок на площадки)

Метод принимает следующие аргументы

platform_id:int - идентификаторов сайта/площадки
search_params:LinkfeedStruct::ReverseSearchParams - критерии поиска площадки

Возвращает пустой массив если:

• сайт/площадка не принадлежит пользователю
• ни одной заявки не найдено
• если превышено кол-во запросов от пользователя (текущий лимит: 5 запросов в минуту)

web set_site_costs(platform_id, currency_id, costs, not_update_links) => string

Устанавливает стоимость страниц на площадке/сайте

Метод принимает следующие аргументы

platform_id:int - идентификатор площадки
currency_id:int - идентификатор валюты
cost:LinkfeedStruct::SiteCost [] - список с ценами страницы на площадке в зависимости от уровня
not_update_links:bool - обновлять или не обновлять стоимость ссылок

• Возвращается “ERROR” в случае ошибки или “OK” в случае успеха

============================================================================

:nodoc: #

(Not documented)

(Not documented)

:nodoc: #

(Not documented)

:nodoc: #

:nodoc: #

stat pays_for_url(url_id, date) => float

Возвращает сумму выплат по URL за определённую дату

Метод принимает следующие аргументы

url_id:int - идентификатор URL площадки
date:date - дата

Дополнительная информация

Даты передаются в формате ‘YYYY-MM-DD’

stat pays_for_user(begin_date, end_date) => double

Возвращает сумму транзакций по пользователю за определённый интервал времени

Метод принимает следующие аргументы

begin_date:date - начальная дата
end_date:date - конечная дата

Дополнительная информация

Даты передаются в формате ‘YYYY-MM-DD’