Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-campaign-version

Описание

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

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

Синтаксис

  get-campaign-version
--application-id <value>
--campaign-id <value>
--campaign-version <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 (строка)

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

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

Уникальный номер версии (свойство Version) для версии кампании.

--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 для вывода.

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

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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 (отправка кампании при возникновении события конечной точки).

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.

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

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

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

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

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

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

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

JSON-payload для тихой push-уведомления.

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

JSON-payload для тихой push-уведомления.

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

JSON-payload для тихой push-уведомления.

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Data -> (строка)

Необработанная JSON-строка, используемая в качестве payload для сообщения. Максимальный размер — 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-уведомления могут использоваться в таких случаях, как обновление конфигурации приложения, отображение сообщений в центре сообщений приложения или поддержка функциональности «возвращения домой».

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

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

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. При указании, это значение должно совпадать с идентификатором существующей версии шаблона. Для получения списка версий и идентификаторов версий шаблона используйте ресурс 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