BVTransactionEvent Class Reference

Inherits from BVBasePIIEvent : NSObject
Conforms to BVAnalyticEvent
Declared in BVTransactionEvent.h

Overview

The trackConversionTransaction event should execute once the user has completed a purchase. This will often be after a payment has been processed or when loading of a payment confirmation view.

– initWithOrderId:orderTotal:orderItems:andOtherParams:

Required - The unique Id of the order.

- (nonnull id)initWithOrderId:(nonnull NSString *)orderId orderTotal:(double)total orderItems:(nonnull NSArray *)items andOtherParams:(nullable NSDictionary *)params

Parameters

orderId

Required - The unique Id of the order.

total

Required - The total amount of the order.

items

Required - [BVTransactionItem] -An array of the individual items in the order.

params

Optional - Used to define any other transaction parameters such as user email.

Return Value

the event object that can be used to submit to Bazaarvoice via the BVPixel API.

Declared In

BVTransactionEvent.h

– __unavailable

- (nonnull instancetype)__unavailable

– toRawNonPII

Creates a raw dictionary event that removes any possibly personally identifiable information. These events are fine to send with IDFA.

- (nonnull NSDictionary *)toRawNonPII

Return Value

The fully created event that can be sent to Bazaarvoice Analytics.

Declared In

BVTransactionEvent.h

  orderId

The unique Id of the order.

@property (nonnull, nonatomic, strong, readonly) NSString *orderId

Declared In

BVTransactionEvent.h

  total

The total amount of the order.

@property (nonatomic, assign, readonly) double total

Declared In

BVTransactionEvent.h

  items

[BVTransactionItem] - An array of the individual items in the order.

@property (nonnull, nonatomic, strong, readonly) NSArray<BVTransactionItem*> *items

Declared In

BVTransactionEvent.h

  tax

The tax amount of the order.

@property (nonatomic, assign) double tax

Declared In

BVTransactionEvent.h

  shipping

The shipping cost of the order.

@property (nonatomic, assign) double shipping

Declared In

BVTransactionEvent.h

  city

The user’s city

@property (nullable, nonatomic, strong) NSString *city

Declared In

BVTransactionEvent.h

  state

The user’s state

@property (nullable, nonatomic, strong) NSString *state

Declared In

BVTransactionEvent.h

  country

The user’s country

@property (nullable, nonatomic, strong) NSString *country

Declared In

BVTransactionEvent.h

  currency

The currency used of the order. ISO 4217 alphabetic currency code.

@property (nullable, nonatomic, strong) NSString *currency

Declared In

BVTransactionEvent.h