Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-campaigns

Описание

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

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

Синтаксис

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

Параметры

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

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

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

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

--token (строка)

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

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

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

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

--debug (булево)

Включить отладку логов.

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

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

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

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

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

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

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

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

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

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

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

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

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

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

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

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

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

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

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

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

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

Примеры

Примечание

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

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

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

Следующий get-campaigns пример получает информацию о статусе, конфигурации и других настройках всех кампаний, связанных с приложением.

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

Вывод:

{
    "CampaignsResponse": {
        "Item": [
            {
                "AdditionalTreatments": [],
                "ApplicationId": "6e0b7591a90841d2b5d93fa11143e5a7",
                "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/6e0b7591a90841d2b5d93fa11143e5a7/campaigns/7e1280344c8f4a9aa40a00b006fe44f1",
                "CreationDate": "2019-10-08T18:40:22.905Z",
                "Description": " ",
                "HoldoutPercent": 0,
                "Id": "7e1280344c8f4a9aa40a00b006fe44f1",
                "IsPaused": false,
                "LastModifiedDate": "2019-10-08T18:40:22.905Z",
                "Limits": {},
                "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 Test"
                    }
                },
                "Name": "MyCampaign1",
                "Schedule": {
                    "IsLocalTime": false,
                    "QuietTime": {},
                    "StartTime": "IMMEDIATE",
                    "Timezone": "UTC"
                },
                "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60",
                "SegmentVersion": 1,
                "State": {
                    "CampaignStatus": "COMPLETED"
                },
                "tags": {},
                "TemplateConfiguration": {},
                "Version": 1
            },
            {
                "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>Demo</body>\n</html>",
                        "Title": "PinpointDemo"
                    }
                },
                "Name": "MyCampaign2",
                "Schedule": {
                    "IsLocalTime": false,
                    "StartTime": "IMMEDIATE",
                    "Timezone": "utc"
                },
                "SegmentId": "b66c9e42f71444b2aa2e0ffc1df28f60",
                "SegmentVersion": 1,
                "State": {
                    "CampaignStatus": "COMPLETED"
                },
                "tags": {},
                "TemplateConfiguration": {},
                "Version": 1
            }
        ]
    }
}

Output

CampaignsResponse -> (structure)

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

Item -> (list)

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

(structure)

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

AdditionalTreatments -> (list)

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

(structure)

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

CustomDeliveryConfiguration -> (structure)

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

DeliveryUri -> (string)

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

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

EndpointTypes -> (list)

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

(string)

Id -> (string)

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

MessageConfiguration -> (structure)

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

ADMMessage -> (structure)

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

Action -> (string)

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

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

Body -> (string)

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

ImageIconUrl -> (string)

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

ImageSmallIconUrl -> (string)

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

ImageUrl -> (string)

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

JsonBody -> (string)

Полезная нагрузка JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

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

RawContent -> (string)

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

SilentPush -> (boolean)

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

TimeToLive -> (integer)

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

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

Title -> (string)

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

Url -> (string)

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

APNSMessage -> (structure)

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

Action -> (string)

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

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

Body -> (string)

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

ImageIconUrl -> (string)

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

ImageSmallIconUrl -> (string)

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

ImageUrl -> (string)

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

JsonBody -> (string)

Полезная нагрузка JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

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

RawContent -> (string)

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

SilentPush -> (boolean)

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

TimeToLive -> (integer)

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

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

Title -> (string)

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

Url -> (string)

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

BaiduMessage -> (structure)

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

Action -> (string)

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

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

Body -> (string)

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

ImageIconUrl -> (string)

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

ImageSmallIconUrl -> (string)

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

ImageUrl -> (string)

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

JsonBody -> (string)

Полезная нагрузка JSON для использования для беззвучного push-уведомления.

MediaUrl -> (string)

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

RawContent -> (string)

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

SilentPush -> (boolean)

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

TimeToLive -> (integer)

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

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

Title -> (string)

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

Url -> (string)

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

CustomMessage -> (structure)

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

Data -> (string)

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

DefaultMessage -> (structure)

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

Идентификатор сущности или id основной сущности (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.

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

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Data -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

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

FromAddress -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

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

HtmlBody -> (строка)

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

Title -> (строка)

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

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

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

Action -> (строка)

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

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

Body -> (строка)

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

ImageIconUrl -> (строка)

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

ImageSmallIconUrl -> (строка)

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

ImageUrl -> (строка)

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

JsonBody -> (строка)

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

MediaUrl -> (строка)

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

RawContent -> (строка)

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

SilentPush -> (булево)

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

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

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

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

Title -> (строка)

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

Url -> (строка)

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

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

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

Body -> (строка)

Текст сообщения SMS.

MessageType -> (строка)

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

OriginationNumber -> (строка)

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

SenderId -> (строка)

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

EntityId -> (строка)

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

TemplateId -> (строка)

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

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

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

Body -> (строка)

Текст сообщения уведомления, тела письма или текстового сообщения.

Content -> (список)

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

(структура)

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

BackgroundColor -> (строка)

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

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

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

Alignment -> (строка)

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

Body -> (строка)

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

TextColor -> (строка)

Цвет текста.

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

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

Alignment -> (строка)

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

Header -> (строка)

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

TextColor -> (строка)

Цвет текста.

ImageUrl -> (строка)

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

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

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

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

Текст стандартной кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Текст стандартной кнопки.

BackgroundColor -> (строка)

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

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

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

ButtonAction -> (строка)

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

Link -> (строка)

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

Text -> (строка)

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

TextColor -> (строка)

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

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

Текст стандартной кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Текст стандартной кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

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

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

Текст стандартной кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Текст стандартной кнопки.

BackgroundColor -> (строка)

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

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

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

ButtonAction -> (строка)

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

Link -> (строка)

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

Text -> (строка)

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

TextColor -> (строка)

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

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

Текст стандартной кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

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

Текст стандартной кнопки.

ButtonAction -> (строка)

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

Link -> (строка)

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

CustomConfig -> (массив)

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

key -> (строка)

value -> (строка)

Layout -> (строка)

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

Name -> (строка)

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

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

Параметры расписания кампании.

EndTime -> (строка)

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

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

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

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

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

Attributes -> (массив)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (массив)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

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

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

FilterType -> (строка)

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

Frequency -> (строка)

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

IsLocalTime -> (булево)

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

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

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

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

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

End -> (строка)

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

Start -> (строка)

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

StartTime -> (строка)

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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