Атрибуты профиля

Передает параметры пользователя.

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

Свойства событий можно передавать в параметрах запроса или в теле. При передаче данных в теле, к URL запроса необходимо добавить .csv. Подробнее в разделе Пример запроса.

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

  • profile_id
  • appmetrica_device_id

Внимание

Post API содержит ограничения на загрузку данных. Подробнее в разделе Ограничения.

Формат запроса

POST https://api.appmetrica.yandex.com/logs/v1/import/profiles
  ? post_api_key=<string>
  & application_id=<int>
  & profile_id=<string>
  & attributes=<>

post_api_key*

Токен для загрузки данных. Его можно получить в разделе Настройки вашего приложения.

application_id*

Уникальный числовой идентификатор приложения в AppMetrica.

profile_id*

Идентификатор профиля пользователя. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK.

Внимание

Не передавайте значение вместе с параметром appmetrica_device_id. Сервер принимает только один из параметров.

attributes*

Набор значений пользовательских атрибутов в формате {key:value}. Value может принимать тип string, number, bool, counter. Если для профиля уже записано значение переданного атрибута — оно будет перезаписано на новое. Предшествующие значения атрибута не сохранятся. Подробнее о пользовательских атрибутах профилей.

Внимание

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

First-party data

First-party data (FPD, 1PD) — это логины, email, телефоны, внутренние идентификаторы user_id, CRM_id и другие данные, которые позволяют однозначно идентифицировать пользователя. Это позволяет корректно связать между собой действия пользователя, если он выполняет часть действий в веб-интерфейсе сервиса, а часть — в мобильном приложении, или использует разные устройства (например, мобильное приложение на смартфоне и планшете).

AppMetrica не хранит значения атрибутов first-party data в открытом виде. Переданные идентификаторы сохраняются в хешированном виде и используются для сопоставления действий пользователя между устройствами и платформами. В профиле пользователя доступна только информация о том, какие атрибуты first-party data были переданы для данного пользователя.

Post API поддерживает отправку атрибутов:

  • appmetrica_1pd_phone_sha256_0..appmetrica_1pd_phone_sha256_9 — хеши номеров телефонов (не больше 10 значений);
  • appmetrica_1pd_email_sha256_0..appmetrica_1pd_email_sha256_9 — хеши адресов email (не больше 10 значений);
  • appmetrica_1pd_telegram_sha256 — хеш логина Telegram (одно значение).

Пример запроса, отправляющего хеш номера телефона:

POST https://api.appmetrica.yandex.com/logs/v1/import/profiles
  ? post_api_key=<string>
  & application_id=<int>
  & profile_id=<string>
  & attributes={"appmetrica_1pd_phone_sha256_0":"<string>"}

При отправке запроса с атрибутами first-party data AppMetrica автоматически сгенерирует атрибуты с названиями appmetrica_1pd_phone_0..appmetrica_1pd_phone_9, appmetrica_1pd_email_0..appmetrica_1pd_email_9, appmetrica_1pd_telegram.

Факт передачи атрибутов first-party data можно проверить с помощью булевых атрибутов профиля:

  • appmetrica_1pd_phone_passed — равен true, если от пользователя получено хотя бы одно корректное значение атрибута appmetrica_1pd_phone_sha256_*.
  • appmetrica_1pd_email_passed - равен true, если от пользователя получено хотя бы одно корректное значение атрибута appmetrica_1pd_email_sha_256_*.
  • appmetrica_1pd_telegram_passed — равен true, если от пользователя получено корректное значение атрибута appmetrica_1pd_telegram_sha256.

В интерфейсе AppMetrica не отображаются сами переданные данные FPD, но факт передачи атрибута first-party data можно проверить в списке профилей — в параметрах сегментирования и в группировках по атрибутам профиля в подразделе Предопределенные атрибуты.

Сегментирование в списке профилей

сегментирование в списке профилей

Группировка в списке профилей

группировка в списке профилей

Отправка атрибутов first-party data доступна также через SDK:

Коды ответа

Код Описание
200 Данные успешно загружены.
403 Запрос не содержит заголовка авторизации, либо указан неверный токен.
400 Запрос не содержит одного или нескольких обязательных параметров.

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

POST /logs/v1/import/profiles.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 HTTP/1.1
Host: api.appmetrica.yandex.com
Connection: close

application_id,profile_id,attributes
1234567890,1234567890abcdef,"{""string_attribute_name"":""string_value"",""number_attribute_name"":1234,""bool_attribute_name"":true,""counter_attribute_name"":-1}"

Передача first-party data:

POST /logs/v1/import/profiles.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 HTTP/1.1
Host: api.appmetrica.yandex.com
Connection: close

application_id,profile_id,attributes
1234567890,1234567890abcdef,"{""appmetrica_1pd_phone_sha256_0"":""phone-number-hash"",""appmetrica_1pd_email_0"":""email-hash"",""appmetrica_1pd_telegram"":""login-hash""}"
POST /logs/v1/import/profiles?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012&application_id=1234567890&profile_id=1234567890abcdef&attributes={"string_attribute_name":"string_value","number_attribute_name":1234,"bool_attribute_name":true,"counter_attribute_name":-1} HTTP/1.1
Host: api.appmetrica.yandex.com
Content-Length: 0
Connection: close

Передача first-party data:

POST /logs/v1/import/profiles?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012&application_id=1234567890&profile_id=1234567890abcdef&attributes={"appmetrica_1pd_phone_sha256_0":"phone-number-hash","appmetrica_1pd_email_0":"email-hash","appmetrica_1pd_telegram":"login-hash"} HTTP/1.1
Host: api.appmetrica.yandex.com
Content-Length: 0
Connection: close

С помощью Post API можно изменить только собственные пользовательские атрибуты. Чтобы передать предопределенные атрибуты, используйте AppMetrica SDK. Подробнее см. в разделе Настройка отправки атрибутов профилей.

Другие методы Post API

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

Написать в службу поддержки Предложить улучшение для документации
Следующая