create-campaign

Описание

Создает новую кампанию для приложения или обновляет настройки существующей кампании для приложения.

См. также: AWS API Documentation

Сводка

  create-campaign
--application-id <value>
--write-campaign-request <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--application-id (string)

Уникальный идентификатор приложения. Этот идентификатор отображается как Project ID в консоли Amazon Pinpoint.

--write-campaign-request (structure)

Задает конфигурацию и другие настройки для кампании.

AdditionalTreatments -> (list)

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

(structure)

Задает параметры для обработки кампании. Обработка — это вариант кампании, который используется для A/B-тестирования кампании.

CustomDeliveryConfiguration -> (structure)

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

DeliveryUri -> (string)

Место назначения для отправки кампании или обработки. Это значение может быть одним из следующих:

Имя или ARN (Amazon Resource Name) функции AWS Lambda для вызова для обработки доставки кампании или обработки.
URL-адрес веб-приложения или службы, поддерживающей HTTPS, которая может получать сообщение. URL-адрес должен быть полным URL-адресом, включая протокол HTTPS.

EndpointTypes -> (list)

Типы конечных точек для отправки кампании или обработки. Каждое допустимое значение сопоставляется с типом канала, который можно связать с конечной точкой, используя свойство ChannelType конечной точки.

(string)

MessageConfiguration -> (structure)

Настройки конфигурации сообщения для обработки.

ADMMessage -> (structure)

Сообщение, которое кампания отправляет через канал ADM (Amazon Device Messaging). Если указано, это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP — ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK — ваше приложение открывается и отображает назначенный пользовательский интерфейс в приложении. Эта настройка использует функции глубоких ссылок iOS и Android.
URL — в браузере мобильного устройства получателя по умолчанию открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Тело сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

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

ImageSmallIconUrl -> (string)

URL-адрес изображения, которое будет отображаться в качестве небольшого значка push-уведомления, например, небольшой версии значка приложения.

ImageUrl -> (string)

URL-адрес изображения, которое будет отображаться в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

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

SilentPush -> (boolean)

Указывает, является ли уведомление скрытым push-уведомлением, то есть push-уведомлением, которое не отображается на устройстве получателя. Скрытые push-уведомления можно использовать в таких случаях, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности phone home.

TimeToLive -> (integer)

Количество секунд, которое служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление с первого раза. Это значение преобразуется в значение срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекшее, и служба не сохраняет и не пытается доставить уведомление снова.

Это значение не применяется к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

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

Url -> (string)

URL-адрес, который будет открыт в браузере мобильного устройства получателя по умолчанию, если получатель коснется push-уведомления, а значение свойства Action — URL.

APNSMessage -> (structure)

Сообщение, которое кампания отправляет через канал APNs (Apple Push Notification service). Если указано, это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP — ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK — ваше приложение открывается и отображает назначенный пользовательский интерфейс в приложении. Эта настройка использует функции глубоких ссылок iOS и Android.
URL — в браузере мобильного устройства получателя по умолчанию открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Тело сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения, которое будет отображаться в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Это значение не применяется к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

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

Url -> (string)

BaiduMessage -> (structure)

Сообщение, которое кампания отправляет через канал Baidu (Baidu Cloud Push). Если указано, это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP — ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK — ваше приложение открывается и отображает назначенный пользовательский интерфейс в приложении. Эта настройка использует функции глубоких ссылок iOS и Android.
URL — в браузере мобильного устройства получателя по умолчанию открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Тело сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения, которое будет отображаться в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Это значение не применяется к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

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

Url -> (string)

CustomMessage -> (structure)

Сообщение, которое кампания отправляет через пользовательский канал, как указано в настройках конфигурации доставки (CustomDeliveryConfiguration) для кампании. Если указано, это сообщение переопределяет сообщение по умолчанию.

Data -> (string)

Строка в формате JSON для использования в качестве полезной нагрузки для сообщения. Максимальный размер — 5 КБ.

DefaultMessage -> (structure)

Сообщение по умолчанию, которое кампания отправляет через все каналы, настроенные для кампании.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение откроется или станет приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение откроется и отобразит назначенный пользовательский интерфейс в приложении. Этот параметр использует функции глубоких ссылок iOS и Android.
URL - В мобильном браузере по умолчанию на устройстве получателя откроется и загрузится веб-страница по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значка приложения.

ImageSmallIconUrl -> (string)

URL-адрес изображения для отображения в качестве небольшого значка push-уведомления, например, уменьшенной версии значка приложения.

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для тихого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

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

SilentPush -> (boolean)

Указывает, является ли уведомление тихим push-уведомлением, которое не отображается на устройстве получателя. Тихие push-уведомления можно использовать в таких случаях, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функции «звонок домой».

TimeToLive -> (integer)

Количество секунд, которое служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление с первого раза. Это значение преобразуется в значение истечения срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекшее, и служба не хранит и не пытается доставить уведомление снова.

Это значение не применяется к сообщениям, отправленным через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

URL-адрес для открытия в мобильном браузере по умолчанию получателя, если получатель коснется push-уведомления, а значение свойства Action — URL.

EmailMessage -> (structure)

Сообщение, которое кампания отправляет через канал электронной почты. Если указано, это сообщение переопределяет сообщение по умолчанию.

Body -> (string)

Текст электронного письма для получателей, чьи почтовые клиенты не отображают HTML-контент.

FromAddress -> (string)

Проверенный адрес электронной почты для отправки электронного письма. Адрес по умолчанию — это адрес FromAddress, указанный для канала электронной почты для приложения.

Headers -> (list)

Список MessageHeaders для электронного письма. Вы можете иметь до 15 MessageHeaders для каждого электронного письма.

(structure)

Содержит пару имя-значение заголовка электронного письма для добавления в ваше письмо. Вы можете иметь до 15 MessageHeaders. Заголовок может содержать информацию, такую как отправитель, получатель, маршрут или метка времени.

Name -> (string)

Имя заголовка сообщения. Имя заголовка может содержать до 126 символов.

Value -> (string)

Значение заголовка сообщения. Значение заголовка может содержать до 870 символов, включая длину любых отображаемых атрибутов. Например, если вы добавите атрибут {CreationDate}, он отобразится как YYYY-MM-DDTHH:MM:SS.SSSZ и имеет длину 24 символа.

HtmlBody -> (string)

Текст электронного письма в формате HTML для получателей, чьи почтовые клиенты отображают HTML-контент.

Title -> (string)

Строка темы или заголовок электронного письма.

GCMMessage -> (structure)

Сообщение, которое кампания отправляет через канал GCM, который позволяет Amazon Pinpoint отправлять push-уведомления через службу Firebase Cloud Messaging (FCM), ранее Google Cloud Messaging (GCM). Если указано, это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение откроется или станет приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение откроется и отобразит назначенный пользовательский интерфейс в приложении. Этот параметр использует функции глубоких ссылок iOS и Android.
URL - В мобильном браузере по умолчанию на устройстве получателя откроется и загрузится веб-страница по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для тихого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Количество секунд, которое служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление с первого раза. Это значение преобразуется в значение истечения срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекшее, и служба не хранит и не пытается доставить уведомление снова.

Это значение не применяется к сообщениям, отправленным через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

SMSMessage -> (structure)

Сообщение, которое кампания отправляет через канал SMS. Если указано, это сообщение переопределяет сообщение по умолчанию.

Body -> (string)

Текст SMS-сообщения.

MessageType -> (string)

Тип SMS-сообщения. Допустимые значения: TRANSACTIONAL (для важных или срочных сообщений, таких как одноразовые пароли) и PROMOTIONAL (для сообщений, которые не являются важными или срочными, например, маркетинговые сообщения).

OriginationNumber -> (string)

Длинный код для отправки SMS-сообщения. Это значение должно быть одним из выделенных длинных кодов, назначенных вашей учетной записи AWS. Хотя это и не требуется, мы рекомендуем указать длинный код, используя формат E.164, чтобы обеспечить быструю и точную доставку сообщения. Например, +12065550100.

SenderId -> (string)

Идентификатор отправителя для отображения на устройствах получателей при получении SMS-сообщения.

EntityId -> (string)

Идентификатор сущности или идентификатор основной сущности (PE), полученный от регулирующего органа для отправки SMS в вашей стране.

TemplateId -> (string)

Идентификатор шаблона, полученный от регулирующего органа для отправки SMS в вашей стране.

InAppMessage -> (structure)

Конфигурация сообщения в приложении.

Body -> (string)

Текст сообщения уведомления, текст электронного письма или текстовое сообщение.

Content -> (list)

Содержимое сообщения в приложении.

(structure)

Конфигурация содержимого сообщения.

BackgroundColor -> (string)

Цвет фона сообщения.

BodyConfig -> (structure)

Конфигурация тела сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Body -> (string)

Тело сообщения.

TextColor -> (string)

Цвет текста.

HeaderConfig -> (structure)

Конфигурация заголовка сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Header -> (string)

Заголовок сообщения.

TextColor -> (string)

Цвет текста.

ImageUrl -> (string)

URL изображения для фона сообщения.

PrimaryBtn -> (structure)

Первая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Цвет фона кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

SecondaryBtn -> (structure)

Вторая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Цвет фона кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

CustomConfig -> (map)

Пользовательская конфигурация для отправки клиенту.

key -> (string)

value -> (string)

Layout -> (string)

Макет сообщения в приложении.

Schedule -> (structure)

