создать-маршрут

Описание

Создаёт маршрут для приложения.

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

Синтаксис

  create-journey
--application-id <value>
--write-journey-request <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.

--write-journey-request (структура)

Указывает конфигурацию и другие параметры маршрута.

Activities -> (карта)

Карта, содержащая набор объектов Activity, по одному объекту для каждой активности в маршруте. Для каждого объекта Activity ключ — это уникальный идентификатор (строка) активности, а значение — параметры активности. Идентификатор активности может содержать до 100 символов. Символы должны быть буквенно-цифровыми.

key -> (строка)

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

Указывает конфигурацию и другие параметры активности в маршруте.

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

Параметры активности отправки пользовательских сообщений. Этот тип активности вызывает функцию AWS Lambda или веб-хук, отправляющие сообщения участникам.

DeliveryUri -> (строка)

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

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

EndpointTypes -> (список)

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

(строка)

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

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

Data -> (строка)

Содержание сообщения, передаваемое функции AWS Lambda или веб-хуку.

NextActivity -> (строка)

Уникальный идентификатор следующей активности, которую следует выполнить после того, как Amazon Pinpoint вызовет функцию AWS Lambda или веб-хук.

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

Параметры активности ветвления по условиям. Этот тип активности отправляет участников по одному из двух путей в маршруте, на основе заданных вами условий.

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

Условия, определяющие пути для активности, и взаимоотношения между условиями.

Conditions -> (список)

Условия для оценки активности.

(структура)

Указывает условие для оценки активности в маршруте.

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

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

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

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

Attributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

ВКЛЮЧАЮЩИЙ — конечные точки, имеющие совпадающие атрибуты и значения, включаются в сегмент.
ИСКЛЮЧАЮЩИЙ — конечные точки, имеющие совпадающие атрибуты и значения, исключаются из сегмента.
СОДЕРЖИТ — конечные точки, у которых атрибуты содержат подстроки значений, включаются в сегмент.
ДО — конечные точки с атрибутами, представленными в формате ISO_INSTANT datetime до значения, включаются в сегмент.
ПОСЛЕ — конечные точки с атрибутами, представленными в формате ISO_INSTANT datetime после значения, включаются в сегмент.
В — конечные точки с атрибутами, представленными в формате ISO_INSTANT date на значении, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ — конечные точки с атрибутами, представленными в формате ISO_INSTANT datetime между значениями, включаются в сегмент.

Values -> (список)

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

(строка)

...

END_OF_DOCUMENT_MARKER

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

Атрибуты -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
ИСКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, предшествующие значению, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, последующие значению, включаются в сегмент.
В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, равные значению, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, заключённые между значениями, включаются в сегмент.

Значения -> (список)

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

(строка)

Поведение -> (структура)

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

Недавность -> (структура)

Настройки измерения, основанные на недавней активности конечной точки.

Длительность -> (строка)

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

ТипНедавности -> (строка)

Тип измерения недавности для сегмента. Допустимые значения: АКТИВНО, конечные точки, активные в течение указанного периода, включаются в сегмент; и, НЕАКТИВНО, конечные точки, неактивные в течение указанного периода, исключаются из сегмента.

Демографические данные -> (структура)

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

ВерсияПриложения -> (структура)

Критерии версии приложения для сегмента.

ТипИзмерения -> (строка)

Тип измерения сегмента, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и, ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Канал -> (структура)

Критерии канала для сегмента.

ТипИзмерения -> (строка)

Значения -> (список)

(строка)

ТипУстройства -> (структура)

Критерии типа устройства для сегмента.

ТипИзмерения -> (строка)

Значения -> (список)

(строка)

Производитель -> (структура)

Критерии производителя устройства для сегмента.

ТипИзмерения -> (строка)

Значения -> (список)

(строка)

Модель -> (структура)

Критерии модели устройства для сегмента.

ТипИзмерения -> (строка)

Значения -> (список)

(строка)

Платформа -> (структура)

Критерии платформы устройства для сегмента.

ТипИзмерения -> (строка)

Значения -> (список)

(строка)

Расположение -> (структура)

Критерии, основанные на местоположении, такие как регион или GPS-координаты, для сегмента.

Страна -> (структура)

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

ТипИзмерения -> (строка)

Значения -> (список)

(строка)

GPSТочка -> (структура)

GPS-местоположение и радиус для сегмента.

Координаты -> (структура)

GPS-координаты для измерения расстояния.

Широта -> (двойное)

Координата широты местоположения.

Долгота -> (двойное)

Координата долготы местоположения.

ДиапазонВКилометрах -> (двойное)

Диапазон в километрах от GPS-координат.

Метрики -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ОператорСравнения -> (строка)

Оператор, используемый при сравнении значений метрик. Допустимые значения: БОЛЬШЕ, МЕНЬШЕ, БОЛЬШЕ_ИЛИ_РАВНО, МЕНЬШЕ_ИЛИ_РАВНО и РАВНО.

Значение -> (двойное)

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

АтрибутыПользователя -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
ИСКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, предшествующие значению, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, последующие значению, включаются в сегмент.
В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, равные значению, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, заключённые между значениями, включаются в сегмент.

Значения -> (список)

(строка)

