UnityEngine.UnityAnalyticsModule.xml 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.UnityAnalyticsModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Analytics.Analytics">
  8. <summary>
  9. <para>Unity Analytics provides insight into your game users e.g. DAU, MAU.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.Analytics.Analytics.deviceStatsEnabled">
  13. <summary>
  14. <para>Controls whether the sending of device stats at runtime is enabled.</para>
  15. </summary>
  16. </member>
  17. <member name="P:UnityEngine.Analytics.Analytics.enabled">
  18. <summary>
  19. <para>Controls whether the Analytics service is enabled at runtime.</para>
  20. </summary>
  21. </member>
  22. <member name="P:UnityEngine.Analytics.Analytics.limitUserTracking">
  23. <summary>
  24. <para>Controls whether to limit user tracking at runtime.</para>
  25. </summary>
  26. </member>
  27. <member name="M:UnityEngine.Analytics.Analytics.CustomEvent(System.String,System.Collections.Generic.IDictionary`2&lt;System.String,System.Object&gt;)">
  28. <summary>
  29. <para>Custom Events (optional).</para>
  30. </summary>
  31. <param name="customEventName">Name of custom event. Name cannot include the prefix "unity." - This is a reserved keyword.</param>
  32. <param name="eventData">Additional parameters sent to Unity Analytics at the time the custom event was triggered. Dictionary key cannot include the prefix "unity." - This is a reserved keyword.</param>
  33. </member>
  34. <member name="M:UnityEngine.Analytics.Analytics.CustomEvent(System.String)">
  35. <summary>
  36. <para>Custom Events (optional).</para>
  37. </summary>
  38. <param name="customEventName"></param>
  39. </member>
  40. <member name="M:UnityEngine.Analytics.Analytics.CustomEvent(System.String,UnityEngine.Vector3)">
  41. <summary>
  42. <para>Custom Events (optional).</para>
  43. </summary>
  44. <param name="customEventName"></param>
  45. <param name="position"></param>
  46. </member>
  47. <member name="M:UnityEngine.Analytics.Analytics.FlushEvents">
  48. <summary>
  49. <para>Attempts to flush immediately all queued analytics events to the network and filesystem cache if possible (optional).</para>
  50. </summary>
  51. </member>
  52. <member name="M:UnityEngine.Analytics.Analytics.RegisterEvent(System.String,System.Int32,System.Int32,System.String,System.String)">
  53. <summary>
  54. <para>This API is used for registering a Runtime Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API.</para>
  55. </summary>
  56. <param name="eventName">Name of the event.</param>
  57. <param name="maxEventPerHour">Hourly limit for this event name.</param>
  58. <param name="maxItems">Maximum number of items in this event.</param>
  59. <param name="vendorKey">Vendor key name.</param>
  60. <param name="prefix">Optional event name prefix value.</param>
  61. <param name="ver">Event version number.</param>
  62. </member>
  63. <member name="M:UnityEngine.Analytics.Analytics.RegisterEvent(System.String,System.Int32,System.Int32,System.String,System.Int32,System.String)">
  64. <summary>
  65. <para>This API is used for registering a Runtime Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API.</para>
  66. </summary>
  67. <param name="eventName">Name of the event.</param>
  68. <param name="maxEventPerHour">Hourly limit for this event name.</param>
  69. <param name="maxItems">Maximum number of items in this event.</param>
  70. <param name="vendorKey">Vendor key name.</param>
  71. <param name="prefix">Optional event name prefix value.</param>
  72. <param name="ver">Event version number.</param>
  73. </member>
  74. <member name="M:UnityEngine.Analytics.Analytics.SendEvent(System.String,System.Object,System.Int32,System.String)">
  75. <summary>
  76. <para>This API is used to send a Runtime Analytics event. It is meant for internal use only and is likely to change in the future. User code should never use this API.</para>
  77. </summary>
  78. <param name="eventName">Name of the event.</param>
  79. <param name="ver">Event version number.</param>
  80. <param name="prefix">Optional event name prefix value.</param>
  81. <param name="parameters">Additional event data.</param>
  82. </member>
  83. <member name="M:UnityEngine.Analytics.Analytics.SetUserBirthYear(System.Int32)">
  84. <summary>
  85. <para>User Demographics (optional).</para>
  86. </summary>
  87. <param name="birthYear">Birth year of user. Must be 4-digit year format, only.</param>
  88. </member>
  89. <member name="M:UnityEngine.Analytics.Analytics.SetUserGender(UnityEngine.Analytics.Gender)">
  90. <summary>
  91. <para>User Demographics (optional).</para>
  92. </summary>
  93. <param name="gender">Gender of user can be "Female", "Male", or "Unknown".</param>
  94. </member>
  95. <member name="M:UnityEngine.Analytics.Analytics.SetUserId(System.String)">
  96. <summary>
  97. <para>User Demographics (optional).</para>
  98. </summary>
  99. <param name="userId">User id.</param>
  100. </member>
  101. <member name="M:UnityEngine.Analytics.Analytics.Transaction(System.String,System.Decimal,System.String)">
  102. <summary>
  103. <para>Tracking Monetization (optional).</para>
  104. </summary>
  105. <param name="productId">The id of the purchased item.</param>
  106. <param name="amount">The price of the item.</param>
  107. <param name="currency">Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations.</param>
  108. <param name="receiptPurchaseData">Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts.</param>
  109. <param name="signature">Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature.</param>
  110. <param name="usingIAPService">Set to true when using UnityIAP.</param>
  111. </member>
  112. <member name="M:UnityEngine.Analytics.Analytics.Transaction(System.String,System.Decimal,System.String,System.String,System.String)">
  113. <summary>
  114. <para>Tracking Monetization (optional).</para>
  115. </summary>
  116. <param name="productId">The id of the purchased item.</param>
  117. <param name="amount">The price of the item.</param>
  118. <param name="currency">Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations.</param>
  119. <param name="receiptPurchaseData">Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts.</param>
  120. <param name="signature">Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature.</param>
  121. <param name="usingIAPService">Set to true when using UnityIAP.</param>
  122. </member>
  123. <member name="M:UnityEngine.Analytics.Analytics.Transaction(System.String,System.Decimal,System.String,System.String,System.String,System.Boolean)">
  124. <summary>
  125. <para>Tracking Monetization (optional).</para>
  126. </summary>
  127. <param name="productId">The id of the purchased item.</param>
  128. <param name="amount">The price of the item.</param>
  129. <param name="currency">Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations.</param>
  130. <param name="receiptPurchaseData">Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts.</param>
  131. <param name="signature">Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature.</param>
  132. <param name="usingIAPService">Set to true when using UnityIAP.</param>
  133. </member>
  134. <member name="T:UnityEngine.Analytics.AnalyticsResult">
  135. <summary>
  136. <para>Analytics API result.</para>
  137. </summary>
  138. </member>
  139. <member name="F:UnityEngine.Analytics.AnalyticsResult.AnalyticsDisabled">
  140. <summary>
  141. <para>Analytics API result: Analytics is disabled.</para>
  142. </summary>
  143. </member>
  144. <member name="F:UnityEngine.Analytics.AnalyticsResult.InvalidData">
  145. <summary>
  146. <para>Analytics API result: Invalid argument value.</para>
  147. </summary>
  148. </member>
  149. <member name="F:UnityEngine.Analytics.AnalyticsResult.NotInitialized">
  150. <summary>
  151. <para>Analytics API result: Analytics not initialized.</para>
  152. </summary>
  153. </member>
  154. <member name="F:UnityEngine.Analytics.AnalyticsResult.Ok">
  155. <summary>
  156. <para>Analytics API result: Success.</para>
  157. </summary>
  158. </member>
  159. <member name="F:UnityEngine.Analytics.AnalyticsResult.SizeLimitReached">
  160. <summary>
  161. <para>Analytics API result: Argument size limit.</para>
  162. </summary>
  163. </member>
  164. <member name="F:UnityEngine.Analytics.AnalyticsResult.TooManyItems">
  165. <summary>
  166. <para>Analytics API result: Too many parameters.</para>
  167. </summary>
  168. </member>
  169. <member name="F:UnityEngine.Analytics.AnalyticsResult.TooManyRequests">
  170. <summary>
  171. <para>Analytics API result: Too many requests.</para>
  172. </summary>
  173. </member>
  174. <member name="F:UnityEngine.Analytics.AnalyticsResult.UnsupportedPlatform">
  175. <summary>
  176. <para>Analytics API result: This platform doesn't support Analytics.</para>
  177. </summary>
  178. </member>
  179. <member name="T:UnityEngine.Analytics.AnalyticsSessionInfo">
  180. <summary>
  181. <para>Accesses for Analytics session information (common for all game instances).</para>
  182. </summary>
  183. </member>
  184. <member name="P:UnityEngine.Analytics.AnalyticsSessionInfo.sessionElapsedTime">
  185. <summary>
  186. <para>Session time since the begining of player game session.</para>
  187. </summary>
  188. </member>
  189. <member name="P:UnityEngine.Analytics.AnalyticsSessionInfo.sessionId">
  190. <summary>
  191. <para>Session id is used for tracking player game session.</para>
  192. </summary>
  193. </member>
  194. <member name="P:UnityEngine.Analytics.AnalyticsSessionInfo.sessionState">
  195. <summary>
  196. <para>Session state.</para>
  197. </summary>
  198. </member>
  199. <member name="?:UnityEngine.Analytics.AnalyticsSessionInfo.sessionStateChanged(UnityEngine.Analytics.AnalyticsSessionInfo/SessionStateChanged)">
  200. <summary>
  201. <para>This event occurs when a Analytics session state changes.</para>
  202. </summary>
  203. <param name="value"></param>
  204. </member>
  205. <member name="P:UnityEngine.Analytics.AnalyticsSessionInfo.userId">
  206. <summary>
  207. <para>UserId is random GUID to track a player and is persisted across game session.</para>
  208. </summary>
  209. </member>
  210. <member name="T:UnityEngine.Analytics.AnalyticsSessionInfo.SessionStateChanged">
  211. <summary>
  212. <para>This event occurs when a Analytics session state changes.</para>
  213. </summary>
  214. <param name="sessionState">Current session state.</param>
  215. <param name="sessionId">Current session id.</param>
  216. <param name="sessionElapsedTime">Game player current session time.</param>
  217. <param name="sessionChanged">Set to true when sessionId has changed.</param>
  218. </member>
  219. <member name="T:UnityEngine.Analytics.AnalyticsSessionState">
  220. <summary>
  221. <para>Session tracking states.</para>
  222. </summary>
  223. </member>
  224. <member name="F:UnityEngine.Analytics.AnalyticsSessionState.kSessionPaused">
  225. <summary>
  226. <para>Session tracking has paused.</para>
  227. </summary>
  228. </member>
  229. <member name="F:UnityEngine.Analytics.AnalyticsSessionState.kSessionResumed">
  230. <summary>
  231. <para>Session tracking has resumed.</para>
  232. </summary>
  233. </member>
  234. <member name="F:UnityEngine.Analytics.AnalyticsSessionState.kSessionStarted">
  235. <summary>
  236. <para>Session tracking has started.</para>
  237. </summary>
  238. </member>
  239. <member name="F:UnityEngine.Analytics.AnalyticsSessionState.kSessionStopped">
  240. <summary>
  241. <para>Session tracking has stopped.</para>
  242. </summary>
  243. </member>
  244. <member name="T:UnityEngine.Analytics.Gender">
  245. <summary>
  246. <para>User Demographics: Gender of a user.</para>
  247. </summary>
  248. </member>
  249. <member name="F:UnityEngine.Analytics.Gender.Female">
  250. <summary>
  251. <para>User Demographics: Female Gender of a user.</para>
  252. </summary>
  253. </member>
  254. <member name="F:UnityEngine.Analytics.Gender.Male">
  255. <summary>
  256. <para>User Demographics: Male Gender of a user.</para>
  257. </summary>
  258. </member>
  259. <member name="F:UnityEngine.Analytics.Gender.Unknown">
  260. <summary>
  261. <para>User Demographics: Unknown Gender of a user.</para>
  262. </summary>
  263. </member>
  264. <member name="T:UnityEngine.RemoteSettings">
  265. <summary>
  266. <para>Provides access to your remote settings.</para>
  267. </summary>
  268. </member>
  269. <member name="?:UnityEngine.RemoteSettings.BeforeFetchFromServer(System.Action)">
  270. <summary>
  271. <para>Dispatched before the RemoteSettings object makes the network request for the latest settings.</para>
  272. </summary>
  273. <param name="value"></param>
  274. </member>
  275. <member name="?:UnityEngine.RemoteSettings.Completed(System.Action`3&lt;System.Boolean,System.Boolean,System.Int32&gt;)">
  276. <summary>
  277. <para>Dispatched when the network request made by the RemoteSettings object to fetch the remote configuration file is complete.</para>
  278. </summary>
  279. <param name="value"></param>
  280. </member>
  281. <member name="M:UnityEngine.RemoteSettings.ForceUpdate">
  282. <summary>
  283. <para>Forces the game to download the newest settings from the server and update its values.</para>
  284. </summary>
  285. </member>
  286. <member name="M:UnityEngine.RemoteSettings.GetBool(System.String)">
  287. <summary>
  288. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  289. </summary>
  290. <param name="key">The key identifying the setting.</param>
  291. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  292. <returns>
  293. <para>The current value of the setting identified by key, or the default value.</para>
  294. </returns>
  295. </member>
  296. <member name="M:UnityEngine.RemoteSettings.GetBool(System.String,System.Boolean)">
  297. <summary>
  298. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  299. </summary>
  300. <param name="key">The key identifying the setting.</param>
  301. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  302. <returns>
  303. <para>The current value of the setting identified by key, or the default value.</para>
  304. </returns>
  305. </member>
  306. <member name="M:UnityEngine.RemoteSettings.GetCount">
  307. <summary>
  308. <para>Gets the number of keys in the remote settings configuration.</para>
  309. </summary>
  310. </member>
  311. <member name="M:UnityEngine.RemoteSettings.GetFloat(System.String)">
  312. <summary>
  313. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  314. </summary>
  315. <param name="key">The key identifying the setting.</param>
  316. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  317. <returns>
  318. <para>The current value of the setting identified by key, or the default value.</para>
  319. </returns>
  320. </member>
  321. <member name="M:UnityEngine.RemoteSettings.GetFloat(System.String,System.Single)">
  322. <summary>
  323. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  324. </summary>
  325. <param name="key">The key identifying the setting.</param>
  326. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  327. <returns>
  328. <para>The current value of the setting identified by key, or the default value.</para>
  329. </returns>
  330. </member>
  331. <member name="M:UnityEngine.RemoteSettings.GetInt(System.String)">
  332. <summary>
  333. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  334. </summary>
  335. <param name="key">The key identifying the setting.</param>
  336. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  337. <returns>
  338. <para>The current value of the setting identified by key, or the default value.</para>
  339. </returns>
  340. </member>
  341. <member name="M:UnityEngine.RemoteSettings.GetInt(System.String,System.Int32)">
  342. <summary>
  343. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  344. </summary>
  345. <param name="key">The key identifying the setting.</param>
  346. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  347. <returns>
  348. <para>The current value of the setting identified by key, or the default value.</para>
  349. </returns>
  350. </member>
  351. <member name="M:UnityEngine.RemoteSettings.GetKeys">
  352. <summary>
  353. <para>Gets an array containing all the keys in the remote settings configuration.</para>
  354. </summary>
  355. </member>
  356. <member name="M:UnityEngine.RemoteSettings.GetLong(System.String,System.Int64)">
  357. <summary>
  358. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  359. </summary>
  360. <param name="key">The key identifying the setting.</param>
  361. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  362. <returns>
  363. <para>The current value of the setting identified by key, or the default value.</para>
  364. </returns>
  365. </member>
  366. <member name="M:UnityEngine.RemoteSettings.GetString(System.String)">
  367. <summary>
  368. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  369. </summary>
  370. <param name="key">The key identifying the setting.</param>
  371. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  372. <returns>
  373. <para>The current value of the setting identified by key, or the default value.</para>
  374. </returns>
  375. </member>
  376. <member name="M:UnityEngine.RemoteSettings.GetString(System.String,System.String)">
  377. <summary>
  378. <para>Gets the value corresponding to remote setting identified by key, if it exists.</para>
  379. </summary>
  380. <param name="key">The key identifying the setting.</param>
  381. <param name="defaultValue">The default value to use if the setting identified by the key parameter cannot be found or is unavailable.</param>
  382. <returns>
  383. <para>The current value of the setting identified by key, or the default value.</para>
  384. </returns>
  385. </member>
  386. <member name="M:UnityEngine.RemoteSettings.HasKey(System.String)">
  387. <summary>
  388. <para>Reports whether the specified key exists in the remote settings configuration.</para>
  389. </summary>
  390. <param name="key">The key identifying the setting.</param>
  391. <returns>
  392. <para>True, if the key exists.</para>
  393. </returns>
  394. </member>
  395. <member name="?:UnityEngine.RemoteSettings.Updated(UnityEngine.RemoteSettings/UpdatedEventHandler)">
  396. <summary>
  397. <para>Dispatched when a remote settings configuration is fetched and successfully parsed from the server or from local cache.</para>
  398. </summary>
  399. <param name="value"></param>
  400. </member>
  401. <member name="T:UnityEngine.RemoteSettings.UpdatedEventHandler">
  402. <summary>
  403. <para>Defines the delegate signature for handling RemoteSettings.Updated events.</para>
  404. </summary>
  405. </member>
  406. <member name="M:UnityEngine.RemoteSettings.WasLastUpdatedFromServer">
  407. <summary>
  408. <para>Reports whether or not the settings available from the RemoteSettings object were received from the Analytics Service during the current session.</para>
  409. </summary>
  410. <returns>
  411. <para>True, if the remote settings file was received from the Analytics Service in the current session. False, if the remote settings file was received during an earlier session and cached.</para>
  412. </returns>
  413. </member>
  414. <member name="A:UnityEngine.UnityAnalyticsModule">
  415. <summary>
  416. <para>The UnityAnalytics module implements APIs required to use Unity Analytics.</para>
  417. </summary>
  418. </member>
  419. </members>
  420. </doc>