Перейти до основного вмісту

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 до розширення, яке вже має користувачів, тобі потрібно повідомити їх про зміни перед тим, як запитувати згоду. Ми надаємо шаблон оголошення для копіювання та вставки, який ти можеш адаптувати.

​
Пов’язане