forked from PlayFab/API_Specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAdmin.api.json
More file actions
12339 lines (12339 loc) · 465 KB
/
Admin.api.json
File metadata and controls
12339 lines (12339 loc) · 465 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"name": "Admin",
"url": "/Admin",
"description": "APIs for managing title configurations, uploaded Game Server code executables, and user data",
"datatypes": {
"AbortTaskInstanceRequest": {
"name": "AbortTaskInstanceRequest",
"className": "AbortTaskInstanceRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "TaskInstanceId",
"description": "ID of a task instance that is being aborted.",
"jsontype": "String",
"actualtype": "String",
"optional": false
}
]
},
"ActionsOnPlayersInSegmentTaskParameter": {
"name": "ActionsOnPlayersInSegmentTaskParameter",
"className": "ActionsOnPlayersInSegmentTaskParameter",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "SegmentId",
"description": "ID of the segment to perform actions on.",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "ActionId",
"description": "ID of the action to perform on each player in segment.",
"jsontype": "String",
"actualtype": "String",
"optional": false
}
]
},
"ActionsOnPlayersInSegmentTaskSummary": {
"name": "ActionsOnPlayersInSegmentTaskSummary",
"className": "ActionsOnPlayersInSegmentTaskSummary",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "TaskInstanceId",
"description": "ID of the task instance.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "TaskIdentifier",
"description": "Identifier of the task this instance belongs to.",
"jsontype": "Object",
"actualtype": "NameIdentifier",
"isclass": true,
"optional": true
},
{
"name": "StartedAt",
"description": "UTC timestamp when the task started.",
"jsontype": "String",
"actualtype": "DateTime",
"optional": false
},
{
"name": "CompletedAt",
"description": "UTC timestamp when the task completed.",
"jsontype": "String",
"actualtype": "DateTime",
"optional": true
},
{
"name": "Status",
"description": "Current status of the task instance.",
"jsontype": "String",
"actualtype": "TaskInstanceStatus",
"isenum": true,
"optional": true
},
{
"name": "PercentComplete",
"description": "Progress represented as percentage.",
"jsontype": "Number",
"actualtype": "double",
"optional": true
},
{
"name": "EstimatedSecondsRemaining",
"description": "Estimated time remaining in seconds.",
"jsontype": "Number",
"actualtype": "double",
"optional": true
},
{
"name": "ScheduledByUserId",
"description": "If manually scheduled, ID of user who scheduled the task.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ErrorMessage",
"description": "Error message for last processing attempt, if an error occured.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ErrorWasFatal",
"description": "Flag indicating if the error was fatal, if false job will be retried.",
"jsontype": "Boolean",
"actualtype": "Boolean",
"optional": true
},
{
"name": "TotalPlayersInSegment",
"description": "Total players in segment when task was started.",
"jsontype": "Number",
"actualtype": "int32",
"optional": true
},
{
"name": "TotalPlayersProcessed",
"description": "Total number of players that have had the actions applied to.",
"jsontype": "Number",
"actualtype": "int32",
"optional": true
}
]
},
"AdCampaignAttribution": {
"name": "AdCampaignAttribution",
"className": "AdCampaignAttribution",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "Platform",
"description": "Attribution network name",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "CampaignId",
"description": "Attribution campaign identifier",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "AttributedAt",
"description": "UTC time stamp of attribution",
"jsontype": "String",
"actualtype": "DateTime",
"optional": false
}
]
},
"AddNewsRequest": {
"name": "AddNewsRequest",
"className": "AddNewsRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "Timestamp",
"description": "Time this news was published. If not set, defaults to now.",
"jsontype": "String",
"actualtype": "DateTime",
"optional": true
},
{
"name": "Title",
"description": "Title (headline) of the news item",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "Body",
"description": "Body text of the news",
"jsontype": "String",
"actualtype": "String",
"optional": false
}
]
},
"AddNewsResult": {
"name": "AddNewsResult",
"className": "AddNewsResult",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "NewsId",
"description": "Unique id of the new news item",
"jsontype": "String",
"actualtype": "String",
"optional": true
}
]
},
"AddPlayerTagRequest": {
"name": "AddPlayerTagRequest",
"className": "AddPlayerTagRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "PlayFabId",
"description": "Unique PlayFab assigned ID of the user on whom the operation will be performed.",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "TagName",
"description": "Unique tag for player profile.",
"jsontype": "String",
"actualtype": "String",
"optional": false
}
]
},
"AddPlayerTagResult": {
"name": "AddPlayerTagResult",
"className": "AddPlayerTagResult",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": []
},
"AddServerBuildRequest": {
"name": "AddServerBuildRequest",
"className": "AddServerBuildRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "BuildId",
"description": "unique identifier for the build executable",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "CommandLineTemplate",
"description": "appended to the end of the command line when starting game servers",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ExecutablePath",
"description": "path to the game server executable. Defaults to gameserver.exe",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ActiveRegions",
"description": "server host regions in which this build should be running and available",
"collection": "array",
"jsontype": "String",
"actualtype": "Region",
"isenum": true,
"optional": true
},
{
"name": "Comment",
"description": "developer comment(s) for this build",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "MaxGamesPerHost",
"description": "maximum number of game server instances that can run on a single host machine",
"jsontype": "Number",
"actualtype": "int32",
"optional": false
},
{
"name": "MinFreeGameSlots",
"description": "minimum capacity of additional game server instances that can be started before the autoscaling service starts new host machines (given the number of current running host machines and game server instances)",
"jsontype": "Number",
"actualtype": "int32",
"optional": false
}
]
},
"AddServerBuildResult": {
"name": "AddServerBuildResult",
"className": "AddServerBuildResult",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "BuildId",
"description": "unique identifier for this build executable",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ActiveRegions",
"description": "array of regions where this build can used, when it is active",
"collection": "array",
"jsontype": "String",
"actualtype": "Region",
"isenum": true,
"optional": true
},
{
"name": "MaxGamesPerHost",
"description": "maximum number of game server instances that can run on a single host machine",
"jsontype": "Number",
"actualtype": "int32",
"optional": false
},
{
"name": "MinFreeGameSlots",
"description": "minimum capacity of additional game server instances that can be started before the autoscaling service starts new host machines (given the number of current running host machines and game server instances)",
"jsontype": "Number",
"actualtype": "int32",
"optional": false
},
{
"name": "CommandLineTemplate",
"description": "appended to the end of the command line when starting game servers",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ExecutablePath",
"description": "path to the game server executable. Defaults to gameserver.exe",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Comment",
"description": "developer comment(s) for this build",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Timestamp",
"description": "time this build was last modified (or uploaded, if this build has never been modified)",
"jsontype": "String",
"actualtype": "DateTime",
"optional": false
},
{
"name": "TitleId",
"description": "Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Status",
"description": "the current status of the build validation and processing steps",
"jsontype": "String",
"actualtype": "GameBuildStatus",
"isenum": true,
"optional": true
}
]
},
"AddUserVirtualCurrencyRequest": {
"name": "AddUserVirtualCurrencyRequest",
"className": "AddUserVirtualCurrencyRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "PlayFabId",
"description": "PlayFab unique identifier of the user whose virtual currency balance is to be increased.",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "VirtualCurrency",
"description": "Name of the virtual currency which is to be incremented.",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "Amount",
"description": "Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded.",
"jsontype": "Number",
"actualtype": "int32",
"optional": false
}
]
},
"AddVirtualCurrencyTypesRequest": {
"name": "AddVirtualCurrencyTypesRequest",
"className": "AddVirtualCurrencyTypesRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "VirtualCurrencies",
"description": "List of virtual currencies and their initial deposits (the amount a user is granted when signing in for the first time) to the title",
"collection": "array",
"jsontype": "Object",
"actualtype": "VirtualCurrencyData",
"isclass": true,
"optional": false
}
]
},
"ApiCondition": {
"name": "ApiCondition",
"className": "ApiCondition",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "HasSignatureOrEncryption",
"description": "Require that API calls contain an RSA encrypted payload or signed headers.",
"jsontype": "String",
"actualtype": "Conditionals",
"isenum": true,
"optional": true
}
]
},
"BanInfo": {
"name": "BanInfo",
"className": "BanInfo",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"description": "Contains information for a ban.",
"properties": [
{
"name": "PlayFabId",
"description": "Unique PlayFab assigned ID of the user on whom the operation will be performed.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "BanId",
"description": "The unique Ban Id associated with this ban.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "IPAddress",
"description": "The IP address on which the ban was applied. May affect multiple players.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "MACAddress",
"description": "The MAC address on which the ban was applied. May affect multiple players.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Created",
"description": "The time when this ban was applied.",
"jsontype": "String",
"actualtype": "DateTime",
"optional": true
},
{
"name": "Expires",
"description": "The time when this ban expires. Permanent bans do not have expiration date.",
"jsontype": "String",
"actualtype": "DateTime",
"optional": true
},
{
"name": "Reason",
"description": "The reason why this ban was applied.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Active",
"description": "The active state of this ban. Expired bans may still have this value set to true but they will have no effect.",
"jsontype": "Boolean",
"actualtype": "Boolean",
"optional": false
}
]
},
"BanRequest": {
"name": "BanRequest",
"className": "BanRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"description": "Represents a single ban request.",
"properties": [
{
"name": "PlayFabId",
"description": "Unique PlayFab assigned ID of the user on whom the operation will be performed.",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "IPAddress",
"description": "IP address to be banned. May affect multiple players.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "MACAddress",
"description": "MAC address to be banned. May affect multiple players.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Reason",
"description": "The reason for this ban. Maximum 140 characters.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "DurationInHours",
"description": "The duration in hours for the ban. Leave this blank for a permanent ban.",
"jsontype": "Number",
"actualtype": "uint32",
"optional": true
}
]
},
"BanUsersRequest": {
"name": "BanUsersRequest",
"className": "BanUsersRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "Bans",
"description": "List of ban requests to be applied. Maximum 100.",
"collection": "array",
"jsontype": "Object",
"actualtype": "BanRequest",
"isclass": true,
"optional": false
}
]
},
"BanUsersResult": {
"name": "BanUsersResult",
"className": "BanUsersResult",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "BanData",
"description": "Information on the bans that were applied",
"collection": "array",
"jsontype": "Object",
"actualtype": "BanInfo",
"isclass": true,
"optional": true
}
]
},
"BlankResult": {
"name": "BlankResult",
"className": "BlankResult",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": []
},
"CatalogItem": {
"name": "CatalogItem",
"className": "CatalogItem",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"description": "A purchasable item from the item catalog",
"sortKey": "ItemId",
"properties": [
{
"name": "ItemId",
"description": "unique identifier for this item",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "ItemClass",
"description": "class to which the item belongs",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "CatalogVersion",
"description": "catalog version for this item",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "DisplayName",
"description": "text name for the item, to show in-game",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Description",
"description": "text description of item, to show in-game",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "VirtualCurrencyPrices",
"description": "price of this item in virtual currencies and \"RM\" (the base Real Money purchase price, in USD pennies)",
"collection": "map",
"jsontype": "Number",
"actualtype": "uint32",
"optional": true
},
{
"name": "RealCurrencyPrices",
"description": "override prices for this item for specific currencies",
"collection": "map",
"jsontype": "Number",
"actualtype": "uint32",
"optional": true
},
{
"name": "Tags",
"description": "list of item tags",
"collection": "array",
"isUnordered": true,
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "CustomData",
"description": "game specific custom data",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Consumable",
"description": "defines the consumable properties (number of uses, timeout) for the item",
"jsontype": "Object",
"actualtype": "CatalogItemConsumableInfo",
"isclass": true,
"optional": true
},
{
"name": "Container",
"description": "defines the container properties for the item - what items it contains, including random drop tables and virtual currencies, and what item (if any) is required to open it via the UnlockContainerItem API",
"jsontype": "Object",
"actualtype": "CatalogItemContainerInfo",
"isclass": true,
"optional": true
},
{
"name": "Bundle",
"description": "defines the bundle properties for the item - bundles are items which contain other items, including random drop tables and virtual currencies",
"jsontype": "Object",
"actualtype": "CatalogItemBundleInfo",
"isclass": true,
"optional": true
},
{
"name": "CanBecomeCharacter",
"description": "if true, then an item instance of this type can be used to grant a character to a user.",
"jsontype": "Boolean",
"actualtype": "Boolean",
"optional": false
},
{
"name": "IsStackable",
"description": "if true, then only one item instance of this type will exist and its remaininguses will be incremented instead. RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded",
"jsontype": "Boolean",
"actualtype": "Boolean",
"optional": false
},
{
"name": "IsTradable",
"description": "if true, then an item instance of this type can be traded between players using the trading APIs",
"jsontype": "Boolean",
"actualtype": "Boolean",
"optional": false
},
{
"name": "ItemImageUrl",
"description": "URL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP URL.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "IsLimitedEdition",
"description": "BETA: If true, then only a fixed number can ever be granted.",
"jsontype": "Boolean",
"actualtype": "Boolean",
"optional": false
},
{
"name": "InitialLimitedEditionCount",
"description": "If the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited edition item, this value determines the total number of instances to allocate for the title. Once this limit has been reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less than zero, it will be ignored.",
"jsontype": "Number",
"actualtype": "int32",
"optional": false
}
]
},
"CatalogItemBundleInfo": {
"name": "CatalogItemBundleInfo",
"className": "CatalogItemBundleInfo",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "BundledItems",
"description": "unique ItemId values for all items which will be added to the player inventory when the bundle is added",
"collection": "array",
"isUnordered": true,
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "BundledResultTables",
"description": "unique TableId values for all RandomResultTable objects which are part of the bundle (random tables will be resolved and add the relevant items to the player inventory when the bundle is added)",
"collection": "array",
"isUnordered": true,
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "BundledVirtualCurrencies",
"description": "virtual currency types and balances which will be added to the player inventory when the bundle is added",
"collection": "map",
"jsontype": "Number",
"actualtype": "uint32",
"optional": true
}
]
},
"CatalogItemConsumableInfo": {
"name": "CatalogItemConsumableInfo",
"className": "CatalogItemConsumableInfo",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "UsageCount",
"description": "number of times this object can be used, after which it will be removed from the player inventory",
"jsontype": "Number",
"actualtype": "uint32",
"optional": true
},
{
"name": "UsagePeriod",
"description": "duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on this item's details have completed)",
"jsontype": "Number",
"actualtype": "uint32",
"optional": true
},
{
"name": "UsagePeriodGroup",
"description": "all inventory item instances in the player inventory sharing a non-null UsagePeriodGroup have their UsagePeriod values added together, and share the result - when that period has elapsed, all the items in the group will be removed",
"jsontype": "String",
"actualtype": "String",
"optional": true
}
]
},
"CatalogItemContainerInfo": {
"name": "CatalogItemContainerInfo",
"className": "CatalogItemContainerInfo",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"description": "Containers are inventory items that can hold other items defined in the catalog, as well as virtual currency, which is added to the player inventory when the container is unlocked, using the UnlockContainerItem API. The items can be anything defined in the catalog, as well as RandomResultTable objects which will be resolved when the container is unlocked. Containers and their keys should be defined as Consumable (having a limited number of uses) in their catalog defintiions, unless the intent is for the player to be able to re-use them infinitely.",
"properties": [
{
"name": "KeyItemId",
"description": "ItemId for the catalog item used to unlock the container, if any (if not specified, a call to UnlockContainerItem will open the container, adding the contents to the player inventory and currency balances)",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ItemContents",
"description": "unique ItemId values for all items which will be added to the player inventory, once the container has been unlocked",
"collection": "array",
"isUnordered": true,
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ResultTableContents",
"description": "unique TableId values for all RandomResultTable objects which are part of the container (once unlocked, random tables will be resolved and add the relevant items to the player inventory)",
"collection": "array",
"isUnordered": true,
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "VirtualCurrencyContents",
"description": "virtual currency types and balances which will be added to the player inventory when the container is unlocked",
"collection": "map",
"jsontype": "Number",
"actualtype": "uint32",
"optional": true
}
]
},
"CheckLimitedEditionItemAvailabilityRequest": {
"name": "CheckLimitedEditionItemAvailabilityRequest",
"className": "CheckLimitedEditionItemAvailabilityRequest",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"AnyInclusiveFlags": [
"Beta"
],
"properties": [
{
"name": "CatalogVersion",
"description": "Which catalog is being updated. If null, uses the default catalog.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "ItemId",
"description": "The item to check for.",
"jsontype": "String",
"actualtype": "String",
"optional": false
}
]
},
"CheckLimitedEditionItemAvailabilityResult": {
"name": "CheckLimitedEditionItemAvailabilityResult",
"className": "CheckLimitedEditionItemAvailabilityResult",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"AnyInclusiveFlags": [
"Beta"
],
"properties": [
{
"name": "Amount",
"description": "The amount of the specified resource remaining.",
"jsontype": "Number",
"actualtype": "int32",
"optional": false
}
]
},
"CloudScriptFile": {
"name": "CloudScriptFile",
"className": "CloudScriptFile",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "Filename",
"description": "Name of the javascript file. These names are not used internally by the server, they are only for developer organizational purposes.",
"jsontype": "String",
"actualtype": "String",
"optional": false
},
{
"name": "FileContents",
"description": "Contents of the Cloud Script javascript. Must be string-escaped javascript.",
"jsontype": "String",
"actualtype": "String",
"optional": false
}
]
},
"CloudScriptTaskParameter": {
"name": "CloudScriptTaskParameter",
"className": "CloudScriptTaskParameter",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "FunctionName",
"description": "Name of the CloudScript function to execute.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Argument",
"description": "Argument to pass to the CloudScript function.",
"jsontype": "Object",
"actualtype": "object",
"optional": true
}
]
},
"CloudScriptTaskSummary": {
"name": "CloudScriptTaskSummary",
"className": "CloudScriptTaskSummary",
"classNameSpace": "PlayFab.Admin.Models",
"assembly": "PlayFab.Admin.Models",
"properties": [
{
"name": "TaskInstanceId",
"description": "ID of the task instance.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "TaskIdentifier",
"description": "Identifier of the task this instance belongs to.",
"jsontype": "Object",
"actualtype": "NameIdentifier",
"isclass": true,
"optional": true
},
{
"name": "StartedAt",
"description": "UTC timestamp when the task started.",
"jsontype": "String",
"actualtype": "DateTime",
"optional": false
},
{
"name": "CompletedAt",
"description": "UTC timestamp when the task completed.",
"jsontype": "String",
"actualtype": "DateTime",
"optional": true
},
{
"name": "Status",
"description": "Current status of the task instance.",
"jsontype": "String",
"actualtype": "TaskInstanceStatus",
"isenum": true,
"optional": true
},
{
"name": "PercentComplete",
"description": "Progress represented as percentage.",
"jsontype": "Number",
"actualtype": "double",
"optional": true
},
{
"name": "EstimatedSecondsRemaining",
"description": "Estimated time remaining in seconds.",
"jsontype": "Number",
"actualtype": "double",
"optional": true
},
{
"name": "ScheduledByUserId",
"description": "If manually scheduled, ID of user who scheduled the task.",
"jsontype": "String",
"actualtype": "String",
"optional": true
},
{
"name": "Result",
"description": "Result of CloudScript execution",
"jsontype": "Object",
"actualtype": "ExecuteCloudScriptResult",
"isclass": true,
"optional": true
}
]
},
"CloudScriptVersionStatus": {