Регистрация событий с помощью Events API для переписок компании

Упразднение Messaging Events API

  • Messaging Events API будет упразднен в сентябре 2025 г. Чтобы подготовиться к этому упразднению, Messaging Events API больше не будет поддерживаться ни в одном из последующих выпусков Graph API, начиная с версии 21.0 с 24 сентября 2024 г.
  • Партнеры, которые решат не обновлять Graph API до последней версии, смогут получить доступ к Messaging Events API, обратившись к Graph API версии 20.0 или более ранней, до официального прекращения поддержки продукта в сентябре 2025 г.
  • Партнерам, которые не обновят Graph API, мы рекомендуем использовать для новых интеграций Conversions API. Подробнее о Conversions API см. в этой статье.

В этом руководстве рассказывается, как регистрировать события в приложении и на Странице Facebook, а затем с их помощью анализировать то, как пользователи взаимодействуют с ботом Messenger.

Прежде чем начать

Вам понадобятся:

  • Разрешение page_events.
    • Когда вы отправите приложение на проверку, для этого разрешения будет автоматически предоставлен расширенный доступ, если у приложения уже есть расширенный доступ для разрешения pages_messaging и при этом оно не нарушало никакие политики в течение последних 90 дней.
  • Маркер доступа к Странице, запрошенный пользователем, который может выполнять на ней задачу ANALYZE.

Ограничения

Этот API пока недоступен компаниям и клиентам в Японии и странах Европы.

Политики и правила

Регистрация событий

Чтобы зарегистрировать событие, отправьте запрос POST к границе контекста page_activities приложения:

https://graph.facebook.com/

Пример запроса:

curl -X POST -H "Content-Type: application/json" -d '{
  "custom_events": [
    {
      "_eventName": "fb_mobile_purchase",
      "_valueToSum": 57.23,
      "fb_currency": "USD"
    }
  ],
  "advertiser_tracking_enabled": 1,
  "application_tracking_enabled": 1,
  "page_id": <PAGE_ID>,
  "page_scoped_user_id": <PSID>,
  "logging_source": "messenger_bot",
  "logging_target": "page"
}' https://graph.facebook.com/v21.0/<APP_ID>/page_activities?access_token=<PAGE_ACCESS_TOKEN>

Для поля _eventName рекомендуется использовать стандартные события. В Ads Manager для отчетов, настройки таргетинга и оптимизации (если эти функции доступны) можно использовать только стандартные события.

Например, чтобы зарегистрировать событие покупки для атрибуции в Ads Manager, используйте имя события fb_mobile_purchase.

Полный список имен и параметров стандартных событий см. в руководстве по App Events API (раздел Схема события в приложении).

В следующей таблице перечислены свойства и значения, которые необходимо предоставить конечной точке, чтобы зарегистрировать событие Messenger:

СвойствоОписаниеЗначение

custom_events

Массив событий, которые нужно зарегистрировать. Список стандартных событий и соответствующих параметров см. в руководстве по App Events API. Кроме того, вы можете использовать и собственные события в приложении. В массиве можно указать сразу несколько событий.

Чтобы указать сведения о специально настроенном событии, используйте массив JSON.

page_id

ID Страницы, связанной с событием.

Используйте ID Страницы Facebook, связанной с ботом.

page_scoped_user_id

ID пользователя в пределах страницы, связанный с ботом Messenger, который регистрирует событие.

Укажите ID пользователя в пределах страницы, предоставленный вашему Webhook.

advertiser_tracking_enabled

Указывает, включено ли отслеживание рекламы.

0 — отключено; 1 — включено.

application_tracking_enabled

Указывает, включено ли отслеживание рекламы на уровне приложения.

0 — отключено; 1 — включено.

logging_source

Источник события.

Чтобы указать, что событие поступает от бота Messenger, используйте строку messenger_bot.

logging_target

Целевые объекты, для которых регистрируется событие.

Укажите объект, используя строки app, page или app_and_page. Подробнее см. в часто задаваемых вопросах о событиях в приложении.

Отчетность о лидах с использованием Messaging Event API

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

Это событие наиболее эффективно используется, чтобы выделить определенных пользователей в качестве потенциальных лидов, что должно помочь компаниям установить приоритеты переписок для них. Например, компания может настроить автоматическую операцию для определения того или иного пользователя в качестве потенциального лида и запускать это событие, когда пользователь выполнит такую операцию, чтобы пометить ее для службы поддержки как переписку с высоким потенциалом.

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

