Перейти к основному содержанию

Documentation Index

Fetch the complete documentation index at: https://docs.mellowtel.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Что это

Mellowtel не будет использовать ни одного байта полосы пропускания, пока пользователь явно не подключится, и у пользователя всегда должна быть очевидная возможность отключиться. Это жесткое требование SDK и жесткое требование каждой политики магазина браузеров, которая позволяет расширения на основе Mellowtel.

​
Почему это важно

Это полоса пропускания пользователя. Все, что меньше явного, отзывного согласия, является как неэтичным, так и основанием для удаления из магазина. SDK разработан таким образом, что легкий путь также является соответствующим. Если вы следуете рекомендованной реализации, вы не сможете случайно выпустить версию, которая активируется без согласия.

​
Как это работает

При первой установке (и при любом обновлении, которое впервые вводит Mellowtel) вы должны показать пользователю неотключаемый дисклеймер, объясняющий, что делает Mellowtel, а затем зафиксировать их выбор. С этого момента ссылка на настройки должна быть доступна из очевидного места в вашем интерфейсе, чтобы они могли изменить свое мнение.
У вас есть два варианта реализации:
  1. Рекомендуется: откройте предварительно созданную страницу подключения Mellowtel с помощью generateAndOpenOptInLink(). Один вызов метода, полное соответствие, максимизация конверсии подключения.
  2. Пользовательский интерфейс: создайте собственную поверхность согласия и вызовите optIn() / optOut() самостоятельно.

​
Поверхность API

МетодВозвращаетИспользуйте для
generateAndOpenOptInLink()Promise<void>Открыть размещенную страницу подключения (рекомендуемый путь).
getOptInStatus()Promise<boolean>Проверить, подключился ли пользователь.
optIn()Promise<void>Зафиксировать согласие из вашего интерфейса.
optOut()Promise<void>Отозвать согласие из вашего интерфейса.
start()Promise<void>Начать обработку запросов после подключения.
generateSettingsLink()Promise<string>URL на размещенную страницу настроек, чтобы пользователи могли изменить свой выбор позже.
Все методы доступны из любой части вашего расширения: всплывающее окно, скрипт содержимого или фоновый скрипт.

​
Рекомендуемая реализация

Полное руководство по интеграции находится в быстрых стартах платформы. Они показывают, куда поместить SDK, как интегрировать его в жизненный цикл установки/обновления и как его тестировать: Короче говоря, после new Mellowtel(...) и initBackground(), вызовите generateAndOpenOptInLink() из вашего обработчика установки/обновления. Вот и все.

​
Пользовательский интерфейс

Если вы хотите полностью контролировать поверхность согласия, зафиксируйте выбор пользователя в вашем интерфейсе и передайте его в SDK: 
// Пользователь согласился
await mellowtel.optIn();
await mellowtel.start();

// Пользователь отказался или позже отозвал согласие
await mellowtel.optOut();

// Проверить статус (например, чтобы отобразить переключатель)
const hasOptedIn = await mellowtel.getOptInStatus();
Какой бы интерфейс вы ни создали, он должен:
  1. Быть неотключаемым при первой установке.
  2. По умолчанию быть отключенным, пока пользователь активно не согласится.
  3. Быть повторно открываемым из очевидного места в вашем продукте, чтобы пользователи могли изменить свой выбор.

​
Ссылка на настройки

У пользователей всегда должна быть легкая возможность изменить свои настройки. Используйте generateSettingsLink(), чтобы получить URL на размещенную страницу настроек и разместите его в постоянном месте: ваше всплывающее окно, страница опций, экран учетной записи. 
const settingsUrl = await mellowtel.generateSettingsLink();

​
Объявление Mellowtel существующим пользователям

Если вы добавляете Mellowtel в расширение, у которого уже есть пользователи, вам нужно сообщить им, что изменилось, прежде чем запрашивать согласие. Мы предоставляем шаблон объявления для копирования и вставки, который вы можете адаптировать.

​
Связанные темы