Class: Aws::Pinpoint::Types::WriteCampaignRequest

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

{
  additional_treatments: [
    {
      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",
    },
  ],
  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
  },
  description: "__string",
  holdout_percent: 1,
  hook: {
    lambda_function_name: "__string",
    mode: "DELIVERY", # accepts DELIVERY, FILTER
    web_url: "__string",
  },
  is_paused: false,
  limits: {
    daily: 1,
    maximum_duration: 1,
    messages_per_second: 1,
    total: 1,
    session: 1,
  },
  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
    },
  },
  name: "__string",
  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",
  },
  segment_id: "__string",
  segment_version: 1,
  tags: {
    "__string" => "__string",
  },
  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",
  priority: 1,
}

Specifies the configuration and other settings for a campaign.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_treatmentsArray<Types::WriteTreatmentResource>

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

Returns:



20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#custom_delivery_configurationTypes::CustomDeliveryConfiguration

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



20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A custom description of the campaign.

Returns:

  • (String)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#holdout_percentInteger

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

Returns:

  • (Integer)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#hookTypes::CampaignHook

The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

Returns:



20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#is_pausedBoolean

Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

Returns:

  • (Boolean)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#limitsTypes::CampaignLimits

The messaging limits for the campaign.



20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#message_configurationTypes::MessageConfiguration

The message configuration settings for the campaign.



20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A custom name for the campaign.

Returns:

  • (String)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

Returns:

  • (Integer)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::Schedule

The schedule settings for the campaign.

Returns:



20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#segment_idString

The unique identifier for the segment to associate with the campaign.

Returns:

  • (String)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#segment_versionInteger

The version of the segment to associate with the campaign.

Returns:

  • (Integer)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  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 campaign. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (Hash<String,String>)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#template_configurationTypes::TemplateConfiguration

The message template to use for the campaign.



20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_descriptionString

A custom description of the default treatment for the campaign.

Returns:

  • (String)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_nameString

A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

Returns:

  • (String)


20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 20896

class WriteCampaignRequest < Struct.new(
  :additional_treatments,
  :custom_delivery_configuration,
  :description,
  :holdout_percent,
  :hook,
  :is_paused,
  :limits,
  :message_configuration,
  :name,
  :schedule,
  :segment_id,
  :segment_version,
  :tags,
  :template_configuration,
  :treatment_description,
  :treatment_name,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end