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

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

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

Где его найти

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

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

Где его найти

Pushwoosh Control Panel → API Access.

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

Где его найти

• В логах устройства. Подробнее

• В User Explorer при поиске по User ID

• В CSV-файле, загруженном из списка сегментов

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

Где его найти

• В логах устройства. Подробнее

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

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

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

1 – iOS
3 – Android
7 – macOS
8 – Windows
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
13 – Internet Explorer
14 – Email
17 – Huawei
18 – SMS
20 – Web
21 – WhatsApp
22 – Line
23 – Kakao Talk
24 – Telegram
25 – Apple Wallet
26 – Google Wallet
27 – Viber

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

Где его найти

Pushwoosh Control Panel → Audience → User Explorer

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

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

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

Где его найти

• Pushwoosh Control Panel: Перейдите в Campaigns → One-time messages, затем откройте свойства нужного сообщения. Код сообщения будет отображен там.
• Ответ API /createMessage: При создании нового сообщения через API, код сообщения включается в ответ.

Соотносит сообщение с HTTP-запросом, который его создал, позволяя отслеживать одну отправку от начала до конца — от HTTP-вызова через уровень маршрутизации Pushwoosh до итогового сообщения.

Присутствует в любом сообщении, созданном HTTP-вызовом к /createMessage или Messaging API v2, включая сообщения, отправленные из Control Panel. Сообщения, созданные с помощью Journeys, cron-отправок или других внутренних триггеров, не являющихся HTTP, не имеют Request ID.

Установка собственного значения

Передайте заголовок X-Request-ID вместе с запросом. Если значение имеет длину от 8 до 128 символов и содержит только латинские буквы, цифры, точки, подчеркивания и дефисы, Pushwoosh использует его повторно; в противном случае — или если заголовок опущен — Pushwoosh сгенерирует его для вас. Недопустимое значение заменяется без уведомления, поэтому запрос никогда не завершится ошибкой из-за него. Уникальность не проверяется, поэтому используйте значение, которое действительно уникально для каждого запроса, если вы полагаетесь на него для отслеживания.

Где его найти

Pushwoosh Control Panel → откройте сообщение → Message Details → Show all properties → Message settings → Request ID (с кнопкой копирования).

Пример: a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d

Уникальный код, который идентифицирует кампанию мгновенных In-App сообщений. Где его найти

Pushwoosh Control Panel → Campaigns → Instant in-apps. В списке код отображается под названием кампании.

Пример: AAAAA-BBBBB

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

Где его найти

Pushwoosh Control Panel → Content → Presets.

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

• В виде списка, отображаемого под названием пресета.

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

Пример:

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

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

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

Где его найти

Pushwoosh Control Panel → Content → Rich media.

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

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

Где его найти

Pushwoosh Control Panel → Content → Email content.

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

Пример:

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

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

Где его найти

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

Пример:

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

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

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

Где его найти

• В URL-адресе холста кампании в Pushwoosh Control Panel.
• Выберите точку на холсте и нажмите Ctrl+I (Cmd+I) — в буфер обмена будет скопировано <journey UUID>/<point UUID>; Journey ID — это часть до слэша.

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

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

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

Где его найти

Pushwoosh Control Panel → Segments.

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

Где его найти

• Через метод API /listFilters.

• В адресной строке при просмотре сегмента в Pushwoosh Control Panel:

Пример:

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

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

Где его найти

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

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

Где его найти

Pushwoosh Control Panel → Audience → Events.

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

Где его найти

Pushwoosh Control Panel → Geozones.