Class: Aws::Pinpoint::Types::CreateCampaignRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::CreateCampaignRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
Note:
When making an API call, you may pass CreateCampaignRequest data as a hash:
{
application_id: "__string", # required
write_campaign_request: { # required
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",
},
}
Instance Attribute Summary collapse
- #application_id ⇒ String
-
#write_campaign_request ⇒ Types::WriteCampaignRequest
Used to create a campaign.
Instance Attribute Details
#application_id ⇒ String
2187 2188 2189 2190 2191 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2187 class CreateCampaignRequest < Struct.new( :application_id, :write_campaign_request) include Aws::Structure end |
#write_campaign_request ⇒ Types::WriteCampaignRequest
Used to create a campaign.
2187 2188 2189 2190 2191 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2187 class CreateCampaignRequest < Struct.new( :application_id, :write_campaign_request) include Aws::Structure end |