async-playfab-web-sdk 1.192.250526-4 → 1.192.250526-5
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.
- package/dist/Addon.d.ts +178 -38
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +2385 -194
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +31 -4
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +2234 -320
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +198 -30
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +136 -17
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +1145 -106
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +199 -12
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +163 -16
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +266 -27
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +32 -6
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +4 -1
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.d.ts +271 -0
- package/dist/Matchmaker.js +8 -0
- package/dist/Matchmaker.js.map +1 -0
- package/dist/Multiplayer.d.ts +2696 -168
- package/dist/Multiplayer.js +2 -2
- package/dist/Profiles.d.ts +162 -18
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +286 -34
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +1903 -241
- package/dist/Server.js +2 -2
- package/dist/chunk-3I6ONUUQ.js +237 -0
- package/dist/chunk-3I6ONUUQ.js.map +1 -0
- package/dist/chunk-3O5QT4SL.js +2477 -0
- package/dist/chunk-3O5QT4SL.js.map +1 -0
- package/dist/chunk-3OBHYLBF.js +2673 -0
- package/dist/chunk-3OBHYLBF.js.map +1 -0
- package/dist/chunk-57KYHGBO.js +421 -0
- package/dist/chunk-57KYHGBO.js.map +1 -0
- package/dist/{chunk-CLMINF57.js → chunk-5CWZN75H.js} +6 -3
- package/dist/chunk-5CWZN75H.js.map +1 -0
- package/dist/chunk-73SVDH45.js +197 -0
- package/dist/chunk-73SVDH45.js.map +1 -0
- package/dist/chunk-ADHTNFTN.js +175 -0
- package/dist/chunk-ADHTNFTN.js.map +1 -0
- package/dist/chunk-C7U2JQNZ.js +76 -0
- package/dist/chunk-C7U2JQNZ.js.map +1 -0
- package/dist/{chunk-PXPOK2QU.js → chunk-GAZYZIK2.js} +34 -8
- package/dist/chunk-GAZYZIK2.js.map +1 -0
- package/dist/chunk-J54WY4UN.js +413 -0
- package/dist/chunk-J54WY4UN.js.map +1 -0
- package/dist/chunk-NFWQ4MMZ.js +1048 -0
- package/dist/chunk-NFWQ4MMZ.js.map +1 -0
- package/dist/{chunk-7UQYMDJQ.js → chunk-P7UVG26J.js} +167 -32
- package/dist/chunk-P7UVG26J.js.map +1 -0
- package/dist/chunk-PFXZB4UN.js +2387 -0
- package/dist/chunk-PFXZB4UN.js.map +1 -0
- package/dist/{chunk-RJPMKD7P.js → chunk-QNGQW3YB.js} +28 -6
- package/dist/chunk-QNGQW3YB.js.map +1 -0
- package/dist/chunk-SQWILU5T.js +270 -0
- package/dist/chunk-SQWILU5T.js.map +1 -0
- package/dist/{chunk-FEEE3PRD.js → chunk-SR2RIRLX.js} +1482 -175
- package/dist/chunk-SR2RIRLX.js.map +1 -0
- package/dist/{chunk-6TH6EJYH.js → chunk-XVDYM74A.js} +4 -4
- package/dist/chunk-XVDYM74A.js.map +1 -0
- package/dist/chunk-ZW4TJ3MQ.js +225 -0
- package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
- package/dist/index.d.ts +6 -5
- package/dist/index.js +29 -25
- package/package.json +2 -2
- package/dist/chunk-2IBLMNAQ.js +0 -882
- package/dist/chunk-2IBLMNAQ.js.map +0 -1
- package/dist/chunk-3TRLETD6.js +0 -119
- package/dist/chunk-3TRLETD6.js.map +0 -1
- package/dist/chunk-4LT3OUQD.js +0 -632
- package/dist/chunk-4LT3OUQD.js.map +0 -1
- package/dist/chunk-6TH6EJYH.js.map +0 -1
- package/dist/chunk-7UQYMDJQ.js.map +0 -1
- package/dist/chunk-CLMINF57.js.map +0 -1
- package/dist/chunk-F5NRBD4O.js +0 -174
- package/dist/chunk-F5NRBD4O.js.map +0 -1
- package/dist/chunk-FEEE3PRD.js.map +0 -1
- package/dist/chunk-HKZJ4H4O.js +0 -97
- package/dist/chunk-HKZJ4H4O.js.map +0 -1
- package/dist/chunk-NJQCK4TL.js +0 -61
- package/dist/chunk-NJQCK4TL.js.map +0 -1
- package/dist/chunk-ONCBQLGS.js +0 -1147
- package/dist/chunk-ONCBQLGS.js.map +0 -1
- package/dist/chunk-PXPOK2QU.js.map +0 -1
- package/dist/chunk-Q22JHX4G.js +0 -76
- package/dist/chunk-Q22JHX4G.js.map +0 -1
- package/dist/chunk-RJPMKD7P.js.map +0 -1
- package/dist/chunk-WROXLFDZ.js +0 -103
- package/dist/chunk-WROXLFDZ.js.map +0 -1
- package/dist/chunk-XAI5IWL4.js +0 -187
- package/dist/chunk-XAI5IWL4.js.map +0 -1
- package/dist/chunk-XM26BUTO.js +0 -384
- package/dist/chunk-XM26BUTO.js.map +0 -1
package/dist/Economy.js
CHANGED
package/dist/Events.d.ts
CHANGED
@@ -76,6 +76,16 @@ interface DeleteDataConnectionResponse extends IPlayFabResultCommon {
|
|
76
76
|
/** Indicates whether or not the connection was deleted as part of the request. */
|
77
77
|
WasDeleted: boolean;
|
78
78
|
}
|
79
|
+
interface DeleteEventSamplingRatioRequest extends IPlayFabRequestCommon {
|
80
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
81
|
+
CustomTags?: Record<string, string | null>;
|
82
|
+
/** Name of the sampled event */
|
83
|
+
EventName: string;
|
84
|
+
/** Namespace of the sampled event */
|
85
|
+
EventNamespace: string;
|
86
|
+
}
|
87
|
+
interface DeleteEventSamplingRatioResult extends IPlayFabResultCommon {
|
88
|
+
}
|
79
89
|
interface DeleteTelemetryKeyRequest extends IPlayFabRequestCommon {
|
80
90
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
81
91
|
CustomTags?: Record<string, string | null>;
|
@@ -93,6 +103,11 @@ interface EntityKey {
|
|
93
103
|
Id: string;
|
94
104
|
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
95
105
|
Type?: string;
|
106
|
+
/**
|
107
|
+
* Alternate name for Type.
|
108
|
+
* @deprecated Please use Type instead.
|
109
|
+
*/
|
110
|
+
TypeString?: string;
|
96
111
|
}
|
97
112
|
interface EventContents {
|
98
113
|
/**
|
@@ -125,6 +140,11 @@ interface EventContents {
|
|
125
140
|
*/
|
126
141
|
PayloadJSON?: string;
|
127
142
|
}
|
143
|
+
interface EventSamplingRatio {
|
144
|
+
EventName?: string;
|
145
|
+
EventNamespace?: string;
|
146
|
+
Ratio: number;
|
147
|
+
}
|
128
148
|
interface GetDataConnectionRequest extends IPlayFabRequestCommon {
|
129
149
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
130
150
|
CustomTags?: Record<string, string | null>;
|
@@ -135,6 +155,29 @@ interface GetDataConnectionResponse extends IPlayFabResultCommon {
|
|
135
155
|
/** The details of the queried Data Connection. */
|
136
156
|
DataConnection?: DataConnectionDetails;
|
137
157
|
}
|
158
|
+
interface GetEventSamplingRatioRequest extends IPlayFabRequestCommon {
|
159
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
160
|
+
CustomTags?: Record<string, string | null>;
|
161
|
+
/** Name of the sampled event */
|
162
|
+
EventName: string;
|
163
|
+
/** Namespace of the sampled event */
|
164
|
+
EventNamespace: string;
|
165
|
+
}
|
166
|
+
interface GetEventSamplingRatioResult extends IPlayFabResultCommon {
|
167
|
+
/** Name of the sampled event */
|
168
|
+
EventName: string;
|
169
|
+
/** Namespace of the sampled event */
|
170
|
+
EventNamespace: string;
|
171
|
+
/** Sampling ratio of the event */
|
172
|
+
Ratio: number;
|
173
|
+
}
|
174
|
+
interface GetEventSamplingRatiosRequest extends IPlayFabRequestCommon {
|
175
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
176
|
+
CustomTags?: Record<string, string | null>;
|
177
|
+
}
|
178
|
+
interface GetEventSamplingRatiosResult extends IPlayFabResultCommon {
|
179
|
+
Ratios?: EventSamplingRatio[];
|
180
|
+
}
|
138
181
|
interface GetTelemetryKeyRequest extends IPlayFabRequestCommon {
|
139
182
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
140
183
|
CustomTags?: Record<string, string | null>;
|
@@ -198,6 +241,18 @@ interface SetDataConnectionResponse extends IPlayFabResultCommon {
|
|
198
241
|
/** The details of the Data Connection to be created or updated. */
|
199
242
|
DataConnection?: DataConnectionDetails;
|
200
243
|
}
|
244
|
+
interface SetEventSamplingRatioRequest extends IPlayFabRequestCommon {
|
245
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
246
|
+
CustomTags?: Record<string, string | null>;
|
247
|
+
/** Name of the sampled event */
|
248
|
+
EventName: string;
|
249
|
+
/** Namespace of the sampled event */
|
250
|
+
EventNamespace: string;
|
251
|
+
/** Sampling ratio of the event */
|
252
|
+
Ratio: number;
|
253
|
+
}
|
254
|
+
interface SetEventSamplingRatioResult extends IPlayFabResultCommon {
|
255
|
+
}
|
201
256
|
interface SetTelemetryKeyActiveRequest extends IPlayFabRequestCommon {
|
202
257
|
/** Whether to set the key to active (true) or deactivated (false). */
|
203
258
|
Active: boolean;
|
@@ -243,63 +298,195 @@ interface WriteEventsResponse extends IPlayFabResultCommon {
|
|
243
298
|
declare class PlayFabEventsApi extends PlayFabCommon {
|
244
299
|
/**
|
245
300
|
* Creates a new telemetry key for the title.
|
246
|
-
*
|
301
|
+
*
|
302
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/createtelemetrykey Microsoft Documentation}
|
303
|
+
* @example
|
304
|
+
* await eventClient.CreateTelemetryKey({
|
305
|
+
* "KeyName": "MyTelemetryKey"
|
306
|
+
* });
|
247
307
|
*/
|
248
308
|
CreateTelemetryKey(request: CreateTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<CreateTelemetryKeyResponse>;
|
249
309
|
/**
|
250
310
|
* Deletes a Data Connection from a title.
|
251
|
-
*
|
311
|
+
*
|
312
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/deletedataconnection Microsoft Documentation}
|
313
|
+
* @example
|
314
|
+
* await eventClient.DeleteDataConnection({
|
315
|
+
* "Name": "MyDataConnection"
|
316
|
+
* });
|
252
317
|
*/
|
253
318
|
DeleteDataConnection(request: DeleteDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<DeleteDataConnectionResponse>;
|
319
|
+
/**
|
320
|
+
* Deletes the sampling ratio for an event.
|
321
|
+
*
|
322
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/deleteeventsamplingratio Microsoft Documentation}
|
323
|
+
*/
|
324
|
+
DeleteEventSamplingRatio(request: DeleteEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<DeleteEventSamplingRatioResult>;
|
254
325
|
/**
|
255
326
|
* Deletes a telemetry key configured for the title.
|
256
|
-
*
|
327
|
+
*
|
328
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/deletetelemetrykey Microsoft Documentation}
|
329
|
+
* @example
|
330
|
+
* await eventClient.DeleteTelemetryKey({
|
331
|
+
* "KeyName": "MyTelemetryKey"
|
332
|
+
* });
|
257
333
|
*/
|
258
334
|
DeleteTelemetryKey(request: DeleteTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<DeleteTelemetryKeyResponse>;
|
259
335
|
/**
|
260
336
|
* Retrieves a single Data Connection associated with a title.
|
261
|
-
*
|
337
|
+
*
|
338
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/getdataconnection Microsoft Documentation}
|
339
|
+
* @example
|
340
|
+
* await eventClient.GetDataConnection({
|
341
|
+
* "Name": "MyDataConnection"
|
342
|
+
* });
|
262
343
|
*/
|
263
344
|
GetDataConnection(request: GetDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<GetDataConnectionResponse>;
|
345
|
+
/**
|
346
|
+
* Gets the sampling ratio for an event.
|
347
|
+
*
|
348
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/geteventsamplingratio Microsoft Documentation}
|
349
|
+
* @example
|
350
|
+
* await eventClient.GetEventSamplingRatio({
|
351
|
+
* "EventNamespace": "com.playfab",
|
352
|
+
* "EventName": "player_executed_cloudscript"
|
353
|
+
* });
|
354
|
+
*/
|
355
|
+
GetEventSamplingRatio(request: GetEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<GetEventSamplingRatioResult>;
|
356
|
+
/**
|
357
|
+
* Gets the event sampling ratios for a title.
|
358
|
+
*
|
359
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/geteventsamplingratios Microsoft Documentation}
|
360
|
+
*/
|
361
|
+
GetEventSamplingRatios(request: GetEventSamplingRatiosRequest, extraHeaders?: Record<string, string>): Promise<GetEventSamplingRatiosResult>;
|
264
362
|
/**
|
265
363
|
* Gets information about a telemetry key configured for the title.
|
266
|
-
*
|
364
|
+
*
|
365
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/gettelemetrykey Microsoft Documentation}
|
366
|
+
* @example
|
367
|
+
* await eventClient.GetTelemetryKey({
|
368
|
+
* "KeyName": "MyTelemetryKey"
|
369
|
+
* });
|
267
370
|
*/
|
268
371
|
GetTelemetryKey(request: GetTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<GetTelemetryKeyResponse>;
|
269
372
|
/**
|
270
373
|
* Retrieves the list of Data Connections associated with a title.
|
271
|
-
*
|
374
|
+
*
|
375
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/listdataconnections Microsoft Documentation}
|
376
|
+
* @example
|
377
|
+
* await eventClient.ListDataConnections({});
|
272
378
|
*/
|
273
379
|
ListDataConnections(request: ListDataConnectionsRequest, extraHeaders?: Record<string, string>): Promise<ListDataConnectionsResponse>;
|
274
380
|
/**
|
275
381
|
* Lists all telemetry keys configured for the title.
|
276
|
-
*
|
382
|
+
*
|
383
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/listtelemetrykeys Microsoft Documentation}
|
384
|
+
* @example
|
385
|
+
* await eventClient.ListTelemetryKeys({});
|
277
386
|
*/
|
278
387
|
ListTelemetryKeys(request: ListTelemetryKeysRequest, extraHeaders?: Record<string, string>): Promise<ListTelemetryKeysResponse>;
|
279
388
|
/**
|
280
389
|
* Creates or updates a Data Connection on a title.
|
281
|
-
*
|
390
|
+
*
|
391
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/setdataconnection Microsoft Documentation}
|
392
|
+
* @example
|
393
|
+
* await eventClient.SetDataConnection({
|
394
|
+
* "Name": "MyDataConnection",
|
395
|
+
* "Type": "AzureDataExplorer",
|
396
|
+
* "IsActive": true,
|
397
|
+
* "ConnectionSettings": {
|
398
|
+
* "AzureDataExplorerSettings": {
|
399
|
+
* "ClusterUri": "https://myadxcluster.kusto.windows.net",
|
400
|
+
* "Database": "MyDatabase",
|
401
|
+
* "Table": "MyTable"
|
402
|
+
* }
|
403
|
+
* }
|
404
|
+
* });
|
282
405
|
*/
|
283
406
|
SetDataConnection(request: SetDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<SetDataConnectionResponse>;
|
284
407
|
/**
|
285
408
|
* Sets a Data Connection for the title to either the active or deactivated state.
|
286
|
-
*
|
409
|
+
*
|
410
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/setdataconnectionactive Microsoft Documentation}
|
411
|
+
* @example
|
412
|
+
* await eventClient.SetDataConnectionActive({
|
413
|
+
* "Name": "MyDataConnection",
|
414
|
+
* "Active": false
|
415
|
+
* });
|
287
416
|
*/
|
288
417
|
SetDataConnectionActive(request: SetDataConnectionActiveRequest, extraHeaders?: Record<string, string>): Promise<SetDataConnectionActiveResponse>;
|
418
|
+
/**
|
419
|
+
* Sets the sampling ratio for an event.
|
420
|
+
*
|
421
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/seteventsamplingratio Microsoft Documentation}
|
422
|
+
*/
|
423
|
+
SetEventSamplingRatio(request: SetEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<SetEventSamplingRatioResult>;
|
289
424
|
/**
|
290
425
|
* Sets a telemetry key to the active or deactivated state.
|
291
|
-
*
|
426
|
+
*
|
427
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/settelemetrykeyactive Microsoft Documentation}
|
428
|
+
* @example
|
429
|
+
* await eventClient.SetTelemetryKeyActive({
|
430
|
+
* "KeyName": "MyTelemetryKey",
|
431
|
+
* "Active": false
|
432
|
+
* });
|
292
433
|
*/
|
293
434
|
SetTelemetryKeyActive(request: SetTelemetryKeyActiveRequest, extraHeaders?: Record<string, string>): Promise<SetTelemetryKeyActiveResponse>;
|
294
435
|
/**
|
295
436
|
* Write batches of entity based events to PlayStream. The namespace of the Event must be 'custom' or start with 'custom.'.
|
296
|
-
*
|
437
|
+
*
|
438
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/writeevents Microsoft Documentation}
|
439
|
+
* @example
|
440
|
+
* await eventClient.WriteEvents({
|
441
|
+
* "Events": [
|
442
|
+
* {
|
443
|
+
* "Entity": {
|
444
|
+
* "Id": "A8140AB9109712B",
|
445
|
+
* "Type": "title",
|
446
|
+
* "TypeString": "title"
|
447
|
+
* },
|
448
|
+
* "EventNamespace": "com.playfab.events.example",
|
449
|
+
* "Name": "something_happened",
|
450
|
+
* "Payload": {
|
451
|
+
* "Foo": "Bar",
|
452
|
+
* "Nums": [
|
453
|
+
* 1,
|
454
|
+
* 2,
|
455
|
+
* 3
|
456
|
+
* ]
|
457
|
+
* }
|
458
|
+
* }
|
459
|
+
* ]
|
460
|
+
* });
|
297
461
|
*/
|
298
462
|
WriteEvents(request: WriteEventsRequest, extraHeaders?: Record<string, string>): Promise<WriteEventsResponse>;
|
299
463
|
/**
|
300
464
|
* Write batches of entity based events to as Telemetry events (bypass PlayStream). The namespace must be 'custom' or start
|
301
465
|
* with 'custom.'
|
302
|
-
*
|
466
|
+
*
|
467
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/writetelemetryevents Microsoft Documentation}
|
468
|
+
* @example
|
469
|
+
* await eventClient.WriteTelemetryEvents({
|
470
|
+
* "Events": [
|
471
|
+
* {
|
472
|
+
* "Entity": {
|
473
|
+
* "Id": "A8140AB9109712B",
|
474
|
+
* "Type": "title",
|
475
|
+
* "TypeString": "title"
|
476
|
+
* },
|
477
|
+
* "EventNamespace": "com.playfab.events.example",
|
478
|
+
* "Name": "something_happened",
|
479
|
+
* "Payload": {
|
480
|
+
* "Foo": "Bar",
|
481
|
+
* "Nums": [
|
482
|
+
* 1,
|
483
|
+
* 2,
|
484
|
+
* 3
|
485
|
+
* ]
|
486
|
+
* }
|
487
|
+
* }
|
488
|
+
* ]
|
489
|
+
* });
|
303
490
|
*/
|
304
491
|
WriteTelemetryEvents(request: WriteEventsRequest, extraHeaders?: Record<string, string>): Promise<WriteEventsResponse>;
|
305
492
|
}
|
package/dist/Events.js
CHANGED
@@ -17,6 +17,11 @@ interface CreateExperimentRequest extends IPlayFabRequestCommon {
|
|
17
17
|
CustomTags?: Record<string, string | null>;
|
18
18
|
/** Description of the experiment. */
|
19
19
|
Description?: string;
|
20
|
+
/**
|
21
|
+
* The duration of the experiment, in days.
|
22
|
+
* @deprecated Please use EndDate instead.
|
23
|
+
*/
|
24
|
+
Duration?: number;
|
20
25
|
/** When experiment should end. */
|
21
26
|
EndDate?: string;
|
22
27
|
/** Id of the exclusion group. */
|
@@ -27,7 +32,7 @@ interface CreateExperimentRequest extends IPlayFabRequestCommon {
|
|
27
32
|
ExperimentType?: string;
|
28
33
|
/** Friendly name of the experiment. */
|
29
34
|
Name: string;
|
30
|
-
/** Id of the segment to which this experiment applies. Defaults to the
|
35
|
+
/** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
|
31
36
|
SegmentId?: string;
|
32
37
|
/** When experiment should start. */
|
33
38
|
StartDate: string;
|
@@ -60,6 +65,11 @@ interface EntityKey {
|
|
60
65
|
Id: string;
|
61
66
|
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
62
67
|
Type?: string;
|
68
|
+
/**
|
69
|
+
* Alternate name for Type.
|
70
|
+
* @deprecated Please use Type instead.
|
71
|
+
*/
|
72
|
+
TypeString?: string;
|
63
73
|
}
|
64
74
|
interface ExclusionGroupTrafficAllocation {
|
65
75
|
/** Id of the experiment. */
|
@@ -70,6 +80,11 @@ interface ExclusionGroupTrafficAllocation {
|
|
70
80
|
interface Experiment {
|
71
81
|
/** Description of the experiment. */
|
72
82
|
Description?: string;
|
83
|
+
/**
|
84
|
+
* The duration of the experiment, in days.
|
85
|
+
* @deprecated Please use EndDate instead.
|
86
|
+
*/
|
87
|
+
Duration?: number;
|
73
88
|
/** When experiment should end/was ended. */
|
74
89
|
EndDate?: string;
|
75
90
|
/** Id of the exclusion group for this experiment. */
|
@@ -82,7 +97,7 @@ interface Experiment {
|
|
82
97
|
Id?: string;
|
83
98
|
/** Friendly name of the experiment. */
|
84
99
|
Name?: string;
|
85
|
-
/** Id of the segment to which this experiment applies. Defaults to the
|
100
|
+
/** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
|
86
101
|
SegmentId?: string;
|
87
102
|
/** When experiment should start/was started. */
|
88
103
|
StartDate: string;
|
@@ -239,6 +254,11 @@ interface UpdateExperimentRequest extends IPlayFabRequestCommon {
|
|
239
254
|
CustomTags?: Record<string, string | null>;
|
240
255
|
/** Description of the experiment. */
|
241
256
|
Description?: string;
|
257
|
+
/**
|
258
|
+
* The duration of the experiment, in days.
|
259
|
+
* @deprecated Please use EndDate instead.
|
260
|
+
*/
|
261
|
+
Duration?: number;
|
242
262
|
/** When experiment should end. */
|
243
263
|
EndDate?: string;
|
244
264
|
/** Id of the exclusion group. */
|
@@ -251,7 +271,7 @@ interface UpdateExperimentRequest extends IPlayFabRequestCommon {
|
|
251
271
|
Id: string;
|
252
272
|
/** Friendly name of the experiment. */
|
253
273
|
Name: string;
|
254
|
-
/** Id of the segment to which this experiment applies. Defaults to the
|
274
|
+
/** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
|
255
275
|
SegmentId?: string;
|
256
276
|
/** When experiment should start. */
|
257
277
|
StartDate: string;
|
@@ -278,6 +298,11 @@ interface Variant {
|
|
278
298
|
IsControl: boolean;
|
279
299
|
/** Name of the variant. */
|
280
300
|
Name: string;
|
301
|
+
/**
|
302
|
+
* Id of the TitleDataOverrideGroup to use with this variant.
|
303
|
+
* @deprecated Do not use
|
304
|
+
*/
|
305
|
+
TitleDataOverrideId?: string;
|
281
306
|
/** Id of the TitleDataOverride to use with this variant. */
|
282
307
|
TitleDataOverrideLabel?: string;
|
283
308
|
/** Percentage of target audience traffic that will see this variant. */
|
@@ -289,67 +314,189 @@ interface Variant {
|
|
289
314
|
declare class PlayFabExperimentationApi extends PlayFabCommon {
|
290
315
|
/**
|
291
316
|
* Creates a new experiment exclusion group for a title.
|
292
|
-
*
|
317
|
+
*
|
318
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexclusiongroup Microsoft Documentation}
|
319
|
+
* @example
|
320
|
+
* await experimentationClient.CreateExclusionGroup({
|
321
|
+
* "Name": "Commerce Exclusion Group",
|
322
|
+
* "Description": "Exclusion group for independent, commerce-related experiments"
|
323
|
+
* });
|
293
324
|
*/
|
294
325
|
CreateExclusionGroup(request: CreateExclusionGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateExclusionGroupResult>;
|
295
326
|
/**
|
296
327
|
* Creates a new experiment for a title.
|
297
|
-
*
|
328
|
+
*
|
329
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexperiment Microsoft Documentation}
|
330
|
+
* @example
|
331
|
+
* await experimentationClient.CreateExperiment({
|
332
|
+
* "Name": "BackgroundColor Experiment",
|
333
|
+
* "Description": "Tests whether a green background color increases revenue",
|
334
|
+
* "StartDate": "2019-10-25T20:37:00Z",
|
335
|
+
* "EndDate": "2019-11-13T20:37:00Z",
|
336
|
+
* "Variants": [
|
337
|
+
* {
|
338
|
+
* "Name": "Control",
|
339
|
+
* "Description": "Control variant",
|
340
|
+
* "TrafficPercentage": 10,
|
341
|
+
* "Variables": [
|
342
|
+
* {
|
343
|
+
* "Name": "BackgroundColor",
|
344
|
+
* "Value": "White"
|
345
|
+
* }
|
346
|
+
* ],
|
347
|
+
* "IsControl": true
|
348
|
+
* },
|
349
|
+
* {
|
350
|
+
* "Name": "Treatment",
|
351
|
+
* "Description": "Treatment variant",
|
352
|
+
* "TrafficPercentage": 90,
|
353
|
+
* "Variables": [
|
354
|
+
* {
|
355
|
+
* "Name": "BackgroundColor",
|
356
|
+
* "Value": "Green"
|
357
|
+
* }
|
358
|
+
* ],
|
359
|
+
* "IsControl": false
|
360
|
+
* }
|
361
|
+
* ],
|
362
|
+
* "ExperimentType": "Active"
|
363
|
+
* });
|
298
364
|
*/
|
299
365
|
CreateExperiment(request: CreateExperimentRequest, extraHeaders?: Record<string, string>): Promise<CreateExperimentResult>;
|
300
366
|
/**
|
301
367
|
* Deletes an existing exclusion group for a title.
|
302
|
-
*
|
368
|
+
*
|
369
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexclusiongroup Microsoft Documentation}
|
370
|
+
* @example
|
371
|
+
* await experimentationClient.DeleteExclusionGroup({
|
372
|
+
* "ExclusionGroupId": "00000000-0000-0000-0000-000000000000"
|
373
|
+
* });
|
303
374
|
*/
|
304
375
|
DeleteExclusionGroup(request: DeleteExclusionGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
305
376
|
/**
|
306
377
|
* Deletes an existing experiment for a title.
|
307
|
-
*
|
378
|
+
*
|
379
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexperiment Microsoft Documentation}
|
380
|
+
* @example
|
381
|
+
* await experimentationClient.DeleteExperiment({
|
382
|
+
* "ExperimentId": "00000000-0000-0000-0000-000000000000"
|
383
|
+
* });
|
308
384
|
*/
|
309
385
|
DeleteExperiment(request: DeleteExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
310
386
|
/**
|
311
387
|
* Gets the details of all exclusion groups for a title.
|
312
|
-
*
|
388
|
+
*
|
389
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongroups Microsoft Documentation}
|
390
|
+
* @example
|
391
|
+
* await experimentationClient.GetExclusionGroups({});
|
313
392
|
*/
|
314
393
|
GetExclusionGroups(request: GetExclusionGroupsRequest, extraHeaders?: Record<string, string>): Promise<GetExclusionGroupsResult>;
|
315
394
|
/**
|
316
395
|
* Gets the details of all exclusion groups for a title.
|
317
|
-
*
|
396
|
+
*
|
397
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongrouptraffic Microsoft Documentation}
|
398
|
+
* @example
|
399
|
+
* await experimentationClient.GetExclusionGroupTraffic({});
|
318
400
|
*/
|
319
401
|
GetExclusionGroupTraffic(request: GetExclusionGroupTrafficRequest, extraHeaders?: Record<string, string>): Promise<GetExclusionGroupTrafficResult>;
|
320
402
|
/**
|
321
403
|
* Gets the details of all experiments for a title.
|
322
|
-
*
|
404
|
+
*
|
405
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexperiments Microsoft Documentation}
|
406
|
+
* @example
|
407
|
+
* await experimentationClient.GetExperiments({});
|
323
408
|
*/
|
324
409
|
GetExperiments(request: GetExperimentsRequest, extraHeaders?: Record<string, string>): Promise<GetExperimentsResult>;
|
325
410
|
/**
|
326
411
|
* Gets the latest scorecard of the experiment for the title.
|
327
|
-
*
|
412
|
+
*
|
413
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getlatestscorecard Microsoft Documentation}
|
414
|
+
* @example
|
415
|
+
* await experimentationClient.GetLatestScorecard({
|
416
|
+
* "ExperimentId": "00000000-0000-0000-0000-000000000000"
|
417
|
+
* });
|
328
418
|
*/
|
329
419
|
GetLatestScorecard(request: GetLatestScorecardRequest, extraHeaders?: Record<string, string>): Promise<GetLatestScorecardResult>;
|
330
420
|
/**
|
331
421
|
* Gets the treatment assignments for a player for every running experiment in the title.
|
332
|
-
*
|
422
|
+
*
|
423
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/gettreatmentassignment Microsoft Documentation}
|
424
|
+
* @example
|
425
|
+
* await experimentationClient.GetTreatmentAssignment({});
|
333
426
|
*/
|
334
427
|
GetTreatmentAssignment(request: GetTreatmentAssignmentRequest, extraHeaders?: Record<string, string>): Promise<GetTreatmentAssignmentResult>;
|
335
428
|
/**
|
336
429
|
* Starts an existing experiment for a title.
|
337
|
-
*
|
430
|
+
*
|
431
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/startexperiment Microsoft Documentation}
|
432
|
+
* @example
|
433
|
+
* await experimentationClient.StartExperiment({
|
434
|
+
* "ExperimentId": "00000000-0000-0000-0000-000000000000"
|
435
|
+
* });
|
338
436
|
*/
|
339
437
|
StartExperiment(request: StartExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
340
438
|
/**
|
341
439
|
* Stops an existing experiment for a title.
|
342
|
-
*
|
440
|
+
*
|
441
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/stopexperiment Microsoft Documentation}
|
442
|
+
* @example
|
443
|
+
* await experimentationClient.StopExperiment({
|
444
|
+
* "ExperimentId": "00000000-0000-0000-0000-000000000000"
|
445
|
+
* });
|
343
446
|
*/
|
344
447
|
StopExperiment(request: StopExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
345
448
|
/**
|
346
449
|
* Updates an existing exclusion group for a title.
|
347
|
-
*
|
450
|
+
*
|
451
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexclusiongroup Microsoft Documentation}
|
452
|
+
* @example
|
453
|
+
* await experimentationClient.UpdateExclusionGroup({
|
454
|
+
* "ExclusionGroupId": "00000000-0000-0000-0000-000000000000",
|
455
|
+
* "Name": "Commerce Exclusion Group",
|
456
|
+
* "Description": "Exclusion group for independent, commerce-related experiments"
|
457
|
+
* });
|
348
458
|
*/
|
349
459
|
UpdateExclusionGroup(request: UpdateExclusionGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
350
460
|
/**
|
351
461
|
* Updates an existing experiment for a title.
|
352
|
-
*
|
462
|
+
*
|
463
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexperiment Microsoft Documentation}
|
464
|
+
* @example
|
465
|
+
* await experimentationClient.UpdateExperiment({
|
466
|
+
* "Name": "BackgroundColor Experiment",
|
467
|
+
* "Id": "B9A90E90-A009-4254-80A4-46B5933E9D26",
|
468
|
+
* "Description": "Tests whether a green background color increases revenue",
|
469
|
+
* "StartDate": "2019-10-25T20:37:00Z",
|
470
|
+
* "EndDate": "2019-11-13T20:37:00Z",
|
471
|
+
* "SegmentId": "0",
|
472
|
+
* "Variants": [
|
473
|
+
* {
|
474
|
+
* "Name": "Control",
|
475
|
+
* "Description": "Control variant",
|
476
|
+
* "TrafficPercentage": 10,
|
477
|
+
* "Variables": [
|
478
|
+
* {
|
479
|
+
* "Name": "BackgroundColor",
|
480
|
+
* "Value": "White"
|
481
|
+
* }
|
482
|
+
* ],
|
483
|
+
* "IsControl": true
|
484
|
+
* },
|
485
|
+
* {
|
486
|
+
* "Name": "Treatment",
|
487
|
+
* "Description": "Treatment variant",
|
488
|
+
* "TrafficPercentage": 90,
|
489
|
+
* "Variables": [
|
490
|
+
* {
|
491
|
+
* "Name": "BackgroundColor",
|
492
|
+
* "Value": "Green"
|
493
|
+
* }
|
494
|
+
* ],
|
495
|
+
* "IsControl": false
|
496
|
+
* }
|
497
|
+
* ],
|
498
|
+
* "ExperimentType": "Active"
|
499
|
+
* });
|
353
500
|
*/
|
354
501
|
UpdateExperiment(request: UpdateExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
355
502
|
}
|