Настройки расписания для обработки.

EndTime -> (string)

Запланированное время в формате ISO 8601, когда кампания закончилась или закончится.

EventFilter -> (structure)

Тип события, которое приводит к отправке кампании, если значение свойства Frequency равно EVENT.

Dimensions -> (structure)

Настройки измерения фильтра событий для кампании.

Attributes -> (map)

Одно или несколько пользовательских атрибутов, которые ваше приложение сообщает в Amazon Pinpoint. Эти атрибуты можно использовать в качестве критериев отбора при создании фильтра событий.

key -> (string)

value -> (structure)

Задает критерии на основе атрибутов для включения или исключения конечных точек из сегмента.

AttributeType -> (string)

Тип измерения сегмента, которое следует использовать. Допустимые значения:

INCLUSIVE — конечные точки, атрибуты которых соответствуют значениям, включены в сегмент.
EXCLUSIVE — конечные точки, атрибуты которых соответствуют значениям, исключаются из сегмента.
CONTAINS — конечные точки, подстроки атрибутов которых соответствуют значениям, включены в сегмент.
BEFORE — конечные точки с атрибутами, считываемыми как даты и время ISO_INSTANT до значения, включены в сегмент.
AFTER — конечные точки с атрибутами, считываемыми как даты и время ISO_INSTANT после значения, включены в сегмент.
ON — конечные точки с атрибутами, считываемыми как даты ISO_INSTANT в значении, включены в сегмент. Время игнорируется в этом сравнении.
BETWEEN — конечные точки с атрибутами, считываемыми как даты и время ISO_INSTANT между значениями, включены в сегмент.

Values -> (list)

Значения критериев, которые следует использовать для измерения сегмента. В зависимости от значения свойства AttributeType конечные точки включаются или исключаются из сегмента, если значения их атрибутов соответствуют значениям критериев.

(string)

EventType -> (structure)

Имя события, которое приводит к отправке кампании или выполнению действия пути. Это может быть стандартное событие, которое генерирует Amazon Pinpoint, например _email.delivered. Для кампаний это также может быть пользовательское событие, специфичное для вашего приложения. Сведения о стандартных событиях см. в разделе Streaming Amazon Pinpoint Events в Руководстве разработчика Amazon Pinpoint.

DimensionType -> (string)

Тип измерения сегмента, который следует использовать. Допустимые значения: INCLUSIVE — конечные точки, которые соответствуют критериям, включены в сегмент; и, EXCLUSIVE — конечные точки, которые соответствуют критериям, исключаются из сегмента.

Values -> (list)

Значения критериев, которые следует использовать для измерения сегмента. В зависимости от значения свойства DimensionType конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.

(string)

Metrics -> (map)

Одна или несколько пользовательских метрик, которые ваше приложение сообщает в Amazon Pinpoint. Эти метрики можно использовать в качестве критериев отбора при создании фильтра событий.

key -> (string)

value -> (structure)

Задает критерии на основе метрик для включения или исключения конечных точек из сегмента. Эти критерии зависят от пользовательских метрик, которые вы определяете для конечных точек.

ComparisonOperator -> (string)

Оператор, который следует использовать при сравнении значений метрик. Допустимые значения: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL и EQUAL.

Value -> (double)

Значение для сравнения.

FilterType -> (string)

Тип события, которое приводит к отправке кампании. Допустимые значения: SYSTEM — отправляет кампанию при возникновении системного события; и, ENDPOINT — отправляет кампанию при возникновении события конечной точки (Eventsresource).

Frequency -> (string)

Указывает, как часто отправляется кампания, или отправляется ли кампания в ответ на конкретное событие.

IsLocalTime -> (boolean)

Указывает, используют ли начало и конец расписания кампании местное время каждого получателя. Чтобы основывать расписание на местном времени каждого получателя, задайте для этого значения значение true.

QuietTime -> (structure)

Тихое время по умолчанию для кампании. Тихое время — это определенный временной диапазон, когда кампания не отправляет сообщения конечным точкам, если выполняются все следующие условия:

Свойство EndpointDemographic.Timezone конечной точки установлено в допустимое значение.
Текущее время в часовом поясе конечной точки позже или равно времени, указанному в свойстве QuietTime.Start для кампании.
Текущее время в часовом поясе конечной точки раньше или равно времени, указанному в свойстве QuietTime.End для кампании.

Если какое-либо из предыдущих условий не выполняется, конечная точка будет получать сообщения от кампании, даже если включено тихое время.

End -> (string)

Конкретное время, когда тихое время заканчивается. Это значение должно использовать 24-часовой формат и быть в формате ЧЧ:ММ, где ЧЧ — час (с начальным нулем, если применимо), а ММ — минуты. Например, используйте 02:30, чтобы представить 2:30 утра, или 14:30, чтобы представить 2:30 вечера.

Start -> (string)

Конкретное время, когда начинается тихое время. Это значение должно использовать 24-часовой формат и быть в формате ЧЧ:ММ, где ЧЧ — час (с начальным нулем, если применимо), а ММ — минуты. Например, используйте 02:30, чтобы представить 2:30 утра, или 14:30, чтобы представить 2:30 вечера.

StartTime -> (string)

Запланированное время, когда кампания началась или начнется. Допустимые значения: IMMEDIATE — чтобы запустить кампанию немедленно; или конкретное время в формате ISO 8601.

Timezone -> (string)

Смещение UTC для начала расписания кампании, если значение свойства IsLocalTime равно true. Допустимые значения: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10 и UTC-11.

SizePercent -> (integer)

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

TemplateConfiguration -> (structure)

Шаблон сообщения для использования в обработке.

EmailTemplate -> (структура)

Шаблон электронной почты для использования в сообщении.

Name -> (string)

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

Version -> (string)

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс Template Versions.

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

PushTemplate -> (структура)

Шаблон push-уведомления для использования в сообщении.

Name -> (string)

Version -> (string)

SMSTemplate -> (структура)

Шаблон SMS для использования в сообщении.

Name -> (string)

Version -> (string)

VoiceTemplate -> (структура)

Шаблон голосового сообщения для использования в сообщении. Этот объект не поддерживается для кампаний.

Name -> (string)

Version -> (string)

InAppTemplate -> (структура)

Шаблон InApp для использования в сообщении. Объект шаблона InApp не поддерживается для SendMessages.

Name -> (string)

Version -> (string)

TreatmentDescription -> (string)

Пользовательское описание обработки.

TreatmentName -> (string)

Пользовательское имя обработки.

CustomDeliveryConfiguration -> (структура)

Настройки конфигурации доставки для отправки кампании через пользовательский канал. Этот объект обязателен, если объект MessageConfiguration для кампании указывает объект CustomMessage.

DeliveryUri -> (string)

Место назначения для отправки кампании или обработки. Это значение может быть одним из следующих:

Имя или ARN (Amazon Resource Name) функции AWS Lambda, которую нужно вызвать для обработки доставки кампании или обработки.
URL-адрес для веб-приложения или службы, которая поддерживает HTTPS и может получать сообщение. URL-адрес должен быть полным URL-адресом, включая протокол HTTPS.

EndpointTypes -> (list)

(string)

Description -> (string)

Пользовательское описание кампании.

HoldoutPercent -> (integer)

Выделенный процент пользователей (членов сегмента), которые не должны получать сообщения из кампании.

Hook -> (структура)

Настройки для функции AWS Lambda, которую нужно вызвать в качестве программного перехватчика для кампании. Вы можете использовать этот перехватчик для настройки сегмента, используемого кампанией.

LambdaFunctionName -> (string)

Имя или ARN (Amazon Resource Name) функции AWS Lambda, которую Amazon Pinpoint вызывает для настройки сегмента для кампании.

Mode -> (string)

Режим, который Amazon Pinpoint использует для вызова функции AWS Lambda. Возможные значения:

FILTER - вызов функции для настройки сегмента, используемого кампанией.
DELIVERY - (Устарело) Ранее вызывалась функция для отправки кампании через пользовательский канал. Эта функциональность больше не поддерживается. Чтобы отправить кампанию через пользовательский канал, используйте объекты CustomDeliveryConfiguration и CampaignCustomMessage кампании.

WebUrl -> (string)

Веб-URL, который Amazon Pinpoint вызывает для вызова функции AWS Lambda через HTTPS.

IsPaused -> (boolean)

Указывает, нужно ли приостановить кампанию. Приостановленная кампания не запускается, если вы не возобновите ее, изменив это значение на false.

Limits -> (структура)

Ограничения обмена сообщениями для кампании.

Daily -> (integer)

Максимальное количество сообщений, которое кампания может отправить в одну конечную точку в течение 24-часового периода. Для приложения это значение определяет ограничение по умолчанию для количества сообщений, которые кампании и путешествия могут отправить в одну конечную точку в течение 24-часового периода. Максимальное значение — 100.

MaximumDuration -> (integer)

Максимальное количество времени в секундах, которое кампания может пытаться доставить сообщение после запланированного времени запуска кампании. Минимальное значение — 60 секунд.

MessagesPerSecond -> (integer)

Максимальное количество сообщений, которое кампания может отправлять каждую секунду. Для приложения это значение определяет ограничение по умолчанию для количества сообщений, которые кампании могут отправлять каждую секунду. Минимальное значение — 1. Максимальное значение — 20 000.

Total -> (integer)

Максимальное количество сообщений, которое кампания может отправить в одну конечную точку в течение кампании. Если кампания повторяется, эта настройка применяется ко всем запускам кампании. Максимальное значение — 100.

