Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-campaign-versions

Описание

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

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

Синтаксис

  get-campaign-versions
--application-id <value>
--campaign-id <value>
[--page-size <value>]
[--token <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 (строка)

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

--page-size (строка)

Максимальное количество элементов на странице результата при постраничном выводе. Этот параметр не поддерживается для метрик приложений, кампаний и маршрутов.

--token (строка)

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

--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 pager.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Output

CampaignsResponse -> (structure)

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

Item -> (list)

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

(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)

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

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

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)

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

ImageUrl -> (string)

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

JsonBody -> (string)

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

MediaUrl -> (string)

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

RawContent -> (string)

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

SilentPush -> (boolean)

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

TimeToLive -> (integer)

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

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

Title -> (string)

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

Url -> (string)

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

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)

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

ImageUrl -> (string)

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

JsonBody -> (string)

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

MediaUrl -> (string)

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

RawContent -> (string)

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

SilentPush -> (boolean)

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

TimeToLive -> (integer)

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

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

Title -> (string)

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

Url -> (string)

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

CustomMessage -> (structure)

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

Data -> (string)

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

DefaultMessage -> (structure)

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

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}, он отображается как ГГГГ-ММ-ДДЧЧ:ММ:СС.ССЗ и имеет длину 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. Для кампаний это также может быть пользовательское событие, специфичное для вашего приложения. Подробнее о стандартных событиях см. в разделе Потоковая передача событий 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, отправляет кампанию при возникновении события конечной точки (Eventsresource).

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.

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

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

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

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

CampaignStatus -> (строка)

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

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

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

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

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. Максимальное значение равно 20000.

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-данные для отправки бесшумного уведомления.

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

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

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

Планируемое время начала кампании. Допустимые значения: IMMEDIATE (немедленное начало) или конкретное время в формате 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.

SegmentId -> (строка)

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

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

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

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

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

CampaignStatus -> (строка)

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

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

tags -> (массив)

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

key -> (строка)

value -> (строка)

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

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

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

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

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

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

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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