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: {
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,
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,
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,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
sender_id: "__string",
},
},
schedule: {
end_time: "__string",
frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
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,
is_paused: false,
limits: {
daily: 1,
total: 1,
},
message_configuration: {
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,
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,
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,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
sender_id: "__string",
},
},
name: "__string",
schedule: {
end_time: "__string",
frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
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.
-
#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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :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.
5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5235 class WriteCampaignRequest < Struct.new( :additional_treatments, :description, :holdout_percent, :is_paused, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :treatment_description, :treatment_name) include Aws::Structure end |