Session -> (integer)

Максимальное общее количество сообщений, которое кампания может отправить за сеанс пользователя.

MessageConfiguration -> (structure)

Настройки конфигурации сообщения для кампании.

ADMMessage -> (структура)

Action -> (строка)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Эта настройка использует функции глубокой связи iOS и Android.
URL - Браузер мобильного устройства получателя по умолчанию открывается и загружает веб-страницу по указанному вами URL-адресу.

Body -> (строка)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (строка)

URL-адрес изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (строка)

URL-адрес изображения для отображения в качестве небольшого значка push-уведомления, например уменьшенной версии значка приложения.

ImageUrl -> (строка)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (строка)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (строка)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (строка)

SilentPush -> (логическое)

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

TimeToLive -> (целое число)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если службе не удается доставить уведомление с первого раза. Это значение преобразуется в значение истечения срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление так, как если бы оно истекло немедленно, и служба не сохраняет и не пытается доставить уведомление повторно.

Это значение не применимо к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (строка)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (строка)

URL-адрес для открытия в браузере мобильного устройства получателя по умолчанию, если получатель коснется push-уведомления и значение свойства Action равно URL.

APNSMessage -> (структура)

Action -> (строка)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Эта настройка использует функции глубокой связи iOS и Android.
URL - Браузер мобильного устройства получателя по умолчанию открывается и загружает веб-страницу по указанному вами URL-адресу.

Body -> (строка)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (строка)

URL-адрес изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (строка)

ImageUrl -> (строка)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (строка)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (строка)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (строка)

SilentPush -> (логическое)

TimeToLive -> (целое число)

Это значение не применимо к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (строка)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (строка)

BaiduMessage -> (структура)

Action -> (строка)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Эта настройка использует функции глубокой связи iOS и Android.
URL - Браузер мобильного устройства получателя по умолчанию открывается и загружает веб-страницу по указанному вами URL-адресу.

Body -> (строка)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (строка)

URL-адрес изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (строка)

ImageUrl -> (строка)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (строка)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (строка)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (строка)

SilentPush -> (логическое)

TimeToLive -> (целое число)

Это значение не применимо к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (строка)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (строка)

CustomMessage -> (структура)

Data -> (строка)

Необработанная строка в формате JSON для использования в качестве полезной нагрузки для сообщения. Максимальный размер — 5 КБ.

DefaultMessage -> (структура)

Сообщение по умолчанию, которое кампания отправляет через все каналы, настроенные для кампании.

Action -> (string)

Действие, которое должно произойти, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Этот параметр использует функции глубокого связывания iOS и Android.
URL - В мобильном браузере по умолчанию на устройстве получателя открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Тело сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (string)

URL изображения для отображения в качестве небольшого значка push-уведомления, например, небольшой версии значка приложения.

ImageUrl -> (string)

URL изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

URL изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

Строка в формате JSON для использования в качестве полезных данных для сообщения уведомления. Если указано, это значение переопределяет все остальное содержимое сообщения.

SilentPush -> (boolean)

Указывает, является ли уведомление беззвучным push-уведомлением, которое не отображается на устройстве получателя. Беззвучные push-уведомления можно использовать для таких случаев, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности phone home.

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление в первый раз. Это значение преобразуется в значение истечения срока действия при отправке в службу push-уведомлений. Если это значение равно 0, служба обрабатывает уведомление так, как если бы оно истекло немедленно, и служба не сохраняет и не пытается доставить уведомление снова.

Это значение не применимо к сообщениям, отправляемым через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

URL для открытия в мобильном браузере по умолчанию получателя, если получатель коснется push-уведомления, а значение свойства Action равно URL.

EmailMessage -> (structure)

Body -> (string)

Тело электронного письма для получателей, чьи почтовые клиенты не отображают HTML-контент.

FromAddress -> (string)

Проверенный адрес электронной почты для отправки электронного письма. Адрес по умолчанию — FromAddress, указанный для канала электронной почты для приложения.

Headers -> (list)

Список MessageHeaders для электронного письма. Вы можете иметь до 15 MessageHeaders для каждого электронного письма.

(structure)

Содержит имя и пару значений заголовка электронной почты для добавления в ваше электронное письмо. Вы можете иметь до 15 MessageHeaders. Заголовок может содержать информацию, такую как отправитель, получатель, маршрут или временная метка.

Name -> (string)

Имя заголовка сообщения. Имя заголовка может содержать до 126 символов.

Value -> (string)

HtmlBody -> (string)

Тело электронного письма в формате HTML для получателей, чьи почтовые клиенты отображают HTML-контент.

Title -> (string)

Тема или заголовок электронного письма.

GCMMessage -> (structure)

Action -> (string)

Действие, которое должно произойти, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Этот параметр использует функции глубокого связывания iOS и Android.
URL - В мобильном браузере по умолчанию на устройстве получателя открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Тело сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

URL изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Это значение не применимо к сообщениям, отправляемым через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

SMSMessage -> (structure)

Body -> (string)

Тело SMS-сообщения.

MessageType -> (string)

Тип SMS-сообщения. Допустимые значения: TRANSACTIONAL (для важных или срочных сообщений, таких как одноразовые пароли) и PROMOTIONAL (для сообщений, которые не являются критическими или срочными, например, маркетинговые сообщения).

OriginationNumber -> (string)

Длинный код, с которого следует отправлять SMS-сообщение. Это значение должно быть одним из выделенных длинных кодов, назначенных вашей учетной записи AWS. Хотя это и не обязательно, мы рекомендуем указать длинный код, используя формат E.164, чтобы обеспечить быструю и точную доставку сообщения. Например, +12065550100.

SenderId -> (string)

Идентификатор отправителя для отображения на устройствах получателей при получении SMS-сообщения.

EntityId -> (string)

TemplateId -> (string)

Идентификатор шаблона, полученный от регулирующего органа для отправки SMS в вашей стране.

InAppMessage -> (structure)

Настройка сообщения в приложении.

Body -> (string)

Текст сообщения уведомления, текст электронного письма или текстовое сообщение.

Content -> (list)

Содержимое сообщения в приложении.

(structure)

Настройка содержимого сообщения.

BackgroundColor -> (string)

Цвет фона сообщения.

BodyConfig -> (structure)

Настройка текста сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Body -> (string)

Текст сообщения.

TextColor -> (string)

Цвет текста.

HeaderConfig -> (structure)

Настройка заголовка сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Header -> (string)

Заголовок сообщения.

TextColor -> (string)

Цвет текста.

ImageUrl -> (string)

URL изображения для фона сообщения.

PrimaryBtn -> (structure)

Первая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Цвет фона кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

SecondaryBtn -> (structure)

Вторая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Цвет фона кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

CustomConfig -> (map)

Пользовательская конфигурация для отправки клиенту.

key -> (string)

value -> (string)

Layout -> (string)

Макет сообщения в приложении.

Name -> (string)

Пользовательское имя кампании.

Schedule -> (structure)

Настройки расписания для кампании.

EndTime -> (string)

Запланированное время в формате ISO 8601, когда кампания завершилась или завершится.

EventFilter -> (structure)

Тип события, которое вызывает отправку кампании, если значение свойства Frequency равно EVENT.

Dimensions -> (structure)

Настройки измерений фильтра событий для кампании.

Attributes -> (map)

Один или несколько пользовательских атрибутов, которые ваше приложение сообщает в Amazon Pinpoint. Вы можете использовать эти атрибуты в качестве критериев выбора при создании фильтра событий.

key -> (string)

value -> (structure)

Указывает критерии на основе атрибутов для включения или исключения конечных точек из сегмента.

AttributeType -> (string)

Тип измерения сегмента для использования. Допустимые значения:

INCLUSIVE - конечные точки, атрибуты которых соответствуют значениям, включаются в сегмент.
EXCLUSIVE - конечные точки, атрибуты которых соответствуют значениям, исключаются из сегмента.
CONTAINS - конечные точки, подстроки атрибутов которых соответствуют значениям, включаются в сегмент.
BEFORE - конечные точки с атрибутами, которые считываются как метки времени ISO_INSTANT до значения, включаются в сегмент.
AFTER - конечные точки с атрибутами, которые считываются как метки времени ISO_INSTANT после значения, включаются в сегмент.
ON - конечные точки с атрибутами, которые считываются как даты ISO_INSTANT по значению, включаются в сегмент. Время игнорируется в этом сравнении.
BETWEEN - конечные точки с атрибутами, которые считываются как метки времени ISO_INSTANT между значениями, включаются в сегмент.

Values -> (list)

Значения критериев для использования для измерения сегмента. В зависимости от значения свойства AttributeType конечные точки включаются или исключаются из сегмента, если значения их атрибутов соответствуют значениям критериев.

(string)

EventType -> (structure)

Имя события, которое вызывает отправку кампании или выполнение действия пути. Это может быть стандартное событие, которое генерирует Amazon Pinpoint, например _email.delivered. Для кампаний это также может быть пользовательское событие, которое относится к вашему приложению. Сведения о стандартных событиях см. в разделе Потоковая передача событий Amazon Pinpoint в Руководстве разработчика Amazon Pinpoint .

DimensionType -> (string)

Тип измерения сегмента для использования. Допустимые значения: INCLUSIVE, конечные точки, соответствующие критериям, включаются в сегмент; и, EXCLUSIVE, конечные точки, соответствующие критериям, исключаются из сегмента.

