BVViewedCGCEvent Class Reference
Inherits from | NSObject |
---|---|
Conforms to | BVAnalyticEvent |
Declared in | BVViewedCGCEvent.h |
Overview
BVViewedCGCEvent should be used to indicate that UGC (User Generated Content) is visible on the screen and has been in the view for an designated amount of time. This event should only be fired once per lifetime of a ViewController. This differs from a BVInView event in that a delay should be provided (typically 5 seconds) to know that content is visible and readable on the screen.
– initWithProductId:withRootCategoryID:withCategoryId:withProductType:withBrand:withAdditionalParams:
Used to create an event to indicate that CGC is visible on the screen and has been in the view for an designated amount of time. This event should only be fired once per lifetime of a ViewController.
- (nonnull id)initWithProductId:(nonnull NSString *)productId withRootCategoryID:(nullable NSString *)rootCategoryId withCategoryId:(nullable NSString *)categoryId withProductType:(BVPixelProductType)bvProduct withBrand:(nullable NSString *)brand withAdditionalParams:(nullable NSDictionary *)params
Parameters
productId |
Required - The product Id for which the UGC is assoicated. |
---|---|
rootCategoryId |
Optional - This value should be obtained from the product feed. |
categoryId |
Optional - This value should be obtained from the product feed. |
bvProduct |
Reuired - The product with API key being used. |
brand |
Optional - The brand name of the product. |
params |
Optional - Additional key/value pairs to be send along the request. Most cases this will be nil. |
Return Value
The event object that can be used to submit to Bazaarvoice via the BVPixel API.
Declared In
BVViewedCGCEvent.h
productId
The product Id for product presented.
@property (nonnull, nonatomic, strong, readonly) NSString *productId
Declared In
BVViewedCGCEvent.h
bvProduct
The BV API used to request the product, as defined in the BVPixelProductType.
@property (nonatomic, assign, readonly) BVPixelProductType bvProduct
Declared In
BVViewedCGCEvent.h
categoryId
The category Id, if known, for the product presented.
@property (nullable, nonatomic, strong, readonly) NSString *categoryId
Declared In
BVViewedCGCEvent.h
rootCategoryId
The root category Id, if known, for the product presented.
@property (nullable, nonatomic, strong, readonly) NSString *rootCategoryId
Declared In
BVViewedCGCEvent.h
brand
Brand name for the product being viewed.
@property (nullable, nonatomic, strong, readonly) NSString *brand
Declared In
BVViewedCGCEvent.h