Оператор -> (строка)

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

ВремяОжиданияОценки -> (структура)

Количество времени, которое нужно подождать, прежде чем определить, выполнены ли условия, или дата и время, когда Amazon Pinpoint определит, выполнены ли условия.

Подождать -> (строка)

Количество времени для ожидания в формате ISO 8601, прежде чем определить, выполнены ли условия активности или переместить участников к следующей активности в маршруте.

ПодождатьДо -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия активности или активность переместит участников к следующей активности в маршруте.

АктивностьПриНевыполнении -> (строка)

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

АктивностьПриВыполнении -> (строка)

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

Описание -> (строка)

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

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

Настройки активности по электронной почте. Этот тип активности отправляет электронное сообщение участникам.

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

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

FromAddress -> (строка)

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

Настройки активности исключения. Этот тип активности приостанавливает этап для заданного процента участников.

NextActivity -> (строка)

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

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

Процент участников, которые не должны продолжать этап.

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

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

Настройки активности многовариантного разделения. Этот тип активности направляет участников по одному из возможных пяти путей (включая путь по умолчанию «Else») в рамках этапа на основе заданных условий.

Branches -> (список)

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

(структура)

Указывает условие для оценки на пути активности в рамках этапа.

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

Условие для оценки на пути активности.

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

Настройки измерения события, связанного с активностью.

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

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

Attributes -> (отображение)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (отображение)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

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

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

MessageActivity -> (строка)

Идентификатор сообщения (message_id) для использования при определении соответствия событий сообщения условию.

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

Сегмент, связанный с активностью.

SegmentId -> (строка)

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

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

Настройки размерности для сегмента, связанного с активностью.

Атрибуты -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
ИСКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, имеющие подстроки атрибутов, соответствующие значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT до значения, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT после значения, включаются в сегмент.
В - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT в значении, включаются в сегмент. Время при этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT между значениями, включаются в сегмент.

Значения -> (список)

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

(строка)

Поведение -> (структура)

Критерии, основанные на поведении, такие как то, как недавно пользователи использовали ваше приложение, для сегмента.

Новизна -> (структура)

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

Продолжительность -> (строка)

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

ТипНовизны -> (строка)

Тип размерности новизны для сегмента. Допустимые значения: АКТИВНО, конечные точки, которые были активны в течение указанной продолжительности, включаются в сегмент; и, НЕАКТИВНО, конечные точки, которые не были активны в течение указанной продолжительности, исключаются из сегмента.

Демографические данные -> (структура)

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

Версия приложения -> (структура)

Критерии версии приложения для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧЕНИЕ, конечные точки, соответствующие критериям, включаются в сегмент; и, ИСКЛЮЧЕНИЕ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Канал -> (структура)

Критерии канала для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Тип устройства -> (структура)

Критерии типа устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Производитель -> (структура)

Критерии производителя устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Модель -> (структура)

Критерии модели устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Платформа -> (структура)

Критерии платформы устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Расположение -> (структура)

Критерии, основанные на местоположении, такие как регион или GPS-координаты, для сегмента.

Страна -> (структура)

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

GPSТочка -> (структура)

GPS-местоположение и радиус для сегмента.

Координаты -> (структура)

GPS-координаты для измерения расстояния.

Широта -> (двойное)

Координата широты местоположения.

Долгота -> (двойное)

Координата долготы местоположения.

ДиапазонВКилометрах -> (двойное)

Диапазон в километрах от GPS-координат.

Метрики -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ОператорСравнения -> (строка)

Значение -> (двойное)

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

АтрибутыПользователя -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
ИСКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, имеющие подстроки атрибутов, соответствующие значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT до значения, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT после значения, включаются в сегмент.
В - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT в значении, включаются в сегмент. Время при этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT между значениями, включаются в сегмент.

Значения -> (список)

(строка)

СледующаяАктивность -> (строка)

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

АктивностьПоУмолчанию -> (строка)

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

ВремяОжиданияОценки -> (структура)

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

Ожидать -> (строка)

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

ОжидатьДо -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия активности или активность переводит участников на следующую активность в путешествии.

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

Настройки действия отправки push-уведомления. Этот тип действия отправляет push-уведомление участникам.

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

Указывает значение TTL (времени жизни) для push-уведомлений, отправляемых участникам в рамках этапа.

TimeToLive -> (строка)

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

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

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

Branches -> (список)

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

(структура)

Указывает настройки пути в действии случайного разделения на этапе этапа.

NextActivity -> (строка)

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

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

Процент участников, которые нужно направить по пути действия.

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

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

Настройки действия SMS. Этот тип действия отправляет текстовое сообщение участникам.

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

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

MessageType -> (строка)

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

OriginationNumber -> (строка)

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

SenderId -> (строка)

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

EntityId -> (строка)

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

TemplateId -> (строка)

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

NextActivity -> (строка)

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

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

Количество времени ожидания или дата и время, когда действие переводит участников к следующему действию на этапе этапа.

WaitFor -> (строка)

Количество времени ожидания в формате ISO 8601 в качестве длительности, прежде чем определить, выполнены ли условия действия или участников переводятся к следующему действию на этапе.

WaitUntil -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия действия или действие переводит участников к следующему действию на этапе.

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

Настройки действия соединения. Этот тип действия инициирует звонок в контактный центр для участников.

NextActivity -> (строка)

Уникальный идентификатор следующего действия, которое нужно выполнить после этого действия.

CreationDate -> (строка)

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

LastModifiedDate -> (строка)

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

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

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

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

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

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

Максимальное количество раз, которое участник может войти в этап. Максимальное значение — 100. Чтобы разрешить участникам неограниченное количество входов в этап, установите это значение в 0.

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

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

EndpointReentryInterval -> (строка)

Минимальное время, которое должно пройти, прежде чем конечная точка сможет снова войти в данный этап. Длительность должна использовать формат ISO 8601, такой как PT1H.

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

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

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

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

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

Длительность временного интервала в днях. Максимальное значение — 30. Если установлено в 0, этот предел не будет применяться.

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

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

LocalTime -> (булево)

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

Name -> (строка)

Имя этапа. Имя этапа может содержать не более 150 символов. Символы могут быть алфавитно-цифровыми символами или символами, такими как подчеркивание (_) или дефис (-). Имя этапа не может содержать пробелов.

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 дня.

RefreshFrequency -> (строка)

Частота, с которой Amazon Pinpoint оценивает сегментные и событийные данные для этапа, в формате длительности ISO 8601.

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

Настройки расписания для этапа.

EndTime -> (отметка времени)

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

StartTime -> (отметка времени)

Запланированное время начала этапа в формате ISO 8601.

Timezone -> (строка)

Начальное смещение UTC для расписания этапа, если значение свойства LocalTime этапа равно 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10 и UTC-11.

StartActivity -> (строка)

Уникальный идентификатор первого действия на этапе. Идентификатор этого действия может содержать не более 128 символов. Символы должны быть алфавитно-цифровыми.

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

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

Описание -> (строка)

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

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

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

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

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

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

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

Attributes -> (отображение)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧАЮЩИЙ - конечные точки с атрибутами, соответствующими значениям, включаются в сегмент.
ИСКЛЮЧАЮЩИЙ - конечные точки с атрибутами, соответствующими значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, до значения, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, после значения, включаются в сегмент.
В - конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, на значение, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, между значениями, включаются в сегмент.

Значения -> (список)

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

(строка)

ТипСобытия -> (структура)

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

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Метрики -> (отображение)

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

ключ -> (строка)

значение -> (структура)

ОператорСравнения -> (строка)

Оператор для использования при сравнении значений метрики. Допустимые значения: БОЛЬШЕ, МЕНЬШЕ, БОЛЬШЕ_ИЛИ_РАВНО, МЕНЬШЕ_ИЛИ_РАВНО и РАВНО.

Значение -> (двойное)

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

ТипФильтра -> (строка)

Тип события, вызывающего отправку кампании или выполнение действия перехода. Допустимые значения: СИСТЕМНОЕ, отправляет кампанию или выполняет действие при возникновении системного события; и КОНЕЧНАЯ_ТОЧКА, отправляет кампанию или выполняет действие при возникновении события конечной точки (ресурс событий).

IdСегмента -> (строка)

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

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

IdСегмента -> (строка)

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

Состояние -> (строка)

Статус перехода. Допустимые значения:

ЧЕРНОВИК - Сохраняет переход и не публикует его.
АКТИВНО - Сохраняет и публикует переход. В зависимости от расписания перехода, он запускается немедленно или в запланированное время начала. Если состояние перехода АКТИВНО, вы не можете добавлять, изменять или удалять действия из него.

Состояния ПРИОСТАНОВЛЕНО, ОТМЕНЕНО, ЗАВЕРШЕНО и ЗАКРЫТО не поддерживаются в запросах для создания или обновления перехода. Чтобы отменить, приостановить или возобновить переход, используйте ресурс Journey Stateresource.

WaitForQuietTime -> (булево)

Указывает, должны ли конечные точки в часы тишины ожидать до конца своих часов тишины.

RefreshOnSegmentUpdate -> (булево)

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

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

Настройки канала для перехода.

ConnectCampaignArn -> (строка)

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

ConnectCampaignExecutionRoleArn -> (строка)

IAM роль ARN для предположения при вызове API выполнения кампании Connect для звонков.

SendingSchedule -> (булево)

Указывает, включено ли в переходе расширенное время тишины. Этот флаг должен быть установлен в значение true, чтобы разрешить использование OpenHours и ClosedDays.

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

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

EMAIL -> (отображение)

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

ключ -> (строка)

День недели, когда будет применено правило. Допустимые значения [ПОНЕДЕЛЬНИК, ВТОРНИК, СРЕДА, ЧЕТВЕРГ, ПЯТНИЦА, СУББОТА, ВОСКРЕСЕНЬЕ]

значение -> (список)

Правила часов работы.

(структура)

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

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

SMS -> (отображение)

Указывает параметры расписания для канала SMS.

ключ -> (строка)

значение -> (список)

Правила часов работы.

(структура)

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

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

PUSH -> (отображение)

Указывает параметры расписания для канала push.

ключ -> (строка)

значение -> (список)

Правила часов работы.

(структура)

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

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