Пример вызова API для предоставления отчета о событии лида, происходящем в переписке:

curl -X POST -H "Content-Type: application/json" -d '{
  "custom_events": [
    {
      "_eventName": "lead_submitted"
    }
  ],
  "advertiser_tracking_enabled": 1,
  "application_tracking_enabled": 1,
  "page_id": <PAGE_ID>,
  "page_scoped_user_id": <PSID>,
  "logging_source": "messenger_bot",
  "logging_target": "page"
}' https://graph.facebook.com/v21.0/<APP_ID>/page_activities?access_token=<PAGE_ACCESS_TOKEN>

Отчетность о лидах с использованием Ads Insights API

Включенные в отчет события лидов можно визуализировать с помощью Ads Insights API. Этот API позволяет создать расширенную панель аналитики, чтобы помочь вам визуализировать лиды, атрибутированные кампаниям с переходом к переписке.

Предварительные требования

Прежде чем начинать работу с этим API, убедитесь, что приложение прошло проверку для разрешения ads_read и получило расширенный доступ.

Выполнение

Пример вызова на уровне рекламной кампании:

curl -G \
-d "date_preset=last_7d" \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<AD_CAMPAIGN_ID>/insights"
    

Insight API можно вызывать на уровне рекламного аккаунта, кампании или группы объявлений в зависимости от нужного уровня детализации.

Вызов для получения лида:

  • Лиды (атрибутированные)
    • /<OBJECT_ID>/insights?fields=actions
    • В результате action_type=onsite_converstion.lead_grouped

Подробное определение перечисленных типов действий см. в справке по действиям с рекламой.

Рекомендации по классификации лидов

  1. Рекламодатель относится к одной из классических отраслей генерации лидов (авто, профессиональные услуги, финансовые услуги, B2B, образование, здравоохранение).
  2. Рекламодатель запрашивает контактную информацию, например телефон или электронный адрес, и пользователь предоставляет ее.
  3. Вопросы о телефоне или электронном адресе предваряются каким-либо уточнением (например, 1–2 дополнительными вопросами).
  4. Если в вашем приложении предлагаются шаблоны для генерации лидов, добавьте этот сигнал в конец процессов генерации лидов по умолчанию.

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

Проверка регистрации событий

Администратор приложения или Страницы может проверить в Ads Manager, правильно ли регистрируются события.

Особые замечания об аналитике для Messenger

  • Одно приложение может регистрировать взаимодействия для нескольких Страниц. В таких случаях в приложении видны события взаимодействия со всеми Страницами.
  • С одной Страницей можно связать несколько приложений. В этом случае, когда Страница блокируется, все связанные с ней приложения получают событие fb_messenger_bot_stopped.
  • Количество событий Удалена переписка с ботом Messenger может быть больше количества событий Новое действие пользователя. Количество событий Удалена переписка с ботом Messenger показывает, сколько раз пользователь удалял переписку. После удаления переписки пользователем Страница может инициировать новые переписки. Они также могут удаляться пользователями, в результате чего количество событий Удалена переписка с ботом Messenger увеличивается.

Использование для поставщиков платформ

Цель регистрации

Платформы, которые позволяют людям создавать боты Messenger с помощью визуального интерфейса, обычно используют одно центральное приложение для работы всех связанных с ним Страниц. Чтобы ваши клиенты могли просматривать свои собственные события, регистрируйте их на Страницах клиентов. Для этого установите для параметра logging_target значение page или app_and_page.

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

В визуальном редакторе можно добавить перетаскиваемый блок, где можно выбирать события и определять дополнительные параметры. Таким образом администраторы Страницы смогут настроить события для работы бота Messenger. Желательно, чтобы пользователям предлагался список с именами стандартных событий. В Ads Manager для отчетов, настройки таргетинга и оптимизации (если эти функции доступны) можно использовать только стандартные события. Если для действия пользователя не подходит ни одно имя стандартного события, а отчет по рекламе не нужен, можно добавить поле, в котором пользователи смогут ввести произвольное имя события и задать его параметры.

Разрешения

Необходимое разрешение page_events нужно получить в процессе входа в ваше приложение через Facebook. Его нужно добавить в список разрешений, необходимых для работы кнопки "Вход", вызова Facebook SDK для JavaScript или собственного процесса входа, следуя этому руководству.

Дополнительные ресурсы