update-campaign

Description

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

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

Synopsis

  update-campaign
--application-id <value>
--campaign-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]

Options

--application-id (string)

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

--campaign-id (string)

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

--write-campaign-request (structure)

Указывает конфигурацию и другие настройки кампании.

AdditionalTreatments -> (list)

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

(structure)

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

CustomDeliveryConfiguration -> (structure)

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

DeliveryUri -> (string)

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

Имя или Amazon Resource Name (ARN) функции 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-уведомления можно использовать в таких случаях, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функции «звонок домой».

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)

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)

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)

Это значение не относится к сообщениям, отправляемым через службу 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-адресу.

Тело -> (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).

Заголовок -> (string)

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

Url -> (string)

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

EmailMessage -> (structure)

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

Тело -> (string)

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

FromAddress -> (string)

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

Headers -> (list)

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

(structure)

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

Имя -> (string)

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

Значение -> (string)

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

HtmlBody -> (string)

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

Заголовок -> (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-адресу.

Тело -> (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).

Заголовок -> (string)

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

Url -> (string)

SMSMessage -> (structure)

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

Тело -> (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 - конечные точки с атрибутами, прочитанными как datetimes ISO_INSTANT до значения, включаются в сегмент.
AFTER - конечные точки с атрибутами, прочитанными как datetimes ISO_INSTANT после значения, включаются в сегмент.
ON - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT по значению, включаются в сегмент. Время игнорируется при этом сравнении.
BETWEEN - конечные точки с атрибутами, прочитанными как datetimes 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-часовой формат и быть в формате 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)

Начальное смещение 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 -> (structure)

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

Name -> (string)

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

Version -> (string)

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

Если вы не укажете значение этого свойства, 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)

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

CustomDeliveryConfiguration -> (structure)

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

DeliveryUri -> (string)

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

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

EndpointTypes -> (list)

(string)

Description -> (string)

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

HoldoutPercent -> (integer)

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

Hook -> (structure)

Настройки для вызова функции 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 -> (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-уведомления можно использовать в таких случаях, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функции 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). Если указано, это сообщение переопределяет сообщение по умолчанию.

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)

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)

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)

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

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)

Список 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)

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)

SMSMessage -> (structure)

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)

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

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-часовой формат и быть в формате ЧЧ:ММ, где ЧЧ - это час (с лидирующим нулем, если применимо), а ММ - минуты. Например, используйте 02:30, чтобы представить 2:30 утра, или 14:30, чтобы представить 2:30 вечера.

Start -> (string)

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

StartTime -> (string)

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 -> (структура)

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

Name -> (string)

Version -> (string)

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

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

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

Name -> (string)

Version -> (string)

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

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

Name -> (string)

Version -> (string)

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

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

Name -> (string)

Version -> (string)

InAppTemplate -> (structure)

Шаблон InApp для использования в сообщении. Объект шаблона InApp не поддерживается для 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-адрес должен быть полным URL-адресом, включая протокол HTTPS.

EndpointTypes -> (list)

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

(string)

Id -> (string)

The unique identifier for the treatment.

MessageConfiguration -> (structure)

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

ADMMessage -> (structure)

Action -> (string)

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

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

Body -> (string)

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

ImageIconUrl -> (string)

The URL of the image to display as the push-notification icon, such as the icon for the app.

ImageSmallIconUrl -> (string)

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

ImageUrl -> (string)

The URL of an image to display in the push notification.

JsonBody -> (string)

The JSON payload to use for a silent push notification.

MediaUrl -> (string)

The URL of the image or video to display in the push notification.

RawContent -> (string)

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

SilentPush -> (boolean)

Specifies whether the notification is a silent push notification, which is a push notification that doesn’t display on a recipient’s device. Silent push notifications can be used for cases such as updating an app’s configuration, displaying messages in an in-app message center, or supporting phone home functionality.

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)

The URL of the image to display as the push-notification icon, such as the icon for the app.

ImageSmallIconUrl -> (string)

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

ImageUrl -> (string)

The URL of an image to display in the push notification.

JsonBody -> (string)

The JSON payload to use for a silent push notification.

MediaUrl -> (string)

The URL of the image or video to display in the push notification.

RawContent -> (string)

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

SilentPush -> (boolean)

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)

The URL of the image to display as the push-notification icon, such as the icon for the app.

ImageSmallIconUrl -> (string)

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

ImageUrl -> (string)

The URL of an image to display in the push notification.

JsonBody -> (string)

The JSON payload to use for a silent push notification.

MediaUrl -> (string)

The URL of the image or video to display in the push notification.

RawContent -> (string)

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

SilentPush -> (boolean)

TimeToLive -> (integer)

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

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

Title -> (string)

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

Url -> (string)

CustomMessage -> (structure)

Data -> (string)

The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

DefaultMessage -> (structure)

The default message that the campaign sends through all the channels that are configured for the campaign.

Action -> (string)

The action to occur if a recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

Body -> (string)

The body of the notification message. The maximum number of characters is 200.

ImageIconUrl -> (string)

The URL of the image to display as the push-notification icon, such as the icon for the app.

