Ключевые идентификаторы API

В этой статье перечислены основные идентификаторы, используемые в API-запросах Wavesend. Эти идентификаторы необходимы для аутентификации, создания сообщений, таргетинга, сегментации, отслеживания и управления пользователями в ваших приложениях.

Общие идентификаторы

Application code

Уникальный идентификатор, присваиваемый каждому приложению в вашем аккаунте Wavesend. Он требуется в большинстве вызовов API для указания целевого приложения.

Где найти

Wavesend Control Panel → Под названием приложения.

API access token

Уникальный токен, присваиваемый аккаунту Wavesend и используемый для аутентификации API-запросов. Он позволяет управлять Project, отправлять сообщения, изменять настройки и получать данные. В каждом аккаунте по умолчанию создан как минимум один токен. Подробнее

Где найти

Wavesend Control Panel → API Access.

Идентификаторы устройства

Hardware ID

Уникальный идентификатор, присваиваемый устройству SDK Wavesend. Устанавливается SDK автоматически или передается при регистрации устройства. Подробнее

Где найти

В логах устройства. Подробнее
В User Explorer при поиске по User ID
В CSV-файле, загруженном из списка сегментов

Push token

Токен, выдаваемый поставщиками платформ, который идентифицирует пару “приложение-устройство” для доставки push-уведомлений. Собирается SDK автоматически при предоставлении разрешений на отправку push-уведомлений. Подробнее

Где найти

В логах устройства. Подробнее
В User Explorer введите HWID в поле поиска, чтобы найти связанное устройство, затем откройте сведения об устройстве, чтобы просмотреть Push token.

Тип устройства

Указывает платформу целевого устройства с помощью числового кода. Устанавливается SDK автоматически.

Поддерживаемые значения:

1 – iOS
3 – Android
7 – macOS
8 – Windows
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
14 – Email
17 – Huawei
18 – SMS
21 – WhatsApp
22 – Line

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

User ID

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

Где найти

Wavesend Control Panel → Audience → User Explorer

Идентификаторы сообщений

Код сообщения

Уникальный идентификатор, присваиваемый каждому сообщению при его создании. Имеет следующий формат: XXXX-XXXXXXXX-XXXXXXXX.

Этот код необходим для:

Отслеживания статуса и доставки определенного сообщения.
Отмены (или удаления) ранее отправленного сообщения.
Получения статистики по сообщению.

Где найти

Wavesend Control Panel: Перейдите в Message history, затем откройте свойства нужного сообщения. Код сообщения будет отображен там.
Ответ API /createMessage: При создании нового сообщения через API, Код сообщения включается в ответ.

Идентификаторы контента

Код Preset

Идентификатор для сохраненного пресета сообщения (например, push или SMS). Подробнее

Где найти

Wavesend Control Panel → Контент → Presets.

Вы можете найти код пресета в двух местах:

В виде списка, под названием пресета.
В URL-адресе при редактировании или создании пресета (это последняя часть URL).

Пример:

URL: https://app.wavesend.ru/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB

Код Preset: AAAAA-BBBBB

Код Rich Media

Идентификатор для шаблона rich media. Подробнее

Где найти

Wavesend Control Panel → Контент → Rich media.

Пример: URL: https://app.wavesend.ru/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics Код Rich Media: AAAAA-BBBBB

Код контента Email

Код контента Email — это уникальный идентификатор для сохраненного контента Email. Подробнее

Где найти

Wavesend Control Panel → Контент → Email content.

Код является последней частью URL-адреса.

Пример:

URL: https://app.wavesend.ru/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB Код контента Email: AAAAA-BBBBB

Идентификаторы кампании

Код кампании

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

Где найти

Код кампании отображается в URL-адресе при просмотре статистики по кампании в Wavesend Control Panel. Чтобы найти его, перейдите в Статистика → Сводная статистика, нажмите на нужную кампанию и скопируйте код, находящийся в конце URL-адреса.

Пример:

URL: https://app.wavesend.ru/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY

Код кампании: YYYYY-YYYYY

Journey ID

Уникальный идентификатор, используемый для связывания сообщений с конкретными маркетинговыми кампаниями для отслеживания и анализа эффективности.

Где найти

Journey ID отображается в URL-адресе холста кампании в Wavesend Control Panel.

Пример: URL: https://app.wavesend.ru/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Journey ID: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Идентификаторы для сегментации и таргетинга

Название Segment / Фильтра

Название предопределенного пользовательского Segment, созданного в Wavesend для таргетинга на аудиторию. Подробнее

Где найти

Wavesend Control Panel → Segments.

Код Segment / Фильтра

Уникальный код в формате XXXXX-XXXXX, который идентифицирует segment (также называемый фильтром) в Wavesend. Этот код используется в вызовах API, логике автоматизации и правилах динамической сегментации.

Где найти

Вы можете найти код сегмента в предпросмотре определения сегмента в разделе Segments в Wavesend Control Panel. Код фильтра отображается в начале логики таргетинга.

Пример:

Tag("XXXXX-XXXXX", "In-app Purchase", noteq, "0.00")

В этом случае XXXXX-XXXXX — это код фильтра (сегмента).

Tag

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

Где найти

Wavesend Control Panel → Tags или через API /getTags.

Идентификаторы событий

Название Event

Название отслеживаемого Event (например, purchase, login, subscription). Используется для запуска автоматизированных рабочих процессов или для аналитики. Подробнее

Где найти

Wavesend Control Panel → Audience → Events.

Идентификаторы геолокации

Geozone ID

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

Где найти

Wavesend Control Panel → Geozones.