Class: Aws::Pinpoint::Types::InAppTemplateRequest

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 InAppTemplateRequest data as a hash:

{
  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
  tags: {
    "__string" => "__string",
  },
  template_description: "__string",
}

In-App Template Request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#contentArray<Types::InAppMessageContent>

The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

Returns:



11566
11567
11568
11569
11570
11571
11572
11573
11574
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11566

class InAppTemplateRequest < Struct.new(
  :content,
  :custom_config,
  :layout,
  :tags,
  :template_description)
  SENSITIVE = []
  include Aws::Structure
end

#custom_configHash<String,String>

Custom config to be sent to client.

Returns:

  • (Hash<String,String>)


11566
11567
11568
11569
11570
11571
11572
11573
11574
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11566

class InAppTemplateRequest < Struct.new(
  :content,
  :custom_config,
  :layout,
  :tags,
  :template_description)
  SENSITIVE = []
  include Aws::Structure
end

#layoutString

The layout of the message.

Returns:

  • (String)


11566
11567
11568
11569
11570
11571
11572
11573
11574
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11566

class InAppTemplateRequest < Struct.new(
  :content,
  :custom_config,
  :layout,
  :tags,
  :template_description)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (Hash<String,String>)


11566
11567
11568
11569
11570
11571
11572
11573
11574
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11566

class InAppTemplateRequest < Struct.new(
  :content,
  :custom_config,
  :layout,
  :tags,
  :template_description)
  SENSITIVE = []
  include Aws::Structure
end

#template_descriptionString

The description of the template.

Returns:

  • (String)


11566
11567
11568
11569
11570
11571
11572
11573
11574
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11566

class InAppTemplateRequest < Struct.new(
  :content,
  :custom_config,
  :layout,
  :tags,
  :template_description)
  SENSITIVE = []
  include Aws::Structure
end