WriteCampaignRequest class
Specifies the configuration and other settings for a campaign.
Constructors
-
WriteCampaignRequest({List<
WriteTreatmentResource> ? additionalTreatments, CustomDeliveryConfiguration? customDeliveryConfiguration, String? description, int? holdoutPercent, CampaignHook? hook, bool? isPaused, CampaignLimits? limits, MessageConfiguration? messageConfiguration, String? name, Schedule? schedule, String? segmentId, int? segmentVersion, TemplateConfiguration? templateConfiguration, String? treatmentDescription, String? treatmentName, Map<String, String> ? tags})
Properties
-
additionalTreatments
→ List<
WriteTreatmentResource> ? -
An array of requests that defines additional treatments for the campaign, in
addition to the default treatment for the campaign.
final
- customDeliveryConfiguration → 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.
final
- description → String?
-
A custom description of the campaign.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- holdoutPercent → int?
-
The allocated percentage of users (segment members) who shouldn't receive
messages from the campaign.
final
- hook → 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.
final
- isPaused → bool?
-
Specifies whether to pause the campaign. A paused campaign doesn't run
unless you resume it by changing this value to false.
final
- limits → CampaignLimits?
-
The messaging limits for the campaign.
final
- messageConfiguration → MessageConfiguration?
-
The message configuration settings for the campaign.
final
- name → String?
-
A custom name for the campaign.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- schedule → Schedule?
-
The schedule settings for the campaign.
final
- segmentId → String?
-
The unique identifier for the segment to associate with the campaign.
final
- segmentVersion → int?
-
The version of the segment to associate with the campaign.
final
-
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.
final
- templateConfiguration → TemplateConfiguration?
-
The message template to use for the campaign.
final
- treatmentDescription → String?
-
A custom description of the default treatment for the campaign.
final
- treatmentName → String?
-
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.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited