Параметры серверных событий

ПараметрОписание
event_name
Строка

Обязательный параметр.
Имя стандартного или специально настроенного события. Это поле используется для дедупликации событий сервера (отправленных через пиксель Meta), приложения (через SDK или API App Events) или API Conversions. Параметр event_id также используется в дедупликации.


Для одного и того же действия пользователя значение event события браузера совпадает с event_name события на сервере или в приложении. Если мы обнаружим идентичные события, второе из которых отправлено не позднее 48 часов после первого, будет учитываться только первое событие. Если события сервера и браузера или приложения получены примерно в одно и то же время (с интервалом не более пяти минут), предпочтение отдается событию браузера или приложения. Дополнительную информацию о дедупликации событий пикселя и сервера см. в этой статье.

event_time
Целое число

Обязательный параметр.
Метка времени в формате UNIX в секундах. Это время, когда событие произошло. Оно может быть раньше, чем время отправки события на Facebook. Это обеспечивает пакетную обработку и оптимизацию производительности сервера. Это время следует отправлять в часовом поясе GMT.


Поле event_time может иметь значение в прошлом, но не ранее 7 дней до момента отправки события на Facebook. Если какое-либо значение event_time в data старше 7 дней, мы возвращаем ошибку для всего запроса и не обрабатываем ни одно событие.

user_data
Объект

Обязательный параметр.
Карта, содержащая сведения о клиентах. Параметры см. в статье Параметры информации о клиентах. Также см. статью Расширенный поиск совпадений, в которой перечислены аналогичные параметры для данных, отправляемых через пиксель Meta.

custom_data
Объект

Необязательный параметр.
Карта, содержащая дополнительные бизнес-данные о событии. Дополнительную информацию см. в статье Параметры пользовательских данных.

event_source_url
Строка

Необязательный параметр.
URL браузера, где произошло событие. URL должен начинаться с http:// или https:// и соответствовать подтвержденному домену.


Примечание. Поле event_source_url является обязательным для событий на сайте, передаваемых через API Conversions.

opt_out
Логическое значение

Необязательный параметр.
Флажок, означающий, что это событие не нужно использовать для оптимизации показов объявлений. Если задано значение true, событие используется только для атрибуции.

event_id
Строка

Необязательный параметр.
Этот ID можно указать в виде уникальной строки, заданной рекламодателем. Параметры event_id и event_name используются для дедупликации событий сервера (отправленных через пиксель Meta), приложения (через SDK или API App Events) или API Conversions. Обратите внимание: поле event_id помечено как необязательное, однако мы рекомендуем использовать для дедупликации событий именно его.


Для дедупликации значение eventID, получаемое от события браузера или приложения, должно совпадать со значением event_id соответствующего события, получаемого от сервера. Подробнее см. в статье Дедупликация событий пикселя и событий API Conversions.


Номер заказа или ID транзакции — это два потенциальных идентификатора, которые можно использовать для event_id. Например, если клиент делает на вашем сайте две покупки с номерами заказа 123 и 456, каждый вызов API Conversions должен содержать соответствующий номер заказа для event_id. Это позволяет нам правильно идентифицировать эти два события покупки в виде отдельных заказов. Два соответствующих события покупки пикселя браузера также должны отправить эти же номера покупок в параметре eventID, благодаря чему мы сможем понять, что имели место именно два события, а не четыре отдельные покупки.


Для других событий без действительного номера ID может использоваться произвольный номер (при условии, что этот же произвольный номер отправляется между событиями браузера и сервера).

action_source
Строка

Обязательный параметр.
Это поле позволяет указать, где произошли конверсии. Информация о том, где произошли события, позволяет убедиться, что ваши объявления отображаются целевой аудитории. Используя API Conversions, вы соглашаетесь, что параметр action_source является максимально точным, насколько вам это известно.


