HIVE_Analytics.h

Go to the documentation of this file.

 
#ifndef __HIVE_ANALYTICS_H__
#define  __HIVE_ANALYTICS_H__
 
 
#include "HIVE_ResultAPI.h"
#include <map>
 
NS_HIVE_BEGIN
 
class AnalyticsAdRevenue;
class ConsentStatus;
class ConsentForm;
class ConsentMode;
class AnalyticsAttributes;
class IAnalyticsSpecific;
class AirbridgeSpecific;
 
#define HIVE_SDK_ANALYTICS_CONSENT_TYPE_AD_STORAGE "ad_storage"
#define HIVE_SDK_ANALYTICS_CONSENT_TYPE_AD_USER_DATA "ad_user_data"
#define HIVE_SDK_ANALYTICS_CONSENT_TYPE_AD_PERSONALIZATION "ad_personalization"
#define HIVE_SDK_ANALYTICS_CONSENT_TYPE_ANALYTICS_STORAGE "analytics_storage"
#define HIVE_SDK_ANALYTICS_CONSENT_GRANTED "granted"
#define HIVE_SDK_ANALYTICS_CONSENT_DENIED "denied"
 
class HIVESDK_DLLEXPORT Analytics
{
public:
 
    enum class TrackingType
    {
        ADJUST
        , SINGULAR
        , APPSFLYER
        , UNKNOWN
    };
 
    typedef std::function<void(ResultAPI const & result, std::vector<ConsentStatus> const & consentStatus)> onShowConsentMode;
 
    static bool sendAnalyticsLog(picojson::object & logData);
 
 
    static void setEnableTracker(TrackingType trackingType, bool isEnable);
 
 
    static void setEnableTrackerWithName(std::string name, bool isEnable);
    
 
 
    static void sendEvent(std::string eventName);
    
    static void sendEventWithAttributes(std::string eventName, AnalyticsAttributes const& attributes);
 
    static void sendAdRevenueEvent(AnalyticsAdRevenue analyticsAdRevenue);
    
    static unsigned int getRemainAnalyticsLogCount();
    
    
    static void sendUserEntryFunnelsLogs(std::string funnelTrack, std::string optionTag);
    
    static void setConsent(std::string providerName, std::map<std::string, std::string> settings);
    
    static std::map<std::string, std::string> getConsent(std::string providerName);
    
    static void showConsentModeIfRequire(bool checkCmp, ConsentMode* consentMode, onShowConsentMode listener);
        
    static void showConsentMode(ConsentMode* consentMode, onShowConsentMode listener);
 
 
    // Native 영역에서 호출된 요청을 처리하기 위한 플러그인 내부 코드
    static void executeEngine(picojson::value jsonParam);
};
 
class HIVESDK_DLLEXPORT AnalyticsAdRevenue
{
public:
 
    double revenue;             
 
    std::string adPlatform;     
 
    std::string adUnitId;       
 
    std::string adType;         
 
    std::string adPlacement;    
 
    std::string currency;       
 
    AnalyticsAdRevenue();
 
    AnalyticsAdRevenue(double revenue, std::string adPlatform, std::string adUnitId, std::string adType, std::string adPlacement, std::string currency);
 
    AnalyticsAdRevenue(picojson::value jsonParam);
 
    picojson::object toJson() const;
 
    std::string toString() const;
};
 
class HIVESDK_DLLEXPORT ConsentStatus {
public:
    std::string providerName;                   
    std::string consentForDataUsage;            
    std::string consentForPersonalization;      
    long consentDate;                           
    long expiredDate;                           
    
    ConsentStatus();
    ConsentStatus(picojson::value jsonParam);
    
    picojson::object toJson() const;
    std::string toString() const;
};
 
class HIVESDK_DLLEXPORT ConsentForm {
public:
    std::string providerName;                   
    int retentionPeriod;                        
    std::string dataUsageTitle;                 
    std::string dataUsageDescription;           
    std::string personalizationTitle;           
    std::string personalizationDescription;     
    
    ConsentForm();
    ConsentForm(picojson::value jsonParam);
    
    picojson::object toJson() const;
    std::string toString() const;
};
 
class HIVESDK_DLLEXPORT ConsentMode {
public:
    std::string title;                          
    std::string companyName;                    
    std::string privacyPolicy;                  
    ConsentForm* mainForm;                       
    std::vector<ConsentForm> formList;          
    
    ConsentMode();
    ~ConsentMode();
    ConsentMode(picojson::value jsonParam);
    
    picojson::object toJson() const;
    std::string toString() const;
};
 
class HIVESDK_DLLEXPORT AnalyticsAttributes
{
public:
    picojson::object customAttributes;
    picojson::object moduleSpecificAttributes;
    
    AnalyticsAttributes();
 
    void addCustomAttribute(const std::string& key, const picojson::value& value);
    void addModuleSpecificAttribute(const IAnalyticsSpecific& specific);
 
    virtual picojson::object toJson() const;
    virtual std::string toString() const;
    
    virtual ~AnalyticsAttributes() = default; // 가상 소멸자
};
 
class HIVESDK_DLLEXPORT IAnalyticsSpecific
{
public:
    std::string providerName;
    
    IAnalyticsSpecific();
    
    virtual picojson::object toJson() const;
    virtual std::string toString() const;
    
    virtual ~IAnalyticsSpecific() = default; // 가상 소멸자
};
 
class HIVESDK_DLLEXPORT AirbridgeSpecific : public IAnalyticsSpecific
{
public:
    picojson::object semanticAttributes;
 
    AirbridgeSpecific();
 
    void setSemanticAction(const std::string& value);
    void setSemanticLabel(const std::string& value);
    void setSemanticValue(const double value);
    void addSemanticAttribute(const std::string& key, const picojson::value& value);
    picojson::object toJson() const override; // 부모 메서드 재정의
    std::string toString() const override;    // 부모 메서드 재정의
};
 
NS_HIVE_END        // namespace hive
 
#endif      // __HIVE_ANALYTICS_H__