Values -> (list)

Значения критериев для использования для измерения сегмента. В зависимости от значения свойства DimensionType конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.

(string)

Metrics -> (map)

Одна или несколько пользовательских метрик, которые ваше приложение сообщает в Amazon Pinpoint. Вы можете использовать эти метрики в качестве критериев выбора при создании фильтра событий.

key -> (string)

value -> (structure)

Указывает критерии на основе метрик для включения или исключения конечных точек из сегмента. Эти критерии исходят из пользовательских метрик, которые вы определяете для конечных точек.

ComparisonOperator -> (string)

Оператор для использования при сравнении значений метрик. Допустимые значения: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL и EQUAL.

Value -> (double)

Значение для сравнения.

FilterType -> (string)

Тип события, которое вызывает отправку кампании. Допустимые значения: SYSTEM, отправляет кампанию при возникновении системного события; и, ENDPOINT, отправляет кампанию при возникновении события конечной точки (Eventsresource).

Frequency -> (string)

Указывает, как часто отправляется кампания или отправляется ли кампания в ответ на определенное событие.

IsLocalTime -> (boolean)

Указывает, используют ли начальное и конечное время для расписания кампании местное время каждого получателя. Чтобы настроить расписание на основе местного времени каждого получателя, установите для этого значения true.

QuietTime -> (structure)

Время тишины по умолчанию для кампании. Время тишины — это определенный диапазон времени, когда кампания не отправляет сообщения конечным точкам, если выполнены все следующие условия:

Свойство EndpointDemographic.Timezone конечной точки имеет допустимое значение.
Текущее время в часовом поясе конечной точки позже или равно времени, указанному в свойстве QuietTime.Start для кампании.
Текущее время в часовом поясе конечной точки раньше или равно времени, указанному в свойстве QuietTime.End для кампании.

Если какое-либо из предыдущих условий не выполнено, конечная точка получит сообщения от кампании, даже если время тишины включено.

End -> (string)

Определенное время, когда заканчивается время тишины. Это значение должно использовать 24-часовой формат и быть в формате HH:MM, где HH — час (с ведущим нулем, если применимо), а MM — минуты. Например, используйте 02:30, чтобы представить 2:30 утра, или 14:30, чтобы представить 2:30 вечера.

Start -> (string)

Определенное время, когда начинается время тишины. Это значение должно использовать 24-часовой формат и быть в формате HH:MM, где HH — час (с ведущим нулем, если применимо), а MM — минуты. Например, используйте 02:30, чтобы представить 2:30 утра, или 14:30, чтобы представить 2:30 вечера.

StartTime -> (string)

Запланированное время, когда кампания началась или начнется. Допустимые значения: IMMEDIATE, чтобы немедленно запустить кампанию; или определенное время в формате ISO 8601.

Timezone -> (string)

Смещение в формате UTC для начала расписания кампании, если значение свойства IsLocalTime равно true. Допустимые значения: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10 и UTC-11.

SegmentId -> (string)

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

SegmentVersion -> (integer)

Версия сегмента для связи с кампанией.

tags -> (map)

Примечание

Начиная с 22-05-2023 теги были признаны устаревшими для операций обновления. После этой даты любое значение в тегах не обрабатывается, и код ошибки не возвращается. Для управления тегами мы рекомендуем использовать теги в Справочнике по API Amazon Pinpoint , команды resourcegroupstaggingapi в Документации по интерфейсу командной строки AWS или resourcegroupstaggingapi в AWS SDK .

(Устарело) Карта «строка-строка» пар ключ-значение, которая определяет теги для связи с кампанией. Каждый тег состоит из обязательного ключа тега и связанного значения тега.

key -> (string)

value -> (string)

TemplateConfiguration -> (structure)

Шаблон сообщения для использования в кампании.

EmailTemplate -> (structure)

Шаблон электронной почты для использования в сообщении.

Name -> (string)

Имя шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать имени существующего шаблона сообщения.

Version -> (string)

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

PushTemplate -> (structure)

Шаблон push-уведомления для использования в сообщении.

Name -> (string)

Version -> (string)

SMSTemplate -> (structure)

Шаблон SMS для использования в сообщении.

Name -> (string)

Version -> (string)

VoiceTemplate -> (structure)

Голосовой шаблон для использования в сообщении. Этот объект не поддерживается для кампаний.

Name -> (string)

Version -> (string)

InAppTemplate -> (structure)

Шаблон InApp для использования в сообщении. Объект InApp template не поддерживается для SendMessages.

Name -> (string)

Version -> (string)

TreatmentDescription -> (string)

Пользовательское описание обработки по умолчанию для кампании.

TreatmentName -> (string)

Пользовательское имя обработки по умолчанию для кампании, если у кампании несколько обработок. Обработка - это вариант кампании, который используется для A/B-тестирования.

Priority -> (integer)

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

Синтаксис JSON:

{
  "AdditionalTreatments": [
    {
      "CustomDeliveryConfiguration": {
        "DeliveryUri": "string",
        "EndpointTypes": ["PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP", ...]
      },
      "MessageConfiguration": {
        "ADMMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "APNSMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "BaiduMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "CustomMessage": {
          "Data": "string"
        },
        "DefaultMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "EmailMessage": {
          "Body": "string",
          "FromAddress": "string",
          "Headers": [
            {
              "Name": "string",
              "Value": "string"
            }
            ...
          ],
          "HtmlBody": "string",
          "Title": "string"
        },
        "GCMMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "SMSMessage": {
          "Body": "string",
          "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
          "OriginationNumber": "string",
          "SenderId": "string",
          "EntityId": "string",
          "TemplateId": "string"
        },
        "InAppMessage": {
          "Body": "string",
          "Content": [
            {
              "BackgroundColor": "string",
              "BodyConfig": {
                "Alignment": "LEFT"|"CENTER"|"RIGHT",
                "Body": "string",
                "TextColor": "string"
              },
              "HeaderConfig": {
                "Alignment": "LEFT"|"CENTER"|"RIGHT",
                "Header": "string",
                "TextColor": "string"
              },
              "ImageUrl": "string",
              "PrimaryBtn": {
                "Android": {
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string"
                },
                "DefaultConfig": {
                  "BackgroundColor": "string",
                  "BorderRadius": integer,
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string",
                  "Text": "string",
                  "TextColor": "string"
                },
                "IOS": {
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string"
                },
                "Web": {
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string"
                }
              },
              "SecondaryBtn": {
                "Android": {
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string"
                },
                "DefaultConfig": {
                  "BackgroundColor": "string",
                  "BorderRadius": integer,
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string",
                  "Text": "string",
                  "TextColor": "string"
                },
                "IOS": {
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string"
                },
                "Web": {
                  "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
                  "Link": "string"
                }
              }
            }
            ...
          ],
          "CustomConfig": {"string": "string"
            ...},
          "Layout": "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL"
        }
      },
      "Schedule": {
        "EndTime": "string",
        "EventFilter": {
          "Dimensions": {
            "Attributes": {"string": {
                  "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                  "Values": ["string", ...]
                }
              ...},
            "EventType": {
              "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
              "Values": ["string", ...]
            },
            "Metrics": {"string": {
                  "ComparisonOperator": "string",
                  "Value": double
                }
              ...}
          },
          "FilterType": "SYSTEM"|"ENDPOINT"
        },
        "Frequency": "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|"IN_APP_EVENT",
        "IsLocalTime": true|false,
        "QuietTime": {
          "End": "string",
          "Start": "string"
        },
        "StartTime": "string",
        "Timezone": "string"
      },
      "SizePercent": integer,
      "TemplateConfiguration": {
        "EmailTemplate": {
          "Name": "string",
          "Version": "string"
        },
        "PushTemplate": {
          "Name": "string",
          "Version": "string"
        },
        "SMSTemplate": {
          "Name": "string",
          "Version": "string"
        },
        "VoiceTemplate": {
          "Name": "string",
          "Version": "string"
        },
        "InAppTemplate": {
          "Name": "string",
          "Version": "string"
        }
      },
      "TreatmentDescription": "string",
      "TreatmentName": "string"
    }
    ...
  ],
  "CustomDeliveryConfiguration": {
    "DeliveryUri": "string",
    "EndpointTypes": ["PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP", ...]
  },
  "Description": "string",
  "HoldoutPercent": integer,
  "Hook": {
    "LambdaFunctionName": "string",
    "Mode": "DELIVERY"|"FILTER",
    "WebUrl": "string"
  },
  "IsPaused": true|false,
  "Limits": {
    "Daily": integer,
    "MaximumDuration": integer,
    "MessagesPerSecond": integer,
    "Total": integer,
    "Session": integer
  },
  "MessageConfiguration": {
    "ADMMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "APNSMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "BaiduMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "CustomMessage": {
      "Data": "string"
    },
    "DefaultMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "EmailMessage": {
      "Body": "string",
      "FromAddress": "string",
      "Headers": [
        {
          "Name": "string",
          "Value": "string"
        }
        ...
      ],
      "HtmlBody": "string",
      "Title": "string"
    },
    "GCMMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "SMSMessage": {
      "Body": "string",
      "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
      "OriginationNumber": "string",
      "SenderId": "string",
      "EntityId": "string",
      "TemplateId": "string"
    },
    "InAppMessage": {
      "Body": "string",
      "Content": [
        {
          "BackgroundColor": "string",
          "BodyConfig": {
            "Alignment": "LEFT"|"CENTER"|"RIGHT",
            "Body": "string",
            "TextColor": "string"
          },
          "HeaderConfig": {
            "Alignment": "LEFT"|"CENTER"|"RIGHT",
            "Header": "string",
            "TextColor": "string"
          },
          "ImageUrl": "string",
          "PrimaryBtn": {
            "Android": {
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string"
            },
            "DefaultConfig": {
              "BackgroundColor": "string",
              "BorderRadius": integer,
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string",
              "Text": "string",
              "TextColor": "string"
            },
            "IOS": {
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string"
            },
            "Web": {
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string"
            }
          },
          "SecondaryBtn": {
            "Android": {
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string"
            },
            "DefaultConfig": {
              "BackgroundColor": "string",
              "BorderRadius": integer,
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string",
              "Text": "string",
              "TextColor": "string"
            },
            "IOS": {
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string"
            },
            "Web": {
              "ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
              "Link": "string"
            }
          }
        }
        ...
      ],
      "CustomConfig": {"string": "string"
        ...},
      "Layout": "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL"
    }
  },
  "Name": "string",
  "Schedule": {
    "EndTime": "string",
    "EventFilter": {
      "Dimensions": {
        "Attributes": {"string": {
              "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
              "Values": ["string", ...]
            }
          ...},
        "EventType": {
          "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
          "Values": ["string", ...]
        },
        "Metrics": {"string": {
              "ComparisonOperator": "string",
              "Value": double
            }
          ...}
      },
      "FilterType": "SYSTEM"|"ENDPOINT"
    },
    "Frequency": "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|"IN_APP_EVENT",
    "IsLocalTime": true|false,
    "QuietTime": {
      "End": "string",
      "Start": "string"
    },
    "StartTime": "string",
    "Timezone": "string"
  },
  "SegmentId": "string",
  "SegmentVersion": integer,
  "tags": {"string": "string"
    ...},
  "TemplateConfiguration": {
    "EmailTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "PushTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "SMSTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "VoiceTemplate": {
      "Name": "string",
      "Version": "string"
    },
    "InAppTemplate": {
      "Name": "string",
      "Version": "string"
    }
  },
  "TreatmentDescription": "string",
  "TreatmentName": "string",
  "Priority": integer
}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если в командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное JSON, поскольку строка будет воспринята буквально. Это может не указываться вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если значение не предоставлено или предоставлено значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогичным образом, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный скелет JSON не стабилен между версиями AWS CLI, и никаких гарантий обратной совместимости в сгенерированном скелете JSON нет.

