Class: Aws::Pinpoint::Types::MessageConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass MessageConfiguration data as a hash:

{
  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
  },
}

Specifies the message configuration settings for a campaign.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#adm_messageTypes::Message

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

Returns:



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#apns_messageTypes::Message

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

Returns:



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#baidu_messageTypes::Message

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

Returns:



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#custom_messageTypes::CampaignCustomMessage

The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#default_messageTypes::Message

The default message that the campaign sends through all the channels that are configured for the campaign.

Returns:



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#email_messageTypes::CampaignEmailMessage

The message that the campaign sends through the email channel. If specified, this message overrides the default message.



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#gcm_messageTypes::Message

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

Returns:



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#in_app_messageTypes::CampaignInAppMessage

The in-app message configuration.



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end

#sms_messageTypes::CampaignSmsMessage

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.



12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 12890

class MessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :custom_message,
  :default_message,
  :email_message,
  :gcm_message,
  :sms_message,
  :in_app_message)
  SENSITIVE = []
  include Aws::Structure
end