@xmobitea/gn-typescript-client 2.6.9 → 2.6.10-tsc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/dist/index.js +337 -34162
  2. package/dist/runtime/GNNetwork.js +250 -0
  3. package/dist/runtime/GNNetworkAuthenticateApi.js +122 -0
  4. package/dist/runtime/GNNetworkCharacterPlayerApi.js +968 -0
  5. package/dist/runtime/GNNetworkCloudScriptApi.js +104 -0
  6. package/dist/runtime/GNNetworkContentApi.js +140 -0
  7. package/dist/runtime/GNNetworkDashboardApi.js +170 -0
  8. package/dist/runtime/GNNetworkGamePlayerApi.js +950 -0
  9. package/dist/runtime/GNNetworkGroupApi.js +734 -0
  10. package/dist/runtime/GNNetworkInventoryApi.js +626 -0
  11. package/dist/runtime/GNNetworkMasterPlayerApi.js +1550 -0
  12. package/dist/runtime/GNNetworkMultiplayerApi.js +194 -0
  13. package/dist/runtime/GNNetworkStoreInventoryApi.js +266 -0
  14. package/dist/runtime/common/Action0.js +1 -0
  15. package/dist/runtime/common/Action1.js +1 -0
  16. package/dist/runtime/common/Action2.js +1 -0
  17. package/dist/runtime/common/Action3.js +1 -0
  18. package/dist/runtime/common/Action4.js +1 -0
  19. package/dist/runtime/common/GNData.js +211 -0
  20. package/dist/runtime/config/GNServerSettings.d.ts +3 -0
  21. package/dist/runtime/config/GNServerSettings.js +156 -0
  22. package/dist/runtime/constant/Commands.d.ts +1 -0
  23. package/dist/runtime/constant/Commands.js +20 -0
  24. package/dist/runtime/constant/EventCode.js +8 -0
  25. package/dist/runtime/constant/OperationCode.js +221 -0
  26. package/dist/runtime/constant/ReturnCode.js +14 -0
  27. package/dist/runtime/constant/enumType/ExecuteResponseStatus.js +8 -0
  28. package/dist/runtime/constant/enumType/FriendStatus.js +7 -0
  29. package/dist/runtime/constant/enumType/GoogleLoginType.js +5 -0
  30. package/dist/runtime/constant/enumType/GroupStatus.js +7 -0
  31. package/dist/runtime/constant/enumType/InvalidMemberType.js +18 -0
  32. package/dist/runtime/constant/enumType/ItemType.js +5 -0
  33. package/dist/runtime/constant/enumType/MatchmakingMemberStatus.js +6 -0
  34. package/dist/runtime/constant/enumType/MatchmakingTicketStatus.js +8 -0
  35. package/dist/runtime/constant/enumType/OwnerType.js +9 -0
  36. package/dist/runtime/constant/enumType/PermissionDataItem.js +5 -0
  37. package/dist/runtime/constant/enumType/PushPlatformType.js +5 -0
  38. package/dist/runtime/constant/enumType/RequestRole.js +6 -0
  39. package/dist/runtime/constant/enumType/RequestType.js +15 -0
  40. package/dist/runtime/constant/enumType/StoreItemType.js +5 -0
  41. package/dist/runtime/constant/enumType/StoreReceiveType.js +8 -0
  42. package/dist/runtime/constant/errorCode/ErrorCode.js +52 -0
  43. package/dist/runtime/constant/parameterCode/ParameterCode.js +617 -0
  44. package/dist/runtime/entity/DataMember.js +208 -0
  45. package/dist/runtime/entity/GNMetadata.js +11 -0
  46. package/dist/runtime/entity/InvalidMember.js +1 -0
  47. package/dist/runtime/entity/OperationEvent.js +24 -0
  48. package/dist/runtime/entity/OperationHelper.js +24 -0
  49. package/dist/runtime/entity/OperationRequest.js +42 -0
  50. package/dist/runtime/entity/OperationResponse.js +73 -0
  51. package/dist/runtime/entity/models/AuthenticateModels.js +426 -0
  52. package/dist/runtime/entity/models/AuthenticateRequestModels.js +188 -0
  53. package/dist/runtime/entity/models/AuthenticateResponseModels.js +131 -0
  54. package/dist/runtime/entity/models/CharacterPlayerModels.js +1433 -0
  55. package/dist/runtime/entity/models/CharacterPlayerRequestModels.js +1386 -0
  56. package/dist/runtime/entity/models/CharacterPlayerResponseModels.js +376 -0
  57. package/dist/runtime/entity/models/CloudScriptModels.js +197 -0
  58. package/dist/runtime/entity/models/CloudScriptRequestModels.js +138 -0
  59. package/dist/runtime/entity/models/CloudScriptResponseModels.js +40 -0
  60. package/dist/runtime/entity/models/ContentModels.js +203 -0
  61. package/dist/runtime/entity/models/ContentRequestModels.js +190 -0
  62. package/dist/runtime/entity/models/ContentResponseModels.js +54 -0
  63. package/dist/runtime/entity/models/DashboardModels.js +3002 -0
  64. package/dist/runtime/entity/models/DashboardRequestModels.js +268 -0
  65. package/dist/runtime/entity/models/DashboardResponseModels.js +187 -0
  66. package/dist/runtime/entity/models/GamePlayerModels.js +1591 -0
  67. package/dist/runtime/entity/models/GamePlayerRequestModels.js +1360 -0
  68. package/dist/runtime/entity/models/GamePlayerResponseModels.js +369 -0
  69. package/dist/runtime/entity/models/GenericModels.js +177 -0
  70. package/dist/runtime/entity/models/GroupModels.js +1135 -0
  71. package/dist/runtime/entity/models/GroupRequestModels.js +1048 -0
  72. package/dist/runtime/entity/models/GroupResponseModels.js +285 -0
  73. package/dist/runtime/entity/models/InventoryModels.js +915 -0
  74. package/dist/runtime/entity/models/InventoryRequestModels.js +892 -0
  75. package/dist/runtime/entity/models/InventoryResponseModels.js +243 -0
  76. package/dist/runtime/entity/models/MasterPlayerModels.js +2573 -0
  77. package/dist/runtime/entity/models/MasterPlayerRequestModels.js +2228 -0
  78. package/dist/runtime/entity/models/MasterPlayerResponseModels.js +607 -0
  79. package/dist/runtime/entity/models/MultiplayerModels.js +404 -0
  80. package/dist/runtime/entity/models/MultiplayerRequestModels.js +268 -0
  81. package/dist/runtime/entity/models/MultiplayerResponseModels.js +75 -0
  82. package/dist/runtime/entity/models/StoreInventoryModels.js +797 -0
  83. package/dist/runtime/entity/models/StoreInventoryRequestModels.js +372 -0
  84. package/dist/runtime/entity/models/StoreInventoryResponseModels.js +103 -0
  85. package/dist/runtime/entity/request/CustomOperationRequest.js +24 -0
  86. package/dist/runtime/entity/response/CustomOperationResponse.js +29 -0
  87. package/dist/runtime/entity/response/GetAuthInfoResponse.js +2 -0
  88. package/dist/runtime/entity/response/UploadFileResponse.js +2 -0
  89. package/dist/runtime/helper/CodeHelper.js +63 -0
  90. package/dist/runtime/helper/ConverterService.js +275 -0
  91. package/dist/runtime/helper/EnumUtility.js +33 -0
  92. package/dist/runtime/helper/GNSupport.js +8 -0
  93. package/dist/runtime/helper/GNUtils.js +72 -0
  94. package/dist/runtime/helper/MessagePackConverterService.js +9 -0
  95. package/dist/runtime/logger/GNDebug.js +29 -0
  96. package/dist/runtime/networking/AuthenticateStatus.js +14 -0
  97. package/dist/runtime/networking/IPeer.js +1 -0
  98. package/dist/runtime/networking/NetworkingPeer.js +178 -0
  99. package/dist/runtime/networking/OperationPending.js +53 -0
  100. package/dist/runtime/networking/PeerBase.js +161 -0
  101. package/dist/runtime/networking/handler/IServerEventHandler.js +13 -0
  102. package/dist/runtime/networking/handler/OnCharacterPlayerFriendUpdateEventHandler.js +39 -0
  103. package/dist/runtime/networking/handler/OnCharacterPlayerGroupUpdateEventHandler.js +39 -0
  104. package/dist/runtime/networking/handler/OnGamePlayerFriendUpdateEventHandler.js +39 -0
  105. package/dist/runtime/networking/handler/OnGamePlayerGroupUpdateEventHandler.js +39 -0
  106. package/dist/runtime/networking/handler/OnGroupMemberUpdateEventHandler.js +35 -0
  107. package/dist/runtime/networking/handler/OnGroupMessageUpdateEventHandler.js +43 -0
  108. package/dist/runtime/networking/http/HttpPeer.js +123 -0
  109. package/dist/runtime/networking/http/NetworkingHttpPeerBase.d.ts +2 -0
  110. package/dist/runtime/networking/http/NetworkingHttpPeerBase.js +9 -0
  111. package/dist/runtime/networking/http/NetworkingPeerAxiosRequest.js +179 -0
  112. package/dist/runtime/networking/socket/NetworkingPeerSocketIOClient.js +130 -0
  113. package/dist/runtime/networking/socket/NetworkingSocketPeerBase.js +165 -0
  114. package/dist/runtime/networking/socket/SocketPeer.js +115 -0
  115. package/dist/runtime/typescript/ServiceUpdate.js +12 -0
  116. package/package.json +1 -1
  117. package/dist/gearn.js.client.js +0 -46884
  118. package/dist/gearn.js.client.min.js +0 -2
  119. package/dist/gearn.js.client.min.js.LICENSE.txt +0 -14
  120. package/responseModel/chatgpt/Authenticate.json +0 -724
  121. package/responseModel/chatgpt/CharacterPlayer.json +0 -1890
  122. package/responseModel/chatgpt/CloudScript.json +0 -254
  123. package/responseModel/chatgpt/Content.json +0 -273
  124. package/responseModel/chatgpt/Dashboard.json +0 -4110
  125. package/responseModel/chatgpt/GamePlayer.json +0 -2306
  126. package/responseModel/chatgpt/Generic.json +0 -253
  127. package/responseModel/chatgpt/Group.json +0 -1509
  128. package/responseModel/chatgpt/Inventory.json +0 -1211
  129. package/responseModel/chatgpt/MasterPlayer.json +0 -3801
  130. package/responseModel/chatgpt/Multiplayer.json +0 -634
  131. package/responseModel/chatgpt/StoreInventory.json +0 -1099
  132. package/responseModel/clients/AuthenticateModels.json +0 -271
  133. package/responseModel/clients/CharacterPlayerModels.json +0 -792
  134. package/responseModel/clients/CloudScriptModels.json +0 -191
  135. package/responseModel/clients/ContentModels.json +0 -178
  136. package/responseModel/clients/DashboardModels.json +0 -5423
  137. package/responseModel/clients/GamePlayerModels.json +0 -781
  138. package/responseModel/clients/GenericModels.json +0 -344
  139. package/responseModel/clients/GroupModels.json +0 -705
  140. package/responseModel/clients/InventoryModels.json +0 -568
  141. package/responseModel/clients/MasterPlayerModels.json +0 -1281
  142. package/responseModel/clients/MultiplayerModels.json +0 -439
  143. package/responseModel/clients/StoreInventoryModels.json +0 -971
  144. package/responseModel/finalChatgpt/Authenticate.json +0 -1475
  145. package/responseModel/finalChatgpt/CharacterPlayer.json +0 -4104
  146. package/responseModel/finalChatgpt/CloudScript.json +0 -515
  147. package/responseModel/finalChatgpt/Content.json +0 -536
  148. package/responseModel/finalChatgpt/Dashboard.json +0 -6712
  149. package/responseModel/finalChatgpt/GamePlayer.json +0 -5142
  150. package/responseModel/finalChatgpt/Generic.json +0 -333
  151. package/responseModel/finalChatgpt/Group.json +0 -3232
  152. package/responseModel/finalChatgpt/Inventory.json +0 -2606
  153. package/responseModel/finalChatgpt/MasterPlayer.json +0 -8385
  154. package/responseModel/finalChatgpt/Multiplayer.json +0 -1196
  155. package/responseModel/finalChatgpt/StoreInventory.json +0 -2085
  156. package/responseModel/finals/Authenticate.json +0 -1460
  157. package/responseModel/finals/CharacterPlayer.json +0 -3639
  158. package/responseModel/finals/CloudScript.json +0 -465
  159. package/responseModel/finals/Content.json +0 -479
  160. package/responseModel/finals/Dashboard.json +0 -6718
  161. package/responseModel/finals/GamePlayer.json +0 -4291
  162. package/responseModel/finals/Generic.json +0 -345
  163. package/responseModel/finals/Group.json +0 -2885
  164. package/responseModel/finals/Inventory.json +0 -2309
  165. package/responseModel/finals/MasterPlayer.json +0 -7018
  166. package/responseModel/finals/Multiplayer.json +0 -1082
  167. package/responseModel/finals/StoreInventory.json +0 -1979
  168. package/responseModel/finalsShort/Authenticate.json +0 -723
  169. package/responseModel/finalsShort/CharacterPlayer.json +0 -1889
  170. package/responseModel/finalsShort/CloudScript.json +0 -253
  171. package/responseModel/finalsShort/Content.json +0 -272
  172. package/responseModel/finalsShort/Dashboard.json +0 -4109
  173. package/responseModel/finalsShort/GamePlayer.json +0 -2305
  174. package/responseModel/finalsShort/Generic.json +0 -252
  175. package/responseModel/finalsShort/Group.json +0 -1508
  176. package/responseModel/finalsShort/Inventory.json +0 -1210
  177. package/responseModel/finalsShort/MasterPlayer.json +0 -3800
  178. package/responseModel/finalsShort/Multiplayer.json +0 -633
  179. package/responseModel/finalsShort/StoreInventory.json +0 -1098
  180. package/responseModel/operationResponse/AuthenticateResponseModels.json +0 -77
  181. package/responseModel/operationResponse/CharacterPlayerResponseModels.json +0 -217
  182. package/responseModel/operationResponse/CloudScriptResponseModels.json +0 -25
  183. package/responseModel/operationResponse/ContentResponseModels.json +0 -33
  184. package/responseModel/operationResponse/DashboardResponseModels.json +0 -109
  185. package/responseModel/operationResponse/GamePlayerResponseModels.json +0 -213
  186. package/responseModel/operationResponse/GroupResponseModels.json +0 -165
  187. package/responseModel/operationResponse/InventoryResponseModels.json +0 -141
  188. package/responseModel/operationResponse/MasterPlayerResponseModels.json +0 -349
  189. package/responseModel/operationResponse/MultiplayerResponseModels.json +0 -45
  190. package/responseModel/operationResponse/StoreInventoryResponseModels.json +0 -61
  191. package/responseModel/servers/Authenticate.json +0 -1328
  192. package/responseModel/servers/CharacterPlayer.json +0 -3199
  193. package/responseModel/servers/CloudScript.json +0 -278
  194. package/responseModel/servers/Content.json +0 -324
  195. package/responseModel/servers/GamePlayer.json +0 -3844
  196. package/responseModel/servers/Group.json +0 -2454
  197. package/responseModel/servers/Inventory.json +0 -1964
  198. package/responseModel/servers/MasterAdmin.json +0 -5569
  199. package/responseModel/servers/MasterPlayer.json +0 -5924
  200. package/responseModel/servers/Multiplayer.json +0 -545
  201. package/responseModel/servers/StoreInventory.json +0 -1290
