Добавить тэги и удалить тэги

Результатом работы данных команд является добавление тэга в атрибуты пользователя или удаление из атрибутов.

На основании этих команд можно проанализировать в каких разделах бота был пользователь. Тэги записываются в хранилище на платформе и могут быть использованы для дальнейшего взаимодействия с пользователем. Также с помощью тэга можно настроить рассылку сообщений для цифровой автоворонки продаж.

Подробнее с тэгами вы можете ознакомиться в статье Структура платформы в разделе 11. Тэги и атрибуты

Добавить в скрипт их можно, выбрав пункты Добавить тэги и Удалить тэги из списка Команд:

После выбора команды в списке Команд перед вами откроется диалоговое окно настройки свойств:

С пунктом Использовать условие вы можете познакомиться в статье 

В поле Тэги необходимо ввести имя тэга и нажать Enter. Вы можете вводить в это поле больше одного тэга.

Имена тегов пишутся одним словом, без пробелов. Если тэг состоит из нескольких слов, то слова разделяются между собой знаком "_"

В случае команды Удалить тэги, если оставить поле Тэги пустым, то удалятся все тэги лида.

По кнопке Создать как итог команда появится в редакторе скрипта:

JS методы для работы с тэгами

К тэгам можно обращаться из JS следующими методами:

Название метода	Метод
Проверить наличие тэга лида	lead.isTagExist('some_tag'): bool
	lead.issetTag('some_tag'): bool
Получить значение тэга лида	lead.getTag(string $key): string|null
Получить массив всех тэгов лида	lead.getAllTags(): array
Добавление тэгов лида	lead.addTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false): self
	lead.addTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false): self
Удаление тэгов лида	lead.deleteTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false): self
	lead.deleteTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false): self
Принудительное удаление тэгов лида из БД	lead.forceDeleteTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false): self
	lead.forceDeleteTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false): self

Каждый из методов подробнее расписан ниже.

Проверить наличие тэга лида

lead.isTagExist($some_tag)

или

lead.issetTag($some_tag)

Описание:

Проверяет существование тега у лида.

Атрибуты:

Имя	Тип	Описание
some_tag	string	Наименование тэга

Возвращает:

bool - подтверждение существования тега.

Пример:

let TagExist = lead.isTagExist('тэг');

или

let TagExist = lead.issetTag('тэг');

Получить значение тэга лида

lead.getTag(string $key)

Описание:

Возвращает значение тэга лида по наименованию.

Атрибуты:

Имя	Тип	Описание
key	string	Наименование тэга

Возвращает:

string - если тэг активен

или

null - если тэг неактивен.

Пример:

let Tag = lead.getTag('тэг');

Получить массив всех тэгов лида

lead.getAllTags()

Описание:

Возвращает массив всех тэгов лида.

Возвращает:

array - массив наименований тэгов лида.

Пример:

let AllTags = lead.getAllTags();
let Tag2 = AllTags[1];

Добавление тэгов лида

lead.addTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)

или

lead.addTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)

Описание:

Добавляет тэг в бот.

Атрибуты:

Имя	Тип	Описание
tags	string|object|array|null	Строка, представляющая собой список названий тэгов(разделитель запятая). Можно указать вместо списка json объект или массив
ticketId	?int	Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления тэга
scriptRequestParams	object	Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления тэга
isSuppressTriggers	bool	Не мягкое удаление. Если передано true, то тэг будет удален из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается

Возвращает:

self - наименование созданного тэга.

Пример:

lead.addTags('new_tag', null, {"some_key": "some_value"});

Удаление тэгов лида

lead.deleteTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)

или

lead.deleteTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isForceDelete = false, bool $isSuppressTriggers = false)

Описание:

Удаляет тэг из бота.

Атрибуты:

Имя	Тип	Описание
tags	string|object|array|null	Строка, представляющая собой список названий тэгов (разделитель запятая). Можно указать вместо списка json объект или массив
ticketId	?int	Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления тэга
scriptRequestParams	object	Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления тэга
isForceDelete	bool	Подавить запуск триггеров или нет, т.е. если передать true,  и есть триггер подписанный на событие изменения/удаления тэга то он не будет запущен.
isSuppressTriggers	bool	Не мягкое удаление. Если передано true, то тэг будет удален из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается

Возвращает:

self - подтверждение удаления тэга.

Пример:

lead.deleteTags('TAG_111, tag_222 , tag_333', null, null, true);

Принудительное удаление тэгов лидаиз БД

lead.forceDeleteTags(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)

или

lead.forceDeleteTag(string|object|array|null $tags, ?int $ticketId = null, $scriptRequestParams = [], bool $isSuppressTriggers = false)

Описание:

Удаляет тэг из бота и БД.

Атрибуты:

Имя	Тип	Описание
attrs	string|object|array|null	Строка, представляющая собой список названий переменных (разделитель запятая). Можно указать вместо списка json объект или массив
ticketId	?int	Передает ticket в запускаемый триггер, который подписан на событие изменения/удаления тэга
scriptRequestParams	object	Передает дополнительный параметры в запускаемый триггер , который подписан на событие изменения/удаления тэга
isSuppressTriggers	bool	Не мягкое удаление. Если передано true, то тэг будет удален из БД, иначе у удаляемого атрибута указывается признак что он удален, но в бд он остается

Возвращает:

self - подтверждение удаления тэга.

Пример:

lead.forceDeleteTags('TAG_111, tag_222 , tag_333');