AWSPinpointTargetingWriteCampaignRequest

@interface 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 (readwrite, strong, nonatomic)
        NSArray<AWSPinpointTargetingWriteTreatmentResource *>
            *_Nullable additionalTreatments;

    Swift

    var additionalTreatments: [AWSPinpointTargetingWriteTreatmentResource]? { get set }
  • A custom description of the campaign.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) 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 (readwrite, strong, nonatomic) NSNumber *_Nullable holdoutPercent;

    Swift

    var holdoutPercent: NSNumber? { get set }
  • The settings for the AWS Lambda function to use as a code hook for the campaign.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        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 setting this value to false.

    Declaration

    Objective-C

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

    Swift

    var isPaused: NSNumber? { get set }
  • The messaging limits for the campaign.

    Declaration

    Objective-C

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

    Swift

    var limits: AWSPinpointTargetingCampaignLimits? { get set }
  • The message configuration settings for the campaign.

    Declaration

    Objective-C

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

    Swift

    var messageConfiguration: AWSPinpointTargetingMessageConfiguration? { get set }
  • A custom name for the campaign.

    Declaration

    Objective-C

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

    Swift

    var name: String? { get set }
  • The schedule settings for the campaign.

    Declaration

    Objective-C

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

    Swift

    var schedule: AWSPinpointTargetingSchedule? { get set }
  • The unique identifier for the segment to associate with the campaign.

    Declaration

    Objective-C

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

    Swift

    var segmentId: String? { get set }
  • The version of the segment to associate with the campaign.

    Declaration

    Objective-C

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

    Swift

    var segmentVersion: NSNumber? { get set }
  • The message template to use for the campaign.

    Declaration

    Objective-C

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

    Swift

    var templateConfiguration: AWSPinpointTargetingTemplateConfiguration? { get set }
  • A custom description of a variation of the campaign to use for A/B testing.

    Declaration

    Objective-C

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

    Swift

    var treatmentDescription: String? { get set }
  • A custom name for a variation of the campaign to use for A/B testing.

    Declaration

    Objective-C

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

    Swift

    var treatmentName: String? { get set }
  • 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 (readwrite, strong, nonatomic)
        NSDictionary<NSString *, NSString *> *_Nullable tags;

    Swift

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