Class: Aws::Pinpoint::Types::InAppMessageCampaign

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::InAppMessageCampaign

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #campaign_id ⇒ String

  Campaign id of the corresponding campaign.

• #daily_cap ⇒ Integer

  Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

• #in_app_message ⇒ Types::InAppMessage

  In-app message content with all fields required for rendering an in-app message.

• #priority ⇒ Integer

  Priority of the in-app message.

• #schedule ⇒ Types::InAppCampaignSchedule

  Schedule of the campaign.

• #session_cap ⇒ Integer

  Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

• #total_cap ⇒ Integer

  Total cap which controls the number of times an in-app message can be shown to the endpoint.

• #treatment_id ⇒ String

  Treatment id of the campaign.

Instance Attribute Details

#campaign_id ⇒ String

Campaign id of the corresponding campaign.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end

#daily_cap ⇒ Integer

Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end

#in_app_message ⇒ Types::InAppMessage

In-app message content with all fields required for rendering an in-app message.

Returns:

• (Types::InAppMessage)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

Priority of the in-app message.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::InAppCampaignSchedule

Schedule of the campaign.

Returns:

• (Types::InAppCampaignSchedule)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end

#session_cap ⇒ Integer

Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end

#total_cap ⇒ Integer

Total cap which controls the number of times an in-app message can be shown to the endpoint.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_id ⇒ String

Treatment id of the campaign.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 7977

class InAppMessageCampaign < Struct.new(
  :campaign_id,
  :daily_cap,
  :in_app_message,
  :priority,
  :schedule,
  :session_cap,
  :total_cap,
  :treatment_id)
  SENSITIVE = []
  include Aws::Structure
end