AWSPinpointTargetingWriteCampaignRequest

Objective-C

@interface AWSPinpointTargetingWriteCampaignRequest

Swift

class AWSPinpointTargetingWriteCampaignRequest

Specifies the configuration and other settings for a campaign.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSPinpointTargetingWriteTreatmentResource *> *_Nullable additionalTreatments;

    Swift

    var additionalTreatments: [AWSPinpointTargetingWriteTreatmentResource]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingCustomDeliveryConfiguration *_Nullable customDeliveryConfiguration;

    Swift

    var customDeliveryConfiguration: AWSPinpointTargetingCustomDeliveryConfiguration? { get set }

  • A custom description of the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable holdoutPercent;

    Swift

    var holdoutPercent: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingCampaignHook *_Nullable hook;

    Swift

    var hook: AWSPinpointTargetingCampaignHook? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable isPaused;

    Swift

    var isPaused: NSNumber? { get set }

  • The messaging limits for the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingCampaignLimits *_Nullable limits;

    Swift

    var limits: AWSPinpointTargetingCampaignLimits? { get set }

  • The message configuration settings for the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingMessageConfiguration *_Nullable messageConfiguration;

    Swift

    var messageConfiguration: AWSPinpointTargetingMessageConfiguration? { get set }

  • A custom name for the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable priority;

    Swift

    var priority: NSNumber? { get set }

  • The schedule settings for the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingSchedule *_Nullable schedule;

    Swift

    var schedule: AWSPinpointTargetingSchedule? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable segmentId;

    Swift

    var segmentId: String? { get set }

  • The version of the segment to associate with the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable segmentVersion;

    Swift

    var segmentVersion: NSNumber? { get set }

  • The message template to use for the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingTemplateConfiguration *_Nullable templateConfiguration;

    Swift

    var templateConfiguration: AWSPinpointTargetingTemplateConfiguration? { get set }

  • A custom description of the default treatment for the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable treatmentDescription;

    Swift

    var treatmentDescription: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable treatmentName;

    Swift

    var treatmentName: String? { get set }

  • As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

    (Deprecated) 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable tags;

    Swift

    var tags: [String : String]? { get set }