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

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

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

Код приложения (Application code)

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

Где найти

Панель управления Pushwoosh → Под названием приложения.

Токен доступа API (API access token)

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

Где найти

Панель управления Pushwoosh → API Access.

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

Hardware ID (HWID)

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

Где найти

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

Push-токен (Push token)

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

Где найти

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

Тип устройства (Device type)

Указывает платформу целевого устройства с помощью числового кода. Устанавливается 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

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

Где найти

Панель управления Pushwoosh → Audience → User Explorer

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

Код сообщения (Message code)

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

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

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

Где найти

Панель управления Pushwoosh: Перейдите в Message history, затем откройте свойства нужного сообщения. Код сообщения (Message Code) будет отображен там.
Ответ API /createMessage: При создании нового сообщения через API, код сообщения (Message Code) включается в ответ.

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

Код пресета (Preset code)

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

Где найти

Панель управления Pushwoosh → Content → Presets.

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

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

Пример:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB

Код пресета: AAAAA-BBBBB

Код Rich Media

Идентификатор для шаблона In-App сообщения. Подробнее

Где найти

Панель управления Pushwoosh → Content → Rich media.

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

Код контента email-сообщения

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

Где найти

Панель управления Pushwoosh → Content → Email content.

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

Пример:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB Код контента email-сообщения: AAAAA-BBBBB

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

Код кампании (Campaign code)

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

Где найти

Код кампании появляется в URL-адресе при просмотре статистики по кампании в панели управления Pushwoosh. Чтобы найти его, перейдите в Statistics → Aggregated statistics, нажмите на нужную кампанию и скопируйте код, который находится в конце URL.

Пример:

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

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

Journey ID

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

Где найти

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

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

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

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

Название сегмента / фильтра (Segment / Filter name)

Название предопределенного сегмента пользователей, созданного в Pushwoosh для таргетинга аудитории. Подробнее

Где найти

Панель управления Pushwoosh → Segments.

Код сегмента / фильтра (Segment / Filter code)

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

Где найти

Через метод API /listFilters.
В адресной строке при просмотре сегмента в панели управления Pushwoosh:

Пример:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail Код сегмента: XXXE9-XXX49

Тег (Tag)

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

Где найти

Панель управления Pushwoosh → Tags или через API /getTags.

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

Название события (Event name)

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

Где найти

Панель управления Pushwoosh → Audience → Events.

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

Geozone ID

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

Где найти

Панель управления Pushwoosh → Geozones.