Глобальные опции

--debug (boolean)

Включить ведение журнала отладки.

--endpoint-url (string)

Переопределить URL по умолчанию команды данным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии со службами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Эта опция переопределяет поведение по умолчанию при проверке SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую разбивку на страницы. Если автоматическая разбивка на страницы отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования выходных данных команды.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки config/env.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Пакет сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокироваться и не будет превышать время ожидания. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение равно 0, подключение сокета будет блокироваться и не будет превышать время ожидания. Значение по умолчанию - 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших объектов. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные большие объекты будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается на двоичный большой объект, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо будет правильно отформатировать для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Вывод

CampaignResponse -> (structure)

Предоставляет информацию о статусе, конфигурации и других параметрах кампании.

AdditionalTreatments -> (list)

Массив ответов, по одному для каждого варианта, который вы определили для кампании, в дополнение к варианту по умолчанию.

(structure)

Указывает настройки для варианта кампании. Вариант — это вариант кампании, который используется для A/B-тестирования кампании.

CustomDeliveryConfiguration -> (structure)

Настройки конфигурации доставки для отправки варианта через пользовательский канал. Этот объект требуется, если объект MessageConfiguration для варианта указывает объект CustomMessage.

DeliveryUri -> (string)

Место назначения для отправки кампании или варианта. Это значение может быть одним из следующих:

Имя или ARN (Amazon Resource Name) функции AWS Lambda для вызова обработки доставки кампании или варианта.
URL-адрес веб-приложения или службы, поддерживающей HTTPS и способной получать сообщение. URL-адрес должен быть полным, включая протокол HTTPS.

EndpointTypes -> (list)

Типы конечных точек для отправки кампании или варианта. Каждое допустимое значение сопоставляется с типом канала, который можно связать с конечной точкой с помощью свойства ChannelType конечной точки.

(string)

Id -> (string)

Уникальный идентификатор варианта.

MessageConfiguration -> (structure)

Настройки конфигурации сообщения для варианта.

ADMMessage -> (structure)

Сообщение, которое кампания отправляет через канал ADM (Amazon Device Messaging). При указании это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP — ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK — ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Этот параметр использует функции глубокой связи iOS и Android.
URL — в мобильном браузере по умолчанию на устройстве получателя открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значок приложения.

ImageSmallIconUrl -> (string)

URL-адрес изображения для отображения в качестве небольшого значка push-уведомления, например, уменьшенная версия значка приложения.

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

Строка в формате JSON для использования в качестве полезных данных для сообщения уведомления. При указании это значение переопределяет все остальное содержимое сообщения.

SilentPush -> (boolean)

Указывает, является ли уведомление беззвучным push-уведомлением, которое не отображается на устройстве получателя. Беззвучные push-уведомления можно использовать в таких случаях, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности phone home.

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если службе не удается доставить уведомление с первого раза. Это значение преобразуется в значение срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекающее, и служба не сохраняет и не пытается снова доставить уведомление.

Это значение не применяется к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

APNSMessage -> (structure)

Сообщение, которое кампания отправляет через канал APNs (Apple Push Notification service). При указании это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP — ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK — ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Этот параметр использует функции глубокой связи iOS и Android.
URL — в мобильном браузере по умолчанию на устройстве получателя открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значок приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если службе не удается доставить уведомление с первого раза. Это значение преобразуется в значение срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекающее, и служба не сохраняет и не пытается снова доставить уведомление.

Это значение не применяется к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

BaiduMessage -> (structure)

Сообщение, которое кампания отправляет через канал Baidu (Baidu Cloud Push). При указании это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP — ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK — ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Этот параметр использует функции глубокой связи iOS и Android.
URL — в мобильном браузере по умолчанию на устройстве получателя открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значок приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если службе не удается доставить уведомление с первого раза. Это значение преобразуется в значение срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекающее, и служба не сохраняет и не пытается снова доставить уведомление.

Это значение не применяется к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

CustomMessage -> (structure)

Сообщение, которое кампания отправляет через пользовательский канал, как указано в настройках конфигурации доставки (CustomDeliveryConfiguration) для кампании. При указании это сообщение переопределяет сообщение по умолчанию.

Data -> (string)

Строка в формате JSON для использования в качестве полезных данных для сообщения. Максимальный размер — 5 КБ.

DefaultMessage -> (structure)

Сообщение по умолчанию, которое кампания отправляет по всем каналам, настроенным для кампании.

Действие -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Этот параметр использует функции глубокой связи iOS и Android.
URL - Открывается мобильный браузер по умолчанию на устройстве получателя и загружает веб-страницу по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов - 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

Необработанная строка в формате JSON для использования в качестве полезных данных для сообщения уведомления. Если указано, это значение переопределяет все остальное содержимое сообщения.

SilentPush -> (boolean)

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление с первого раза. Это значение преобразуется в значение срока действия, когда оно отправляется в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекшее, и служба не сохраняет и не пытается доставить уведомление повторно.

Это значение не применяется к сообщениям, отправляемым через службу Amazon Device Messaging (ADM).

Title -> (string)

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

Url -> (string)

URL-адрес для открытия в мобильном браузере по умолчанию получателя, если получатель коснется push-уведомления и значение свойства Action равно URL.

EmailMessage -> (structure)

Сообщение, которое кампания отправляет по каналу электронной почты. Если указано, это сообщение переопределяет сообщение по умолчанию.

Body -> (string)

Текст письма для получателей, чьи почтовые клиенты не отображают HTML-контент.

FromAddress -> (string)

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

Headers -> (list)

Список заголовков сообщений для электронной почты. Для каждого письма можно использовать до 15 MessageHeaders.

(structure)

Содержит имя и значение пары заголовка электронной почты, который необходимо добавить в ваше письмо. У вас может быть до 15 MessageHeaders. Заголовок может содержать такую информацию, как отправитель, получатель, маршрут или отметка времени.

Name -> (string)

Имя заголовка сообщения. Имя заголовка может содержать до 126 символов.

Value -> (string)

Значение заголовка сообщения. Значение заголовка может содержать до 870 символов, включая длину всех отображаемых атрибутов. Например, если вы добавите атрибут {CreationDate}, он будет отображаться как YYYY-MM-DDTHH:MM:SS.SSSZ и имеет длину 24 символа.

HtmlBody -> (string)

Текст письма в формате HTML для получателей, чьи почтовые клиенты отображают HTML-контент.

Title -> (string)

Тема или заголовок электронного письма.

GCMMessage -> (structure)

Сообщение, которое кампания отправляет по каналу GCM, что позволяет Amazon Pinpoint отправлять push-уведомления через службу Firebase Cloud Messaging (FCM), ранее Google Cloud Messaging (GCM). Если указано, это сообщение переопределяет сообщение по умолчанию.

Action -> (string)

Действие, которое произойдет, если получатель коснется push-уведомления. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Этот параметр использует функции глубокой связи iOS и Android.
URL - Открывается мобильный браузер по умолчанию на устройстве получателя и загружает веб-страницу по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов - 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Это значение не применяется к сообщениям, отправляемым через службу Amazon Device Messaging (ADM).