VOICE -> (отображение)

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

ключ -> (строка)

значение -> (список)

Правила часов работы.

(структура)

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

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

CUSTOM -> (отображение)

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

ключ -> (строка)

значение -> (список)

Правила часов работы.

(структура)

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

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

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

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

EMAIL -> (список)

Правила для канала электронной почты.

(структура)

Подробные сведения о правиле ClosedDays.

Имя -> (строка)

Имя правила ClosedDays.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

SMS -> (список)

Правила для канала SMS.

(структура)

Подробные сведения о правиле ClosedDays.

Имя -> (строка)

Имя правила ClosedDays.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

PUSH -> (список)

Правила для канала Push.

(структура)

Подробные сведения о правиле ClosedDays.

Имя -> (строка)

Имя правила ClosedDays.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

VOICE -> (список)

Правила для голосового канала.

(структура)

Подробные сведения о правиле ClosedDays.

Имя -> (строка)

Имя правила ClosedDays.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

CUSTOM -> (список)

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

(структура)

Подробные сведения о правиле ClosedDays.

Имя -> (строка)

Имя правила ClosedDays.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

TimezoneEstimationMethods -> (список)

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

PHONE_NUMBER - Часовой пояс определяется на основе Endpoint.Address и Endpoint.Location.Country.
POSTAL_CODE - Часовой пояс определяется на основе Endpoint.Location.PostalCode и Endpoint.Location.Country.

Примечание

Обнаружение POSTAL_CODE поддерживается только в США, Великобритании, Австралии, Новой Зеландии, Канаде, Франции, Италии, Испании, Германии и в регионах, где доступен Amazon Pinpoint.

(строка)

Синтаксис JSON:

{
  "Activities": {"string": {
        "CUSTOM": {
          "DeliveryUri": "string",
          "EndpointTypes": ["PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP", ...],
          "MessageConfig": {
            "Data": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "ConditionalSplit": {
          "Condition": {
            "Conditions": [
              {
                "EventCondition": {
                  "Dimensions": {
                    "Attributes": {"string": {
                          "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                          "Values": ["string", ...]
                        }
                      ...},
                    "EventType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Metrics": {"string": {
                          "ComparisonOperator": "string",
                          "Value": double
                        }
                      ...}
                  },
                  "MessageActivity": "string"
                },
                "SegmentCondition": {
                  "SegmentId": "string"
                },
                "SegmentDimensions": {
                  "Attributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...},
                  "Behavior": {
                    "Recency": {
                      "Duration": "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
                      "RecencyType": "ACTIVE"|"INACTIVE"
                    }
                  },
                  "Demographic": {
                    "AppVersion": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Channel": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "DeviceType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Make": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Model": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Platform": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    }
                  },
                  "Location": {
                    "Country": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "GPSPoint": {
                      "Coordinates": {
                        "Latitude": double,
                        "Longitude": double
                      },
                      "RangeInKilometers": double
                    }
                  },
                  "Metrics": {"string": {
                        "ComparisonOperator": "string",
                        "Value": double
                      }
                    ...},
                  "UserAttributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...}
                }
              }
              ...
            ],
            "Operator": "ALL"|"ANY"
          },
          "EvaluationWaitTime": {
            "WaitFor": "string",
            "WaitUntil": "string"
          },
          "FalseActivity": "string",
          "TrueActivity": "string"
        },
        "Description": "string",
        "EMAIL": {
          "MessageConfig": {
            "FromAddress": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "Holdout": {
          "NextActivity": "string",
          "Percentage": integer
        },
        "MultiCondition": {
          "Branches": [
            {
              "Condition": {
                "EventCondition": {
                  "Dimensions": {
                    "Attributes": {"string": {
                          "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                          "Values": ["string", ...]
                        }
                      ...},
                    "EventType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Metrics": {"string": {
                          "ComparisonOperator": "string",
                          "Value": double
                        }
                      ...}
                  },
                  "MessageActivity": "string"
                },
                "SegmentCondition": {
                  "SegmentId": "string"
                },
                "SegmentDimensions": {
                  "Attributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...},
                  "Behavior": {
                    "Recency": {
                      "Duration": "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
                      "RecencyType": "ACTIVE"|"INACTIVE"
                    }
                  },
                  "Demographic": {
                    "AppVersion": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Channel": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "DeviceType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Make": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Model": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Platform": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    }
                  },
                  "Location": {
                    "Country": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "GPSPoint": {
                      "Coordinates": {
                        "Latitude": double,
                        "Longitude": double
                      },
                      "RangeInKilometers": double
                    }
                  },
                  "Metrics": {"string": {
                        "ComparisonOperator": "string",
                        "Value": double
                      }
                    ...},
                  "UserAttributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...}
                }
              },
              "NextActivity": "string"
            }
            ...
          ],
          "DefaultActivity": "string",
          "EvaluationWaitTime": {
            "WaitFor": "string",
            "WaitUntil": "string"
          }
        },
        "PUSH": {
          "MessageConfig": {
            "TimeToLive": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "RandomSplit": {
          "Branches": [
            {
              "NextActivity": "string",
              "Percentage": integer
            }
            ...
          ]
        },
        "SMS": {
          "MessageConfig": {
            "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
            "OriginationNumber": "string",
            "SenderId": "string",
            "EntityId": "string",
            "TemplateId": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "Wait": {
          "NextActivity": "string",
          "WaitTime": {
            "WaitFor": "string",
            "WaitUntil": "string"
          }
        },
        "ContactCenter": {
          "NextActivity": "string"
        }
      }
    ...},
  "CreationDate": "string",
  "LastModifiedDate": "string",
  "Limits": {
    "DailyCap": integer,
    "EndpointReentryCap": integer,
    "MessagesPerSecond": integer,
    "EndpointReentryInterval": "string",
    "TimeframeCap": {
      "Cap": integer,
      "Days": integer
    },
    "TotalCap": integer
  },
  "LocalTime": true|false,
  "Name": "string",
  "QuietTime": {
    "End": "string",
    "Start": "string"
  },
  "RefreshFrequency": "string",
  "Schedule": {
    "EndTime": timestamp,
    "StartTime": timestamp,
    "Timezone": "string"
  },
  "StartActivity": "string",
  "StartCondition": {
    "Description": "string",
    "EventStartCondition": {
      "EventFilter": {
        "Dimensions": {
          "Attributes": {"string": {
                "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                "Values": ["string", ...]
              }
            ...},
          "EventType": {
            "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
            "Values": ["string", ...]
          },
          "Metrics": {"string": {
                "ComparisonOperator": "string",
                "Value": double
              }
            ...}
        },
        "FilterType": "SYSTEM"|"ENDPOINT"
      },
      "SegmentId": "string"
    },
    "SegmentStartCondition": {
      "SegmentId": "string"
    }
  },
  "State": "DRAFT"|"ACTIVE"|"COMPLETED"|"CANCELLED"|"CLOSED"|"PAUSED",
  "WaitForQuietTime": true|false,
  "RefreshOnSegmentUpdate": true|false,
  "JourneyChannelSettings": {
    "ConnectCampaignArn": "string",
    "ConnectCampaignExecutionRoleArn": "string"
  },
  "SendingSchedule": true|false,
  "OpenHours": {
    "EMAIL": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "SMS": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "PUSH": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "VOICE": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "CUSTOM": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...}
  },
  "ClosedDays": {
    "EMAIL": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "SMS": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "PUSH": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "VOICE": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "CUSTOM": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ]
  },
  "TimezoneEstimationMethods": ["PHONE_NUMBER"|"POSTAL_CODE", ...]
}

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

Вывод

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

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

Activities -> (отображение)

Отображение, содержащее набор объектов Activity, по одному для каждого этапа в процессе. Для каждого объекта Activity ключ — уникальный идентификатор (строка) этапа, а значение — настройки этапа.

key -> (строка)

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

Указывает конфигурацию и другие настройки для этапа в процессе.

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

Настройки этапа с пользовательским сообщением. Этот тип этапа вызывает функцию AWS Lambda или веб-хук, которые отправляют сообщения участникам.

DeliveryUri -> (строка)

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

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

EndpointTypes -> (список)

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

(строка)

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

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

Data -> (строка)

Содержание сообщения, передаваемое функции AWS Lambda или веб-хуку.

NextActivity -> (строка)

Уникальный идентификатор следующего этапа, который необходимо выполнить после того, как Amazon Pinpoint вызовет функцию AWS Lambda или веб-хук.

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

Настройки этапа «разветвление по условиям». Этот тип этапа отправляет участников по одному из двух путей в процессе, на основании заданных вами условий.

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

Условия, определяющие пути для этапа, и взаимосвязь между условиями.

Conditions -> (список)

Условия, подлежащие оценке для этапа.

(структура)

Указывает условие для оценки на этапе в процессе.

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

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

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

Измерения для фильтра событий, используемого для этапа.

Attributes -> (отображение)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

ВКЛЮЧАЮЩЕЕ — конечные точки, атрибуты которых соответствуют значениям, включаются в сегмент.
ИСКЛЮЧАЮЩЕЕ — конечные точки, атрибуты которых соответствуют значениям, исключаются из сегмента.
СОДЕРЖИТ — конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
ДО — конечные точки с атрибутами, представленными в формате ISO_INSTANT даты/времени, предшествующими значению, включаются в сегмент.
ПОСЛЕ — конечные точки с атрибутами, представленными в формате ISO_INSTANT даты/времени, последующими за значением, включаются в сегмент.
В — конечные точки с атрибутами, представленными в формате ISO_INSTANT даты, совпадающими со значением, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ — конечные точки с атрибутами, представленными в формате ISO_INSTANT даты/времени, находящиеся между значениями, включаются в сегмент.

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

Тип измерения сегмента, используемого. Допустимые значения: ВКЛЮЧАЮЩЕЕ, конечные точки, соответствующие критериям, включаются в сегмент; ИСКЛЮЧАЮЩЕЕ, конечные точки, соответствующие критериям, исключаются из сегмента.

Values -> (список)

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

(строка)

Metrics -> (отображение)

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

key -> (строка)

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

ComparisonOperator -> (строка)

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

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

MessageActivity -> (строка)

Идентификатор сообщения (message_id) сообщения, используемого для определения того, соответствуют ли события сообщения условию.

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

Сегмент, связанный с этапом.

SegmentId -> (строка)

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

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

Настройки размерности для сегмента, связанного с активностью.

Атрибуты -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
ИСКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых атрибуты содержат подстроки, соответствующие значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, прочитанными как ISO_INSTANT datetime, предшествующие значению, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, прочитанными как ISO_INSTANT datetime, последующие значению, включаются в сегмент.
В - конечные точки с атрибутами, прочитанными как ISO_INSTANT даты на значении, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, прочитанными как ISO_INSTANT datetime, находящиеся между значениями, включаются в сегмент.

Значения -> (список)

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

(строка)

Поведение -> (структура)

Недавность -> (структура)

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

Длительность -> (строка)

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

ТипНедавности -> (строка)

Тип размерности недавности для сегмента. Допустимые значения: АКТИВНО, конечные точки, которые были активны в течение указанной длительности, включаются в сегмент; и, НЕАКТИВНО, конечные точки, которые не были активны в течение указанной длительности, исключаются из сегмента.

Демографические -> (структура)

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

ВерсияПриложения -> (структура)

Критерии версии приложения для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

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

(строка)

Канал -> (структура)

Критерии канала для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

ТипУстройства -> (структура)

Критерии типа устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Производитель -> (структура)

Критерии производителя устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Модель -> (структура)

Критерии модели устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Платформа -> (структура)

Критерии платформы устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Местоположение -> (структура)

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

Страна -> (структура)

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

GPSТочка -> (структура)

Местоположение GPS и диапазон для сегмента.

Координаты -> (структура)

Координаты GPS для измерения расстояния.

Широта -> (двойное)

Координата широты местоположения.

Долгота -> (двойное)

Координата долготы местоположения.

ДиапазонВКилометрах -> (двойное)

Диапазон в километрах от координат GPS.

Метрики -> (карта)

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

ключ -> (строка)

значение -> (структура)

ОператорСравнения -> (строка)

Оператор для сравнения значений метрик. Допустимые значения: БОЛЬШЕ, МЕНЬШЕ, БОЛЬШЕ_ИЛИ_РАВНО, МЕНЬШЕ_ИЛИ_РАВНО и РАВНО.

Значение -> (двойное)

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

АтрибутыПользователя -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
ИСКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых атрибуты содержат подстроки, соответствующие значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, прочитанными как ISO_INSTANT datetime, предшествующие значению, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, прочитанными как ISO_INSTANT datetime, последующие значению, включаются в сегмент.
В - конечные точки с атрибутами, прочитанными как ISO_INSTANT даты на значении, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, прочитанными как ISO_INSTANT datetime, находящиеся между значениями, включаются в сегмент.

Значения -> (список)

(строка)

Оператор -> (строка)

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

ВремяОжиданияОценки -> (структура)

Время ожидания, прежде чем определить, выполнены ли условия, или дата и время, когда Amazon Pinpoint определяет, выполнены ли условия.

Подождать -> (строка)

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

ПодождатьДо -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия активности или активность переводит участников к следующей активности в пути.

АктивностьПриЛожномУсловии -> (строка)

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

АктивностьПриИстинномУсловии -> (строка)

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

Описание -> (строка)

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

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

Настройки активности по электронной почте. Этот тип активности отправляет сообщение электронной почты участникам.

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

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

FromAddress -> (строка)

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

Настройки активности удержания. Этот тип активности приостанавливает переход для определенного процента участников.

NextActivity -> (строка)

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

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

Процент участников, которые не должны продолжать переход.

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

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

Настройки для активности многовариантного разделения. Этот тип активности направляет участников по одному из пяти путей (включая путь по умолчанию «Else») в переходе на основе указанных вами условий.

Branches -> (список)

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

(структура)

Указывает условие для оценки пути активности в переходе.

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

Условие для оценки пути активности.

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

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

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

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

Attributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (карта)

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

key -> (строка)

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

ComparisonOperator -> (строка)

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

Value -> (двойное значение)

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

MessageActivity -> (строка)

Идентификатор сообщения (message_id) для использования при определении соответствия событий сообщения условию.

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

Сегмент, связанный с активностью.

SegmentId -> (строка)

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

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

END_OF_DOCUMENT_MARKER ```

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

Атрибуты -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
ИСКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и время, предшествующие значению, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и время, последующие за значением, включаются в сегмент.
В - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты, совпадающие со значением, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и время, попадающие в диапазон значений, включаются в сегмент.

Значения -> (список)

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

(строка)

Поведение -> (структура)

Недавность -> (структура)

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

Продолжительность -> (строка)

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

ТипНедавности -> (строка)

Тип размерности недавности для сегмента. Допустимые значения: АКТИВНО, конечные точки, активные в течение указанной продолжительности, включаются в сегмент; и, НЕАКТИВНО, конечные точки, неактивные в течение указанной продолжительности, исключаются из сегмента.

Демографические данные -> (структура)

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

ВерсияПриложения -> (структура)

Критерии версии приложения для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента. Допустимые значения: ВКЛЮЧЕНИЕ, конечные точки, соответствующие критериям, включаются в сегмент; и, ИСКЛЮЧЕНИЕ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Канал -> (структура)

Критерии канала для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

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

(строка)

ТипУстройства -> (структура)

Критерии типа устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Производитель -> (структура)

Критерии производителя устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Модель -> (структура)

Критерии модели устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Платформа -> (структура)

Критерии платформы устройства для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

Местоположение -> (структура)

Критерии местоположения, такие как регион или координаты GPS, для сегмента.

Страна -> (структура)

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

ТипРазмерности -> (строка)

Значения -> (список)

(строка)

ТочкаGPS -> (структура)

GPS-местоположение и радиус для сегмента.

Координаты -> (структура)

GPS-координаты для измерения расстояния.

Широта -> (двойное)

Координата широты местоположения.

Долгота -> (двойное)

Координата долготы местоположения.

ДиапазонВКилометрах -> (двойное)

Диапазон в километрах от GPS-координат.

Метрики -> (карта)

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

ключ -> (строка)

значение -> (структура)

ОператорСравнения -> (строка)

Значение -> (двойное)

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

АтрибутыПользователей -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
ИСКЛЮЧЕНИЕ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и время, предшествующие значению, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и время, последующие за значением, включаются в сегмент.
В - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты, совпадающие со значением, включаются в сегмент. Время в этом сравнении игнорируется.
МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как ISO_INSTANT даты и время, попадающие в диапазон значений, включаются в сегмент.

Значения -> (список)

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

(строка)

СледующаяАктивность -> (строка)

Уникальный идентификатор следующей выполняемой активности после завершения активности для пути.

АктивностьПоУмолчанию -> (строка)

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

ВремяОжиданияОценки -> (структура)

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

Ожидать -> (строка)

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

ОжидатьДо -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия активности или переведены ли участники на следующую активность в путешествии.

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

Настройки активности отправки push-уведомлений. Этот тип активности отправляет push-уведомление участникам.

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

Указывает значение времени жизни (TTL) push-уведомлений, отправляемых участникам в рамках этапа.

TimeToLive -> (строка)

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

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

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

Branches -> (список)

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

(структура)

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

NextActivity -> (строка)

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

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

Процент участников, которых следует направить по пути активности.

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

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

Настройки активности отправки SMS. Этот тип активности отправляет текстовое сообщение участникам.

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

Указывает идентификатор отправителя и тип сообщения для SMS-сообщения, отправляемого участникам в рамках этапа.

MessageType -> (строка)

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

OriginationNumber -> (строка)

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

SenderId -> (строка)

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

EntityId -> (строка)

TemplateId -> (строка)

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

Настройки активности ожидания. Этот тип активности ожидает определенное количество времени или до определенной даты и времени, прежде чем переместить участников к следующей активности в рамках этапа.

NextActivity -> (строка)

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

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

Количество времени для ожидания или дата и время, когда активность переместит участников к следующей активности в рамках этапа.

WaitFor -> (строка)

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

WaitUntil -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, были ли выполнены условия активности или активность переместит участников к следующей активности в рамках этапа.

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

Настройки активности подключения. Этот тип активности инициирует звонок в контактный центр для участников.

NextActivity -> (строка)

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

ApplicationId -> (строка)

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

CreationDate -> (строка)

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

Id -> (строка)

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

LastModifiedDate -> (строка)

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

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

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

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

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

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

Максимальное количество раз, которое участник может войти в этап. Максимальное значение равно 100. Чтобы разрешить участникам неограниченное количество входов в этап, установите это значение в 0.

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

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

EndpointReentryInterval -> (строка)

Минимальное время, которое должно пройти, прежде чем конечная точка сможет повторно войти в заданный этап. Длительность должна быть в формате ISO 8601, например, PT1H.

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

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

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

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

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

Продолжительность временного интервала в днях. Максимальное значение равно 30. Если установлено в 0, этот лимит не будет применяться.

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

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

LocalTime -> (булево)

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

Name -> (строка)

Имя этапа.

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 дня.

RefreshFrequency -> (строка)

Частота, с которой Amazon Pinpoint оценивает данные сегмента и события для этапа, в формате ISO 8601.

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

Настройки расписания для этапа.

EndTime -> (метка времени)

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

StartTime -> (метка времени)

Запланированное время начала этапа в формате ISO 8601.

Timezone -> (строка)

Начальная временная зона UTC для расписания этапа, если значение свойства LocalTime этапа равно 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+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10 и UTC-11.

StartActivity -> (строка)

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

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

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

Описание -> (строка)

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

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

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

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

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

Размеры -> (структура)

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

Атрибуты -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

ВКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
ИСКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT, до значения, включаются в сегмент.
ПОСЛЕ - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT, после значения, включаются в сегмент.
В - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT, на значении, включаются в сегмент. Время игнорируется в этом сравнении.
МЕЖДУ - конечные точки с атрибутами, прочитанными как даты ISO_INSTANT, между значениями, включаются в сегмент.

Значения -> (список)

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

(строка)

ТипСобытия -> (структура)

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

ТипИзмерения -> (строка)

Тип измерения сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и, ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Метрики -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ОператорСравнения -> (строка)

Оператор для использования при сравнении значений метрик. Допустимые значения: БОЛЬШЕ, МЕНЬШЕ, БОЛЬШЕ_ИЛИ_РАВНО, МЕНЬШЕ_ИЛИ_РАВНО и РАВНО.

Значение -> (двойное)

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

ТипФильтра -> (строка)

Тип события, вызывающего отправку кампании или выполнение действия путешествия. Допустимые значения: СИСТЕМА, отправляет кампанию или выполняет действие при возникновении системного события; и, КОНЕЧНАЯ_ТОЧКА, отправляет кампанию или выполняет действие при возникновении события конечной точки (ресурс событий).

IdСегмента -> (строка)

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

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

IdСегмента -> (строка)

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

Состояние -> (строка)

Текущий статус путешествия. Возможные значения:

ПРОЕКТ - путешествие разрабатывается и еще не опубликовано.
АКТИВНО - путешествие разработано и опубликовано. В зависимости от расписания путешествия, оно может выполняться сейчас или запланировано на запуск в более позднее время. Если статус путешествия АКТИВНО, вы не можете добавлять, изменять или удалять действия из него.
ЗАВЕРШЕНО - путешествие опубликовано и завершило выполнение. Все участники прошли через путешествие, и ни один участник не ждет завершения путешествия или каких-либо действий в путешествии.
ОТМЕНЕНО - путешествие остановлено. Если статус путешествия ОТМЕНЕНО, вы не можете добавлять, изменять или удалять действия или настройки сегмента в путешествии.
ЗАКРЫТО - путешествие опубликовано и начато выполнение. Также может истечь запланированное время окончания, или истечь запланированное время начала, и не указана частота обновления. Если статус путешествия ЗАКРЫТО, вы не можете добавлять участников, и никакие существующие участники не могут войти в путешествие впервые. Однако любые существующие участники, которые в настоящее время ожидают начала действия, могут продолжить путешествие.

теги -> (карта)

Этот объект не используется или не поддерживается.

ключ -> (строка)

значение -> (строка)

WaitForQuietTime -> (булево)

Указывает, должны ли конечные точки в часы тишины входить в действие ожидания до истечения часов тишины.

RefreshOnSegmentUpdate -> (булево)

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

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

Настройки каналов, специфичные для путешествия.

ConnectCampaignArn -> (строка)

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

ConnectCampaignExecutionRoleArn -> (строка)

IAM роль ARN, которая должна быть принята при вызове API выполнения кампании Connect для совершения звонков.

SendingSchedule -> (булево)

Указывает, имеет ли путешествие включенные Расширенные часы тишины. Этот флаг должен быть установлен в значение true, чтобы разрешить использование OpenHours и ClosedDays.

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

Время, когда путешествие может отправлять сообщения. Сначала должна быть настроена QuietTime, а SendingSchedule должна быть установлена в значение true.

EMAIL -> (карта)

Определяет настройки расписания для канала электронной почты.

ключ -> (строка)

День недели, когда правило будет применено. Допустимые значения [ПОНЕДЕЛЬНИК, ВТОРНИК, СРЕДА, ЧЕТВЕРГ, ПЯТНИЦА, СУББОТА, ВОСКРЕСЕНЬЕ]

значение -> (список)

Правила Открытых часов.

(структура)

Подробности правила Открытых часов.

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

SMS -> (карта)

Определяет настройки расписания для канала SMS.

ключ -> (строка)

значение -> (список)

Правила Открытых часов.

(структура)

Подробности правила Открытых часов.

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

PUSH -> (карта)

Определяет настройки расписания для канала push.

ключ -> (строка)

значение -> (список)

Правила Открытых часов.

(структура)

Подробности правила Открытых часов.

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

VOICE -> (карта)

Определяет настройки расписания для канала голосовой связи.

ключ -> (строка)

значение -> (список)

Правила Открытых часов.

(структура)

Подробности правила Открытых часов.

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

CUSTOM -> (карта)

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

ключ -> (строка)

значение -> (список)

Правила Открытых часов.

(структура)

Подробности правила Открытых часов.

StartTime -> (строка)

Начало запланированного времени, в формате ISO 8601, когда канал может отправлять сообщения.

EndTime -> (строка)

Конец запланированного времени, в формате ISO 8601, когда канал не может отправлять сообщения.

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

Время, когда поездка не будет отправлять сообщения. QuietTime должен быть настроен в первую очередь, а SendingSchedule должен быть установлен в значение true.

EMAIL -> (список)

Правила для канала Email.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытых дней.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

SMS -> (список)

Правила для канала SMS.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытых дней.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

PUSH -> (список)

Правила для канала Push.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытых дней.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

VOICE -> (список)

Правила для канала Voice.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытых дней.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

CUSTOM -> (список)

Правила для канала Custom.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытых дней.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

TimezoneEstimationMethods -> (список)

Массив методов оценки часового пояса, если таковые имеются, для определения часового пояса Endpoints, если у Endpoint нет значения для атрибута Demographic.Timezone.

PHONE_NUMBER - Часовой пояс определяется на основе Endpoint.Address и Endpoint.Location.Country.
POSTAL_CODE - Часовой пояс определяется на основе Endpoint.Location.PostalCode и Endpoint.Location.Country.

Примечание

(строка)