В поле action_source можно отправить следующие значения:


  • email — конверсия произошла через электронное письмо;
  • website — конверсия произошла на сайте;
  • app — конверсия произошла в мобильном приложении;
  • phone_call — конверсия произошла по телефону;
  • chat — конверсия произошла через приложение для обмена сообщениями, SMS или онлайн-переписку;
  • physical_store — конверсия произошла в физическом магазине;
  • system_generated — конверсия произошла автоматически, например в результате продления ежемесячной подписки;
  • business_messaging — конверсия произошла из рекламы с переходом в Messenger, Instagram или WhatsApp;
  • other — конверсия произошла другим способом.
Примечание. Все значения источника действия включают возможности измерения результативности рекламы и создания пользовательской аудитории. Все источники действия, за исключением physical_store, включают возможности оптимизации рекламы.
data_processing_options
Массив

Необязательный параметр.
Параметры обработки, которые следует включить для определенного события. Допустимое в настоящее время значение — LDU (ограниченное использование данных). Чтобы явным образом указать, что событие должно обрабатываться без ограничений, передайте пустой массив. Подробнее о параметрах обработки данных см. в этой статье. См. примеры реализации Conversions API.

data_processing_options_country
Целое число

Обязательный параметр, если в поле LDU отправляется значение data_processing_options.
Страна, связанная с параметром обработки данных. Допустимые в настоящее время значения — 1 (США) или 0 (мы самостоятельно определяем местонахождение пользователя). Подробнее о параметрах обработки данных см. в этой статье. См. примеры реализации Conversions API.

data_processing_options_state
Целое число

Обязательный параметр в некоторых случаях. (Подробную информацию см. в примечании ниже.)
Штат, связанный с параметром обработки данных. Допустимые в настоящее время значения — 1000 (Калифорния) или 0 (мы самостоятельно определяем местонахождение пользователя).


Примечание.

  • Если указана страна, необходимо также указать штат. В противном случае мы используем геолокационные данные для всего события.
  • Это поле обязательно, если в поле data_processing_options отправляется значение LDU, а IP-адрес не предоставляется.

Подробнее о параметрах обработки данных см. в этой статье. См. примеры реализации Conversions API.

app_data

Объект

Обязательно для событий в приложении.

Параметры для передачи данных приложения и информации об устройстве в API Conversions.

extinfo является подпараметром app_data.

extinfo

Объект

Обязательно для событий в приложении.

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


Примечания


  • Параметр version для Android должен иметь значение a2.

  • Параметр для iOS version должен иметь значение i2.

0

Строка

Обязательный параметр.

Версия extinfo


Пример: i2.

1

Строка

Имя пакета приложения


Пример: com.facebook.sdk.samples.hellofacebook.

2

Строка

Короткое имя версии (целое число или строка)


Пример: 1.0.

3

Строка

Длинное имя версии


Пример: 1.0 long.

4

Строка

Обязательный параметр.

Версия ОС


Пример: 13.4.1.

5

Строка

Имя модели устройства


Пример: iPhone5,1.

6

Строка

Язык


Пример: En_US.

7

Строка

Часовой пояс (сокращенно)


Пример: PDT.

8

Строка

Оператор


Пример: AT&T.

9

64-разрядное целое число

Ширина экрана


Пример: 320.

10

64-разрядное целое число

Высота экрана


Пример: 568.

11

Строка

Плотность пикселей экрана


Пример: 2.

12

64-разрядное целое число

Ядра ЦП


Пример: 2.

13

64-разрядное целое число

Размер внешнего хранилища в ГБ


Пример: 13.

14

64-разрядное целое число

Свободное место на внешнем хранилище в ГБ


Пример: 8.

15

Строка

Часовой пояс устройства


Пример: USA/New York.

referrer_url
Строка

Необязательный параметр.
Входящий сайт, который пользователь посетил непосредственно перед переходом на страницу рекламодателя, на которой сработал пиксель Meta. Это HTTP-реферер с точки зрения JavaScript. Значением referral_url будет либо страница, которую пользователь посетил перед текущей, либо iFrame.