ImageSmallIconUrl -> (string)

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

ImageUrl -> (string)

The URL of an image to display in the push notification.

JsonBody -> (string)

The JSON payload to use for a silent push notification.

MediaUrl -> (string)

The URL of the image or video to display in the push notification.

RawContent -> (string)

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

SilentPush -> (boolean)

TimeToLive -> (integer)

The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it’s sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn’t store or try to deliver the notification again.

This value doesn’t apply to messages that are sent through the Amazon Device Messaging (ADM) service.

Title -> (string)

The title to display above the notification message on a recipient’s device.

Url -> (string)

The URL to open in a recipient’s default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

EmailMessage -> (structure)

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

Body -> (string)

The body of the email for recipients whose email clients don’t render HTML content.

FromAddress -> (string)

The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

Headers -> (list)

The list of MessageHeaders for the email. You can have up to 15 MessageHeaders for each email.

(structure)

Contains the name and value pair of an email header to add to your email. You can have up to 15 MessageHeaders. A header can contain information such as the sender, receiver, route, or timestamp.

Name -> (string)

The name of the message header. The header name can contain up to 126 characters.

Value -> (string)

The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.

HtmlBody -> (string)

The body of the email, in HTML format, for recipients whose email clients render HTML content.

Title -> (string)

The subject line, or title, of the email.

GCMMessage -> (structure)

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

Action -> (string)

The action to occur if a recipient taps the push notification. Valid values are:

OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

Body -> (string)

The body of the notification message. The maximum number of characters is 200.

ImageIconUrl -> (string)

The URL of the image to display as the push-notification icon, such as the icon for the app.

ImageSmallIconUrl -> (string)

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

ImageUrl -> (string)

The URL of an image to display in the push notification.

JsonBody -> (string)

The JSON payload to use for a silent push notification.

MediaUrl -> (string)

The URL of the image or video to display in the push notification.

RawContent -> (string)

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

SilentPush -> (boolean)

TimeToLive -> (integer)

This value doesn’t apply to messages that are sent through the Amazon Device Messaging (ADM) service.

Title -> (string)

The title to display above the notification message on a recipient’s device.

Url -> (string)

The URL to open in a recipient’s default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

SMSMessage -> (structure)

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

Body -> (string)

The body of the SMS message.

MessageType -> (string)

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren’t critical or time-sensitive, such as marketing messages).

OriginationNumber -> (string)

The long code to send the SMS message from. This value should be one of the dedicated long codes that’s assigned to your AWS account. Although it isn’t required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

SenderId -> (string)

The sender ID to display on recipients’ devices when they receive the SMS message.

EntityId -> (string)

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

TemplateId -> (string)

The template ID received from the regulatory body for sending SMS in your country.

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-часовой формат и быть в формате 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)

SizePercent -> (integer)

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

State -> (structure)

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

CampaignStatus -> (string)

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

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

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 template не поддерживается для SendMessages.

Name -> (string)

Version -> (string)

TreatmentDescription -> (string)

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

TreatmentName -> (string)

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

ApplicationId -> (string)

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

Arn -> (string)

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

CreationDate -> (string)

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

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

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

DeliveryUri -> (string)

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

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

EndpointTypes -> (list)

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

(string)

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

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

CampaignStatus -> (string)

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

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

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 - (Deprecated) Ранее вызывалась функция для отправки кампании через пользовательский канал. Эта функциональность больше не поддерживается. Чтобы отправить кампанию через пользовательский канал, используйте объекты 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 -> (структура)

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-уведомления можно использовать для таких случаев, как обновление конфигурации приложения, отображение сообщений в центре сообщений в приложении или поддержка функциональности phone home.

TimeToLive -> (integer)

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

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

Title -> (string)

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

Url -> (string)

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

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

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 -> (структура)

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 -> (структура)

Data -> (string)

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

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

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

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

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

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

Body -> (string)

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

ImageIconUrl -> (string)

ImageSmallIconUrl -> (string)

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

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)

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

EmailMessage -> (structure)

Body -> (string)

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

FromAddress -> (string)

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

Headers -> (list)

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

(structure)

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

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). Если указано, это сообщение переопределяет сообщение по умолчанию.

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)

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. Для кампаний это также может быть пользовательское событие, которое относится к вашему приложению. Сведения о стандартных событиях см. в разделе Streaming Amazon Pinpoint Events в Руководстве разработчика Amazon Pinpoint .

DimensionType -> (string)

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

Values -> (list)

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

(string)

Metrics -> (map)

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

key -> (string)

value -> (structure)

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

ComparisonOperator -> (string)

Value -> (double)

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

FilterType -> (string)

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)

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

State -> (structure)

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

CampaignStatus -> (string)

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

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

tags -> (map)

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

key -> (string)

value -> (string)

TemplateConfiguration -> (structure)

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

EmailTemplate -> (structure)

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

Name -> (string)

Version -> (string)

Если вы не укажете значение для этого свойства, 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 template не поддерживается для SendMessages.

Name -> (string)

Version -> (string)

TreatmentDescription -> (string)

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

TreatmentName -> (string)

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

Version -> (integer)

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

Priority -> (integer)