package/responseModel/chatgpt/MasterPlayer.json DELETED
@@ -1,3801 +0,0 @@
1
- {
2
- "requestType": "MasterPlayer",
3
- "description": "API endpoints for managing master player accounts, linked services, player metadata, statistics, push notifications, segmentation, and leaderboard analytics.",
4
- "operations": [
5
- {
6
- "operationCode": "AddPushNotification",
7
- "details": [
8
- {
9
- "role": "Client",
10
- "requestData": [
11
- {
12
- "code": "UserId",
13
- "description": "The unique identifier of the player.",
14
- "type": "string"
15
- },
16
- {
17
- "code": "Token",
18
- "description": "The push notification token provided by the client device.",
19
- "type": "string"
20
- },
21
- {
22
- "code": "PlatformType",
23
- "description": "The platform or operating system the push token was generated on.",
24
- "type": "number"
25
- }
26
- ]
27
- },
28
- {
29
- "role": "Server",
30
- "requestData": [
31
- {
32
- "code": "UserId",
33
- "description": "The unique identifier of the player.",
34
- "type": "string"
35
- }
36
- ]
37
- }
38
- ],
39
- "description": "Register a new push notification token for the player."
40
- },
41
- {
42
- "operationCode": "AddSegment",
43
- "details": [
44
- {
45
- "role": "Client",
46
- "requestData": [
47
- {
48
- "code": "UserId",
49
- "description": "The unique identifier of the player.",
50
- "type": "string"
51
- },
52
- {
53
- "code": "Value",
54
- "description": "The value to assign to the custom player data entry.",
55
- "type": "string"
56
- }
57
- ]
58
- },
59
- {
60
- "role": "Server",
61
- "requestData": [
62
- {
63
- "code": "UserId",
64
- "description": "The unique identifier of the player.",
65
- "type": "string"
66
- }
67
- ]
68
- }
69
- ],
70
- "description": "Assign the player to a specific segment for targeting or analysis."
71
- },
72
- {
73
- "operationCode": "ChangeAccountPassword",
74
- "details": [
75
- {
76
- "role": "Client",
77
- "requestData": [
78
- {
79
- "code": "UserId",
80
- "description": "The unique identifier of the player.",
81
- "type": "string"
82
- },
83
- {
84
- "code": "CurrentPassword",
85
- "description": "CurrentPassword parameter.",
86
- "type": "string"
87
- },
88
- {
89
- "code": "Password",
90
- "description": "Password associated with the email account.",
91
- "type": "string"
92
- }
93
- ]
94
- }
95
- ],
96
- "description": "Update the player's account password using the current password."
97
- },
98
- {
99
- "operationCode": "ChangePlayerCurrency",
100
- "details": [
101
- {
102
- "role": "Client",
103
- "requestData": [
104
- {
105
- "code": "UserId",
106
- "description": "The unique identifier of the player.",
107
- "type": "string"
108
- },
109
- {
110
- "code": "PlayerCurrencies",
111
- "description": "PlayerCurrencies parameter.",
112
- "type": "Array<PlayerCurrencyParam>"
113
- },
114
- {
115
- "code": "Log",
116
- "description": "Optional note or message to include in the operation log.",
117
- "type": "string"
118
- }
119
- ]
120
- },
121
- {
122
- "role": "Server",
123
- "requestData": [
124
- {
125
- "code": "UserId",
126
- "description": "The unique identifier of the player.",
127
- "type": "string"
128
- }
129
- ]
130
- }
131
- ],
132
- "description": "Modify the player's virtual currency balance."
133
- },
134
- {
135
- "operationCode": "ChangePlayerStatistics",
136
- "details": [
137
- {
138
- "role": "Client",
139
- "requestData": [
140
- {
141
- "code": "UserId",
142
- "description": "The unique identifier of the player.",
143
- "type": "string"
144
- },
145
- {
146
- "code": "PlayerStatistics",
147
- "description": "PlayerStatistics parameter.",
148
- "type": "Array<PlayerStatisticsParam>"
149
- },
150
- {
151
- "code": "Log",
152
- "description": "Optional note or message to include in the operation log.",
153
- "type": "string"
154
- }
155
- ]
156
- },
157
- {
158
- "role": "Server",
159
- "requestData": [
160
- {
161
- "code": "UserId",
162
- "description": "The unique identifier of the player.",
163
- "type": "string"
164
- }
165
- ]
166
- }
167
- ],
168
- "description": "Update the values of one or more player statistics."
169
- },
170
- {
171
- "operationCode": "GetAvatar",
172
- "details": [
173
- {
174
- "role": "Client",
175
- "requestData": [
176
- {
177
- "code": "UserId",
178
- "description": "The unique identifier of the player.",
179
- "type": "string"
180
- }
181
- ]
182
- },
183
- {
184
- "role": "Server",
185
- "requestData": [
186
- {
187
- "code": "UserId",
188
- "description": "The unique identifier of the player.",
189
- "type": "string"
190
- }
191
- ]
192
- }
193
- ],
194
- "description": "Retrieve the player's avatar."
195
- },
196
- {
197
- "operationCode": "GetCountryCode",
198
- "details": [
199
- {
200
- "role": "Client",
201
- "requestData": [
202
- {
203
- "code": "UserId",
204
- "description": "The unique identifier of the player.",
205
- "type": "string"
206
- }
207
- ]
208
- },
209
- {
210
- "role": "Server",
211
- "requestData": [
212
- {
213
- "code": "UserId",
214
- "description": "The unique identifier of the player.",
215
- "type": "string"
216
- }
217
- ]
218
- }
219
- ],
220
- "description": "Retrieve the player's countrycode."
221
- },
222
- {
223
- "operationCode": "GetCreateLeaderboard",
224
- "details": [
225
- {
226
- "role": "Client",
227
- "requestData": [
228
- {
229
- "code": "InfoRequestParam",
230
- "description": "Flags and filters used to control the information included in the response.",
231
- "type": "InfoRequestParam"
232
- },
233
- {
234
- "code": "Skip",
235
- "description": "Skip parameter.",
236
- "type": "number",
237
- "defaultValue": "0"
238
- },
239
- {
240
- "code": "Limit",
241
- "description": "Limit parameter.",
242
- "type": "number",
243
- "defaultValue": "10"
244
- },
245
- {
246
- "code": "LoadFromCache",
247
- "description": "LoadFromCache parameter.",
248
- "type": "boolean",
249
- "defaultValue": "true"
250
- }
251
- ]
252
- }
253
- ],
254
- "description": "Retrieve leaderboard data based on createl."
255
- },
256
- {
257
- "operationCode": "GetCurrencyLeaderboard",
258
- "details": [
259
- {
260
- "role": "Client",
261
- "requestData": [
262
- {
263
- "code": "Key",
264
- "description": "The key associated with a custom player data entry.",
265
- "type": "string"
266
- },
267
- {
268
- "code": "InfoRequestParam",
269
- "description": "Flags and filters used to control the information included in the response.",
270
- "type": "InfoRequestParam"
271
- },
272
- {
273
- "code": "Skip",
274
- "description": "Skip parameter.",
275
- "type": "number",
276
- "defaultValue": "0"
277
- },
278
- {
279
- "code": "Limit",
280
- "description": "Limit parameter.",
281
- "type": "number",
282
- "defaultValue": "10"
283
- },
284
- {
285
- "code": "LoadFromCache",
286
- "description": "LoadFromCache parameter.",
287
- "type": "boolean",
288
- "defaultValue": "true"
289
- }
290
- ]
291
- }
292
- ],
293
- "description": "Retrieve leaderboard data based on currencyl."
294
- },
295
- {
296
- "operationCode": "GetCurrencyLog",
297
- "details": [
298
- {
299
- "role": "Client",
300
- "requestData": [
301
- {
302
- "code": "Keys",
303
- "description": "List of keys to retrieve from the player’s custom data.",
304
- "type": "Array<string>"
305
- },
306
- {
307
- "code": "UserId",
308
- "description": "The unique identifier of the player.",
309
- "type": "string"
310
- },
311
- {
312
- "code": "Limit",
313
- "description": "Limit parameter.",
314
- "type": "number",
315
- "defaultValue": "10"
316
- },
317
- {
318
- "code": "Token",
319
- "description": "The push notification token provided by the client device.",
320
- "type": "string"
321
- }
322
- ]
323
- }
324
- ],
325
- "description": "Fetch the player's currency transaction history."
326
- },
327
- {
328
- "operationCode": "GetCustomData",
329
- "details": [
330
- {
331
- "role": "Client",
332
- "requestData": [
333
- {
334
- "code": "UserId",
335
- "description": "The unique identifier of the player.",
336
- "type": "string"
337
- },
338
- {
339
- "code": "CustomDataKeys",
340
- "description": "CustomDataKeys parameter.",
341
- "type": "Array<string>"
342
- }
343
- ]
344
- },
345
- {
346
- "role": "Server",
347
- "requestData": [
348
- {
349
- "code": "UserId",
350
- "description": "The unique identifier of the player.",
351
- "type": "string"
352
- }
353
- ]
354
- }
355
- ],
356
- "description": "Retrieve the player's customdata."
357
- },
358
- {
359
- "operationCode": "GetDisplayName",
360
- "details": [
361
- {
362
- "role": "Client",
363
- "requestData": [
364
- {
365
- "code": "UserId",
366
- "description": "The unique identifier of the player.",
367
- "type": "string"
368
- }
369
- ]
370
- },
371
- {
372
- "role": "Server",
373
- "requestData": [
374
- {
375
- "code": "UserId",
376
- "description": "The unique identifier of the player.",
377
- "type": "string"
378
- }
379
- ]
380
- }
381
- ],
382
- "description": "Retrieve the player's displayname."
383
- },
384
- {
385
- "operationCode": "GetEmail",
386
- "details": [
387
- {
388
- "role": "Client",
389
- "requestData": [
390
- {
391
- "code": "UserId",
392
- "description": "The unique identifier of the player.",
393
- "type": "string"
394
- }
395
- ]
396
- },
397
- {
398
- "role": "Server",
399
- "requestData": [
400
- {
401
- "code": "UserId",
402
- "description": "The unique identifier of the player.",
403
- "type": "string"
404
- }
405
- ]
406
- }
407
- ],
408
- "description": "Retrieve the player's email."
409
- },
410
- {
411
- "operationCode": "GetExternal",
412
- "details": [
413
- {
414
- "role": "Client",
415
- "requestData": [
416
- {
417
- "code": "UserId",
418
- "description": "The unique identifier of the player.",
419
- "type": "string"
420
- }
421
- ]
422
- },
423
- {
424
- "role": "Server",
425
- "requestData": [
426
- {
427
- "code": "UserId",
428
- "description": "The unique identifier of the player.",
429
- "type": "string"
430
- }
431
- ]
432
- }
433
- ],
434
- "description": "Retrieve the player's external."
435
- },
436
- {
437
- "operationCode": "GetIpAddressCreate",
438
- "details": [
439
- {
440
- "role": "Client",
441
- "requestData": [
442
- {
443
- "code": "UserId",
444
- "description": "The unique identifier of the player.",
445
- "type": "string"
446
- }
447
- ]
448
- },
449
- {
450
- "role": "Server",
451
- "requestData": [
452
- {
453
- "code": "UserId",
454
- "description": "The unique identifier of the player.",
455
- "type": "string"
456
- }
457
- ]
458
- }
459
- ],
460
- "description": "Retrieve the player's ipaddresscreate."
461
- },
462
- {
463
- "operationCode": "GetLastLoginLeaderboard",
464
- "details": [
465
- {
466
- "role": "Client",
467
- "requestData": [
468
- {
469
- "code": "InfoRequestParam",
470
- "description": "Flags and filters used to control the information included in the response.",
471
- "type": "InfoRequestParam"
472
- },
473
- {
474
- "code": "Skip",
475
- "description": "Skip parameter.",
476
- "type": "number",
477
- "defaultValue": "0"
478
- },
479
- {
480
- "code": "Limit",
481
- "description": "Limit parameter.",
482
- "type": "number",
483
- "defaultValue": "10"
484
- },
485
- {
486
- "code": "LoadFromCache",
487
- "description": "LoadFromCache parameter.",
488
- "type": "boolean",
489
- "defaultValue": "true"
490
- }
491
- ]
492
- }
493
- ],
494
- "description": "Retrieve leaderboard data based on lastloginl."
495
- },
496
- {
497
- "operationCode": "GetPlayerBan",
498
- "details": [
499
- {
500
- "role": "Client",
501
- "requestData": [
502
- {
503
- "code": "UserId",
504
- "description": "The unique identifier of the player.",
505
- "type": "string"
506
- }
507
- ]
508
- },
509
- {
510
- "role": "Server",
511
- "requestData": [
512
- {
513
- "code": "UserId",
514
- "description": "The unique identifier of the player.",
515
- "type": "string"
516
- }
517
- ]
518
- }
519
- ],
520
- "description": "Retrieve the player's playerban."
521
- },
522
- {
523
- "operationCode": "GetPlayerCurrency",
524
- "details": [
525
- {
526
- "role": "Client",
527
- "requestData": [
528
- {
529
- "code": "UserId",
530
- "description": "The unique identifier of the player.",
531
- "type": "string"
532
- },
533
- {
534
- "code": "PlayerCurrencyKeys",
535
- "description": "PlayerCurrencyKeys parameter.",
536
- "type": "Array<string>"
537
- }
538
- ]
539
- },
540
- {
541
- "role": "Server",
542
- "requestData": [
543
- {
544
- "code": "UserId",
545
- "description": "The unique identifier of the player.",
546
- "type": "string"
547
- }
548
- ]
549
- }
550
- ],
551
- "description": "Retrieve the player's playercurrency."
552
- },
553
- {
554
- "operationCode": "GetPlayerData",
555
- "details": [
556
- {
557
- "role": "Client",
558
- "requestData": [
559
- {
560
- "code": "UserId",
561
- "description": "The unique identifier of the player.",
562
- "type": "string"
563
- },
564
- {
565
- "code": "PlayerDataKeys",
566
- "description": "PlayerDataKeys parameter.",
567
- "type": "Array<string>"
568
- }
569
- ]
570
- },
571
- {
572
- "role": "Server",
573
- "requestData": [
574
- {
575
- "code": "UserId",
576
- "description": "The unique identifier of the player.",
577
- "type": "string"
578
- }
579
- ]
580
- }
581
- ],
582
- "description": "Fetch custom key-value data stored in the player's profile."
583
- },
584
- {
585
- "operationCode": "GetPlayerInformation",
586
- "details": [
587
- {
588
- "role": "Client",
589
- "requestData": [
590
- {
591
- "code": "UserId",
592
- "description": "The unique identifier of the player.",
593
- "type": "string"
594
- },
595
- {
596
- "code": "InfoRequestParam",
597
- "description": "Flags and filters used to control the information included in the response.",
598
- "type": "InfoRequestParam"
599
- }
600
- ]
601
- },
602
- {
603
- "role": "Server",
604
- "requestData": [
605
- {
606
- "code": "UserId",
607
- "description": "The unique identifier of the player.",
608
- "type": "string"
609
- }
610
- ]
611
- }
612
- ],
613
- "description": "Retrieve the full profile and metadata of a player."
614
- },
615
- {
616
- "operationCode": "GetPlayerStatistics",
617
- "details": [
618
- {
619
- "role": "Client",
620
- "requestData": [
621
- {
622
- "code": "UserId",
623
- "description": "The unique identifier of the player.",
624
- "type": "string"
625
- },
626
- {
627
- "code": "PlayerStatisticsKeys",
628
- "description": "PlayerStatisticsKeys parameter.",
629
- "type": "Array<string>"
630
- }
631
- ]
632
- },
633
- {
634
- "role": "Server",
635
- "requestData": [
636
- {
637
- "code": "UserId",
638
- "description": "The unique identifier of the player.",
639
- "type": "string"
640
- }
641
- ]
642
- }
643
- ],
644
- "description": "Retrieve the player's playerstatistics."
645
- },
646
- {
647
- "operationCode": "GetPlayersWithApple",
648
- "details": [
649
- {
650
- "role": "Client",
651
- "requestData": [
652
- {
653
- "code": "AppleIds",
654
- "description": "AppleIds parameter.",
655
- "type": "Array<string>"
656
- },
657
- {
658
- "code": "InfoRequestParam",
659
- "description": "Flags and filters used to control the information included in the response.",
660
- "type": "InfoRequestParam"
661
- }
662
- ]
663
- }
664
- ],
665
- "description": "Retrieve all master players associated with Apple."
666
- },
667
- {
668
- "operationCode": "GetPlayersWithDisplayName",
669
- "details": [
670
- {
671
- "role": "Client",
672
- "requestData": [
673
- {
674
- "code": "Keyword",
675
- "description": "Keyword parameter.",
676
- "type": "string"
677
- },
678
- {
679
- "code": "InfoRequestParam",
680
- "description": "Flags and filters used to control the information included in the response.",
681
- "type": "InfoRequestParam"
682
- },
683
- {
684
- "code": "Skip",
685
- "description": "Skip parameter.",
686
- "type": "number",
687
- "defaultValue": "0"
688
- },
689
- {
690
- "code": "Limit",
691
- "description": "Limit parameter.",
692
- "type": "number",
693
- "defaultValue": "10"
694
- }
695
- ]
696
- }
697
- ],
698
- "description": "Retrieve all master players associated with DisplayName."
699
- },
700
- {
701
- "operationCode": "GetPlayersWithFacebook",
702
- "details": [
703
- {
704
- "role": "Client",
705
- "requestData": [
706
- {
707
- "code": "FacebookIds",
708
- "description": "FacebookIds parameter.",
709
- "type": "Array<string>"
710
- },
711
- {
712
- "code": "InfoRequestParam",
713
- "description": "Flags and filters used to control the information included in the response.",
714
- "type": "InfoRequestParam"
715
- }
716
- ]
717
- }
718
- ],
719
- "description": "Retrieve all master players associated with Facebook."
720
- },
721
- {
722
- "operationCode": "GetPlayersWithGameCenter",
723
- "details": [
724
- {
725
- "role": "Client",
726
- "requestData": [
727
- {
728
- "code": "PlayerIds",
729
- "description": "PlayerIds parameter.",
730
- "type": "Array<string>"
731
- },
732
- {
733
- "code": "InfoRequestParam",
734
- "description": "Flags and filters used to control the information included in the response.",
735
- "type": "InfoRequestParam"
736
- }
737
- ]
738
- }
739
- ],
740
- "description": "Retrieve all master players associated with GameCenter."
741
- },
742
- {
743
- "operationCode": "GetPlayersWithGenericService",
744
- "details": [
745
- {
746
- "role": "Client",
747
- "requestData": [
748
- {
749
- "code": "ServiceName",
750
- "description": "ServiceName parameter.",
751
- "type": "string"
752
- },
753
- {
754
- "code": "GenericIds",
755
- "description": "GenericIds parameter.",
756
- "type": "Array<string>"
757
- },
758
- {
759
- "code": "InfoRequestParam",
760
- "description": "Flags and filters used to control the information included in the response.",
761
- "type": "InfoRequestParam"
762
- }
763
- ]
764
- }
765
- ],
766
- "description": "Retrieve all master players associated with GenericService."
767
- },
768
- {
769
- "operationCode": "GetPlayersWithGooglePlayGameService",
770
- "details": [
771
- {
772
- "role": "Client",
773
- "requestData": [
774
- {
775
- "code": "PlayerIds",
776
- "description": "PlayerIds parameter.",
777
- "type": "Array<string>"
778
- },
779
- {
780
- "code": "InfoRequestParam",
781
- "description": "Flags and filters used to control the information included in the response.",
782
- "type": "InfoRequestParam"
783
- }
784
- ]
785
- }
786
- ],
787
- "description": "Retrieve all master players associated with GooglePlayGameService."
788
- },
789
- {
790
- "operationCode": "GetPlayersWithGoogle",
791
- "details": [
792
- {
793
- "role": "Client",
794
- "requestData": [
795
- {
796
- "code": "GoogleIds",
797
- "description": "GoogleIds parameter.",
798
- "type": "Array<string>"
799
- },
800
- {
801
- "code": "InfoRequestParam",
802
- "description": "Flags and filters used to control the information included in the response.",
803
- "type": "InfoRequestParam"
804
- }
805
- ]
806
- }
807
- ],
808
- "description": "Retrieve all master players associated with Google."
809
- },
810
- {
811
- "operationCode": "GetPlayersWithSegment",
812
- "details": [
813
- {
814
- "role": "Client",
815
- "requestData": [
816
- {
817
- "code": "Value",
818
- "description": "The value to assign to the custom player data entry.",
819
- "type": "string"
820
- },
821
- {
822
- "code": "InfoRequestParam",
823
- "description": "Flags and filters used to control the information included in the response.",
824
- "type": "InfoRequestParam"
825
- },
826
- {
827
- "code": "Skip",
828
- "description": "Skip parameter.",
829
- "type": "number",
830
- "defaultValue": "0"
831
- },
832
- {
833
- "code": "Limit",
834
- "description": "Limit parameter.",
835
- "type": "number",
836
- "defaultValue": "10"
837
- }
838
- ]
839
- }
840
- ],
841
- "description": "Retrieve all master players associated with Segment."
842
- },
843
- {
844
- "operationCode": "GetPlayersWithTag",
845
- "details": [
846
- {
847
- "role": "Client",
848
- "requestData": [
849
- {
850
- "code": "Key",
851
- "description": "The key associated with a custom player data entry.",
852
- "type": "string"
853
- },
854
- {
855
- "code": "Value",
856
- "description": "The value to assign to the custom player data entry.",
857
- "type": "string"
858
- },
859
- {
860
- "code": "InfoRequestParam",
861
- "description": "Flags and filters used to control the information included in the response.",
862
- "type": "InfoRequestParam"
863
- },
864
- {
865
- "code": "Skip",
866
- "description": "Skip parameter.",
867
- "type": "number",
868
- "defaultValue": "0"
869
- },
870
- {
871
- "code": "Limit",
872
- "description": "Limit parameter.",
873
- "type": "number",
874
- "defaultValue": "10"
875
- }
876
- ]
877
- }
878
- ],
879
- "description": "Retrieve all master players associated with Tag."
880
- },
881
- {
882
- "operationCode": "GetPushNotification",
883
- "details": [
884
- {
885
- "role": "Client",
886
- "requestData": [
887
- {
888
- "code": "UserId",
889
- "description": "The unique identifier of the player.",
890
- "type": "string"
891
- }
892
- ]
893
- },
894
- {
895
- "role": "Server",
896
- "requestData": [
897
- {
898
- "code": "UserId",
899
- "description": "The unique identifier of the player.",
900
- "type": "string"
901
- }
902
- ]
903
- }
904
- ],
905
- "description": "Retrieve the player's pushnotification."
906
- },
907
- {
908
- "operationCode": "GetSegment",
909
- "details": [
910
- {
911
- "role": "Client",
912
- "requestData": [
913
- {
914
- "code": "UserId",
915
- "description": "The unique identifier of the player.",
916
- "type": "string"
917
- }
918
- ]
919
- },
920
- {
921
- "role": "Server",
922
- "requestData": [
923
- {
924
- "code": "UserId",
925
- "description": "The unique identifier of the player.",
926
- "type": "string"
927
- }
928
- ]
929
- }
930
- ],
931
- "description": "Retrieve segment details associated with the player."
932
- },
933
- {
934
- "operationCode": "GetStatisticsLeaderboardAroundPlayer",
935
- "details": [
936
- {
937
- "role": "Client",
938
- "requestData": [
939
- {
940
- "code": "UserId",
941
- "description": "The unique identifier of the player.",
942
- "type": "string"
943
- },
944
- {
945
- "code": "Key",
946
- "description": "The key associated with a custom player data entry.",
947
- "type": "string"
948
- },
949
- {
950
- "code": "InfoRequestParam",
951
- "description": "Flags and filters used to control the information included in the response.",
952
- "type": "InfoRequestParam"
953
- },
954
- {
955
- "code": "Skip",
956
- "description": "Skip parameter.",
957
- "type": "number",
958
- "defaultValue": "0"
959
- },
960
- {
961
- "code": "Limit",
962
- "description": "Limit parameter.",
963
- "type": "number",
964
- "defaultValue": "10"
965
- },
966
- {
967
- "code": "LoadFromCache",
968
- "description": "LoadFromCache parameter.",
969
- "type": "boolean",
970
- "defaultValue": "true"
971
- }
972
- ]
973
- },
974
- {
975
- "role": "Server",
976
- "requestData": [
977
- {
978
- "code": "UserId",
979
- "description": "The unique identifier of the player.",
980
- "type": "string"
981
- }
982
- ]
983
- }
984
- ],
985
- "description": "Retrieve leaderboard data based on statisticsleaderboardar."
986
- },
987
- {
988
- "operationCode": "GetStatisticsLeaderboard",
989
- "details": [
990
- {
991
- "role": "Client",
992
- "requestData": [
993
- {
994
- "code": "Key",
995
- "description": "The key associated with a custom player data entry.",
996
- "type": "string"
997
- },
998
- {
999
- "code": "InfoRequestParam",
1000
- "description": "Flags and filters used to control the information included in the response.",
1001
- "type": "InfoRequestParam"
1002
- },
1003
- {
1004
- "code": "Skip",
1005
- "description": "Skip parameter.",
1006
- "type": "number",
1007
- "defaultValue": "0"
1008
- },
1009
- {
1010
- "code": "Limit",
1011
- "description": "Limit parameter.",
1012
- "type": "number",
1013
- "defaultValue": "10"
1014
- },
1015
- {
1016
- "code": "LoadFromCache",
1017
- "description": "LoadFromCache parameter.",
1018
- "type": "boolean",
1019
- "defaultValue": "true"
1020
- },
1021
- {
1022
- "code": "Version",
1023
- "description": "Version parameter.",
1024
- "type": "string"
1025
- }
1026
- ]
1027
- }
1028
- ],
1029
- "description": "Retrieve leaderboard rankings based on player statistics."
1030
- },
1031
- {
1032
- "operationCode": "GetStatisticsLog",
1033
- "details": [
1034
- {
1035
- "role": "Client",
1036
- "requestData": [
1037
- {
1038
- "code": "Keys",
1039
- "description": "List of keys to retrieve from the player’s custom data.",
1040
- "type": "Array<string>"
1041
- },
1042
- {
1043
- "code": "UserId",
1044
- "description": "The unique identifier of the player.",
1045
- "type": "string"
1046
- },
1047
- {
1048
- "code": "Limit",
1049
- "description": "Limit parameter.",
1050
- "type": "number",
1051
- "defaultValue": "10"
1052
- },
1053
- {
1054
- "code": "Token",
1055
- "description": "The push notification token provided by the client device.",
1056
- "type": "string"
1057
- }
1058
- ]
1059
- }
1060
- ],
1061
- "description": "Fetch historical log of changes made to the player's statistics."
1062
- },
1063
- {
1064
- "operationCode": "GetTag",
1065
- "details": [
1066
- {
1067
- "role": "Client",
1068
- "requestData": [
1069
- {
1070
- "code": "UserId",
1071
- "description": "The unique identifier of the player.",
1072
- "type": "string"
1073
- },
1074
- {
1075
- "code": "TagKeys",
1076
- "description": "TagKeys parameter.",
1077
- "type": "Array<string>"
1078
- }
1079
- ]
1080
- },
1081
- {
1082
- "role": "Server",
1083
- "requestData": [
1084
- {
1085
- "code": "UserId",
1086
- "description": "The unique identifier of the player.",
1087
- "type": "string"
1088
- }
1089
- ]
1090
- }
1091
- ],
1092
- "description": "Return a list of tags assigned to the player."
1093
- },
1094
- {
1095
- "operationCode": "GetTsCreate",
1096
- "details": [
1097
- {
1098
- "role": "Client",
1099
- "requestData": [
1100
- {
1101
- "code": "UserId",
1102
- "description": "The unique identifier of the player.",
1103
- "type": "string"
1104
- }
1105
- ]
1106
- },
1107
- {
1108
- "role": "Server",
1109
- "requestData": [
1110
- {
1111
- "code": "UserId",
1112
- "description": "The unique identifier of the player.",
1113
- "type": "string"
1114
- }
1115
- ]
1116
- }
1117
- ],
1118
- "description": "Retrieve the player's tscreate."
1119
- },
1120
- {
1121
- "operationCode": "GetTsLastLogin",
1122
- "details": [
1123
- {
1124
- "role": "Client",
1125
- "requestData": [
1126
- {
1127
- "code": "UserId",
1128
- "description": "The unique identifier of the player.",
1129
- "type": "string"
1130
- }
1131
- ]
1132
- },
1133
- {
1134
- "role": "Server",
1135
- "requestData": [
1136
- {
1137
- "code": "UserId",
1138
- "description": "The unique identifier of the player.",
1139
- "type": "string"
1140
- }
1141
- ]
1142
- }
1143
- ],
1144
- "description": "Retrieve the player's tslastlogin."
1145
- },
1146
- {
1147
- "operationCode": "LinkAccount",
1148
- "details": [
1149
- {
1150
- "role": "Client",
1151
- "requestData": [
1152
- {
1153
- "code": "UserId",
1154
- "description": "The unique identifier of the player.",
1155
- "type": "string"
1156
- },
1157
- {
1158
- "code": "Username",
1159
- "description": "Username parameter.",
1160
- "type": "string"
1161
- },
1162
- {
1163
- "code": "Password",
1164
- "description": "Password associated with the email account.",
1165
- "type": "string"
1166
- },
1167
- {
1168
- "code": "ForceLink",
1169
- "description": "ForceLink parameter.",
1170
- "type": "boolean",
1171
- "defaultValue": "false"
1172
- }
1173
- ]
1174
- },
1175
- {
1176
- "role": "Server",
1177
- "requestData": [
1178
- {
1179
- "code": "UserId",
1180
- "description": "The unique identifier of the player.",
1181
- "type": "string"
1182
- }
1183
- ]
1184
- }
1185
- ],
1186
- "description": "Link the player's account to a account identifier."
1187
- },
1188
- {
1189
- "operationCode": "LinkAndroidDeviceId",
1190
- "details": [
1191
- {
1192
- "role": "Client",
1193
- "requestData": [
1194
- {
1195
- "code": "UserId",
1196
- "description": "The unique identifier of the player.",
1197
- "type": "string"
1198
- },
1199
- {
1200
- "code": "AndroidDeviceId",
1201
- "description": "The device-specific Android identifier.",
1202
- "type": "string"
1203
- },
1204
- {
1205
- "code": "ForceLink",
1206
- "description": "ForceLink parameter.",
1207
- "type": "boolean",
1208
- "defaultValue": "false"
1209
- }
1210
- ]
1211
- },
1212
- {
1213
- "role": "Server",
1214
- "requestData": [
1215
- {
1216
- "code": "UserId",
1217
- "description": "The unique identifier of the player.",
1218
- "type": "string"
1219
- }
1220
- ]
1221
- }
1222
- ],
1223
- "description": "Associate the player's account with a device-specific Android ID."
1224
- },
1225
- {
1226
- "operationCode": "LinkApple",
1227
- "details": [
1228
- {
1229
- "role": "Client",
1230
- "requestData": [
1231
- {
1232
- "code": "UserId",
1233
- "description": "The unique identifier of the player.",
1234
- "type": "string"
1235
- },
1236
- {
1237
- "code": "Token",
1238
- "description": "The push notification token provided by the client device.",
1239
- "type": "string"
1240
- },
1241
- {
1242
- "code": "ForceLink",
1243
- "description": "ForceLink parameter.",
1244
- "type": "boolean",
1245
- "defaultValue": "false"
1246
- }
1247
- ]
1248
- },
1249
- {
1250
- "role": "Server",
1251
- "requestData": [
1252
- {
1253
- "code": "UserId",
1254
- "description": "The unique identifier of the player.",
1255
- "type": "string"
1256
- }
1257
- ]
1258
- }
1259
- ],
1260
- "description": "Link the player's account to an Apple Game Center profile."
1261
- },
1262
- {
1263
- "operationCode": "LinkCustomDeviceId",
1264
- "details": [
1265
- {
1266
- "role": "Client",
1267
- "requestData": [
1268
- {
1269
- "code": "UserId",
1270
- "description": "The unique identifier of the player.",
1271
- "type": "string"
1272
- },
1273
- {
1274
- "code": "CustomDeviceId",
1275
- "description": "CustomDeviceId parameter.",
1276
- "type": "string"
1277
- },
1278
- {
1279
- "code": "ForceLink",
1280
- "description": "ForceLink parameter.",
1281
- "type": "boolean",
1282
- "defaultValue": "false"
1283
- }
1284
- ]
1285
- },
1286
- {
1287
- "role": "Server",
1288
- "requestData": [
1289
- {
1290
- "code": "UserId",
1291
- "description": "The unique identifier of the player.",
1292
- "type": "string"
1293
- }
1294
- ]
1295
- }
1296
- ],
1297
- "description": "Link the player's account to a custom identifier."
1298
- },
1299
- {
1300
- "operationCode": "LinkCustomId",
1301
- "details": [
1302
- {
1303
- "role": "Client",
1304
- "requestData": [
1305
- {
1306
- "code": "UserId",
1307
- "description": "The unique identifier of the player.",
1308
- "type": "string"
1309
- },
1310
- {
1311
- "code": "CustomId",
1312
- "description": "A unique custom identifier used to link or authenticate the player.",
1313
- "type": "string"
1314
- },
1315
- {
1316
- "code": "ForceLink",
1317
- "description": "ForceLink parameter.",
1318
- "type": "boolean",
1319
- "defaultValue": "false"
1320
- }
1321
- ]
1322
- },
1323
- {
1324
- "role": "Server",
1325
- "requestData": [
1326
- {
1327
- "code": "UserId",
1328
- "description": "The unique identifier of the player.",
1329
- "type": "string"
1330
- }
1331
- ]
1332
- }
1333
- ],
1334
- "description": "Link a custom identifier to the player's account."
1335
- },
1336
- {
1337
- "operationCode": "LinkEditorDeviceId",
1338
- "details": [
1339
- {
1340
- "role": "Client",
1341
- "requestData": [
1342
- {
1343
- "code": "UserId",
1344
- "description": "The unique identifier of the player.",
1345
- "type": "string"
1346
- },
1347
- {
1348
- "code": "EditorDeviceId",
1349
- "description": "EditorDeviceId parameter.",
1350
- "type": "string"
1351
- },
1352
- {
1353
- "code": "ForceLink",
1354
- "description": "ForceLink parameter.",
1355
- "type": "boolean",
1356
- "defaultValue": "false"
1357
- }
1358
- ]
1359
- },
1360
- {
1361
- "role": "Server",
1362
- "requestData": [
1363
- {
1364
- "code": "UserId",
1365
- "description": "The unique identifier of the player.",
1366
- "type": "string"
1367
- }
1368
- ]
1369
- }
1370
- ],
1371
- "description": "Link the player's account to a editor identifier."
1372
- },
1373
- {
1374
- "operationCode": "LinkFacebook",
1375
- "details": [
1376
- {
1377
- "role": "Client",
1378
- "requestData": [
1379
- {
1380
- "code": "UserId",
1381
- "description": "The unique identifier of the player.",
1382
- "type": "string"
1383
- },
1384
- {
1385
- "code": "Token",
1386
- "description": "The push notification token provided by the client device.",
1387
- "type": "string"
1388
- },
1389
- {
1390
- "code": "ForceLink",
1391
- "description": "ForceLink parameter.",
1392
- "type": "boolean",
1393
- "defaultValue": "false"
1394
- }
1395
- ]
1396
- },
1397
- {
1398
- "role": "Server",
1399
- "requestData": [
1400
- {
1401
- "code": "UserId",
1402
- "description": "The unique identifier of the player.",
1403
- "type": "string"
1404
- }
1405
- ]
1406
- }
1407
- ],
1408
- "description": "Link the player's account to a Facebook profile."
1409
- },
1410
- {
1411
- "operationCode": "LinkGameCenter",
1412
- "details": [
1413
- {
1414
- "role": "Client",
1415
- "requestData": [
1416
- {
1417
- "code": "UserId",
1418
- "description": "The unique identifier of the player.",
1419
- "type": "string"
1420
- },
1421
- {
1422
- "code": "PlayerId",
1423
- "description": "PlayerId parameter.",
1424
- "type": "string"
1425
- },
1426
- {
1427
- "code": "Name",
1428
- "description": "Name parameter.",
1429
- "type": "string"
1430
- },
1431
- {
1432
- "code": "PublicKeyUrl",
1433
- "description": "PublicKeyUrl parameter.",
1434
- "type": "string"
1435
- },
1436
- {
1437
- "code": "Signature",
1438
- "description": "Signature parameter.",
1439
- "type": "string"
1440
- },
1441
- {
1442
- "code": "Salt",
1443
- "description": "Salt parameter.",
1444
- "type": "string"
1445
- },
1446
- {
1447
- "code": "Timestamp",
1448
- "description": "Timestamp parameter.",
1449
- "type": "number"
1450
- },
1451
- {
1452
- "code": "ForceLink",
1453
- "description": "ForceLink parameter.",
1454
- "type": "boolean",
1455
- "defaultValue": "false"
1456
- }
1457
- ]
1458
- },
1459
- {
1460
- "role": "Server",
1461
- "requestData": [
1462
- {
1463
- "code": "UserId",
1464
- "description": "The unique identifier of the player.",
1465
- "type": "string"
1466
- }
1467
- ]
1468
- }
1469
- ],
1470
- "description": "Link the player's account to a gamecenter identifier."
1471
- },
1472
- {
1473
- "operationCode": "LinkGenericService",
1474
- "details": [
1475
- {
1476
- "role": "Client",
1477
- "requestData": [
1478
- {
1479
- "code": "UserId",
1480
- "description": "The unique identifier of the player.",
1481
- "type": "string"
1482
- },
1483
- {
1484
- "code": "ServiceName",
1485
- "description": "ServiceName parameter.",
1486
- "type": "string"
1487
- },
1488
- {
1489
- "code": "ServiceData",
1490
- "description": "ServiceData parameter.",
1491
- "type": "GNHashtable"
1492
- },
1493
- {
1494
- "code": "ForceLink",
1495
- "description": "ForceLink parameter.",
1496
- "type": "boolean",
1497
- "defaultValue": "false"
1498
- }
1499
- ]
1500
- },
1501
- {
1502
- "role": "Server",
1503
- "requestData": [
1504
- {
1505
- "code": "UserId",
1506
- "description": "The unique identifier of the player.",
1507
- "type": "string"
1508
- }
1509
- ]
1510
- }
1511
- ],
1512
- "description": "Link the player's account to a genericservice identifier."
1513
- },
1514
- {
1515
- "operationCode": "LinkGooglePlayGameService",
1516
- "details": [
1517
- {
1518
- "role": "Client",
1519
- "requestData": [
1520
- {
1521
- "code": "UserId",
1522
- "description": "The unique identifier of the player.",
1523
- "type": "string"
1524
- },
1525
- {
1526
- "code": "Token",
1527
- "description": "The push notification token provided by the client device.",
1528
- "type": "string"
1529
- },
1530
- {
1531
- "code": "ForceLink",
1532
- "description": "ForceLink parameter.",
1533
- "type": "boolean",
1534
- "defaultValue": "false"
1535
- }
1536
- ]
1537
- },
1538
- {
1539
- "role": "Server",
1540
- "requestData": [
1541
- {
1542
- "code": "UserId",
1543
- "description": "The unique identifier of the player.",
1544
- "type": "string"
1545
- }
1546
- ]
1547
- }
1548
- ],
1549
- "description": "Link the player's account to Google Play Game Services."
1550
- },
1551
- {
1552
- "operationCode": "LinkGoogle",
1553
- "details": [
1554
- {
1555
- "role": "Client",
1556
- "requestData": [
1557
- {
1558
- "code": "UserId",
1559
- "description": "The unique identifier of the player.",
1560
- "type": "string"
1561
- },
1562
- {
1563
- "code": "Token",
1564
- "description": "The push notification token provided by the client device.",
1565
- "type": "string"
1566
- },
1567
- {
1568
- "code": "Type",
1569
- "description": "Type parameter.",
1570
- "type": "number"
1571
- },
1572
- {
1573
- "code": "ForceLink",
1574
- "description": "ForceLink parameter.",
1575
- "type": "boolean",
1576
- "defaultValue": "false"
1577
- }
1578
- ]
1579
- },
1580
- {
1581
- "role": "Server",
1582
- "requestData": [
1583
- {
1584
- "code": "UserId",
1585
- "description": "The unique identifier of the player.",
1586
- "type": "string"
1587
- }
1588
- ]
1589
- }
1590
- ],
1591
- "description": "Link the player's account to a Google account."
1592
- },
1593
- {
1594
- "operationCode": "LinkiOSDeviceId",
1595
- "details": [
1596
- {
1597
- "role": "Client",
1598
- "requestData": [
1599
- {
1600
- "code": "UserId",
1601
- "description": "The unique identifier of the player.",
1602
- "type": "string"
1603
- },
1604
- {
1605
- "code": "iOSDeviceId",
1606
- "description": "iOSDeviceId parameter.",
1607
- "type": "string"
1608
- },
1609
- {
1610
- "code": "ForceLink",
1611
- "description": "ForceLink parameter.",
1612
- "type": "boolean",
1613
- "defaultValue": "false"
1614
- }
1615
- ]
1616
- },
1617
- {
1618
- "role": "Server",
1619
- "requestData": [
1620
- {
1621
- "code": "UserId",
1622
- "description": "The unique identifier of the player.",
1623
- "type": "string"
1624
- }
1625
- ]
1626
- }
1627
- ],
1628
- "description": "Link the player's account to a ios identifier."
1629
- },
1630
- {
1631
- "operationCode": "LinkLinuxDeviceId",
1632
- "details": [
1633
- {
1634
- "role": "Client",
1635
- "requestData": [
1636
- {
1637
- "code": "UserId",
1638
- "description": "The unique identifier of the player.",
1639
- "type": "string"
1640
- },
1641
- {
1642
- "code": "LinuxDeviceId",
1643
- "description": "LinuxDeviceId parameter.",
1644
- "type": "string"
1645
- },
1646
- {
1647
- "code": "ForceLink",
1648
- "description": "ForceLink parameter.",
1649
- "type": "boolean",
1650
- "defaultValue": "false"
1651
- }
1652
- ]
1653
- },
1654
- {
1655
- "role": "Server",
1656
- "requestData": [
1657
- {
1658
- "code": "UserId",
1659
- "description": "The unique identifier of the player.",
1660
- "type": "string"
1661
- }
1662
- ]
1663
- }
1664
- ],
1665
- "description": "Link the player's account to a linux identifier."
1666
- },
1667
- {
1668
- "operationCode": "LinkMacOSDeviceId",
1669
- "details": [
1670
- {
1671
- "role": "Client",
1672
- "requestData": [
1673
- {
1674
- "code": "UserId",
1675
- "description": "The unique identifier of the player.",
1676
- "type": "string"
1677
- },
1678
- {
1679
- "code": "MacOSDeviceId",
1680
- "description": "MacOSDeviceId parameter.",
1681
- "type": "string"
1682
- },
1683
- {
1684
- "code": "ForceLink",
1685
- "description": "ForceLink parameter.",
1686
- "type": "boolean",
1687
- "defaultValue": "false"
1688
- }
1689
- ]
1690
- },
1691
- {
1692
- "role": "Server",
1693
- "requestData": [
1694
- {
1695
- "code": "UserId",
1696
- "description": "The unique identifier of the player.",
1697
- "type": "string"
1698
- }
1699
- ]
1700
- }
1701
- ],
1702
- "description": "Link the player's account to a macos identifier."
1703
- },
1704
- {
1705
- "operationCode": "LinkWindowsDeviceId",
1706
- "details": [
1707
- {
1708
- "role": "Client",
1709
- "requestData": [
1710
- {
1711
- "code": "UserId",
1712
- "description": "The unique identifier of the player.",
1713
- "type": "string"
1714
- },
1715
- {
1716
- "code": "WindowsDeviceId",
1717
- "description": "WindowsDeviceId parameter.",
1718
- "type": "string"
1719
- },
1720
- {
1721
- "code": "ForceLink",
1722
- "description": "ForceLink parameter.",
1723
- "type": "boolean",
1724
- "defaultValue": "false"
1725
- }
1726
- ]
1727
- },
1728
- {
1729
- "role": "Server",
1730
- "requestData": [
1731
- {
1732
- "code": "UserId",
1733
- "description": "The unique identifier of the player.",
1734
- "type": "string"
1735
- }
1736
- ]
1737
- }
1738
- ],
1739
- "description": "Link the player's account to a windows identifier."
1740
- },
1741
- {
1742
- "operationCode": "LinkWindowsPhoneDeviceId",
1743
- "details": [
1744
- {
1745
- "role": "Client",
1746
- "requestData": [
1747
- {
1748
- "code": "UserId",
1749
- "description": "The unique identifier of the player.",
1750
- "type": "string"
1751
- },
1752
- {
1753
- "code": "WindowsPhoneDeviceId",
1754
- "description": "WindowsPhoneDeviceId parameter.",
1755
- "type": "string"
1756
- },
1757
- {
1758
- "code": "ForceLink",
1759
- "description": "ForceLink parameter.",
1760
- "type": "boolean",
1761
- "defaultValue": "false"
1762
- }
1763
- ]
1764
- },
1765
- {
1766
- "role": "Server",
1767
- "requestData": [
1768
- {
1769
- "code": "UserId",
1770
- "description": "The unique identifier of the player.",
1771
- "type": "string"
1772
- }
1773
- ]
1774
- }
1775
- ],
1776
- "description": "Link the player's account to a windowsphone identifier."
1777
- },
1778
- {
1779
- "operationCode": "RemovePushNotification",
1780
- "details": [
1781
- {
1782
- "role": "Client",
1783
- "requestData": [
1784
- {
1785
- "code": "UserId",
1786
- "description": "The unique identifier of the player.",
1787
- "type": "string"
1788
- },
1789
- {
1790
- "code": "PushId",
1791
- "description": "PushId parameter.",
1792
- "type": "string"
1793
- }
1794
- ]
1795
- },
1796
- {
1797
- "role": "Server",
1798
- "requestData": [
1799
- {
1800
- "code": "UserId",
1801
- "description": "The unique identifier of the player.",
1802
- "type": "string"
1803
- }
1804
- ]
1805
- }
1806
- ],
1807
- "description": "Delete the registered push notification token from the player's profile."
1808
- },
1809
- {
1810
- "operationCode": "RemoveSegment",
1811
- "details": [
1812
- {
1813
- "role": "Client",
1814
- "requestData": [
1815
- {
1816
- "code": "UserId",
1817
- "description": "The unique identifier of the player.",
1818
- "type": "string"
1819
- },
1820
- {
1821
- "code": "Value",
1822
- "description": "The value to assign to the custom player data entry.",
1823
- "type": "string"
1824
- }
1825
- ]
1826
- },
1827
- {
1828
- "role": "Server",
1829
- "requestData": [
1830
- {
1831
- "code": "UserId",
1832
- "description": "The unique identifier of the player.",
1833
- "type": "string"
1834
- }
1835
- ]
1836
- }
1837
- ],
1838
- "description": "Remove the player from a previously assigned segment."
1839
- },
1840
- {
1841
- "operationCode": "RemoveTag",
1842
- "details": [
1843
- {
1844
- "role": "Client",
1845
- "requestData": [
1846
- {
1847
- "code": "UserId",
1848
- "description": "The unique identifier of the player.",
1849
- "type": "string"
1850
- },
1851
- {
1852
- "code": "Key",
1853
- "description": "The key associated with a custom player data entry.",
1854
- "type": "string"
1855
- }
1856
- ]
1857
- },
1858
- {
1859
- "role": "Server",
1860
- "requestData": [
1861
- {
1862
- "code": "UserId",
1863
- "description": "The unique identifier of the player.",
1864
- "type": "string"
1865
- }
1866
- ]
1867
- }
1868
- ],
1869
- "description": "Delete a specific tag from the player's metadata."
1870
- },
1871
- {
1872
- "operationCode": "ResetAccountPassword",
1873
- "details": [
1874
- {
1875
- "role": "Client",
1876
- "requestData": [
1877
- {
1878
- "code": "UserId",
1879
- "description": "The unique identifier of the player.",
1880
- "type": "string"
1881
- },
1882
- {
1883
- "code": "Password",
1884
- "description": "Password associated with the email account.",
1885
- "type": "string"
1886
- }
1887
- ]
1888
- },
1889
- {
1890
- "role": "Server",
1891
- "requestData": [
1892
- {
1893
- "code": "UserId",
1894
- "description": "The unique identifier of the player.",
1895
- "type": "string"
1896
- }
1897
- ]
1898
- }
1899
- ],
1900
- "description": "Reset the player's accountpassword."
1901
- },
1902
- {
1903
- "operationCode": "SendEmail",
1904
- "details": [
1905
- {
1906
- "role": "Client",
1907
- "requestData": [
1908
- {
1909
- "code": "UserId",
1910
- "description": "The unique identifier of the player.",
1911
- "type": "string"
1912
- },
1913
- {
1914
- "code": "Subject",
1915
- "description": "Subject parameter.",
1916
- "type": "string"
1917
- },
1918
- {
1919
- "code": "ContentHtml",
1920
- "description": "ContentHtml parameter.",
1921
- "type": "string"
1922
- }
1923
- ]
1924
- },
1925
- {
1926
- "role": "Server",
1927
- "requestData": [
1928
- {
1929
- "code": "UserId",
1930
- "description": "The unique identifier of the player.",
1931
- "type": "string"
1932
- }
1933
- ]
1934
- }
1935
- ],
1936
- "description": "Send a email to the player."
1937
- },
1938
- {
1939
- "operationCode": "SendPushNotification",
1940
- "details": [
1941
- {
1942
- "role": "Client",
1943
- "requestData": [
1944
- {
1945
- "code": "UserId",
1946
- "description": "The unique identifier of the player.",
1947
- "type": "string"
1948
- },
1949
- {
1950
- "code": "Title",
1951
- "description": "Title parameter.",
1952
- "type": "string"
1953
- },
1954
- {
1955
- "code": "Body",
1956
- "description": "Body parameter.",
1957
- "type": "string"
1958
- },
1959
- {
1960
- "code": "Badge",
1961
- "description": "Badge parameter.",
1962
- "type": "number",
1963
- "defaultValue": "null"
1964
- },
1965
- {
1966
- "code": "Sound",
1967
- "description": "Sound parameter.",
1968
- "type": "string"
1969
- },
1970
- {
1971
- "code": "Icon",
1972
- "description": "Icon parameter.",
1973
- "type": "string"
1974
- },
1975
- {
1976
- "code": "Data",
1977
- "description": "Data parameter.",
1978
- "type": "GNHashtable"
1979
- }
1980
- ]
1981
- },
1982
- {
1983
- "role": "Server",
1984
- "requestData": [
1985
- {
1986
- "code": "UserId",
1987
- "description": "The unique identifier of the player.",
1988
- "type": "string"
1989
- }
1990
- ]
1991
- }
1992
- ],
1993
- "description": "Send a push notification message to the player."
1994
- },
1995
- {
1996
- "operationCode": "SendSocketOperationEvent",
1997
- "details": [
1998
- {
1999
- "role": "Client",
2000
- "requestData": [
2001
- {
2002
- "code": "UserId",
2003
- "description": "The unique identifier of the player.",
2004
- "type": "string"
2005
- },
2006
- {
2007
- "code": "EventCode",
2008
- "description": "EventCode parameter.",
2009
- "type": "string"
2010
- },
2011
- {
2012
- "code": "EventParameters",
2013
- "description": "EventParameters parameter.",
2014
- "type": "GNHashtable"
2015
- }
2016
- ]
2017
- },
2018
- {
2019
- "role": "Server",
2020
- "requestData": [
2021
- {
2022
- "code": "UserId",
2023
- "description": "The unique identifier of the player.",
2024
- "type": "string"
2025
- }
2026
- ]
2027
- }
2028
- ],
2029
- "description": "Send a socketoperationevent to the player."
2030
- },
2031
- {
2032
- "operationCode": "SetAvatar",
2033
- "details": [
2034
- {
2035
- "role": "Client",
2036
- "requestData": [
2037
- {
2038
- "code": "UserId",
2039
- "description": "The unique identifier of the player.",
2040
- "type": "string"
2041
- },
2042
- {
2043
- "code": "Type",
2044
- "description": "Type parameter.",
2045
- "type": "number"
2046
- },
2047
- {
2048
- "code": "Value",
2049
- "description": "The value to assign to the custom player data entry.",
2050
- "type": "string"
2051
- }
2052
- ]
2053
- },
2054
- {
2055
- "role": "Server",
2056
- "requestData": [
2057
- {
2058
- "code": "UserId",
2059
- "description": "The unique identifier of the player.",
2060
- "type": "string"
2061
- }
2062
- ]
2063
- }
2064
- ],
2065
- "description": "Update the player's avatar."
2066
- },
2067
- {
2068
- "operationCode": "SetCountryCode",
2069
- "details": [
2070
- {
2071
- "role": "Client",
2072
- "requestData": [
2073
- {
2074
- "code": "UserId",
2075
- "description": "The unique identifier of the player.",
2076
- "type": "string"
2077
- },
2078
- {
2079
- "code": "CountryCode",
2080
- "description": "CountryCode parameter.",
2081
- "type": "string"
2082
- }
2083
- ]
2084
- },
2085
- {
2086
- "role": "Server",
2087
- "requestData": [
2088
- {
2089
- "code": "UserId",
2090
- "description": "The unique identifier of the player.",
2091
- "type": "string"
2092
- }
2093
- ]
2094
- }
2095
- ],
2096
- "description": "Update the player's countrycode."
2097
- },
2098
- {
2099
- "operationCode": "SetCustomData",
2100
- "details": [
2101
- {
2102
- "role": "Client",
2103
- "requestData": [
2104
- {
2105
- "code": "UserId",
2106
- "description": "The unique identifier of the player.",
2107
- "type": "string"
2108
- },
2109
- {
2110
- "code": "CustomDatas",
2111
- "description": "CustomDatas parameter.",
2112
- "type": "Array<CustomDataParam>"
2113
- }
2114
- ]
2115
- },
2116
- {
2117
- "role": "Server",
2118
- "requestData": [
2119
- {
2120
- "code": "UserId",
2121
- "description": "The unique identifier of the player.",
2122
- "type": "string"
2123
- }
2124
- ]
2125
- }
2126
- ],
2127
- "description": "Update the player's customdata."
2128
- },
2129
- {
2130
- "operationCode": "SetDisplayName",
2131
- "details": [
2132
- {
2133
- "role": "Client",
2134
- "requestData": [
2135
- {
2136
- "code": "UserId",
2137
- "description": "The unique identifier of the player.",
2138
- "type": "string"
2139
- },
2140
- {
2141
- "code": "DisplayName",
2142
- "description": "DisplayName parameter.",
2143
- "type": "string"
2144
- },
2145
- {
2146
- "code": "UniqueDisplayName",
2147
- "description": "UniqueDisplayName parameter.",
2148
- "type": "boolean",
2149
- "defaultValue": "false"
2150
- }
2151
- ]
2152
- },
2153
- {
2154
- "role": "Server",
2155
- "requestData": [
2156
- {
2157
- "code": "UserId",
2158
- "description": "The unique identifier of the player.",
2159
- "type": "string"
2160
- }
2161
- ]
2162
- }
2163
- ],
2164
- "description": "Update the player's displayname."
2165
- },
2166
- {
2167
- "operationCode": "SetEmail",
2168
- "details": [
2169
- {
2170
- "role": "Client",
2171
- "requestData": [
2172
- {
2173
- "code": "UserId",
2174
- "description": "The unique identifier of the player.",
2175
- "type": "string"
2176
- },
2177
- {
2178
- "code": "Email",
2179
- "description": "Email address linked to the player's account.",
2180
- "type": "string"
2181
- }
2182
- ]
2183
- },
2184
- {
2185
- "role": "Server",
2186
- "requestData": [
2187
- {
2188
- "code": "UserId",
2189
- "description": "The unique identifier of the player.",
2190
- "type": "string"
2191
- }
2192
- ]
2193
- }
2194
- ],
2195
- "description": "Update the player's email."
2196
- },
2197
- {
2198
- "operationCode": "SetPlayerBan",
2199
- "details": [
2200
- {
2201
- "role": "Client",
2202
- "requestData": [
2203
- {
2204
- "code": "UserId",
2205
- "description": "The unique identifier of the player.",
2206
- "type": "string"
2207
- },
2208
- {
2209
- "code": "TsExpire",
2210
- "description": "TsExpire parameter.",
2211
- "type": "number"
2212
- },
2213
- {
2214
- "code": "Reason",
2215
- "description": "Reason parameter.",
2216
- "type": "string"
2217
- }
2218
- ]
2219
- },
2220
- {
2221
- "role": "Server",
2222
- "requestData": [
2223
- {
2224
- "code": "UserId",
2225
- "description": "The unique identifier of the player.",
2226
- "type": "string"
2227
- }
2228
- ]
2229
- }
2230
- ],
2231
- "description": "Update the player's playerban."
2232
- },
2233
- {
2234
- "operationCode": "SetPlayerData",
2235
- "details": [
2236
- {
2237
- "role": "Client",
2238
- "requestData": [
2239
- {
2240
- "code": "UserId",
2241
- "description": "The unique identifier of the player.",
2242
- "type": "string"
2243
- },
2244
- {
2245
- "code": "PlayerDatas",
2246
- "description": "PlayerDatas parameter.",
2247
- "type": "Array<PlayerDataParam>"
2248
- }
2249
- ]
2250
- },
2251
- {
2252
- "role": "Server",
2253
- "requestData": [
2254
- {
2255
- "code": "UserId",
2256
- "description": "The unique identifier of the player.",
2257
- "type": "string"
2258
- }
2259
- ]
2260
- }
2261
- ],
2262
- "description": "Set or update key-value pairs in the player's custom data store."
2263
- },
2264
- {
2265
- "operationCode": "SetTag",
2266
- "details": [
2267
- {
2268
- "role": "Client",
2269
- "requestData": [
2270
- {
2271
- "code": "UserId",
2272
- "description": "The unique identifier of the player.",
2273
- "type": "string"
2274
- },
2275
- {
2276
- "code": "Key",
2277
- "description": "The key associated with a custom player data entry.",
2278
- "type": "string"
2279
- },
2280
- {
2281
- "code": "Value",
2282
- "description": "The value to assign to the custom player data entry.",
2283
- "type": "string"
2284
- }
2285
- ]
2286
- },
2287
- {
2288
- "role": "Server",
2289
- "requestData": [
2290
- {
2291
- "code": "UserId",
2292
- "description": "The unique identifier of the player.",
2293
- "type": "string"
2294
- }
2295
- ]
2296
- }
2297
- ],
2298
- "description": "Update the player's tag."
2299
- },
2300
- {
2301
- "operationCode": "SetTsLastLogin",
2302
- "details": [
2303
- {
2304
- "role": "Client",
2305
- "requestData": [
2306
- {
2307
- "code": "UserId",
2308
- "description": "The unique identifier of the player.",
2309
- "type": "string"
2310
- }
2311
- ]
2312
- },
2313
- {
2314
- "role": "Server",
2315
- "requestData": [
2316
- {
2317
- "code": "UserId",
2318
- "description": "The unique identifier of the player.",
2319
- "type": "string"
2320
- }
2321
- ]
2322
- }
2323
- ],
2324
- "description": "Update the player's tslastlogin."
2325
- },
2326
- {
2327
- "operationCode": "UnlinkAccount",
2328
- "details": [
2329
- {
2330
- "role": "Client",
2331
- "requestData": [
2332
- {
2333
- "code": "UserId",
2334
- "description": "The unique identifier of the player.",
2335
- "type": "string"
2336
- },
2337
- {
2338
- "code": "Username",
2339
- "description": "Username parameter.",
2340
- "type": "string"
2341
- }
2342
- ]
2343
- },
2344
- {
2345
- "role": "Server",
2346
- "requestData": [
2347
- {
2348
- "code": "UserId",
2349
- "description": "The unique identifier of the player.",
2350
- "type": "string"
2351
- }
2352
- ]
2353
- }
2354
- ],
2355
- "description": "Unlink the player's account account."
2356
- },
2357
- {
2358
- "operationCode": "UnlinkAndroidDeviceId",
2359
- "details": [
2360
- {
2361
- "role": "Client",
2362
- "requestData": [
2363
- {
2364
- "code": "UserId",
2365
- "description": "The unique identifier of the player.",
2366
- "type": "string"
2367
- },
2368
- {
2369
- "code": "AndroidDeviceId",
2370
- "description": "The device-specific Android identifier.",
2371
- "type": "string"
2372
- }
2373
- ]
2374
- },
2375
- {
2376
- "role": "Server",
2377
- "requestData": [
2378
- {
2379
- "code": "UserId",
2380
- "description": "The unique identifier of the player.",
2381
- "type": "string"
2382
- }
2383
- ]
2384
- }
2385
- ],
2386
- "description": "Remove the association between the player's account and Android device ID."
2387
- },
2388
- {
2389
- "operationCode": "UnlinkApple",
2390
- "details": [
2391
- {
2392
- "role": "Client",
2393
- "requestData": [
2394
- {
2395
- "code": "UserId",
2396
- "description": "The unique identifier of the player.",
2397
- "type": "string"
2398
- },
2399
- {
2400
- "code": "AppleId",
2401
- "description": "The Apple Game Center ID.",
2402
- "type": "string"
2403
- }
2404
- ]
2405
- },
2406
- {
2407
- "role": "Server",
2408
- "requestData": [
2409
- {
2410
- "code": "UserId",
2411
- "description": "The unique identifier of the player.",
2412
- "type": "string"
2413
- }
2414
- ]
2415
- }
2416
- ],
2417
- "description": "Remove the link between the player's account and their Apple ID."
2418
- },
2419
- {
2420
- "operationCode": "UnlinkCustomDeviceId",
2421
- "details": [
2422
- {
2423
- "role": "Client",
2424
- "requestData": [
2425
- {
2426
- "code": "UserId",
2427
- "description": "The unique identifier of the player.",
2428
- "type": "string"
2429
- },
2430
- {
2431
- "code": "CustomDeviceId",
2432
- "description": "CustomDeviceId parameter.",
2433
- "type": "string"
2434
- }
2435
- ]
2436
- },
2437
- {
2438
- "role": "Server",
2439
- "requestData": [
2440
- {
2441
- "code": "UserId",
2442
- "description": "The unique identifier of the player.",
2443
- "type": "string"
2444
- }
2445
- ]
2446
- }
2447
- ],
2448
- "description": "Unlink the player's custom account."
2449
- },
2450
- {
2451
- "operationCode": "UnlinkCustomId",
2452
- "details": [
2453
- {
2454
- "role": "Client",
2455
- "requestData": [
2456
- {
2457
- "code": "UserId",
2458
- "description": "The unique identifier of the player.",
2459
- "type": "string"
2460
- },
2461
- {
2462
- "code": "CustomId",
2463
- "description": "A unique custom identifier used to link or authenticate the player.",
2464
- "type": "string"
2465
- }
2466
- ]
2467
- },
2468
- {
2469
- "role": "Server",
2470
- "requestData": [
2471
- {
2472
- "code": "UserId",
2473
- "description": "The unique identifier of the player.",
2474
- "type": "string"
2475
- }
2476
- ]
2477
- }
2478
- ],
2479
- "description": "Unlink a previously registered custom ID from the player's account."
2480
- },
2481
- {
2482
- "operationCode": "UnlinkEditorDeviceId",
2483
- "details": [
2484
- {
2485
- "role": "Client",
2486
- "requestData": [
2487
- {
2488
- "code": "UserId",
2489
- "description": "The unique identifier of the player.",
2490
- "type": "string"
2491
- },
2492
- {
2493
- "code": "EditorDeviceId",
2494
- "description": "EditorDeviceId parameter.",
2495
- "type": "string"
2496
- }
2497
- ]
2498
- },
2499
- {
2500
- "role": "Server",
2501
- "requestData": [
2502
- {
2503
- "code": "UserId",
2504
- "description": "The unique identifier of the player.",
2505
- "type": "string"
2506
- }
2507
- ]
2508
- }
2509
- ],
2510
- "description": "Unlink the player's editor account."
2511
- },
2512
- {
2513
- "operationCode": "UnlinkFacebook",
2514
- "details": [
2515
- {
2516
- "role": "Client",
2517
- "requestData": [
2518
- {
2519
- "code": "UserId",
2520
- "description": "The unique identifier of the player.",
2521
- "type": "string"
2522
- },
2523
- {
2524
- "code": "FacebookId",
2525
- "description": "The Facebook user ID.",
2526
- "type": "string"
2527
- }
2528
- ]
2529
- },
2530
- {
2531
- "role": "Server",
2532
- "requestData": [
2533
- {
2534
- "code": "UserId",
2535
- "description": "The unique identifier of the player.",
2536
- "type": "string"
2537
- }
2538
- ]
2539
- }
2540
- ],
2541
- "description": "Unlink the player's Facebook profile from their account."
2542
- },
2543
- {
2544
- "operationCode": "UnlinkGameCenter",
2545
- "details": [
2546
- {
2547
- "role": "Client",
2548
- "requestData": [
2549
- {
2550
- "code": "UserId",
2551
- "description": "The unique identifier of the player.",
2552
- "type": "string"
2553
- },
2554
- {
2555
- "code": "PlayerId",
2556
- "description": "PlayerId parameter.",
2557
- "type": "string"
2558
- }
2559
- ]
2560
- },
2561
- {
2562
- "role": "Server",
2563
- "requestData": [
2564
- {
2565
- "code": "UserId",
2566
- "description": "The unique identifier of the player.",
2567
- "type": "string"
2568
- }
2569
- ]
2570
- }
2571
- ],
2572
- "description": "Unlink the player's gamecenter account."
2573
- },
2574
- {
2575
- "operationCode": "UnlinkGenericService",
2576
- "details": [
2577
- {
2578
- "role": "Client",
2579
- "requestData": [
2580
- {
2581
- "code": "UserId",
2582
- "description": "The unique identifier of the player.",
2583
- "type": "string"
2584
- },
2585
- {
2586
- "code": "ServiceName",
2587
- "description": "ServiceName parameter.",
2588
- "type": "string"
2589
- },
2590
- {
2591
- "code": "ServiceId",
2592
- "description": "ServiceId parameter.",
2593
- "type": "string"
2594
- }
2595
- ]
2596
- },
2597
- {
2598
- "role": "Server",
2599
- "requestData": [
2600
- {
2601
- "code": "UserId",
2602
- "description": "The unique identifier of the player.",
2603
- "type": "string"
2604
- }
2605
- ]
2606
- }
2607
- ],
2608
- "description": "Unlink the player's genericservice account."
2609
- },
2610
- {
2611
- "operationCode": "UnlinkGooglePlayGameService",
2612
- "details": [
2613
- {
2614
- "role": "Client",
2615
- "requestData": [
2616
- {
2617
- "code": "UserId",
2618
- "description": "The unique identifier of the player.",
2619
- "type": "string"
2620
- },
2621
- {
2622
- "code": "PlayerId",
2623
- "description": "PlayerId parameter.",
2624
- "type": "string"
2625
- }
2626
- ]
2627
- },
2628
- {
2629
- "role": "Server",
2630
- "requestData": [
2631
- {
2632
- "code": "UserId",
2633
- "description": "The unique identifier of the player.",
2634
- "type": "string"
2635
- }
2636
- ]
2637
- }
2638
- ],
2639
- "description": "Unlink the player's account from Google Play Game Services."
2640
- },
2641
- {
2642
- "operationCode": "UnlinkGoogle",
2643
- "details": [
2644
- {
2645
- "role": "Client",
2646
- "requestData": [
2647
- {
2648
- "code": "UserId",
2649
- "description": "The unique identifier of the player.",
2650
- "type": "string"
2651
- },
2652
- {
2653
- "code": "GoogleId",
2654
- "description": "The Google account ID.",
2655
- "type": "string"
2656
- }
2657
- ]
2658
- },
2659
- {
2660
- "role": "Server",
2661
- "requestData": [
2662
- {
2663
- "code": "UserId",
2664
- "description": "The unique identifier of the player.",
2665
- "type": "string"
2666
- }
2667
- ]
2668
- }
2669
- ],
2670
- "description": "Unlink the player's Google account from their profile."
2671
- },
2672
- {
2673
- "operationCode": "UnlinkiOSDeviceId",
2674
- "details": [
2675
- {
2676
- "role": "Client",
2677
- "requestData": [
2678
- {
2679
- "code": "UserId",
2680
- "description": "The unique identifier of the player.",
2681
- "type": "string"
2682
- },
2683
- {
2684
- "code": "iOSDeviceId",
2685
- "description": "iOSDeviceId parameter.",
2686
- "type": "string"
2687
- }
2688
- ]
2689
- },
2690
- {
2691
- "role": "Server",
2692
- "requestData": [
2693
- {
2694
- "code": "UserId",
2695
- "description": "The unique identifier of the player.",
2696
- "type": "string"
2697
- }
2698
- ]
2699
- }
2700
- ],
2701
- "description": "Unlink the player's ios account."
2702
- },
2703
- {
2704
- "operationCode": "UnlinkLinuxDeviceId",
2705
- "details": [
2706
- {
2707
- "role": "Client",
2708
- "requestData": [
2709
- {
2710
- "code": "UserId",
2711
- "description": "The unique identifier of the player.",
2712
- "type": "string"
2713
- },
2714
- {
2715
- "code": "LinuxDeviceId",
2716
- "description": "LinuxDeviceId parameter.",
2717
- "type": "string"
2718
- }
2719
- ]
2720
- },
2721
- {
2722
- "role": "Server",
2723
- "requestData": [
2724
- {
2725
- "code": "UserId",
2726
- "description": "The unique identifier of the player.",
2727
- "type": "string"
2728
- }
2729
- ]
2730
- }
2731
- ],
2732
- "description": "Unlink the player's linux account."
2733
- },
2734
- {
2735
- "operationCode": "UnlinkMacOSDeviceId",
2736
- "details": [
2737
- {
2738
- "role": "Client",
2739
- "requestData": [
2740
- {
2741
- "code": "UserId",
2742
- "description": "The unique identifier of the player.",
2743
- "type": "string"
2744
- },
2745
- {
2746
- "code": "MacOSDeviceId",
2747
- "description": "MacOSDeviceId parameter.",
2748
- "type": "string"
2749
- }
2750
- ]
2751
- },
2752
- {
2753
- "role": "Server",
2754
- "requestData": [
2755
- {
2756
- "code": "UserId",
2757
- "description": "The unique identifier of the player.",
2758
- "type": "string"
2759
- }
2760
- ]
2761
- }
2762
- ],
2763
- "description": "Unlink the player's macos account."
2764
- },
2765
- {
2766
- "operationCode": "UnlinkWindowsDeviceId",
2767
- "details": [
2768
- {
2769
- "role": "Client",
2770
- "requestData": [
2771
- {
2772
- "code": "UserId",
2773
- "description": "The unique identifier of the player.",
2774
- "type": "string"
2775
- },
2776
- {
2777
- "code": "WindowsDeviceId",
2778
- "description": "WindowsDeviceId parameter.",
2779
- "type": "string"
2780
- }
2781
- ]
2782
- },
2783
- {
2784
- "role": "Server",
2785
- "requestData": [
2786
- {
2787
- "code": "UserId",
2788
- "description": "The unique identifier of the player.",
2789
- "type": "string"
2790
- }
2791
- ]
2792
- }
2793
- ],
2794
- "description": "Unlink the player's windows account."
2795
- },
2796
- {
2797
- "operationCode": "UnlinkWindowsPhoneDeviceId",
2798
- "details": [
2799
- {
2800
- "role": "Client",
2801
- "requestData": [
2802
- {
2803
- "code": "UserId",
2804
- "description": "The unique identifier of the player.",
2805
- "type": "string"
2806
- },
2807
- {
2808
- "code": "WindowsPhoneDeviceId",
2809
- "description": "WindowsPhoneDeviceId parameter.",
2810
- "type": "string"
2811
- }
2812
- ]
2813
- },
2814
- {
2815
- "role": "Server",
2816
- "requestData": [
2817
- {
2818
- "code": "UserId",
2819
- "description": "The unique identifier of the player.",
2820
- "type": "string"
2821
- }
2822
- ]
2823
- }
2824
- ],
2825
- "description": "Unlink the player's windowsphone account."
2826
- }
2827
- ],
2828
- "models": [
2829
- {
2830
- "name": "CustomDataParam",
2831
- "details": [
2832
- {
2833
- "code": "Key",
2834
- "description": "The key name in a key-value data pair.",
2835
- "type": "string"
2836
- },
2837
- {
2838
- "code": "Value",
2839
- "description": "The value assigned to a data key or statistic.",
2840
- "type": "any"
2841
- }
2842
- ],
2843
- "description": "Parameter object used to control behavior or filters in API calls."
2844
- },
2845
- {
2846
- "name": "InfoRequestParam",
2847
- "details": [
2848
- {
2849
- "code": "External",
2850
- "description": "Indicates whether the player is external to the current environment.",
2851
- "type": "boolean",
2852
- "defaultValue": "false"
2853
- },
2854
- {
2855
- "code": "Segments",
2856
- "description": "Timestamp when the event occurred.",
2857
- "type": "boolean",
2858
- "defaultValue": "false"
2859
- },
2860
- {
2861
- "code": "CustomDatas",
2862
- "description": "Custom key-value data defined by the game or system.",
2863
- "type": "boolean",
2864
- "defaultValue": "false"
2865
- },
2866
- {
2867
- "code": "DisplayName",
2868
- "description": "The public-facing name of the player.",
2869
- "type": "boolean",
2870
- "defaultValue": "false"
2871
- },
2872
- {
2873
- "code": "Avatar",
2874
- "description": "URL or identifier of the player's avatar image.",
2875
- "type": "boolean",
2876
- "defaultValue": "false"
2877
- },
2878
- {
2879
- "code": "TsCreate",
2880
- "description": "Timestamp when the event occurred.",
2881
- "type": "boolean",
2882
- "defaultValue": "false"
2883
- },
2884
- {
2885
- "code": "Tags",
2886
- "description": "Tag label used to group or filter the player.",
2887
- "type": "boolean",
2888
- "defaultValue": "false"
2889
- },
2890
- {
2891
- "code": "PlayerBan",
2892
- "description": "Information about whether the player is currently banned.",
2893
- "type": "boolean",
2894
- "defaultValue": "false"
2895
- },
2896
- {
2897
- "code": "PlayerCurrencies",
2898
- "description": "List of all virtual currencies and their balances.",
2899
- "type": "boolean",
2900
- "defaultValue": "false"
2901
- },
2902
- {
2903
- "code": "PlayerStatistics",
2904
- "description": "Name or value of the player's statistic.",
2905
- "type": "boolean",
2906
- "defaultValue": "false"
2907
- },
2908
- {
2909
- "code": "PlayerDatas",
2910
- "description": "Key-value metadata stored in the player's profile.",
2911
- "type": "boolean",
2912
- "defaultValue": "false"
2913
- },
2914
- {
2915
- "code": "IpAddressCreate",
2916
- "description": "IP address from which the player first registered.",
2917
- "type": "boolean",
2918
- "defaultValue": "false"
2919
- },
2920
- {
2921
- "code": "CountryCode",
2922
- "description": "Country associated with the player's IP or settings.",
2923
- "type": "boolean",
2924
- "defaultValue": "false"
2925
- },
2926
- {
2927
- "code": "Email",
2928
- "description": "The email address associated with the player's account.",
2929
- "type": "boolean",
2930
- "defaultValue": "false"
2931
- },
2932
- {
2933
- "code": "TsLastLogin",
2934
- "description": "Timestamp when the event occurred.",
2935
- "type": "boolean",
2936
- "defaultValue": "false"
2937
- },
2938
- {
2939
- "code": "PushNotifications",
2940
- "description": "PushNotifications used in InfoRequestParam.",
2941
- "type": "boolean",
2942
- "defaultValue": "false"
2943
- },
2944
- {
2945
- "code": "PlayerDataKeys",
2946
- "description": "The key name in a key-value data pair.",
2947
- "type": "Array<string>"
2948
- },
2949
- {
2950
- "code": "PlayerCurrencyKeys",
2951
- "description": "The key name in a key-value data pair.",
2952
- "type": "Array<string>"
2953
- },
2954
- {
2955
- "code": "PlayerStatisticsKeys",
2956
- "description": "The key name in a key-value data pair.",
2957
- "type": "Array<string>"
2958
- },
2959
- {
2960
- "code": "CustomDataKeys",
2961
- "description": "The key name in a key-value data pair.",
2962
- "type": "Array<string>"
2963
- },
2964
- {
2965
- "code": "TagKeys",
2966
- "description": "The key name in a key-value data pair.",
2967
- "type": "Array<string>"
2968
- }
2969
- ],
2970
- "description": "Parameter object used to control behavior or filters in API calls."
2971
- },
2972
- {
2973
- "name": "PlayerCurrencyParam",
2974
- "details": [
2975
- {
2976
- "code": "Key",
2977
- "description": "The key name in a key-value data pair.",
2978
- "type": "string"
2979
- },
2980
- {
2981
- "code": "Amount",
2982
- "description": "Amount used in PlayerCurrencyParam.",
2983
- "type": "number"
2984
- }
2985
- ],
2986
- "description": "Parameter object used to control behavior or filters in API calls."
2987
- },
2988
- {
2989
- "name": "PlayerDataParam",
2990
- "details": [
2991
- {
2992
- "code": "Key",
2993
- "description": "The key name in a key-value data pair.",
2994
- "type": "string"
2995
- },
2996
- {
2997
- "code": "Value",
2998
- "description": "The value assigned to a data key or statistic.",
2999
- "type": "any"
3000
- }
3001
- ],
3002
- "description": "Parameter object used to control behavior or filters in API calls."
3003
- },
3004
- {
3005
- "name": "PlayerStatisticsParam",
3006
- "details": [
3007
- {
3008
- "code": "Key",
3009
- "description": "The key name in a key-value data pair.",
3010
- "type": "string"
3011
- },
3012
- {
3013
- "code": "Value",
3014
- "description": "The value assigned to a data key or statistic.",
3015
- "type": "number"
3016
- }
3017
- ],
3018
- "description": "Parameter object used to control behavior or filters in API calls."
3019
- },
3020
- {
3021
- "name": "GenericService",
3022
- "details": [
3023
- {
3024
- "code": "ServiceName",
3025
- "description": "ServiceName used in GenericService.",
3026
- "type": "string"
3027
- },
3028
- {
3029
- "code": "ServiceId",
3030
- "description": "ServiceId used in GenericService.",
3031
- "type": "string"
3032
- }
3033
- ],
3034
- "extends": null,
3035
- "description": "Data structure: GenericService."
3036
- },
3037
- {
3038
- "name": "Device",
3039
- "details": [
3040
- {
3041
- "code": "CustomDeviceId",
3042
- "description": "CustomDeviceId used in Device.",
3043
- "type": "string"
3044
- },
3045
- {
3046
- "code": "AndroidDeviceId",
3047
- "description": "AndroidDeviceId used in Device.",
3048
- "type": "string"
3049
- },
3050
- {
3051
- "code": "iOSDeviceId",
3052
- "description": "iOSDeviceId used in Device.",
3053
- "type": "string"
3054
- },
3055
- {
3056
- "code": "WindowsPhoneDeviceId",
3057
- "description": "WindowsPhoneDeviceId used in Device.",
3058
- "type": "string"
3059
- },
3060
- {
3061
- "code": "WindowsDeviceId",
3062
- "description": "WindowsDeviceId used in Device.",
3063
- "type": "string"
3064
- },
3065
- {
3066
- "code": "LinuxDeviceId",
3067
- "description": "LinuxDeviceId used in Device.",
3068
- "type": "string"
3069
- },
3070
- {
3071
- "code": "MacOSDeviceId",
3072
- "description": "MacOSDeviceId used in Device.",
3073
- "type": "string"
3074
- },
3075
- {
3076
- "code": "EditorDeviceId",
3077
- "description": "EditorDeviceId used in Device.",
3078
- "type": "string"
3079
- }
3080
- ],
3081
- "extends": null,
3082
- "description": "Data structure: Device."
3083
- },
3084
- {
3085
- "name": "Account",
3086
- "details": [
3087
- {
3088
- "code": "Username",
3089
- "description": "Username used in Account.",
3090
- "type": "string"
3091
- }
3092
- ],
3093
- "extends": null,
3094
- "description": "Data structure: Account."
3095
- },
3096
- {
3097
- "name": "Custom",
3098
- "details": [
3099
- {
3100
- "code": "CustomId",
3101
- "description": "CustomId used in Custom.",
3102
- "type": "string"
3103
- }
3104
- ],
3105
- "extends": null,
3106
- "description": "Data structure: Custom."
3107
- },
3108
- {
3109
- "name": "Apple",
3110
- "details": [
3111
- {
3112
- "code": "AppleId",
3113
- "description": "AppleId used in Apple.",
3114
- "type": "string"
3115
- },
3116
- {
3117
- "code": "Email",
3118
- "description": "The email address associated with the player's account.",
3119
- "type": "string"
3120
- }
3121
- ],
3122
- "extends": null,
3123
- "description": "Data structure: Apple."
3124
- },
3125
- {
3126
- "name": "Google",
3127
- "details": [
3128
- {
3129
- "code": "GoogleId",
3130
- "description": "GoogleId used in Google.",
3131
- "type": "string"
3132
- },
3133
- {
3134
- "code": "DisplayName",
3135
- "description": "The public-facing name of the player.",
3136
- "type": "string"
3137
- },
3138
- {
3139
- "code": "Email",
3140
- "description": "The email address associated with the player's account.",
3141
- "type": "string"
3142
- }
3143
- ],
3144
- "extends": null,
3145
- "description": "Data structure: Google."
3146
- },
3147
- {
3148
- "name": "Facebook",
3149
- "details": [
3150
- {
3151
- "code": "FacebookId",
3152
- "description": "FacebookId used in Facebook.",
3153
- "type": "string"
3154
- },
3155
- {
3156
- "code": "DisplayName",
3157
- "description": "The public-facing name of the player.",
3158
- "type": "string"
3159
- },
3160
- {
3161
- "code": "Email",
3162
- "description": "The email address associated with the player's account.",
3163
- "type": "string"
3164
- }
3165
- ],
3166
- "extends": null,
3167
- "description": "Data structure: Facebook."
3168
- },
3169
- {
3170
- "name": "GooglePlayGameService",
3171
- "details": [
3172
- {
3173
- "code": "PlayerId",
3174
- "description": "PlayerId used in GooglePlayGameService.",
3175
- "type": "string"
3176
- },
3177
- {
3178
- "code": "DisplayName",
3179
- "description": "The public-facing name of the player.",
3180
- "type": "string"
3181
- },
3182
- {
3183
- "code": "Email",
3184
- "description": "The email address associated with the player's account.",
3185
- "type": "string"
3186
- }
3187
- ],
3188
- "extends": null,
3189
- "description": "Data structure: GooglePlayGameService."
3190
- },
3191
- {
3192
- "name": "GameCenter",
3193
- "details": [
3194
- {
3195
- "code": "PlayerId",
3196
- "description": "PlayerId used in GameCenter.",
3197
- "type": "string"
3198
- },
3199
- {
3200
- "code": "DisplayName",
3201
- "description": "The public-facing name of the player.",
3202
- "type": "string"
3203
- },
3204
- {
3205
- "code": "Email",
3206
- "description": "The email address associated with the player's account.",
3207
- "type": "string"
3208
- }
3209
- ],
3210
- "extends": null,
3211
- "description": "Data structure: GameCenter."
3212
- },
3213
- {
3214
- "name": "ExternalItem",
3215
- "details": [
3216
- {
3217
- "code": "Device",
3218
- "description": "Device used in ExternalItem.",
3219
- "type": "Device"
3220
- },
3221
- {
3222
- "code": "Account",
3223
- "description": "Account used in ExternalItem.",
3224
- "type": "Account"
3225
- },
3226
- {
3227
- "code": "Custom",
3228
- "description": "Custom used in ExternalItem.",
3229
- "type": "Custom"
3230
- },
3231
- {
3232
- "code": "Apple",
3233
- "description": "Apple used in ExternalItem.",
3234
- "type": "Apple"
3235
- },
3236
- {
3237
- "code": "Google",
3238
- "description": "Google used in ExternalItem.",
3239
- "type": "Google"
3240
- },
3241
- {
3242
- "code": "Facebook",
3243
- "description": "Facebook used in ExternalItem.",
3244
- "type": "Facebook"
3245
- },
3246
- {
3247
- "code": "GenericService",
3248
- "description": "GenericService used in ExternalItem.",
3249
- "type": "Array<GenericService>"
3250
- },
3251
- {
3252
- "code": "GooglePlayGameService",
3253
- "description": "GooglePlayGameService used in ExternalItem.",
3254
- "type": "GooglePlayGameService"
3255
- },
3256
- {
3257
- "code": "GameCenter",
3258
- "description": "GameCenter used in ExternalItem.",
3259
- "type": "GameCenter"
3260
- }
3261
- ],
3262
- "extends": null,
3263
- "description": "Represents a single unit of data related to the player."
3264
- },
3265
- {
3266
- "name": "PushNotificationItem",
3267
- "details": [
3268
- {
3269
- "code": "Token",
3270
- "description": "Token used in PushNotificationItem.",
3271
- "type": "string"
3272
- },
3273
- {
3274
- "code": "PushId",
3275
- "description": "Identifier for the registered push notification device.",
3276
- "type": "string"
3277
- },
3278
- {
3279
- "code": "PlatformType",
3280
- "description": "PlatformType used in PushNotificationItem.",
3281
- "type": "number"
3282
- }
3283
- ],
3284
- "extends": null,
3285
- "description": "Represents a single unit of data related to the player."
3286
- },
3287
- {
3288
- "name": "InfoResponseParameters",
3289
- "details": [
3290
- {
3291
- "code": "External",
3292
- "description": "Indicates whether the player is external to the current environment.",
3293
- "type": "ExternalItem"
3294
- },
3295
- {
3296
- "code": "Segments",
3297
- "description": "Timestamp when the event occurred.",
3298
- "type": "Array<string>"
3299
- },
3300
- {
3301
- "code": "CustomDatas",
3302
- "description": "Custom key-value data defined by the game or system.",
3303
- "type": "Array<GenericModels.DataItem>"
3304
- },
3305
- {
3306
- "code": "DisplayName",
3307
- "description": "The public-facing name of the player.",
3308
- "type": "string"
3309
- },
3310
- {
3311
- "code": "Avatar",
3312
- "description": "URL or identifier of the player's avatar image.",
3313
- "type": "GenericModels.AvatarItem"
3314
- },
3315
- {
3316
- "code": "TsCreate",
3317
- "description": "Timestamp when the event occurred.",
3318
- "type": "number"
3319
- },
3320
- {
3321
- "code": "Tags",
3322
- "description": "Tag label used to group or filter the player.",
3323
- "type": "Array<GenericModels.TagItem>"
3324
- },
3325
- {
3326
- "code": "PlayerBan",
3327
- "description": "Information about whether the player is currently banned.",
3328
- "type": "GenericModels.BanItem"
3329
- },
3330
- {
3331
- "code": "PlayerDatas",
3332
- "description": "Key-value metadata stored in the player's profile.",
3333
- "type": "Array<GenericModels.DataItem>"
3334
- },
3335
- {
3336
- "code": "PlayerCurrencies",
3337
- "description": "List of all virtual currencies and their balances.",
3338
- "type": "Array<GenericModels.CurrencyItem>"
3339
- },
3340
- {
3341
- "code": "PlayerStatistics",
3342
- "description": "Name or value of the player's statistic.",
3343
- "type": "Array<GenericModels.StatisticsItem>"
3344
- },
3345
- {
3346
- "code": "TsLastLogin",
3347
- "description": "Timestamp when the event occurred.",
3348
- "type": "number"
3349
- },
3350
- {
3351
- "code": "IpAddressCreate",
3352
- "description": "IP address from which the player first registered.",
3353
- "type": "string"
3354
- },
3355
- {
3356
- "code": "CountryCode",
3357
- "description": "Country associated with the player's IP or settings.",
3358
- "type": "string"
3359
- },
3360
- {
3361
- "code": "Email",
3362
- "description": "The email address associated with the player's account.",
3363
- "type": "string"
3364
- },
3365
- {
3366
- "code": "PushNotifications",
3367
- "description": "PushNotifications used in InfoResponseParameters.",
3368
- "type": "Array<MasterPlayerModels.PushNotificationItem>"
3369
- }
3370
- ],
3371
- "extends": null,
3372
- "description": "Parameter object used to control behavior or filters in API calls."
3373
- },
3374
- {
3375
- "name": "MasterPlayerResponseData",
3376
- "details": [
3377
- {
3378
- "code": "InfoResponseParameters",
3379
- "description": "InfoResponseParameters used in MasterPlayerResponseData.",
3380
- "type": "InfoResponseParameters"
3381
- }
3382
- ],
3383
- "extends": null,
3384
- "description": "Structured data returned by the corresponding API operation."
3385
- },
3386
- {
3387
- "name": "GenericServiceMasterPlayerResponseData",
3388
- "details": [
3389
- {
3390
- "code": "ErrorMessage",
3391
- "description": "ErrorMessage used in GenericServiceMasterPlayerResponseData.",
3392
- "type": "string"
3393
- },
3394
- {
3395
- "code": "InfoResponseParameters",
3396
- "description": "InfoResponseParameters used in GenericServiceMasterPlayerResponseData.",
3397
- "type": "InfoResponseParameters"
3398
- }
3399
- ],
3400
- "extends": null,
3401
- "description": "Structured data returned by the corresponding API operation."
3402
- },
3403
- {
3404
- "name": "MasterPlayerWithUserIdResponseData",
3405
- "details": [
3406
- {
3407
- "code": "UserId",
3408
- "description": "Unique identifier of the player.",
3409
- "type": "string"
3410
- },
3411
- {
3412
- "code": "InfoResponseParameters",
3413
- "description": "InfoResponseParameters used in MasterPlayerWithUserIdResponseData.",
3414
- "type": "InfoResponseParameters"
3415
- }
3416
- ],
3417
- "extends": null,
3418
- "description": "Structured data returned by the corresponding API operation."
3419
- },
3420
- {
3421
- "name": "MasterPlayerWithAppleIdResponseData",
3422
- "details": [
3423
- {
3424
- "code": "AppleId",
3425
- "description": "AppleId used in MasterPlayerWithAppleIdResponseData.",
3426
- "type": "string"
3427
- },
3428
- {
3429
- "code": "UserId",
3430
- "description": "Unique identifier of the player.",
3431
- "type": "string"
3432
- },
3433
- {
3434
- "code": "InfoResponseParameters",
3435
- "description": "InfoResponseParameters used in MasterPlayerWithAppleIdResponseData.",
3436
- "type": "InfoResponseParameters"
3437
- }
3438
- ],
3439
- "extends": null,
3440
- "description": "Structured data returned by the corresponding API operation."
3441
- },
3442
- {
3443
- "name": "GetPlayersWithAppleResponseData",
3444
- "details": [
3445
- {
3446
- "code": "Results",
3447
- "description": "Timestamp when the event occurred.",
3448
- "type": "Array<MasterPlayerWithAppleIdResponseData>"
3449
- }
3450
- ],
3451
- "extends": null,
3452
- "description": "Structured data returned by the corresponding API operation."
3453
- },
3454
- {
3455
- "name": "MasterPlayersWithUserIdResponseData",
3456
- "details": [
3457
- {
3458
- "code": "Results",
3459
- "description": "Timestamp when the event occurred.",
3460
- "type": "Array<MasterPlayerWithUserIdResponseData>"
3461
- }
3462
- ],
3463
- "extends": null,
3464
- "description": "Structured data returned by the corresponding API operation."
3465
- },
3466
- {
3467
- "name": "MasterPlayerWithFacebookIdResponseData",
3468
- "details": [
3469
- {
3470
- "code": "FacebookId",
3471
- "description": "FacebookId used in MasterPlayerWithFacebookIdResponseData.",
3472
- "type": "string"
3473
- },
3474
- {
3475
- "code": "UserId",
3476
- "description": "Unique identifier of the player.",
3477
- "type": "string"
3478
- },
3479
- {
3480
- "code": "InfoResponseParameters",
3481
- "description": "InfoResponseParameters used in MasterPlayerWithFacebookIdResponseData.",
3482
- "type": "InfoResponseParameters"
3483
- }
3484
- ],
3485
- "extends": null,
3486
- "description": "Structured data returned by the corresponding API operation."
3487
- },
3488
- {
3489
- "name": "GetPlayersWithFacebookResponseData",
3490
- "details": [
3491
- {
3492
- "code": "Results",
3493
- "description": "Timestamp when the event occurred.",
3494
- "type": "Array<MasterPlayerWithFacebookIdResponseData>"
3495
- }
3496
- ],
3497
- "extends": null,
3498
- "description": "Structured data returned by the corresponding API operation."
3499
- },
3500
- {
3501
- "name": "MasterPlayerWithGenericServiceIdResponseData",
3502
- "details": [
3503
- {
3504
- "code": "ServiceId",
3505
- "description": "ServiceId used in MasterPlayerWithGenericServiceIdResponseData.",
3506
- "type": "string"
3507
- },
3508
- {
3509
- "code": "UserId",
3510
- "description": "Unique identifier of the player.",
3511
- "type": "string"
3512
- },
3513
- {
3514
- "code": "InfoResponseParameters",
3515
- "description": "InfoResponseParameters used in MasterPlayerWithGenericServiceIdResponseData.",
3516
- "type": "InfoResponseParameters"
3517
- }
3518
- ],
3519
- "extends": null,
3520
- "description": "Structured data returned by the corresponding API operation."
3521
- },
3522
- {
3523
- "name": "GetPlayersWithGenericServiceResponseData",
3524
- "details": [
3525
- {
3526
- "code": "Results",
3527
- "description": "Timestamp when the event occurred.",
3528
- "type": "Array<MasterPlayerWithGenericServiceIdResponseData>"
3529
- }
3530
- ],
3531
- "extends": null,
3532
- "description": "Structured data returned by the corresponding API operation."
3533
- },
3534
- {
3535
- "name": "MasterPlayerWithGoogleIdResponseData",
3536
- "details": [
3537
- {
3538
- "code": "GoogleId",
3539
- "description": "GoogleId used in MasterPlayerWithGoogleIdResponseData.",
3540
- "type": "string"
3541
- },
3542
- {
3543
- "code": "UserId",
3544
- "description": "Unique identifier of the player.",
3545
- "type": "string"
3546
- },
3547
- {
3548
- "code": "InfoResponseParameters",
3549
- "description": "InfoResponseParameters used in MasterPlayerWithGoogleIdResponseData.",
3550
- "type": "InfoResponseParameters"
3551
- }
3552
- ],
3553
- "extends": null,
3554
- "description": "Structured data returned by the corresponding API operation."
3555
- },
3556
- {
3557
- "name": "GetPlayersWithGoogleResponseData",
3558
- "details": [
3559
- {
3560
- "code": "Results",
3561
- "description": "Timestamp when the event occurred.",
3562
- "type": "Array<MasterPlayerWithGoogleIdResponseData>"
3563
- }
3564
- ],
3565
- "extends": null,
3566
- "description": "Structured data returned by the corresponding API operation."
3567
- },
3568
- {
3569
- "name": "MasterPlayerWithPlayerIdResponseData",
3570
- "details": [
3571
- {
3572
- "code": "PlayerId",
3573
- "description": "PlayerId used in MasterPlayerWithPlayerIdResponseData.",
3574
- "type": "string"
3575
- },
3576
- {
3577
- "code": "UserId",
3578
- "description": "Unique identifier of the player.",
3579
- "type": "string"
3580
- },
3581
- {
3582
- "code": "InfoResponseParameters",
3583
- "description": "InfoResponseParameters used in MasterPlayerWithPlayerIdResponseData.",
3584
- "type": "InfoResponseParameters"
3585
- }
3586
- ],
3587
- "extends": null,
3588
- "description": "Structured data returned by the corresponding API operation."
3589
- },
3590
- {
3591
- "name": "GetPlayersWithGooglePlayGameServiceResponseData",
3592
- "details": [
3593
- {
3594
- "code": "Results",
3595
- "description": "Timestamp when the event occurred.",
3596
- "type": "Array<MasterPlayerWithPlayerIdResponseData>"
3597
- }
3598
- ],
3599
- "extends": null,
3600
- "description": "Structured data returned by the corresponding API operation."
3601
- },
3602
- {
3603
- "name": "GetPlayersWithGameCenterResponseData",
3604
- "details": [
3605
- {
3606
- "code": "Results",
3607
- "description": "Timestamp when the event occurred.",
3608
- "type": "Array<MasterPlayerWithPlayerIdResponseData>"
3609
- }
3610
- ],
3611
- "extends": null,
3612
- "description": "Structured data returned by the corresponding API operation."
3613
- },
3614
- {
3615
- "name": "MasterPlayerLeaderboardResponseData",
3616
- "details": [
3617
- {
3618
- "code": "Position",
3619
- "description": "Position used in MasterPlayerLeaderboardResponseData.",
3620
- "type": "number"
3621
- },
3622
- {
3623
- "code": "BackupValue",
3624
- "description": "The value assigned to a data key or statistic.",
3625
- "type": "number"
3626
- },
3627
- {
3628
- "code": "UserId",
3629
- "description": "Unique identifier of the player.",
3630
- "type": "string"
3631
- },
3632
- {
3633
- "code": "InfoResponseParameters",
3634
- "description": "InfoResponseParameters used in MasterPlayerLeaderboardResponseData.",
3635
- "type": "InfoResponseParameters"
3636
- }
3637
- ],
3638
- "extends": null,
3639
- "description": "Structured data returned by the corresponding API operation."
3640
- },
3641
- {
3642
- "name": "MasterPlayerLogResponseData",
3643
- "details": [
3644
- {
3645
- "code": "UserId",
3646
- "description": "Unique identifier of the player.",
3647
- "type": "string"
3648
- },
3649
- {
3650
- "code": "TsCreate",
3651
- "description": "Timestamp when the event occurred.",
3652
- "type": "number"
3653
- },
3654
- {
3655
- "code": "Log",
3656
- "description": "Log used in MasterPlayerLogResponseData.",
3657
- "type": "string"
3658
- },
3659
- {
3660
- "code": "Key",
3661
- "description": "The key name in a key-value data pair.",
3662
- "type": "string"
3663
- },
3664
- {
3665
- "code": "Amount",
3666
- "description": "Amount used in MasterPlayerLogResponseData.",
3667
- "type": "number"
3668
- },
3669
- {
3670
- "code": "StartValue",
3671
- "description": "The value assigned to a data key or statistic.",
3672
- "type": "number"
3673
- },
3674
- {
3675
- "code": "FinalValue",
3676
- "description": "The value assigned to a data key or statistic.",
3677
- "type": "number"
3678
- }
3679
- ],
3680
- "extends": null,
3681
- "description": "Structured data returned by the corresponding API operation."
3682
- },
3683
- {
3684
- "name": "GetStatisticsLeaderboardResponseData",
3685
- "details": [
3686
- {
3687
- "code": "Results",
3688
- "description": "Timestamp when the event occurred.",
3689
- "type": "Array<MasterPlayerLeaderboardResponseData>"
3690
- },
3691
- {
3692
- "code": "TsCreate",
3693
- "description": "Timestamp when the event occurred.",
3694
- "type": "number"
3695
- }
3696
- ],
3697
- "extends": null,
3698
- "description": "Structured data returned by the corresponding API operation."
3699
- },
3700
- {
3701
- "name": "GetCurrencyLeaderboardResponseData",
3702
- "details": [
3703
- {
3704
- "code": "Results",
3705
- "description": "Timestamp when the event occurred.",
3706
- "type": "Array<MasterPlayerLeaderboardResponseData>"
3707
- }
3708
- ],
3709
- "extends": null,
3710
- "description": "Structured data returned by the corresponding API operation."
3711
- },
3712
- {
3713
- "name": "GetCreateLeaderboardResponseData",
3714
- "details": [
3715
- {
3716
- "code": "Results",
3717
- "description": "Timestamp when the event occurred.",
3718
- "type": "Array<MasterPlayerLeaderboardResponseData>"
3719
- }
3720
- ],
3721
- "extends": null,
3722
- "description": "Structured data returned by the corresponding API operation."
3723
- },
3724
- {
3725
- "name": "GetLastLoginLeaderboardResponseData",
3726
- "details": [
3727
- {
3728
- "code": "Results",
3729
- "description": "Timestamp when the event occurred.",
3730
- "type": "Array<MasterPlayerLeaderboardResponseData>"
3731
- }
3732
- ],
3733
- "extends": null,
3734
- "description": "Structured data returned by the corresponding API operation."
3735
- },
3736
- {
3737
- "name": "GetStatisticsLogResponseData",
3738
- "details": [
3739
- {
3740
- "code": "Results",
3741
- "description": "Timestamp when the event occurred.",
3742
- "type": "Array<MasterPlayerLogResponseData>"
3743
- },
3744
- {
3745
- "code": "Token",
3746
- "description": "Token used in GetStatisticsLogResponseData.",
3747
- "type": "string"
3748
- }
3749
- ],
3750
- "extends": null,
3751
- "description": "Structured data returned by the corresponding API operation."
3752
- },
3753
- {
3754
- "name": "GetCurrencyLogResponseData",
3755
- "details": [
3756
- {
3757
- "code": "Results",
3758
- "description": "Timestamp when the event occurred.",
3759
- "type": "Array<MasterPlayerLogResponseData>"
3760
- },
3761
- {
3762
- "code": "Token",
3763
- "description": "Token used in GetCurrencyLogResponseData.",
3764
- "type": "string"
3765
- }
3766
- ],
3767
- "extends": null,
3768
- "description": "Structured data returned by the corresponding API operation."
3769
- },
3770
- {
3771
- "name": "AddPushNotificationResponseData",
3772
- "details": [
3773
- {
3774
- "code": "PushId",
3775
- "description": "Identifier for the registered push notification device.",
3776
- "type": "string"
3777
- }
3778
- ],
3779
- "extends": null,
3780
- "description": "Structured data returned by the corresponding API operation."
3781
- },
3782
- {
3783
- "name": "SendPushNotificationResponseData",
3784
- "details": [
3785
- {
3786
- "code": "Message",
3787
- "description": "Message used in SendPushNotificationResponseData.",
3788
- "type": "string"
3789
- }
3790
- ],
3791
- "extends": null,
3792
- "description": "Structured data returned by the corresponding API operation."
3793
- },
3794
- {
3795
- "name": "EmptyResponseData",
3796
- "details": [],
3797
- "extends": null,
3798
- "description": "Structured data returned by the corresponding API operation."
3799
- }
3800
- ]
3801
- }