CouponAuthorSDK Class Reference

Inherits from NSObject
Declared in CouponAuthorSDK.h

Overview

This is the main class through which you can communicate with the Coupon Author SDK.

+ startWithAppId:

You must call startWithAppId before you try to access a bucket of coupons or track any analytics.

+ (void)startWithAppId:(NSString *)appId

Parameters

appId

your Coupon Author app identifier from Slyce

Discussion

You must call startWithAppId before you try to access a bucket of coupons or track any analytics.

Add the following line to the bottom of the didFinishLaunchingWithOptions: method of your AppDelegate.

[CouponAuthorSDK startWithAppId:@“YOUR_APP_ID”];

Declared In

CouponAuthorSDK.h

+ getBucketWithSource:andMedium:

Returns the a bucket of coupons for a given source and medium

+ (SSBucket *)getBucketWithSource:(NSString *)source andMedium:(NSString *)medium

Parameters

source

The source for these coupons
medium

The medium for these coupons

Discussion

Returns the a bucket of coupons for a given source and medium

Declared In

CouponAuthorSDK.h

+ trackImpressionForCouponWithId:Source:Medium:

Method to call when a user sees the coupon with the given Id

+ (void)trackImpressionForCouponWithId:(NSInteger)couponId Source:(NSString *)source Medium:(NSString *)medium

Parameters

couponId

the coupon id that was shown. This should come from an SSCoupon instance.
source

The source to track this event for
medium

The medium to track this event for

Discussion

Method to call when a user sees the coupon with the given Id

This event will be tracked under the given source and medium

Declared In

CouponAuthorSDK.h

+ trackImpressionsInBucketWithSource:andMedium:

Method to call to track impressions for an entire bucket

+ (void)trackImpressionsInBucketWithSource:(NSString *)source andMedium:(NSString *)medium

Parameters

source

The source to track these events for
medium

The medium to track these events for

Discussion

Method to call to track impressions for an entire bucket

Declared In

CouponAuthorSDK.h

+ trackViewForCouponWithId:Source:Medium:

Method to call when a user taps the coupon with the given Id

+ (void)trackViewForCouponWithId:(NSInteger)couponId Source:(NSString *)source Medium:(NSString *)medium

Parameters

couponId

the coupon id that was viewed. This should come from an SSCoupon instance.
source

The source to track this event for
medium

The medium to track this event for

Discussion

Method to call when a user taps the coupon with the given Id

Declared In

CouponAuthorSDK.h

+ trackRedemptionForCouponWithId:ofType:Source:Medium:

Method to call when a user snips a coupon to SnipSnap, Apple Wallet, or Google Wallet

+ (void)trackRedemptionForCouponWithId:(NSInteger)couponId ofType:(SSRedemptionType)redemptionType Source:(NSString *)source Medium:(NSString *)medium

Parameters

couponId

the coupon id that was viewed. This should come from an SSCoupon instance.
redemptionType

the type of redemption completed by the user.
source

The source to track this event for.
medium

The medium to track this event for.

Discussion

Method to call when a user snips a coupon to SnipSnap, Apple Wallet, or Google Wallet

Declared In

CouponAuthorSDK.h