Title -> (string)

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

Url -> (string)

SMSMessage -> (structure)

Сообщение, которое кампания отправляет по SMS-каналу. Если указано, это сообщение переопределяет сообщение по умолчанию.

Body -> (string)

Текст SMS-сообщения.

MessageType -> (string)

OriginationNumber -> (string)

Длинный код для отправки SMS-сообщения. Это значение должно быть одним из выделенных длинных кодов, присвоенных вашей учетной записи AWS. Хотя это и не требуется, мы рекомендуем указать длинный код в формате E.164, чтобы обеспечить быструю и точную доставку сообщения. Например, +12065550100.

SenderId -> (string)

Идентификатор отправителя для отображения на устройствах получателей при получении SMS-сообщения.

EntityId -> (string)

Идентификатор организации или идентификатор основного объекта (PE), полученный от регулирующего органа для отправки SMS в вашей стране.

TemplateId -> (string)

Идентификатор шаблона, полученный от регулирующего органа для отправки SMS в вашей стране.

InAppMessage -> (structure)

Настройка сообщения в приложении.

Body -> (string)

Текст сообщения уведомления, тела письма или текстового сообщения.

Content -> (list)

Содержимое сообщения в приложении.

(structure)

Настройка содержимого сообщения.

BackgroundColor -> (string)

Фоновый цвет сообщения.

BodyConfig -> (structure)

Настройка тела сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Body -> (string)

Тело сообщения.

TextColor -> (string)

Цвет текста.

HeaderConfig -> (structure)

Настройка заголовка сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Header -> (string)

Заголовок сообщения.

TextColor -> (string)

Цвет текста.

ImageUrl -> (string)

URL-адрес изображения для фона сообщения.

PrimaryBtn -> (structure)

Первая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Фоновый цвет кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

SecondaryBtn -> (structure)

Вторая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Фоновый цвет кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Место назначения кнопки.

CustomConfig -> (map)

Пользовательская конфигурация для отправки клиенту.

key -> (string)

value -> (string)

Layout -> (string)

Макет сообщения в приложении.

Schedule -> (structure)

Настройки расписания для обработки.

EndTime -> (string)

Запланированное время в формате ISO 8601, когда кампания закончилась или закончится.

EventFilter -> (structure)

Тип события, которое вызывает отправку кампании, если значение свойства Frequency равно EVENT.

Dimensions -> (structure)

Настройки измерения фильтра событий для кампании.

Attributes -> (map)

Один или несколько настраиваемых атрибутов, которые ваше приложение сообщает в Amazon Pinpoint. Вы можете использовать эти атрибуты в качестве критериев отбора при создании фильтра событий.

key -> (string)

value -> (structure)

Указывает критерии на основе атрибутов для включения или исключения конечных точек из сегмента.

AttributeType -> (string)

Тип измерения сегмента для использования. Допустимые значения:

INCLUSIVE - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
EXCLUSIVE - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
CONTAINS - конечные точки, чьи подстроки атрибутов соответствуют значениям, включаются в сегмент.
BEFORE - конечные точки с атрибутами, прочитанными как даты и время ISO_INSTANT до значения, включаются в сегмент.
AFTER - конечные точки с атрибутами, прочитанными как даты и время ISO_INSTANT после значения, включаются в сегмент.
ON - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT в значении, включаются в сегмент. Время игнорируется в этом сравнении.
BETWEEN - конечные точки с атрибутами, прочитанными как даты и время ISO_INSTANT между значениями, включаются в сегмент.

Values -> (list)

Значения критериев, используемые для измерения сегмента. В зависимости от значения свойства AttributeType конечные точки включаются или исключаются из сегмента, если значения их атрибутов соответствуют значениям критериев.

(string)

EventType -> (structure)

Имя события, которое вызывает отправку кампании или выполнение действия путешествия. Это может быть стандартное событие, которое генерирует Amazon Pinpoint, например _email.delivered. Для кампаний это также может быть настраиваемое событие, относящееся к вашему приложению. Сведения о стандартных событиях см. в разделе «Потоковая передача событий Amazon Pinpoint» в Руководстве разработчика Amazon Pinpoint.

DimensionType -> (string)

Values -> (list)

Значения критериев, используемые для измерения сегмента. В зависимости от значения свойства DimensionType конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.

(string)

Metrics -> (map)

Одна или несколько пользовательских метрик, которые ваше приложение сообщает в Amazon Pinpoint. Вы можете использовать эти метрики в качестве критериев отбора при создании фильтра событий.

key -> (string)

value -> (structure)

Указывает критерии на основе метрик для включения или исключения конечных точек из сегмента. Эти критерии основываются на пользовательских метриках, которые вы определяете для конечных точек.

ComparisonOperator -> (string)

Оператор, используемый при сравнении значений метрик. Допустимые значения: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL и EQUAL.

Value -> (double)

Значение для сравнения.

FilterType -> (string)

Frequency -> (string)

Указывает, как часто отправляется кампания или отправляется ли кампания в ответ на определенное событие.

IsLocalTime -> (boolean)

Указывает, используют ли время начала и окончания расписания кампании местное время каждого получателя. Чтобы основывать расписание на местном времени каждого получателя, установите для этого значения значение true.

QuietTime -> (structure)

Тихое время по умолчанию для кампании. Тихое время — это определенный временной диапазон, когда кампания не отправляет сообщения конечным точкам, если выполнены все следующие условия:

Для свойства EndpointDemographic.Timezone конечной точки установлено допустимое значение.
Текущее время в часовом поясе конечной точки позже или равно времени, указанному свойством QuietTime.Start для кампании.
Текущее время в часовом поясе конечной точки раньше или равно времени, указанному свойством QuietTime.End для кампании.

Если какое-либо из предыдущих условий не выполнено, конечная точка получит сообщения от кампании, даже если включено тихое время.

End -> (string)

Определенное время окончания тихого времени. Это значение должно использовать 24-часовой формат и быть в формате ЧЧ:ММ, где ЧЧ — час (с ведущим нулем, если применимо), а ММ — минуты. Например, используйте 02:30, чтобы представить 2:30 утра, или 14:30, чтобы представить 2:30 вечера.

Start -> (string)

Определенное время начала тихого времени. Это значение должно использовать 24-часовой формат и быть в формате ЧЧ:ММ, где ЧЧ — час (с ведущим нулем, если применимо), а ММ — минуты. Например, используйте 02:30, чтобы представить 2:30 утра, или 14:30, чтобы представить 2:30 вечера.

StartTime -> (string)

Запланированное время начала или начала кампании. Допустимые значения: IMMEDIATE, чтобы начать кампанию немедленно; или, определенное время в формате ISO 8601.

Timezone -> (string)

Начальное смещение UTC для расписания кампании, если значение свойства IsLocalTime равно true. Допустимые значения: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10 и UTC-11.

SizePercent -> (integer)

Выделенный процент пользователей (членов сегмента), которым отправляется обработка.

State -> (structure)

Текущий статус обработки.

CampaignStatus -> (string)

Текущий статус кампании или текущий статус обработки, принадлежащей кампании A/B-тестирования.

Если в кампании используется A/B-тестирование, кампания имеет статус COMPLETED, только если все обработки кампании имеют статус COMPLETED. Если вы удалите сегмент, связанный с кампанией, кампания завершится неудачно и будет иметь статус DELETED.

TemplateConfiguration -> (structure)

Шаблон сообщения для использования в лечении.

EmailTemplate -> (структура)

Шаблон электронной почты для использования в сообщении.

Name -> (string)

Название шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать названию существующего шаблона сообщения.

Version -> (string)

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

PushTemplate -> (структура)

Шаблон push-уведомления для использования в сообщении.

Name -> (string)

Version -> (string)

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

SMSTemplate -> (структура)

Шаблон SMS для использования в сообщении.

Name -> (string)

Version -> (string)

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

VoiceTemplate -> (structure)

Голосовой шаблон для использования в сообщении. Этот объект не поддерживается для кампаний.

Name -> (string)

Version -> (string)

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

InAppTemplate -> (structure)

Шаблон InApp для использования в сообщении. Объект шаблона InApp не поддерживается для SendMessages.

Name -> (string)

Version -> (string)

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

TreatmentDescription -> (string)

Пользовательское описание лечения.

TreatmentName -> (string)

Пользовательское название лечения.

ApplicationId -> (string)

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

Arn -> (string)

Имя ресурса Amazon (ARN) кампании.

CreationDate -> (string)

Дата в формате ISO 8601, когда была создана кампания.

CustomDeliveryConfiguration -> (structure)

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

DeliveryUri -> (string)

Место назначения для отправки кампании или лечения. Это значение может быть одним из следующих:

Имя или имя ресурса Amazon (ARN) функции AWS Lambda для вызова, чтобы обработать доставку кампании или лечения.
URL-адрес веб-приложения или службы, которая поддерживает HTTPS и может получать сообщение. URL-адрес должен быть полным URL-адресом, включая протокол HTTPS.

EndpointTypes -> (list)

Типы конечных точек для отправки кампании или лечения. Каждое допустимое значение соответствует типу канала, который можно связать с конечной точкой, используя свойство ChannelType конечной точки.

(string)

DefaultState -> (structure)

Текущий статус лечения по умолчанию кампании. Это значение существует только для кампаний, у которых есть более одного лечения.

CampaignStatus -> (string)

