Как отправлять события в 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