Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-campaign

Описание

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

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

Синтаксис

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

Параметры

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

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

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

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

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

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

Глобальные параметры

--debug (логическое значение)

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

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

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

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

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

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

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

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

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

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

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

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

  • base64
  • raw-in-base64-out

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

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

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

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

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

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

Примеры

Примечание

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

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для получения информации о статусе, конфигурации и других настройках кампании

Следующий get-campaign пример получает информацию о статусе, конфигурации и других настройках кампании.

aws pinpoint get-campaign \
    --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \
    --campaign-id a1e63c6cc0eb43ed826ffcc3cc90b30d \
    --region us-east-1

Вывод:

{
    "CampaignResponse": {
        "AdditionalTreatments": [],
        "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
        "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/a1e63c6cc0eb43ed826ffcc3cc90b30d",
        "CreationDate": "2019-10-08T18:40:16.581Z",
        "Description": " ",
        "HoldoutPercent": 0,
        "Id": "a1e63c6cc0eb43ed826ffcc3cc90b30d",
        "IsPaused": false,
        "LastModifiedDate": "2019-10-08T18:40:16.581Z",
        "Limits": {
            "Daily": 0,
            "MaximumDuration": 60,
            "MessagesPerSecond": 50,
            "Total": 0
        },
        "MessageConfiguration": {
            "EmailMessage": {
                "FromAddress": "sender@example.com",
                "HtmlBody": "<!DOCTYPE html>\n  <html lang=\"en\">\n    <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n</head>\n<body>Hello</body>\n</html>",
                "Title": "PinpointDemo"
            }
        },
        "Name": "MyCampaign",
        "Schedule": {
            "IsLocalTime": false,
            "StartTime": "IMMEDIATE",
            "Timezone": "utc"
        },
        "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60",
        "SegmentVersion": 1,
        "State": {
            "CampaignStatus": "COMPLETED"
        },
        "tags": {},
        "TemplateConfiguration": {},
        "Version": 1
    }
}

Вывод

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

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

AdditionalTreatments -> (список)

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

(структура)

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

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

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

DeliveryUri -> (строка)

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

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

EndpointTypes -> (список)

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

(строка)

Id -> (строка)

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

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

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Data -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

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

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

FromAddress -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

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

HtmlBody -> (строка)

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

Title -> (строка)

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

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

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

Action -> (строка)

Действие, которое должно произойти, если получатель нажмёт на 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 Streaming Events.

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

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

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

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

FromAddress -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

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

HtmlBody -> (строка)

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

Title -> (строка)

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

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

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

Action -> (строка)

Действие, которое должно произойти, если получатель нажмет на 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.

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (карта)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

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

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

FilterType -> (строка)

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

Frequency -> (строка)

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

IsLocalTime -> (логическое значение)

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

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

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

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

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

End -> (строка)

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

Start -> (строка)

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

StartTime -> (строка)

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

Timezone -> (строка)

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

SegmentId -> (строка)

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

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

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

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

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

CampaignStatus -> (строка)

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

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

tags -> (карта)

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

key -> (строка)

value -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

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

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

Name -> (строка)

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

Version -> (строка)

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

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

TreatmentDescription -> (строка)

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

TreatmentName -> (строка)

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

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

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

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

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

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

Spec-Zone.ru

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