This is the documentation for the Scripting APIs of this package.
Show / Hide Table of Contents
-
Unity.
Services. Apis -
Unity.
Services. Apis. Analytics -
Unity.
Services. Apis. Cloud Code -
Axios
Invocation Error Response -
Axios
Invocation Error Response Details -
Axios
Invocation Error Response Request -
Axios
Invocation Error Response Response -
Basic
Error Response -
Cloud
Code Api -
ICloud
Code Api -
Invocation
Error Response -
Invocation
Error Response Details -
Run
Module422Response -
Run
Module Arguments -
Run
Module Response -
Run
Script400Response -
Run
Script Arguments -
Run
Script Response -
Subscription
Token Response -
Validation
Error Body -
Validation
Error Response
-
Axios
-
Unity.
Services. Apis. Cloud Content Delivery -
Unity.
Services. Apis. Cloud Save -
Attempted
Item -
Base
Error Response -
Basic
Error Response -
Basic
Error Response All Of -
Batch
Basic Error Body -
Batch
Basic Error Response -
Batch
Conflict Error Response -
Batch
Conflict Error Response All Of -
Batch
Validation Error Body -
Batch
Validation Error Response -
Cloud
Save Data Api -
Cloud
Save Files Api -
Conflict
Error Response -
Conflict
Error Response All Of -
Conflict
Error Response Data -
Delete
Conflict Error Response -
Delete
Conflict Error Response All Of -
Delete
Conflict Error Response All Of Data -
Field
Filter -
Field
Filter. Op Enum -
File
Details -
File
Item -
File
List -
File
List Links -
Get
Items400Response -
Get
Items Response -
Get
Items Response Links -
Get
Keys Response -
ICloud
Save Data Api -
ICloud
Save Files Api - Item
-
Key
Metadata -
Modified
Metadata -
Query
Index Body -
Query
Index Response -
Query
Index Response Results Inner -
Query
Index Response Results Inner Id -
Set
Item Batch400Response -
Set
Item Batch Body -
Set
Item Batch Response -
Set
Item Batch Response Results Inner -
Set
Item Body -
Set
Item Response -
Signed
Url Response -
Validation
Error Body -
Validation
Error Response
-
Attempted
-
Unity.
Services. Apis. Economy -
Add
Inventory Request -
Basic
Error Response - Cost
-
Currency
Balance Request -
Currency
Balance Response -
Currency
Exchange Item -
Currency
Modify Balance Request -
Currency
Resource -
Currency
Resource. Type Enum -
Economy
Configuration Api -
Economy
Currencies Api -
Economy
Inventory Api -
Economy
Purchases Api -
Error
Response Conflict Currency Balance -
Error
Response Conflict Currency Balance Data -
Error
Response Conflict Currency Balance Data Existing -
Error
Response Conflict Inventory -
Error
Response Conflict Inventory Delete -
Error
Response Conflict Inventory Delete Data -
Error
Response Conflict Inventory Delete Data Attempted -
Error
Response Conflict Inventory Update -
Error
Response Conflict Inventory Update Data -
Error
Response Conflict Inventory Update Data Existing -
Error
Response Purchase Appleappstore Failed -
Error
Response Purchase Googleplaystore Failed -
IEconomy
Configuration Api -
IEconomy
Currencies Api -
IEconomy
Inventory Api -
IEconomy
Purchases Api -
Inventory
Delete Request -
Inventory
Exchange Item -
Inventory
Item Resource -
Inventory
Item Resource. Type Enum -
Inventory
Request Update -
Inventory
Response -
Modified
Metadata -
Player
Configuration Response -
Player
Configuration Response Metadata -
Player
Configuration Response Results Inner -
Player
Currency Balance Response -
Player
Currency Balance Response Links -
Player
Inventory Response -
Player
Purchase Appleappstore Request -
Player
Purchase Appleappstore Response -
Player
Purchase Appleappstore Response Verification -
Player
Purchase Appleappstore Response Verification. Status Enum -
Player
Purchase Appleappstore Response Verification Store -
Player
Purchase Googleplaystore Request -
Player
Purchase Googleplaystore Response -
Player
Purchase Googleplaystore Response Rewards -
Player
Purchase Googleplaystore Response Verification -
Player
Purchase Googleplaystore Response Verification. Status Enum -
Player
Purchase Googleplaystore Response Verification Store -
Player
Purchase Virtual Request -
Player
Purchase Virtual Response -
Player
Purchase Virtual Response Costs -
Player
Purchase Virtual Response Rewards -
Real
Money Purchase Resource -
Real
Money Purchase Resource. Type Enum -
Real
Money Purchase Resource Store Identifiers -
Redeem
Apple App Store Purchase422Response -
Redeem
Google Play Purchase422Response - Reward
-
Set
Player Currency Balance400Response -
Validation
Error Body -
Validation
Error Response -
Virtual
Purchase Resource -
Virtual
Purchase Resource. Type Enum
-
Add
-
Unity.
Services. Apis. Friends -
Add
Relationship Request - Detail
- Error
-
Extended
User -
Extended
User All Of -
Friends
Messaging Api -
Friends
Notifications Api -
Friends
Presence Api -
Friends
Relationships Api -
IFriends
Messaging Api -
IFriends
Notifications Api -
IFriends
Presence Api -
IFriends
Relationships Api - Member
-
Member
All Of -
Member
Identity -
Message
Request -
Message
Request All Of -
Notification
Auth -
Presence
Request -
Presence
Request. Availability Enum - Relationship
-
Relationship
Type - Role
- User
-
User
Presence -
User
Presence. Availability Enum -
User
Profile
-
Add
-
Unity.
Services. Apis. Leaderboards -
Add
Leaderboard Score -
Basic
Error Response -
Get
Leaderboard Scores400Response -
ILeaderboards
Api -
Leaderboard
Entry -
Leaderboard
Entry With Updated Time -
Leaderboard
Entry With Updated Time All Of -
Leaderboard
Player Ids -
Leaderboard
Score -
Leaderboard
Scores -
Leaderboard
Scores All Of -
Leaderboard
Scores Page -
Leaderboard
Scores With Not Found Player Ids -
Leaderboard
Scores With Not Found Player Ids All Of -
Leaderboard
Tier Scores Page -
Leaderboard
Tier Scores Page All Of -
Leaderboard
Version -
Leaderboard
Version Entry -
Leaderboard
Version Range -
Leaderboard
Version Scores By Player Ids -
Leaderboard
Version Scores By Player Ids All Of -
Leaderboard
Version Scores Page -
Leaderboard
Version Tier Scores Page -
Leaderboard
Version Tier Scores Page All Of -
Leaderboard
Version Wrapper -
Leaderboard
Versions -
Leaderboards
Api -
Paging
Params -
Validation
Error -
Validation
Error Response -
Validation
Error Response All Of
-
Add
-
Unity.
Services. Apis. Lobbies -
Bulk
Update Request -
Create
Request -
Data
Object -
Data
Object. Index Enum -
Data
Object. Visibility Enum - Detail
-
Error
Status -
ILobby
Api -
Join
By Code Request -
Join
By Id Request - Lobby
-
Lobby
Api - Player
-
Player
Data Object -
Player
Data Object. Visibility Enum -
Player
Profile -
Player
Update Request -
Query
Filter -
Query
Filter. Field Enum -
Query
Filter. Op Enum -
Query
Order -
Query
Order. Field Enum -
Query
Request -
Query
Response -
Quick
Join Request -
Token
Data -
Token
Request -
Token
Request. Token Type Enum -
Update
Request
-
Bulk
-
Unity.
Services. Apis. Matchmaker -
Backfill
Ticket -
Backfill
Ticket Properties -
Create
Backfill Ticket Request -
Create
Backfill Ticket Response -
Create
Ticket Request -
Create
Ticket Response -
IMatchmaker
Backfill Api -
IMatchmaker
Tickets Api -
Match
Id Assignment -
Match
Id Assignment. Status Enum -
Match
Properties -
Matchmaker
Backfill Api -
Matchmaker
Tickets Api -
Matchmaking
Results -
Multiplay
Assignment -
Multiplay
Assignment. Status Enum - Player
-
Problem
Details -
Qos
Result - Team
-
Ticket
Status Response
-
Backfill
-
Unity.
Services. Apis. Multiplay -
Fleet
Region -
IMultiplay
Allocations Api -
IMultiplay
Fleets Api -
List
Allocations400Response -
List
Allocations401Response -
List
Allocations403Response -
List
Allocations500Response -
Multiplay
Allocations Allocate Request -
Multiplay
Allocations Allocate Response -
Multiplay
Allocations Allocation -
Multiplay
Allocations Api -
Multiplay
Allocations List Allocations Response -
Multiplay
Allocations Pagination -
Multiplay
Fleets Api
-
Fleet
-
Unity.
Services. Apis. Player Authentication -
Apple
Game Center Config -
Authentication
Error -
Authentication
Error Details Inner -
Authentication
Error Details Inner Json Converter -
Authentication
Response -
Code
Link Confirmation Request -
Code
Link Info Request -
Code
Link Info Response -
Custom
IDRequest -
External
Id -
Generate
Code Request -
Generate
Code Response -
IPlayer
Authentication Api -
JSONWeb
Key -
JSONWeb
Key Set -
Link
External Id Request -
Link
External Id Response - Notification
-
Oculus
Config - Player
-
Player
Authentication Api -
Player
Response -
Read
Notifications Response -
Sign
In With Code Request -
Sign
In With External Token Request -
Sign
In With Session Token Request -
Sign
Up Anonymously Request -
Steam
Config -
Unlink
External Id Request -
Unlink
External Id Response -
Username
Password Password Update Request -
Username
Password Request -
Username
Password Response
-
Apple
-
Unity.
Services. Apis. Player Names -
Unity.
Services. Apis. Qo S -
Unity.
Services. Apis. Relay -
Allocate
Response Body - Allocation
-
Allocation
Data -
Allocation
Request -
Error
Response Body -
IRelay
Allocations Api -
Join
Allocation -
Join
Allocation All Of -
Join
Code Data -
Join
Code Request -
Join
Code Response Body -
Join
Data -
Join
Request -
Join
Response Body -
Key
Value Pair - Region
-
Regions
Data -
Regions
Response Body -
Relay
Allocations Api -
Relay
Server -
Relay
Server Endpoint -
Relay
Server Endpoint. Network Enum -
Response
Links -
Response
Meta
-
Allocate
-
Unity.
Services. Apis. Remote Config -
Unity.
Services. Apis. Shared -
Unity.
Services. Apis. UGC -
Add
Representation Version Request -
Add
Version Request -
Api
Error Info -
Average
Stat -
Ban
Player Request -
Banned
Player DTO -
Content
DTO -
Content
DTOPaged Result -
Content
Download Stats -
Content
Moderation Action -
Content
Moderation Audit Log DTO -
Content
Rating Request -
Content
Statistics -
Content
Upload Status -
Content
User Rating DTO -
Content
Version DTO -
Content
Version DTOPaged Result -
Content
Visibility -
Count
Stat -
Create
Representation Request -
Environment
DTO -
Environment
Detailed Statistics DTO -
Environment
Statistics DTO -
Firebase
Auth Data -
Firebase
Auth Provider -
Firebase
Custom Auth Provider -
IUGCAuth
Api -
IUGCContent
Api -
IUGCContent
Versions Api -
IUGCEnvironment
Api -
IUGCModeration
Api -
IUGCPlayer
Api -
IUGCProject
Api -
IUGCRepresentation
Api -
IUGCSubscription
Api -
IUGCTag
Api -
Moderation
Status -
Moderator
DTO -
Moderator
Detailed Statistics DTO -
Moderator
Statistics DTO -
New
Content Request -
New
Subscription Request -
Player
Role DTO -
Player
Statistics DTO -
Project
DTO -
Project
DTOPaged Result -
Project
Review Rule - Reason
-
Reject
Content Request -
Report
Content Request -
Representation
DTO -
Representation
DTOPaged Result -
Representation
Tag DTO -
Representation
Version DTO -
Representation
Version DTOPaged Result -
Subscription
DTO -
Subscription
DTOPaged Result -
Tag
DTO -
UGCAuth
Api -
UGCContent
Api -
UGCContent
Versions Api -
UGCEnvironment
Api -
UGCModeration
Api -
UGCPlayer
Api -
UGCProject
Api -
UGCRepresentation
Api -
UGCSubscription
Api -
UGCTag
Api -
Unban
Player Request -
Update
Content Request -
Update
Content Visibility Request -
Update
Representation Request -
Upload
Content Response -
Upload
Representation Version Response
-
Add