AWSPinpointTargetingCampaignResponse

Objective-C

@interface AWSPinpointTargetingCampaignResponse

Swift

class AWSPinpointTargetingCampaignResponse

Provides information about the status, configuration, and other settings for a campaign.

Required parameters: [LastModifiedDate, CreationDate, SegmentId, SegmentVersion, Id, Arn, ApplicationId]

  • An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

    Declaration

    Objective-C

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

    Swift

    var additionalTreatments: [AWSPinpointTargetingTreatmentResource]? { get set }

  • The unique identifier for the application that the campaign applies to.

    Declaration

    Objective-C

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

    Swift

    var applicationId: String? { get set }
  • arn

    The Amazon Resource Name (ARN) of the campaign.

    Declaration

    Objective-C

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

    Swift

    var arn: String? { get set }

  • The date, in ISO 8601 format, when the campaign was created.

    Declaration

    Objective-C

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

    Swift

    var creationDate: String? { get set }

  • The delivery configuration settings for sending the campaign through a custom channel.

    Declaration

    Objective-C

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

    Swift

    var customDeliveryConfiguration: AWSPinpointTargetingCustomDeliveryConfiguration? { get set }

  • The current status of the campaign’s default treatment. This value exists only for campaigns that have more than one treatment.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingCampaignState *_Nullable defaultState;

    Swift

    var defaultState: AWSPinpointTargetingCampaignState? { get set }

  • The 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 use 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 }

  • The unique identifier for the campaign.

    Declaration

    Objective-C

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

    Swift

    var identifier: String? { get set }

  • Specifies whether the campaign is paused. 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 date, in ISO 8601 format, when the campaign was last modified.

    Declaration

    Objective-C

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

    Swift

    var lastModifiedDate: String? { 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 }

  • The name of the campaign.

    Declaration

    Objective-C

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

    Swift

    var name: String? { 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 that’s associated with the campaign.

    Declaration

    Objective-C

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

    Swift

    var segmentId: String? { get set }

  • The version number of the segment that’s associated with the campaign.

    Declaration

    Objective-C

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

    Swift

    var segmentVersion: NSNumber? { get set }

  • The current status of the campaign.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingCampaignState *_Nullable state;

    Swift

    var state: AWSPinpointTargetingCampaignState? { get set }

  • The message template that’s used for the campaign.

    Declaration

    Objective-C

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

    Swift

    var templateConfiguration: AWSPinpointTargetingTemplateConfiguration? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var treatmentDescription: String? { get set }

  • The 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 }

  • The version number of the campaign.

    Declaration

    Objective-C

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

    Swift

    var version: NSNumber? { get set }

  • A string-to-string map of key-value pairs that identifies the tags that are associated 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 }