BVImpressionEvent Class Reference
Inherits from | NSObject |
---|---|
Conforms to | BVAnalyticEvent |
Declared in | BVImpressionEvent.h |
– initWithProductId:withContentId:withCategoryId:withProductType:withContentType:withBrand:withAdditionalParams:
Required - Product external ID
- (nonnull id)initWithProductId:(nonnull NSString *)productId withContentId:(nonnull NSString *)contentId withCategoryId:(nullable NSString *)categoryId withProductType:(BVPixelProductType)bvProduct withContentType:(BVPixelImpressionContentType)contentType withBrand:(nullable NSString *)brand withAdditionalParams:(nullable NSDictionary *)params
Parameters
productId |
Required - Product external ID |
---|---|
contentId |
Required - The identifier for the unique piece of user-generated content |
categoryId |
Optional - Id of the CGC content |
bvProduct |
Required - The product with API key being used. |
contentType |
Required - The type of content being requested by the API call. |
brand |
Optional - Brand name of what the content (review, question, etc) is about. |
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
BVImpressionEvent.h
productId
The product Id for product presented.
@property (nonnull, nonatomic, strong, readonly) NSString *productId
Declared In
BVImpressionEvent.h
contentId
The identifier for the unique piece of user-generated content
@property (nonnull, nonatomic, strong, readonly) NSString *contentId
Declared In
BVImpressionEvent.h
bvProduct
The BV API used to request the product, as defined in the BVPixelProductType.
@property (nonatomic, assign, readonly) BVPixelProductType bvProduct
Declared In
BVImpressionEvent.h
categoryId
The category Id, if known, for the product presented.
@property (nullable, nonatomic, strong, readonly) NSString *categoryId
Declared In
BVImpressionEvent.h
brand
Brand name for the product being viewed.
@property (nullable, nonatomic, strong, readonly) NSString *brand
Declared In
BVImpressionEvent.h
contentType
The individual piece of content viewed
@property (nonatomic, assign, readonly) BVPixelImpressionContentType contentType
Declared In
BVImpressionEvent.h