You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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:

{
  message_configuration: {
    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,
      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,
      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,
      title: "__string",
      url: "__string",
    },
    sms_message: {
      body: "__string",
      message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
      sender_id: "__string",
    },
  },
  schedule: {
    end_time: "__string",
    frequency: "ONCE", # accepts ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    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.

Instance Attribute Summary collapse

Instance Attribute Details

#message_configurationTypes::MessageConfiguration

The message configuration settings.



5449
5450
5451
5452
5453
5454
5455
5456
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5449

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

#scheduleTypes::Schedule

The campaign schedule.

Returns:



5449
5450
5451
5452
5453
5454
5455
5456
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5449

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

#size_percentInteger

The allocated percentage of users for this treatment.

Returns:

  • (Integer)


5449
5450
5451
5452
5453
5454
5455
5456
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5449

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

#treatment_descriptionString

A custom description for the treatment.

Returns:

  • (String)


5449
5450
5451
5452
5453
5454
5455
5456
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5449

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

#treatment_nameString

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

Returns:

  • (String)


5449
5450
5451
5452
5453
5454
5455
5456
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5449

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