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

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

Overview

Note:

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

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

Used to create a campaign treatment.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#message_configuration ⇒ Types::MessageConfiguration

The message configuration settings.

Returns:



11186
11187
11188
11189
11190
11191
11192
11193
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11186

class WriteTreatmentResource < Struct.new(
  :message_configuration,
  :schedule,
  :size_percent,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#schedule ⇒ Types::Schedule

The campaign schedule.

Returns:



11186
11187
11188
11189
11190
11191
11192
11193
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11186

class WriteTreatmentResource < Struct.new(
  :message_configuration,
  :schedule,
  :size_percent,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#size_percent ⇒ Integer

The allocated percentage of users for this treatment.

Returns:

  • (Integer) 


11186
11187
11188
11189
11190
11191
11192
11193
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11186

class WriteTreatmentResource < Struct.new(
  :message_configuration,
  :schedule,
  :size_percent,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#treatment_description ⇒ String

A custom description for the treatment.

Returns:

  • (String) 


11186
11187
11188
11189
11190
11191
11192
11193
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11186

class WriteTreatmentResource < Struct.new(
  :message_configuration,
  :schedule,
  :size_percent,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end

#treatment_name ⇒ String

The custom name of a variation of the campaign used for A/B testing.

Returns:

  • (String) 


11186
11187
11188
11189
11190
11191
11192
11193
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11186

class WriteTreatmentResource < Struct.new(
  :message_configuration,
  :schedule,
  :size_percent,
  :treatment_description,
  :treatment_name)
  include Aws::Structure
end