UnityEngine.UnityAnalyticsModule.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  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.Gender">
  180. <summary>
  181. <para>User Demographics: Gender of a user.</para>
  182. </summary>
  183. </member>
  184. <member name="F:UnityEngine.Analytics.Gender.Female">
  185. <summary>
  186. <para>User Demographics: Female Gender of a user.</para>
  187. </summary>
  188. </member>
  189. <member name="F:UnityEngine.Analytics.Gender.Male">
  190. <summary>
  191. <para>User Demographics: Male Gender of a user.</para>
  192. </summary>
  193. </member>
  194. <member name="F:UnityEngine.Analytics.Gender.Unknown">
  195. <summary>
  196. <para>User Demographics: Unknown Gender of a user.</para>
  197. </summary>
  198. </member>
  199. </members>
  200. </doc>