Class: Aws::Pinpoint::Types::CampaignResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::CampaignResponse
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
Campaign definition
Instance Attribute Summary collapse
-
#additional_treatments ⇒ Array<Types::TreatmentResource>
Treatments that are defined in addition to the default treatment.
-
#application_id ⇒ String
The ID of the application to which the campaign applies.
-
#creation_date ⇒ String
The date the campaign was created in ISO 8601 format.
-
#default_state ⇒ Types::CampaignState
The status of the campaign’s default treatment.
-
#description ⇒ String
A description of the campaign.
-
#holdout_percent ⇒ Integer
The allocated percentage of end users who will not receive messages from this campaign.
-
#hook ⇒ Types::CampaignHook
Campaign hook information.
-
#id ⇒ String
The unique campaign ID.
-
#is_paused ⇒ Boolean
Indicates whether the campaign is paused.
-
#last_modified_date ⇒ String
The date the campaign was last updated in ISO 8601 format.
-
#limits ⇒ Types::CampaignLimits
The campaign limits settings.
-
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings.
-
#name ⇒ String
The custom name of the campaign.
-
#schedule ⇒ Types::Schedule
The campaign schedule.
-
#segment_id ⇒ String
The ID of the segment to which the campaign sends messages.
-
#segment_version ⇒ Integer
The version of the segment to which the campaign sends messages.
-
#state ⇒ Types::CampaignState
The campaign status.
-
#treatment_description ⇒ String
A custom description for the treatment.
-
#treatment_name ⇒ String
The custom name of a variation of the campaign used for A/B testing.
-
#version ⇒ Integer
The campaign version number.
Instance Attribute Details
#additional_treatments ⇒ Array<Types::TreatmentResource>
Treatments that are defined in addition to the default treatment.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#application_id ⇒ String
The ID of the application to which the campaign applies.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#creation_date ⇒ String
The date the campaign was created in ISO 8601 format.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#default_state ⇒ Types::CampaignState
The status of the campaign’s default treatment. Only present for A/B test campaigns.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#description ⇒ String
A description of the campaign.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#holdout_percent ⇒ Integer
The allocated percentage of end users who will not receive messages from this campaign.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#hook ⇒ Types::CampaignHook
Campaign hook information.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#id ⇒ String
The unique campaign ID.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#is_paused ⇒ Boolean
Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#last_modified_date ⇒ String
The date the campaign was last updated in ISO 8601 format.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#limits ⇒ Types::CampaignLimits
The campaign limits settings.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#message_configuration ⇒ Types::MessageConfiguration
The message configuration settings.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#name ⇒ String
The custom name of the campaign.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#schedule ⇒ Types::Schedule
The campaign schedule.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#segment_id ⇒ String
The ID of the segment to which the campaign sends messages.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#segment_version ⇒ Integer
The version of the segment to which the campaign sends messages.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#state ⇒ Types::CampaignState
The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#treatment_description ⇒ String
A custom description for the treatment.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#treatment_name ⇒ String
The custom name of a variation of the campaign used for A/B testing.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |
#version ⇒ Integer
The campaign version number.
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1703 class CampaignResponse < Struct.new( :additional_treatments, :application_id, :creation_date, :default_state, :description, :holdout_percent, :hook, :id, :is_paused, :last_modified_date, :limits, :message_configuration, :name, :schedule, :segment_id, :segment_version, :state, :treatment_description, :treatment_name, :version) include Aws::Structure end |