CISAdAnalyticsProtocol

@protocol CISAdAnalyticsProtocol <CISStreamAnalyticsProtocol>

/**
* Sets ad info.
* @param adInfo ad related info.
*/
- (void) setAdInfo:(NSDictionary*)adInfo;

/**
* Sets Ad PlayerInfo.
* @param adPlayerInfo ad player info.
*/
- (void) setAdPlayerInfo:(NSDictionary*)adPlayerInfo;

/**
* Reports ad failure.
* @param errorMessage error message.
* @param adInfo ad related info.
*/
- (void) reportAdFailed:(NSString*)errorMessage adInfo:(nullable NSDictionary*)adInfo;

/**
* Reports ad load event.
* @param adInfo ad related info.
*/
- (void) reportAdLoaded:(nullable NSDictionary*)adInfo;

/**
* Reports ad start event.
* @param adInfo ad related info.
*/
- (void) reportAdStarted:(nullable NSDictionary*)adInfo;

/**
* Reports ad end event.
*/
- (void) reportAdEnded;

/**
* Reports ad error event.
* @param errorMessage Error message.
* @param severity Severity of the error.
*/
- (void) reportAdError:(NSString*)errorMessage severity:(ErrorSeverity)severity;

/**
* Reports ad skip event.
*/
- (void) reportAdSkipped;

/**
* Reports ad player event.
* @param eventType Event type.
* @param details Event details.
*/
- (void) reportAdPlayerEvent:(NSString*)eventType details:(nullable NSDictionary*)details;

/**
* Reports ad metirc.
* @param key Metric key.
* @param value Metric value.
*/
- (void) reportAdMetric:(NSString*)key value:(id)value;

/**
* Used to set content session id.If already customer integrated EI using legacy api and wanted to integrate AI or other products using this sdk shall use this.
* @param sessionID Video playback session id.
*/
- (void) setContentSessionID:(int)sessionID;

@end

Undocumented

  • Sets ad info.

    Declaration

    Objective-C

    - (void)setAdInfo:(nonnull NSDictionary *)adInfo;

    Swift

    func setAdInfo(_ adInfo: [AnyHashable : Any])

    Parameters

    adInfo

    ad related info.

  • Sets Ad PlayerInfo.

    Declaration

    Objective-C

    - (void)setAdPlayerInfo:(nonnull NSDictionary *)adPlayerInfo;

    Swift

    func setAdPlayerInfo(_ adPlayerInfo: [AnyHashable : Any])

    Parameters

    adPlayerInfo

    ad player info.

  • Reports ad failure.

    Declaration

    Objective-C

    - (void)reportAdFailed:(nonnull NSString *)errorMessage
                adInfo:(nullable NSDictionary *)adInfo;

    Swift

    func reportAdFailed(_ errorMessage: String, adInfo: [AnyHashable : Any]?)

    Parameters

    errorMessage

    error message.
    adInfo

    ad related info.

  • Reports ad load event.

    Declaration

    Objective-C

    - (void)reportAdLoaded:(nullable NSDictionary *)adInfo;

    Swift

    func reportAdLoaded(_ adInfo: [AnyHashable : Any]?)

    Parameters

    adInfo

    ad related info.

  • Reports ad start event.

    Declaration

    Objective-C

    - (void)reportAdStarted:(nullable NSDictionary *)adInfo;

    Swift

    func reportAdStarted(_ adInfo: [AnyHashable : Any]?)

    Parameters

    adInfo

    ad related info.

  • Reports ad end event.

    Declaration

    Objective-C

    - (void)reportAdEnded;

    Swift

    func reportAdEnded()

  • Reports ad error event.

    Declaration

    Objective-C

    - (void)reportAdError:(nonnull NSString *)errorMessage
             severity:(ErrorSeverity)severity;

    Swift

    func reportAdError(_ errorMessage: String, severity: ErrorSeverity)

    Parameters

    errorMessage

    Error message.
    severity

    Severity of the error.

  • Reports ad skip event.

    Declaration

    Objective-C

    - (void)reportAdSkipped;

    Swift

    func reportAdSkipped()

  • Reports ad player event.

    Declaration

    Objective-C

    - (void)reportAdPlayerEvent:(nonnull NSString *)eventType
                    details:(nullable NSDictionary *)details;

    Swift

    func reportAdPlayerEvent(_ eventType: String, details: [AnyHashable : Any]?)

    Parameters

    eventType

    Event type.
    details

    Event details.

  • Reports ad metirc.

    Declaration

    Objective-C

    - (void)reportAdMetric:(nonnull NSString *)key value:(nonnull id)value;

    Swift

    func reportAdMetric(_ key: String, value: Any)

    Parameters

    key

    Metric key.
    value

    Metric value.

  • Used to set content session id.If already customer integrated EI using legacy api and wanted to integrate AI or other products using this sdk shall use this.

    Declaration

    Objective-C

    - (void)setContentSessionID:(int)sessionID;

    Swift

    func setContentSessionID(_ sessionID: Int32)

    Parameters

    sessionID

    Video playback session id.