Текущий статус кампании или текущий статус лечения, принадлежащего A/B-тестовой кампании.

Если кампания использует A/B-тестирование, кампания имеет статус COMPLETED только в том случае, если все варианты лечения кампании имеют статус COMPLETED. Если вы удалите сегмент, связанный с кампанией, кампания завершится неудачно и будет иметь статус DELETED.

Description -> (string)

Пользовательское описание кампании.

HoldoutPercent -> (integer)

Выделенный процент пользователей (членов сегмента), которые не должны получать сообщения от кампании.

Hook -> (structure)

Настройки для функции AWS Lambda, используемой в качестве хука кода для кампании. Вы можете использовать этот хук для настройки сегмента, используемого кампанией.

LambdaFunctionName -> (string)

Имя или имя ресурса Amazon (ARN) функции AWS Lambda, которую Amazon Pinpoint вызывает для настройки сегмента для кампании.

Mode -> (string)

Режим, который Amazon Pinpoint использует для вызова функции AWS Lambda. Возможные значения:

FILTER - Вызов функции для настройки сегмента, используемого кампанией.
DELIVERY - (Устарело) Ранее вызывалась функция для отправки кампании через пользовательский канал. Эта функциональность больше не поддерживается. Чтобы отправить кампанию через пользовательский канал, используйте объекты CustomDeliveryConfiguration и CampaignCustomMessage кампании.

WebUrl -> (string)

Веб-URL, который Amazon Pinpoint вызывает для вызова функции AWS Lambda по HTTPS.

Id -> (string)

Уникальный идентификатор кампании.

IsPaused -> (boolean)

Указывает, приостановлена ли кампания. Приостановленная кампания не запускается, если вы не возобновите ее, изменив это значение на false.

LastModifiedDate -> (string)

Дата в формате ISO 8601, когда кампания была изменена в последний раз.

Limits -> (structure)

Ограничения обмена сообщениями для кампании.

Daily -> (integer)

Максимальное количество сообщений, которые кампания может отправить одной конечной точке в течение 24-часового периода. Для приложения это значение указывает ограничение по умолчанию на количество сообщений, которые кампании и путешествия могут отправить одной конечной точке в течение 24-часового периода. Максимальное значение — 100.

MaximumDuration -> (integer)

Максимальное количество времени в секундах, которое кампания может пытаться доставить сообщение после запланированного времени начала кампании. Минимальное значение — 60 секунд.

MessagesPerSecond -> (integer)

Максимальное количество сообщений, которые кампания может отправлять каждую секунду. Для приложения это значение указывает ограничение по умолчанию на количество сообщений, которые кампании могут отправлять каждую секунду. Минимальное значение — 1. Максимальное значение — 20 000.

Total -> (integer)

Максимальное количество сообщений, которые кампания может отправить одной конечной точке в течение кампании. Если кампания повторяется, этот параметр применяется ко всем запускам кампании. Максимальное значение — 100.

Session -> (integer)

Максимальное общее количество сообщений, которые кампания может отправить за сеанс пользователя.

MessageConfiguration -> (structure)

Настройки конфигурации сообщения для кампании.

ADMMessage -> (structure)

Action -> (string)

Действие, которое должно произойти, если получатель нажмет на push-уведомление. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает назначенный пользовательский интерфейс в приложении. Этот параметр использует функции глубоких ссылок iOS и Android.
URL - Браузер мобильного устройства получателя по умолчанию открывается и загружает веб-страницу по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов - 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значка приложения.

ImageSmallIconUrl -> (string)

URL-адрес изображения для отображения в качестве маленького значка push-уведомления, например, маленькой версии значка приложения.

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

Исходная строка в формате JSON для использования в качестве полезной нагрузки для сообщения уведомления. Если указано, это значение переопределяет все другое содержимое сообщения.

SilentPush -> (boolean)

Указывает, является ли уведомление скрытым push-уведомлением, то есть push-уведомлением, которое не отображается на устройстве получателя. Скрытые push-уведомления можно использовать для таких случаев, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности home.

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление в первый раз. Это значение преобразуется в значение срока действия при отправке в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекающее, и служба не хранит и не пытается доставить уведомление снова.

Это значение не относится к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

URL для открытия в мобильном браузере получателя по умолчанию, если получатель нажмет на push-уведомление и значение свойства Action равно URL.

APNSMessage -> (structure)

Action -> (string)

Действие, которое должно произойти, если получатель нажмет на push-уведомление. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает назначенный пользовательский интерфейс в приложении. Этот параметр использует функции глубоких ссылок iOS и Android.
URL - Браузер мобильного устройства получателя по умолчанию открывается и загружает веб-страницу по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов - 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

Указывает, является ли уведомление скрытым push-уведомлением, то есть push-уведомлением, которое не отображается на устройстве получателя. Скрытые push-уведомления можно использовать для таких случаев, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности home.

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление в первый раз. Это значение преобразуется в значение срока действия при отправке в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекающее, и служба не хранит и не пытается доставить уведомление снова.

Это значение не относится к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

BaiduMessage -> (structure)

Action -> (string)

Действие, которое должно произойти, если получатель нажмет на push-уведомление. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает назначенный пользовательский интерфейс в приложении. Этот параметр использует функции глубоких ссылок iOS и Android.
URL - Браузер мобильного устройства получателя по умолчанию открывается и загружает веб-страницу по указанному вами URL-адресу.

Body -> (string)

Текст сообщения уведомления. Максимальное количество символов - 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например, значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезная нагрузка JSON для использования для скрытого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

Указывает, является ли уведомление скрытым push-уведомлением, то есть push-уведомлением, которое не отображается на устройстве получателя. Скрытые push-уведомления можно использовать для таких случаев, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности home.

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если служба не может доставить уведомление в первый раз. Это значение преобразуется в значение срока действия при отправке в службу push-уведомлений. Если это значение равно 0, служба рассматривает уведомление как немедленно истекающее, и служба не хранит и не пытается доставить уведомление снова.

Это значение не относится к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

CustomMessage -> (structure)

Data -> (string)

Исходная строка в формате JSON для использования в качестве полезной нагрузки для сообщения. Максимальный размер - 5 КБ.

DefaultMessage -> (structure)

Сообщение по умолчанию, которое кампания отправляет через все каналы, настроенные для кампании.

Действие -> (string)

Действие, которое произойдет, если получатель нажмет push-уведомление. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Эта настройка использует функции глубокой связи iOS и Android.
URL - В мобильном браузере по умолчанию на устройстве получателя открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Тело сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для тихого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

Указывает, является ли уведомление тихим push-уведомлением, то есть push-уведомлением, которое не отображается на устройстве получателя. Тихие push-уведомления можно использовать для таких случаев, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности «звонок домой».

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если службе не удается доставить уведомление с первого раза. Это значение преобразуется в значение истечения срока действия при отправке в службу push-уведомлений. Если это значение равно 0, служба обрабатывает уведомление так, как если бы срок его действия истек немедленно, и служба не сохраняет и не пытается повторно доставить уведомление.

Это значение не применимо к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

URL-адрес для открытия в мобильном браузере по умолчанию получателя, если получатель нажимает push-уведомление и значение свойства Action — URL.

EmailMessage -> (structure)

Body -> (string)

Текст электронного письма для получателей, чьи почтовые клиенты не отображают HTML-контент.

FromAddress -> (string)

Проверенный адрес электронной почты для отправки электронного письма. Адрес по умолчанию — FromAddress, указанный для канала электронной почты приложения.

Headers -> (list)

Список MessageHeaders для электронной почты. Вы можете иметь до 15 MessageHeaders для каждого электронного письма.

(structure)

Содержит имя и значение пары заголовка электронной почты, чтобы добавить его в ваше электронное письмо. Вы можете иметь до 15 MessageHeaders. Заголовок может содержать такую информацию, как отправитель, получатель, маршрут или временная метка.

Name -> (string)

Имя заголовка сообщения. Имя заголовка может содержать до 126 символов.

Value -> (string)

HtmlBody -> (string)

Тело электронного письма в формате HTML для получателей, чьи почтовые клиенты отображают HTML-контент.

Title -> (string)

Строка темы или заголовок электронного письма.

GCMMessage -> (structure)

Сообщение, которое кампания отправляет через канал GCM, что позволяет Amazon Pinpoint отправлять push-уведомления через службу Firebase Cloud Messaging (FCM), ранее Google Cloud Messaging (GCM). Если указано, это сообщение переопределяет сообщение по умолчанию.

Действие -> (string)

Действие, которое произойдет, если получатель нажмет push-уведомление. Допустимые значения:

OPEN_APP - Ваше приложение открывается или становится приложением переднего плана, если оно было отправлено в фоновый режим. Это действие по умолчанию.
DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Эта настройка использует функции глубокой связи iOS и Android.
URL - В мобильном браузере по умолчанию на устройстве получателя открывается и загружается веб-страница по указанному вами URL-адресу.

Body -> (string)

Тело сообщения уведомления. Максимальное количество символов — 200.

ImageIconUrl -> (string)

URL-адрес изображения для отображения в качестве значка push-уведомления, например значка приложения.

ImageSmallIconUrl -> (string)

ImageUrl -> (string)

URL-адрес изображения для отображения в push-уведомлении.

JsonBody -> (string)

Полезные данные JSON для использования для тихого push-уведомления.

MediaUrl -> (string)

URL-адрес изображения или видео для отображения в push-уведомлении.

RawContent -> (string)

