Основные понятия

В этой инструкции рассказывается об основных понятиях, которые используются при работе с сервисом Taglme Link.

Объекты

В сервисе имеется несколько основных объектов, с которыми ведется работа в приложении.

Такими объектами являются: проекты, метки, действия, шаблоны, группы, взаимодействия.

Ниже вы найдете короткое описание параметров для каждого объекта

Проекты

Проекты служат для хранения всех остальных элементов. Элементы, созданные в одном проекте (метки, действия и т.д.), будут не доступны в другом проекте.

Проект имеет следующие параметры

• Имя (обязательный) – идентификатор проекта
• Клиент (не обязательный) – Клиент или Заказчик проекта
• Дата начала (не обязательный) – дата старта проекта
• Дата окончания (не обязательный) – дата окончания проекта
• Заметки (не обязательный) – описание проекта
• Webhook URL (не обязательный) – URL для отправки сообщений о взаимодействиях с метками. Данный параметр может использоваться для интеграции со сторонними системами.
• Google Analytics ID (не обязательный) – идентификатор счетчика Google Analytics. Параметр служит для интеграции с сервисом Google Analytics.
• Укорачивать ссылки (не обязательный) – позволяет использовать внешний сервис сокращения ссылок (https://goo.gl/) При использования данной опции ссылки для взаимодействия с метками будет генерироваться внешним сервисом и будут иметь вид https://goo.gl/xxxxxxx
• Статус проекта (обязательный) – текущее состояние проекта. Параметр задается для изменения состояния проекта. Может иметь следующие значения:
  • В разработке – служит для настройки и тестирования проекта. В этом статусе с элементами проекта доступны любые действия.
  • Активный – используется для текущих активных проектов. В этом статусе удаление элементов проекта не доступно.
  • Приостановлен – служит для приостановки работы проектов. В этом статусе не выполняется активация действий при взаимодействии с метками.
  • Архивный – служит для завершенных проектов. В этом статусе любые действия с элементами проекта не доступны. Не выполняется активация действий при взаимодействии с метками.
  • Дополнительная информация – произвольный набор пар «ключ» - «значение». Служит для записи в проект произвольных дополнительных параметров.

Шаблоны

Шаблон – это элемент на основе, которого создаются действия. Представляет собой разметку страницы (в формате html, json или текст), которая загружается в браузер пользователя при взаимодействии с меткой.

Разметка может иметь опции, которые динамически подставляются в нее при формировании (рендеринге) страницы сервисом в момент загрузки в браузер пользователя.

Значение данных опций может указываться при создании действия на основе шаблона.

Для создания действий можно использовать общедоступные шаблоны или создавать свои.

Шаблон имеет следующие параметры:

• Имя (обязательный) – идентификатор шаблона
• Тип (обязательный) – задает тип отображаемой странице, который передается в браузер. Может иметь значение html, json, текст.
• Заметки (не обязательный) – описание шаблона
• Метки (не обязательный) – теги для поиска шаблона
• Разметка (обязательный) – разметка страницы, которая будет загружаться в браузер пользователя
• Опции (не обязательный) – список параметров, которые можно указать при создании действия на основе шаблона

Каждая опция шаблона имеет следующие параметры:

• Имя (обязательный) – идентификатор опции в разметке шаблона. Именно вместо этого идентификатора в разметке подставляется значение опции.
• Заголовок (обязательный) – наименование опции
• Заметки (не обязательный) – описание назначения опции
• Обязательное (обязательный) – указывает на обязательность заполнения данной опции при создании действия
• Значение (не обязательный) – задает значение по-умолчанию для опции

Действия

Действия – служат для отображения контента в браузере пользователя при взаимодействии с метками. Создаются на основе шаблонов.

Действия имеют следующие параметры:

• Имя – идентификатор действия
• Шаблон – шаблон на основе, которого создано действие
• Заметки – описание действия
• Опции – параметры шаблона, которые будут динамически подставляться в разметку страницы при активации действия.
• Дополнительная информация – произвольный набор пар «ключ» - «значение». Служит для записи в действие произвольных дополнительных параметров.

Группы

Группы – служат для задания группового действия меткам, т.е. действия, которое будет активироваться для всех меток, входящих в группу.

Группы имеют следующие параметры:

• Имя – идентификатор группы
• Действие – действие, которое активирует группа
• Заметки – описание группы
• Дополнительная информация – произвольный набор пар «ключ» - «значение». Служит для записи в группу произвольных дополнительных параметров.

Метки

Метки – фактически представляются собой адрес веб-страницы на сервисе Taglme Link, содержание которой можно задавать с помощью элемента «Действие». Адрес этой веб-страницы может быть записан на физические метки разного типа. Это могут быть NFC метки, Bluetooth Eddystone метки или QR коды.

При взаимодействии с меткой смартфон пользователя считывает веб-адрес, записанный на метку, и загружает ее в браузер. Содержание загружаемой страницы будет зависеть от действия, заданного для метки.

Метки имеют следующие параметры:

• Имя (обязательный) – идентификатор метки
• Тип метки (обязательный) – отображает используемый тип метки
• Заметки (не обязательный) – описание метки
• Группа (не обязательный) – задает групповое действие для метки.
• Действие (не обязательный) – задает индивидуальное действие для метки.

• Дополнительная информация – произвольный набор пар «ключ» - «значение». Служит для записи в метку произвольных дополнительных параметров.

Взаимодействия

Взаимодействия – служат для регистрации взаимодействий с метками. При каждом взаимодействии с меткой (загрузке веб-страницы в браузер) информация об этом сохраняется в базе данных. На основании сохраненных данных строятся отчеты об использовании меток.