Class: Aws::Pinpoint::Types::CreateCampaignRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::CreateCampaignRequest
- Defined in:
- gems/aws-sdk-pinpoint/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: [
{
custom_delivery_configuration: {
delivery_uri: "__string", # required
endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
},
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",
},
custom_message: {
data: "__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
origination_number: "__string",
sender_id: "__string",
entity_id: "__string",
template_id: "__string",
},
in_app_message: {
body: "__string",
content: [
{
background_color: "__string",
body_config: {
alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
body: "__string", # required
text_color: "__string", # required
},
header_config: {
alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
header: "__string", # required
text_color: "__string", # required
},
image_url: "__string",
primary_btn: {
android: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
default_config: {
background_color: "__string",
border_radius: 1,
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
text: "__string", # required
text_color: "__string",
},
ios: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
web: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
},
secondary_btn: {
android: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
default_config: {
background_color: "__string",
border_radius: 1,
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
text: "__string", # required
text_color: "__string",
},
ios: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
web: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
},
},
],
custom_config: {
"__string" => "__string",
},
layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
},
},
schedule: {
end_time: "__string",
event_filter: {
dimensions: { # required
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
values: ["__string"], # required
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
metrics: {
"__string" => {
comparison_operator: "__string", # required
value: 1.0, # required
},
},
},
filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
},
frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT, IN_APP_EVENT
is_local_time: false,
quiet_time: {
end: "__string",
start: "__string",
},
start_time: "__string", # required
timezone: "__string",
},
size_percent: 1, # required
template_configuration: {
email_template: {
name: "__string",
version: "__string",
},
push_template: {
name: "__string",
version: "__string",
},
sms_template: {
name: "__string",
version: "__string",
},
voice_template: {
name: "__string",
version: "__string",
},
},
treatment_description: "__string",
treatment_name: "__string",
},
],
custom_delivery_configuration: {
delivery_uri: "__string", # required
endpoint_types: ["PUSH"], # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
},
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,
session: 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",
},
custom_message: {
data: "__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
origination_number: "__string",
sender_id: "__string",
entity_id: "__string",
template_id: "__string",
},
in_app_message: {
body: "__string",
content: [
{
background_color: "__string",
body_config: {
alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
body: "__string", # required
text_color: "__string", # required
},
header_config: {
alignment: "LEFT", # required, accepts LEFT, CENTER, RIGHT
header: "__string", # required
text_color: "__string", # required
},
image_url: "__string",
primary_btn: {
android: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
default_config: {
background_color: "__string",
border_radius: 1,
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
text: "__string", # required
text_color: "__string",
},
ios: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
web: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
},
secondary_btn: {
android: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
default_config: {
background_color: "__string",
border_radius: 1,
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
text: "__string", # required
text_color: "__string",
},
ios: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
web: {
button_action: "LINK", # required, accepts LINK, DEEP_LINK, CLOSE
link: "__string",
},
},
},
],
custom_config: {
"__string" => "__string",
},
layout: "BOTTOM_BANNER", # accepts BOTTOM_BANNER, TOP_BANNER, OVERLAYS, MOBILE_FEED, MIDDLE_BANNER, CAROUSEL
},
},
name: "__string",
schedule: {
end_time: "__string",
event_filter: {
dimensions: { # required
attributes: {
"__string" => {
attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
values: ["__string"], # required
},
},
event_type: {
dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
values: ["__string"], # required
},
metrics: {
"__string" => {
comparison_operator: "__string", # required
value: 1.0, # required
},
},
},
filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
},
frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT, IN_APP_EVENT
is_local_time: false,
quiet_time: {
end: "__string",
start: "__string",
},
start_time: "__string", # required
timezone: "__string",
},
segment_id: "__string",
segment_version: 1,
tags: {
"__string" => "__string",
},
template_configuration: {
email_template: {
name: "__string",
version: "__string",
},
push_template: {
name: "__string",
version: "__string",
},
sms_template: {
name: "__string",
version: "__string",
},
voice_template: {
name: "__string",
version: "__string",
},
},
treatment_description: "__string",
treatment_name: "__string",
priority: 1,
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#application_id ⇒ String
-
#write_campaign_request ⇒ Types::WriteCampaignRequest
Specifies the configuration and other settings for a campaign.
Instance Attribute Details
#application_id ⇒ String
3964 3965 3966 3967 3968 3969 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3964 class CreateCampaignRequest < Struct.new( :application_id, :write_campaign_request) SENSITIVE = [] include Aws::Structure end |
#write_campaign_request ⇒ Types::WriteCampaignRequest
Specifies the configuration and other settings for a campaign.
3964 3965 3966 3967 3968 3969 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3964 class CreateCampaignRequest < Struct.new( :application_id, :write_campaign_request) SENSITIVE = [] include Aws::Structure end |