Як надсилати події до Pixel з бота

Щоб передавати події з робочого процесу бота, вам потрібен бізнес-акаунт. Ви можете зареєструватися тут.

Як створити новий піксель

Оберіть API Conversions.

Увага! Якщо під час налаштування Conversion API відкриється наступне вікно, краще вийти з налаштувань і почати заново.

Якщо під час налаштування Conversion API відкриється наступне вікно, краще вийти з налаштувань і почати заново.

Оберіть потрібний піксель.

Згенеруйте токен доступу та збережіть його в безпечному місці.

Як передавати події до Facebook

Щоб передавати події до Facebook, вам потрібен власний домен, налаштований у міні-лендінгу. Він має бути підтверджений у Facebook, а в налаштуваннях міні-лендінгу для Facebook має бути увімкнено Збереження значень з cookie у змінні клієнта:

Тепер у картці клієнта, який прийшов з міні-лендінгу, буде автоматично заповнена змінна _fbp. Цю змінну можна передавати до Pixel разом із подією.

Вам потрібно налаштувати наступні параметри в блоці, через який ви хочете передавати подію:

URL функції:

https://store.mavibot.ai/function/fb_pixel

Приклад параметрів:

{
  "pixel_id": "#{pixel_id}",
  "access_token": "#{access_token}",
  "event_name": "Entered the bot",
  "event_source_url": "https://my_best_site.com",
  "action_source": "chat",
  "fbp": "#{_fbp}",
  "fbc": "#{_fbc}"
}

Обов'язкові параметри

pixel_id — ID пікселя.

access_token — токен для доступу до API.

event_name — назва події. Ви можете використовувати стандартні назви, такі як Lead, PageView, Purchase тощо (детальніше тут), а також власні назви, наприклад Entered the bot.

event_source_url — домен, підтверджений у Facebook.

fbp — ID браузера клієнта.

Необов'язкові параметри

action_source — (за замовчуванням other) це поле дозволяє вказати, де саме сталася конверсія. Інформація про те, де сталися події, допомагає гарантувати, що ваші оголошення показуються правильній аудиторії.

Ви можете встановити такі значення в полі action_source:

Значення Опис
email Конверсія відбулася через електронну пошту
website Конверсія відбулася на сайті
phone_call Конверсія відбулася через телефон
chat Конверсія відбулася через месенджер, SMS або онлайн-чат
physical_store Конверсія відбулася у фізичному магазині
system_generated Конверсія відбулася автоматично, тобто в результаті щомісячного поновлення підписки
business_messaging Конверсія відбулася в розмові після того, як клієнт натиснув на рекламу Click-to-WhatsApp
other Конверсія відбулася іншим способом

Як тестувати події

Щоб протестувати події, додайте параметр test_event_code із текстом, збереженим у вкладці Testing messages, до тіла запиту.

{
  "pixel_id": "#{pixel_id}",
  "access_token": "#{access_token}",
  "event_name": "Entered the bot",
  "event_source_url": "https://my_best_site.com",
  "fbp": "#{_fbp}",
  "fbc": "#{_fbc}",
  "test_event_code": "TEST11421"
}

Увага! Не забудьте видалити параметр test_event_code із запиту під час запуску продакшн-версії.

Додаткові необов'язкові параметри

fn — ім'я.

ln — прізвище.

email — електронна пошта клієнта.

phone — номер телефону клієнта.

fbc — ID кліку.

gender — стать клієнта (f — жіноча, m — чоловіча).

country — країна.

state — штат/регіон.

city — місто.

index — поштовий індекс клієнта (ZIP-код).

external_id — будь-який унікальний ID клієнта, наприклад, ID користувача або ID сторонніх cookie-файлів.

client_ip_address — IP-адреса клієнта.

client_user_agent — user agent браузера клієнта.

Ви також можете передавати власні параметри до Pixel. Для цього додайте необов'язковий параметр my_params і вкажіть у ньому власні поля.

Приклад:

{
  "my_params": {
    "value1": "Hello",
    "val2": "Hi"
  }
}

Повний приклад

{
  "pixel_id": "#{pixel_id}",
  "access_token": "#{access_token}",
  "event_name": "Entered the bot",
  "event_source_url": "https://my_best_site.com",
  "email": "[email protected]",
  "phone": "1234567890",
  "currency": "USD",
  "value": "142.52",
  "test_event_code": "TEST11421",
  "external_id": "#{client_id}",
  "fn": "#{name}",
  "gender": "m",
  "post_index": "12345",
  "my_params": {
    "value1": "Hello",
    "val2": "Hi"
  }
}

Увага! Не забудьте видалити параметр test_event_code із запиту під час запуску продакшн-версії.

Як додати рекламний акаунт

Спочатку вам потрібно відкрити доступ до свого акаунта.

Збережіть і перейдіть на вкладку Related Objects → Add Objects.

Потім додайте свій рекламний акаунт.

Конверсії з реклами Click-to-WhatsApp

Доповнення до документації для функції fb_pixel_event().

Meta* позначає кожен клік із реклами Click-to-WhatsApp ідентифікатором кліку ctwa_clid. Він отримується разом із першим повідомленням клієнта у WhatsApp і використовується для атрибуції конверсії з розмови до конкретного оголошення — подібно до того, як події пікселя атрибуються до кліку на сайті.

Сигнатура

fb_pixel_event(
    event_name,
    pixel_id,
    access_token,
    event_source_url,
    action_source,
    fbc,
    test_event_code,
    data,
    ctwa_clid,
    messaging_channel
)

Нові параметри

Параметр Опис
ctwa_clid Ідентифікатор кліку для реклами Click-to-WhatsApp. Якщо цей параметр не вказано, використовується змінна клієнта ctwa_clid, яку бот зберігає автоматично. Необов'язковий.
messaging_channel Канал обміну повідомленнями, де сталася конверсія. За замовчуванням — whatsapp. Необов'язковий.

Нове значення action_source

Для action_source доступне таке значення:

Значення Опис
business_messaging Конверсія відбулася в розмові після того, як клієнт натиснув на рекламу Click-to-WhatsApp.

Подія надсилається як конверсія в обміні повідомленнями, якщо виконано принаймні одну з таких умов:

  • надано action_source="business_messaging";
  • надано ctwa_clid;
  • надано messaging_channel.

У цьому випадку Meta* отримує комбінацію action_source + messaging_channel + ctwa_clid. Без цієї комбінації клік по оголошенню не буде атрибутовано до конверсії.

Значення website не можна використовувати для конверсій в обміні повідомленнями: подія дійде до пікселя, але не буде атрибутована до оголошення.

Змінні клієнта

Коли клієнт надсилає повідомлення у WhatsApp після кліку по оголошенню, бот зберігає дані кліку у змінні клієнта. Вам не потрібно заповнювати ці змінні вручну.

Змінна Опис
ctwa_clid Ідентифікатор кліку. Автоматично додається до події.
ctwa_clid_time Час отримання ідентифікатора у форматі Unix time. Його можна використовувати, щоб визначити, скільки часу минуло з моменту кліку.
wa_ads_data Дані оголошення у форматі JSON: URL оголошення, ID оголошення (source_id), заголовок, опис, тип креативу та URL креативу.

Ідентифікатор кліку автоматично береться зі змінної клієнта, тому вам не потрібно передавати його у функцію явно.

Номер телефону клієнта автоматично додається до події, якщо він не вказаний у data.

Параметр event_source_url не використовується для конверсій в обміні повідомленнями.

Обмеження

Ідентифікатор кліку отримується лише з першим повідомленням клієнта після того, як він натиснув кнопку в оголошенні. Він не включається в наступні повідомлення. Тому подію можна надсилати в будь-який момент розмови, але лише якщо перше повідомлення надійшло з оголошення.

Meta надає ctwa_clid для кліків із застосунків Facebook та Instagram на Android та iOS.

Ідентифікатор не надається, коли клієнт натискає з браузера або натискає звичайний пост замість кнопки в оголошенні. Конверсії з таких взаємодій не можуть бути атрибутовані до оголошення.

Якщо клієнт пізніше натискає інше оголошення, змінні перезаписуються. Конверсія атрибутується до останнього оголошення, з якого прийшов клієнт.

Якщо ідентифікатор кліку відсутній і в параметрах функції, і у змінних клієнта, функція повертає таку помилку, і подія не надсилається:

No ctwa_clid variable in client variables