Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

delete-campaign

Описание

Удаляет кампанию из приложения.

См. также: Документацию API AWS

Синтаксис

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

Параметры

--application-id (строка)

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

--campaign-id (строка)

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

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

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

Общие параметры

--debug (булево)

Включает отладку.

--endpoint-url (строка)

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии этого инструмента.

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (булево)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

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

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

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

AdditionalTreatments -> (список)

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

(структура)

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

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

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

DeliveryUri -> (строка)

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

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

EndpointTypes -> (список)

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

(строка)

Id -> (строка)

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

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

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

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

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

TimeToLive -> (целое)

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

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

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

TimeToLive -> (целое)

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

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

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

TimeToLive -> (целое)

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Data -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

FromAddress -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

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

HtmlBody -> (строка)

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

Title -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

MessageType -> (строка)

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

OriginationNumber -> (строка)

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

SenderId -> (строка)

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

EntityId -> (строка)

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

TemplateId -> (строка)

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

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

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

Body -> (строка)

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

Content -> (список)

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

(структура)

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

BackgroundColor -> (строка)

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

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

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

Alignment -> (строка)

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

Body -> (строка)

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

TextColor -> (строка)

Цвет текста.

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

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

Alignment -> (строка)

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

Header -> (строка)

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

TextColor -> (строка)

Цвет текста.

ImageUrl -> (строка)

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

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

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

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

Стандартное содержимое кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Стандартное содержимое кнопки.

BackgroundColor -> (строка)

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

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

Радиус скругления границ кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

Text -> (строка)

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

TextColor -> (строка)

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

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

Стандартное содержимое кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Стандартное содержимое кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

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

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

Стандартное содержимое кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Стандартное содержимое кнопки.

BackgroundColor -> (строка)

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

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

Радиус скругления границ кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

Text -> (строка)

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

TextColor -> (строка)

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

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

Стандартное содержимое кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Стандартное содержимое кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

CustomConfig -> (карта)

Настраиваемые параметры, которые будут отправлены клиенту.

key -> (строка)

value -> (строка)

Layout -> (строка)

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

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

Параметры расписания для обработки.

EndTime -> (строка)

Расчётное время окончания кампании в формате ISO 8601.

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

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

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

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

Attributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (карта)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

Value -> (двойное)

Сравниваемое значение.

FilterType -> (строка)

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

Frequency -> (строка)

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

IsLocalTime -> (булево)

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

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

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

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

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

End -> (строка)

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

Start -> (строка)

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

StartTime -> (строка)

Расчётное время начала кампании в формате ISO 8601.

Timezone -> (строка)

Начальный 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 -> (целое число)

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

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

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

CampaignStatus -> (строка)

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

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

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

Шаблон SMS для сообщения.

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

TreatmentDescription -> (строка)

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

TreatmentName -> (строка)

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

ApplicationId -> (строка)

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

Arn -> (строка)

Amazon Resource Name (ARN) кампании.

CreationDate -> (строка)

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

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

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

DeliveryUri -> (строка)

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

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

EndpointTypes -> (список)

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

(строка)

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

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

CampaignStatus -> (строка)

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

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

Description -> (строка)

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

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

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

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

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

LambdaFunctionName -> (строка)

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

Mode -> (строка)

Режим, в котором Amazon Pinpoint вызывает функцию AWS Lambda. Возможные значения:

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

WebUrl -> (строка)

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

Id -> (строка)

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

IsPaused -> (булево)

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

LastModifiedDate -> (строка)

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

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

Пределы отправки сообщений для кампании.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Data -> (строка)

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

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

```

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

FromAddress -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

Значение заголовка сообщения. Значение заголовка может содержать до 870 символов, включая длину любых рендеренных атрибутов. Например, если вы добавите атрибут {CreationDate}, он отобразится как ГГГГ-ММ-ДДЧЧ:ММ:СС.ССЗ и будет иметь длину 24 символа.

HtmlBody -> (строка)

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

Title -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

MessageType -> (строка)

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

OriginationNumber -> (строка)

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

SenderId -> (строка)

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

EntityId -> (строка)

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

TemplateId -> (строка)

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

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

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

Body -> (строка)

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

Content -> (список)

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

(структура)

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

BackgroundColor -> (строка)

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

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

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

Alignment -> (строка)

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

Body -> (строка)

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

TextColor -> (строка)

Цвет текста.

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

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

Alignment -> (строка)

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

Header -> (строка)

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

TextColor -> (строка)

Цвет текста.

ImageUrl -> (строка)

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

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

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

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

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

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

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

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

BackgroundColor -> (строка)

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

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

Радиус скругления углов кнопки.

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

Text -> (строка)

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

TextColor -> (строка)

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

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

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

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

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

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

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

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

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

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

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

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

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

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

BackgroundColor -> (строка)

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

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

Радиус скругления углов кнопки.

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

Text -> (строка)

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

TextColor -> (строка)

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

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

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

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

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

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

ButtonAction -> (строка)

Действие, выполняемое кнопкой.

Link -> (строка)

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

CustomConfig -> (мапа)

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

key -> (строка)

value -> (строка)

Layout -> (строка)

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

Name -> (строка)

Название кампании.

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

Настройки графика кампании.

EndTime -> (строка)

Время окончания кампании в формате ISO 8601.

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

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

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

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

Attributes -> (мапа)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (мапа)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

Value -> (двойное)

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

FilterType -> (строка)

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

Frequency -> (строка)

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

IsLocalTime -> (булево)

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

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

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

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

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

End -> (строка)

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

Start -> (строка)

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

StartTime -> (строка)

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

Timezone -> (строка)

Начальный 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 -> (строка)

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

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

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

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

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

CampaignStatus -> (строка)

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

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

tags -> (мапа)

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

key -> (строка)

value -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

Шаблон SMS для сообщения.

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

TreatmentDescription -> (строка)

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

TreatmentName -> (строка)

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

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

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

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

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API