EVGCampaign Class Reference

A custom ‘Data’ campaign to be handled by the app, served in response to Marketing Cloud Personalization actions generated by the user interacting with the app.

A campaign is delivered to a EVGCampaignHandler registered for a unique app-defined target in the scope of an EVGContext (typically a UIViewController).

For additional information, see Mobile Data Campaigns. For lifecycle details, see [EVGContext setCampaignHandler:forTarget:].

An app-defined string that uniquely identifies the payload data schema - what the data represents and its purpose. For example, “Featured Product”, “Recommended Products”, “Info Banner”, etc.

1@property (nonnull, readonly, nonatomic, copy) NSString *target

Discussion

The target is specified in the Personalization web UI when designing the campaign, and in [EVGContext setCampaignHandler:forTarget:] when the app defines an EVGCampaignHandler.

To maximize flexibility, all campaigns designed for the same target should share a compatible data structure, in order to be consumable by any EVGCampaignHandler registered by the app for that specific target.

The identifier for this campaign.

1@property (nonnull, readonly, nonatomic, copy) NSString *campaignId

The name of this campaign, as set in the Personalization web UI.

1@property (nonnull, readonly, nonatomic, copy) NSString *campaignName

The identifier of the experience in this campaign.

1@property (nonnull, readonly, nonatomic, copy) NSString *experienceId

The name of the experience in this campaign, as set in the Personalization web UI.

1@property (nonnull, readonly, nonatomic, copy) NSString *experienceName

The identifier of the message in this campaign.

1@property (nonnull, readonly, nonatomic, copy) NSString *messageId

Array of related promoted items, if any, in minimal JSON form. Automatically used in stat tracking.

1@property (nullable, readonly, nonatomic, strong) NSArray<NSDictionary<NSString*id> *> *promotedItemKeys

This campaign’s dynamic/static JSON payload, as designed in the Personalization web UI.

1@property (nonnull, readonly, nonatomic, strong) NSDictionary<NSString*id> *data

Discussion

The structure should be designed for the app-defined target, in order to be consumable by any EVGCampaignHandler registered for that target.

See Also

• [EVGContext setCampaignHandler:forTarget:]

If this campaign is for a user in the control group.

1@property (readonly, nonatomic, assign) BOOL isControlGroup

Discussion

If NO, this campaign should be handled normally. When applicable, show the campaign to the user and track the impression.

If YES, this campaign should not take effect. Do not show to the user, but do track impression IF the campaign would have been shown.

To ensure accurate statistics, make sure to execute all the logic that could affect whether this campaign would be shown to the user, regardless of this property. If all those checks pass and isControlGroup == NO, show the campaign to the user. Finally, call [EVGContext trackImpression:] to notify Personalization that the user saw the campaign (isControlGroup == NO) or would have seen it (isControlGroup == YES).

Indicates whether this campaign is equivalent to another campaign.

1- (BOOL)isEqual:(id)object

Parameters

Availability

• 1.2.1

Discussion

Typically used in EVGCampaignHandler to avoid re-processing a campaign that’s equivalent to one already visible/active.

The equals method checks for equivalence in the source JSON returned by the server. Campaigns are not equal if there are differences in message content.

Returns a hash code value for the campaign based off of the campaign target, control group, and the ids and names of the campaign, experience, and message, but not message content.

1- (NSUInteger)hash

Availability

• 1.2.1

Discussion

Campaigns with different message content (due to campaign edits or dynamic message content) currently return the same hashcode. Use isEqual: to determine full equivalence or not.