Class: Aws::Pinpoint::Types::WriteTreatmentResource

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

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

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_delivery_configurationTypes::CustomDeliveryConfiguration

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.



22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 22091

class WriteTreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :message_configuration,
  :schedule,
  :size_percent,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#message_configurationTypes::MessageConfiguration

The message configuration settings for the treatment.



22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 22091

class WriteTreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :message_configuration,
  :schedule,
  :size_percent,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::Schedule

The schedule settings for the treatment.

Returns:



22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 22091

class WriteTreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :message_configuration,
  :schedule,
  :size_percent,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#size_percentInteger

The allocated percentage of users (segment members) to send the treatment to.

Returns:

  • (Integer)


22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 22091

class WriteTreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :message_configuration,
  :schedule,
  :size_percent,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#template_configurationTypes::TemplateConfiguration

The message template to use for the treatment.



22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 22091

class WriteTreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :message_configuration,
  :schedule,
  :size_percent,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_descriptionString

A custom description of the treatment.

Returns:

  • (String)


22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 22091

class WriteTreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :message_configuration,
  :schedule,
  :size_percent,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_nameString

A custom name for the treatment.

Returns:

  • (String)


22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 22091

class WriteTreatmentResource < Struct.new(
  :custom_delivery_configuration,
  :message_configuration,
  :schedule,
  :size_percent,
  :template_configuration,
  :treatment_description,
  :treatment_name)
  SENSITIVE = []
  include Aws::Structure
end