GravityAnalyticsSDK.d.ts 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. declare class GravityAnalyticsAPI {
  2. constructor(config: any);
  3. setupAndStart(options?: { clientId?: string; openId?: string }): void;
  4. track(eventName: string): void;
  5. preInit(): void;
  6. track(eventName: string, properties: any): void;
  7. track(eventName: string, properties: any, time: any): void;
  8. track(eventName: string, properties: any, time: any, onComplete: any): void;
  9. track(taEvent: any): void;
  10. timeEvent(eventName: string): void;
  11. login(accoundId: string): void;
  12. logout(): void;
  13. setSuperProperties(properties: any): void;
  14. unsetSuperProperty(properties: any): void;
  15. clearSuperProperties(): void;
  16. getSuperProperties(): any;
  17. getSendProperties(): any;
  18. registerEvent(): void;
  19. loginEvent(): void;
  20. logoutEvent(): void;
  21. payEvent(
  22. pay_amount: number,
  23. pay_type: string,
  24. order_id: string,
  25. pay_reason: string,
  26. pay_method: string
  27. ): void;
  28. payEventToTencent(pay_amount: number): void;
  29. tryPayEventDryRun(pay_amount: number): void;
  30. tryTutorialFinishEventDryRun(): void;
  31. tryRegisterEventDryRun(): void;
  32. tryCreateRoleEventDryRun(role_name: string): void;
  33. adShowEvent(ad_type: string, ad_unit_id: string, otherProperties: any): void;
  34. bindTAThirdPlatform(taAccountId: string, taDistinctId: string): void;
  35. initialize(data: any): any;
  36. initializeWithHistoryUserInfo(
  37. data: any,
  38. history_info: {
  39. company: string;
  40. create_time: number;
  41. }
  42. ): any;
  43. userSet(properties: any): void;
  44. userSetOnce(properties: any): void;
  45. userAppend(properties: any): void;
  46. userUniqAppend(properties: any): void;
  47. userAdd(properties: any): void;
  48. userUnset(property: string): void;
  49. userDel(): void;
  50. authorizeOpenID(distinctId: string): void;
  51. identify(distinctId: string): void;
  52. initInstance(name: string): GravityAnalyticsAPI;
  53. initInstance(name: string, config: any): GravityAnalyticsAPI;
  54. lightInstance(name: string): any;
  55. setDynamicSuperProperties(properties: any): void;
  56. getDeviceId(callback?: any): string;
  57. getDistinctId(callback?: any): string;
  58. getAccountId(callback?: any): string;
  59. getPresetProperties(callback?: any): any;
  60. getWechatOpenId(
  61. code: string
  62. ): Promise<{ session_key: string; openid: string; unionid: string }>;
  63. sendDryRunResult(
  64. traceId: string,
  65. action: string
  66. ): Promise<{
  67. extra: {
  68. error: string;
  69. };
  70. code: number;
  71. msg: string;
  72. }>;
  73. onPayEvent(
  74. pay_amount: number,
  75. pay_type: string,
  76. order_id: string,
  77. pay_reason: string,
  78. pay_method: string
  79. ): void;
  80. onRegisterEvent(): void;
  81. onCreateRoleEvent(role_name: string): void;
  82. onCreateRoleEventWithParams(role_name: string, params: any): void;
  83. onTutorialFinishEvent(): void;
  84. onTutorialFinishEventWithParams(params: any): void;
  85. onViewMallContentEvent(): void;
  86. onViewMallContentEventWithParams(params: any): void;
  87. onViewActivityContentEvent(): void;
  88. onViewActivityContentEventWithParams(params: any): void;
  89. onAddToWishListEvent(wishType: string): void;
  90. onAddToWishListEventWithParams(wishType: string, params: any): void;
  91. onShareEvent(shareType: "APP_MESSAGE" | "TIME_LINE"): void;
  92. onShareEventWithParams(
  93. shareType: "APP_MESSAGE" | "TIME_LINE",
  94. params: any
  95. ): void;
  96. onUpdateLevelEvent(userLevel: number, userPower: number): void;
  97. onUpdateLevelEventWithParams(
  98. userLevel: number,
  99. userPower: number,
  100. params: any
  101. ): void;
  102. getKuaishouOpenId(
  103. code: string
  104. ): Promise<{ session_key: string; openid: string; unionid: string }>;
  105. getDouyinOpenId(
  106. code: string
  107. ): Promise<{ session_key: string; openid: string; unionid: string }>;
  108. getBilibiliOpenId(
  109. code: string
  110. ): Promise<{ session_key: string; openid: string; unionid: string }>;
  111. /**
  112. * 暂停/开启上报
  113. * @param {bool} enabled YES:开启上报 NO:暂停上报
  114. * @deprecated This method is deprecated, use setTrackStatus() instand.
  115. */
  116. enableTracking(enabled: boolean): void;
  117. /**
  118. * 停止上报,后续的上报和设置都无效,数据将清空
  119. * @deprecated This method is deprecated, use setTrackStatus() instand.
  120. */
  121. optOutTracking(): void;
  122. /**
  123. * 停止上报,后续的上报和设置都无效,数据将清空,并且发送 user_del
  124. * @deprecated This method is deprecated, use setTrackStatus() instand.
  125. */
  126. optOutTrackingAndDeleteUser(): void;
  127. /**
  128. * 允许上报
  129. * @deprecated This method is deprecated, use setTrackStatus() instand.
  130. */
  131. optInTracking(): void;
  132. /**
  133. * 设置数据上报状态
  134. * PAUSE 暂停数据上报
  135. * STOP 停止数据上报,并清除缓存
  136. * SAVE_ONLY 数据入库,但不上报 (接入Native原生可支持,JS暂不支持此状态,默认等同 NORMAL)
  137. * NORMAL 恢复数据上报
  138. * @param {string} status 上报状态
  139. */
  140. setTrackStatus(status: string): void;
  141. }