SilentPush -> (boolean)

TimeToLive -> (integer)

Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если службе не удается доставить уведомление с первого раза. Это значение преобразуется в значение истечения срока действия при отправке в службу push-уведомлений. Если это значение равно 0, служба обрабатывает уведомление так, как если бы срок его действия истек немедленно, и служба не сохраняет и не пытается повторно доставить уведомление.

Это значение не применимо к сообщениям, которые отправляются через службу Amazon Device Messaging (ADM).

Title -> (string)

Заголовок для отображения над сообщением уведомления на устройстве получателя.

Url -> (string)

SMSMessage -> (structure)

Body -> (string)

Текст SMS-сообщения.

MessageType -> (string)

Тип SMS-сообщения. Допустимые значения: TRANSACTIONAL (для сообщений, которые являются критическими или срочными, например одноразовые пароли) и PROMOTIONAL (для сообщений, которые не являются критическими или срочными, например маркетинговых сообщений).

OriginationNumber -> (string)

Длинный код для отправки SMS-сообщения. Это значение должно быть одним из выделенных длинных кодов, назначенных вашей учетной записи AWS. Хотя это и не требуется, мы рекомендуем указать длинный код в формате E.164, чтобы обеспечить своевременную и точную доставку сообщения. Например, +12065550100.

SenderId -> (string)

Идентификатор отправителя для отображения на устройствах получателей при получении SMS-сообщения.

EntityId -> (string)

TemplateId -> (string)

Идентификатор шаблона, полученный от регулирующего органа для отправки SMS в вашей стране.

InAppMessage -> (structure)

Настройка сообщения в приложении.

Body -> (string)

Текст сообщения уведомления, тела письма или текстового сообщения.

Content -> (list)

Содержимое сообщения в приложении.

(structure)

Настройка содержимого сообщения.

BackgroundColor -> (string)

Цвет фона сообщения.

BodyConfig -> (structure)

Настройка тела сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Body -> (string)

Текст сообщения.

TextColor -> (string)

Цвет текста.

HeaderConfig -> (structure)

Настройка заголовка сообщения.

Alignment -> (string)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Header -> (string)

Заголовок сообщения.

TextColor -> (string)

Цвет текста.

ImageUrl -> (string)

URL-адрес изображения для фона сообщения.

PrimaryBtn -> (structure)

Первая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Цвет фона кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

SecondaryBtn -> (structure)

Вторая кнопка внутри сообщения.

Android -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

DefaultConfig -> (structure)

Содержимое кнопки по умолчанию.

BackgroundColor -> (string)

Цвет фона кнопки.

BorderRadius -> (integer)

Радиус границы кнопки.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

Text -> (string)

Текст кнопки.

TextColor -> (string)

Цвет текста кнопки.

IOS -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

Web -> (structure)

Содержимое кнопки по умолчанию.

ButtonAction -> (string)

Действие, запускаемое кнопкой.

Link -> (string)

Назначение кнопки.

CustomConfig -> (map)

Настраиваемая конфигурация для отправки клиенту.

key -> (string)

value -> (string)

Layout -> (string)

Макет сообщения в приложении.

Name -> (string)

Имя кампании.

Schedule -> (structure)

Настройки расписания для кампании.

EndTime -> (string)

Запланированное время в формате ISO 8601, когда кампания завершилась или завершится.

EventFilter -> (structure)

Тип события, которое приводит к отправке кампании, если значение свойства Frequency — EVENT.

Dimensions -> (structure)

Настройки измерения фильтра событий для кампании.

Attributes -> (map)

Один или несколько пользовательских атрибутов, которые ваше приложение сообщает в Amazon Pinpoint. Эти атрибуты можно использовать в качестве критериев отбора при создании фильтра событий.

key -> (string)

value -> (structure)

Указывает критерии на основе атрибутов для включения или исключения конечных точек из сегмента.

AttributeType -> (string)

Тип измерения сегмента для использования. Допустимые значения:

INCLUSIVE — конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
EXCLUSIVE — конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
CONTAINS — конечные точки с подстроками атрибутов, соответствующими значениям, включаются в сегмент.
BEFORE — конечные точки с атрибутами, считываемыми как даты и время ISO_INSTANT до значения, включаются в сегмент.
AFTER — конечные точки с атрибутами, считываемыми как даты и время ISO_INSTANT после значения, включаются в сегмент.
ON — конечные точки с атрибутами, считываемыми как даты ISO_INSTANT, в значении, включаются в сегмент. Время игнорируется при этом сравнении.
BETWEEN — конечные точки с атрибутами, считываемыми как даты и время ISO_INSTANT между значениями, включаются в сегмент.

Values -> (list)

Значения критериев для использования в измерении сегмента. В зависимости от значения свойства AttributeType конечные точки включаются или исключаются из сегмента, если значения их атрибутов соответствуют значениям критериев.

(string)

EventType -> (structure)

DimensionType -> (string)

Тип измерения сегмента для использования. Допустимые значения: INCLUSIVE — конечные точки, соответствующие критериям, включаются в сегмент; и EXCLUSIVE — конечные точки, соответствующие критериям, исключаются из сегмента.

Values -> (list)

Значения критериев для использования в измерении сегмента. В зависимости от значения свойства DimensionType конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.

(string)

Metrics -> (map)

key -> (string)

value -> (structure)

Указывает критерии на основе метрик для включения или исключения конечных точек из сегмента. Эти критерии зависят от пользовательских метрик, которые вы определяете для конечных точек.

ComparisonOperator -> (string)

Value -> (double)

Значение для сравнения.

FilterType -> (string)

Тип события, который приводит к отправке кампании. Допустимые значения: SYSTEM — отправляет кампанию при возникновении системного события; и ENDPOINT — отправляет кампанию при возникновении события конечной точки (Eventsresource).

Frequency -> (string)

Определяет, как часто отправляется кампания или отправляется ли кампания в ответ на определенное событие.

IsLocalTime -> (boolean)

QuietTime -> (structure)

Время тишины по умолчанию для кампании. Время тишины — это определенный диапазон времени, когда кампания не отправляет сообщения в конечные точки, если выполняются все следующие условия:

Свойство EndpointDemographic.Timezone конечной точки установлено в допустимое значение.
Текущее время в часовом поясе конечной точки больше или равно времени, указанному свойством QuietTime.Start кампании.
Текущее время в часовом поясе конечной точки меньше или равно времени, указанному свойством QuietTime.End кампании.

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

End -> (string)

Конкретное время, когда время тишины заканчивается. Это значение должно использовать 24-часовой формат и быть в формате HH:MM, где HH — час (с нулем в начале, если применимо), а MM — минуты. Например, используйте 02:30 для представления 2:30 AM или 14:30 для представления 2:30 PM.

Start -> (string)

Конкретное время, когда начинается время тишины. Это значение должно использовать 24-часовой формат и быть в формате HH:MM, где HH — час (с нулем в начале, если применимо), а MM — минуты. Например, используйте 02:30 для представления 2:30 AM или 14:30 для представления 2:30 PM.

StartTime -> (string)

Запланированное время, когда кампания началась или начнется. Допустимые значения: IMMEDIATE — для немедленного запуска кампании; или конкретное время в формате ISO 8601.

Timezone -> (string)

SegmentId -> (string)

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

SegmentVersion -> (integer)

Номер версии сегмента, связанного с кампанией.

State -> (structure)

Текущее состояние кампании.

CampaignStatus -> (string)

Текущее состояние кампании или текущее состояние обработки, которая принадлежит кампании A/B-тестирования.

Если в кампании используется A/B-тестирование, кампания имеет состояние COMPLETED только в том случае, если все обработки кампании имеют состояние COMPLETED. Если удалить сегмент, связанный с кампанией, кампания завершится с ошибкой и будет иметь состояние DELETED.

tags -> (map)

Сопоставление строк с строками пар "ключ-значение", определяющее теги, связанные с кампанией. Каждый тег состоит из обязательного ключа тега и связанного значения тега.

key -> (string)

value -> (string)

TemplateConfiguration -> (structure)

Шаблон сообщения, используемый для кампании.

EmailTemplate -> (structure)

Шаблон электронной почты, используемый для сообщения.

Name -> (string)

Название шаблона сообщения, используемого для сообщения. Если указано, это значение должно соответствовать имени существующего шаблона сообщения.

Version -> (string)

Уникальный идентификатор версии шаблона сообщения, используемой для сообщения. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте Template Versionsresource.

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует active version шаблона. active version обычно является версией шаблона, которая была недавно просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.

PushTemplate -> (structure)

Шаблон push-уведомления, используемый для сообщения.

Name -> (string)

Version -> (string)

SMSTemplate -> (structure)

Шаблон SMS, используемый для сообщения.

Name -> (string)

Version -> (string)

VoiceTemplate -> (structure)

Голосовой шаблон, используемый для сообщения. Этот объект не поддерживается для кампаний.

Name -> (string)

Version -> (string)

InAppTemplate -> (structure)

Шаблон InApp, используемый для сообщения. Объект шаблона InApp не поддерживается для SendMessages.

Name -> (string)

Version -> (string)

TreatmentDescription -> (string)

Пользовательское описание обработки по умолчанию для кампании.

TreatmentName -> (string)

Пользовательское имя обработки по умолчанию для кампании, если у кампании несколько обработок. treatment - это вариант кампании, который используется для A/B-тестирования.

Version -> (integer)

Номер версии кампании.

Priority -> (integer)

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