Class: Aws::Pinpoint::Types::WriteCampaignRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::WriteCampaignRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass WriteCampaignRequest data as a hash:
{
additional_treatments: [
{
message_configuration: {
adm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
apns_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
baidu_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
default_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
email_message: {
body: "__string",
from_address: "__string",
html_body: "__string",
title: "__string",
},
gcm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
sender_id: "__string",
},
},
schedule: {
end_time: "__string",
event_filter: {
dimensions: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
},
filter_type: "SYSTEM", # accepts SYSTEM, ENDPOINT
},
frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
is_local_time: false,
quiet_time: {
end: "__string",
start: "__string",
},
start_time: "__string",
timezone: "__string",
},
size_percent: 1,
treatment_description: "__string",
treatment_name: "__string",
},
],
description: "__string",
holdout_percent: 1,
hook: {
lambda_function_name: "__string",
mode: "DELIVERY", # accepts DELIVERY, FILTER
web_url: "__string",
},
is_paused: false,
limits: {
daily: 1,
maximum_duration: 1,
messages_per_second: 1,
total: 1,
},
message_configuration: {
adm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
apns_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
baidu_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
default_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
email_message: {
body: "__string",
from_address: "__string",
html_body: "__string",
title: "__string",
},
gcm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
image_icon_url: "__string",
image_small_icon_url: "__string",
image_url: "__string",
json_body: "__string",
media_url: "__string",
raw_content: "__string",
silent_push: false,
time_to_live: 1,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
sender_id: "__string",
},
},
name: "__string",
schedule: {
end_time: "__string",
event_filter: {
dimensions: {
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"],
},
metrics: {
"__string" => {
comparison_operator: "__string",
value: 1.0,
},
},
},
filter_type: "SYSTEM", # accepts SYSTEM, ENDPOINT
},
frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
is_local_time: false,
quiet_time: {
end: "__string",
start: "__string",
},
start_time: "__string",
timezone: "__string",
},
segment_id: "__string",
segment_version: 1,
treatment_description: "__string",
treatment_name: "__string",
}
Used to create a campaign.
Instance Attribute Summary collapse
-
#additional_treatments ⇒ Array<Types::WriteTreatmentResource>
Treatments that are defined in addition to the default treatment.
-
#description ⇒ String
A description of the campaign.
-
#holdout_percent ⇒ Integer
The allocated percentage of end users who will not receive messages from this campaign.
-
#hook ⇒ Types::CampaignHook
Campaign hook information.
-
#is_paused ⇒ Boolean
Indicates whether the campaign is paused.
-
#limits ⇒ Types::CampaignLimits
The campaign limits settings.
-
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings.
-
#name ⇒ String
The custom name of the campaign.
-
#schedule ⇒ Types::Schedule
The campaign schedule.
-
#segment_id ⇒ String
The ID of the segment to which the campaign sends messages.
-
#segment_version ⇒ Integer
The version of the segment to which the campaign sends messages.
-
#treatment_description ⇒ String
A custom description for the treatment.
-
#treatment_name ⇒ String
The custom name of a variation of the campaign used for A/B testing.
Instance Attribute Details
#additional_treatments ⇒ Array<Types::WriteTreatmentResource>
Treatments that are defined in addition to the default treatment.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#description ⇒ String
A description of the campaign.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#holdout_percent ⇒ Integer
The allocated percentage of end users who will not receive messages from this campaign.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#hook ⇒ Types::CampaignHook
Campaign hook information.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#is_paused ⇒ Boolean
Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#limits ⇒ Types::CampaignLimits
The campaign limits settings.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#name ⇒ String
The custom name of the campaign.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#schedule ⇒ Types::Schedule
The campaign schedule.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#segment_id ⇒ String
The ID of the segment to which the campaign sends messages.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#segment_version ⇒ Integer
The version of the segment to which the campaign sends messages.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#treatment_description ⇒ String
A custom description for the treatment.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |
#treatment_name ⇒ String
The custom name of a variation of the campaign used for A/B testing.
10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 10810 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :hook, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |