CreatorGameService
Managing one game in the Creator Hub: details, audience, rating, places, servers, team, configs, secrets, webhooks, saved data, products, analytics, activity and reports.
On this page
- Summary
- Methods
- ListManagedGames
- GetGame
- UpdateGameDetails
- SetAudience
- GetContentRating
- SubmitContentRating
- ListPlaces
- CreatePlace
- UpdatePlace
- ListPlaceVersions
- SetPlaceLiveVersion
- GetChatSettings
- UpdateChatSettings
- ListServers
- ShutdownServers
- ListCollaborators
- AddCollaborator
- UpdateCollaborator
- RemoveCollaborator
- ListConfigs
- SetConfig
- DeleteConfig
- ListSecrets
- SetSecret
- DeleteSecret
- ListServerKeys
- CreateServerKey
- RevokeServerKey
- ListWebhooks
- CreateWebhook
- UpdateWebhook
- DeleteWebhook
- RotateWebhookSecret
- TestWebhook
- ListWebhookDeliveries
- RedeliverWebhook
- ListDataStores
- ListDataStoreEntries
- GetDataStoreEntry
- SetDataStoreEntry
- DeleteDataStoreEntry
- ListLeaderboards
- ListLeaderboardEntries
- SetLeaderboardEntry
- DeleteLeaderboardEntry
- ListPlayerRoles
- GrantPlayerRole
- RevokePlayerRole
- GetPlayerScriptAccess
- GetMonetization
- ListProducts
- CreateProduct
- UpdateProduct
- GetSnapshot
- GetAudience
- GetEngagement
- GetMonitoring
- GetDiscovery
- ListExperiments
- CreateExperiment
- StopExperiment
- ApplyExperimentVariant
- ListActivity
- ListReports
- ListScriptBans
- BanFromScripting
- UnbanFromScripting
- ListGrantRules
- SaveGrantRule
- DeleteGrantRule
- ListGrantRequests
- ReviewGrantRequest
- ListBadges
- SaveBadge
- Types
- ActivityEntry
- AddCollaboratorRequest
- ApplyExperimentVariantRequest
- AudienceBucket
- BanFromScriptingRequest
- ChatSettings
- Collaborator
- CollaboratorRef
- ConfigKeyRef
- ContentRating
- CreateExperimentRequest
- CreatePlaceRequest
- CreateProductRequest
- CreateServerKeyRequest
- CreateServerKeyResponse
- CreateWebhookRequest
- DataStoreEntry
- DataStoreEntryDetail
- DataStoreEntryRef
- DataStoreInfo
- DataStoreVersion
- DiscoverySource
- Experiment
- ExperimentRef
- ExperimentVariant
- ExperimentVariantInput
- ExplorationStatus
- GameAudience
- GameConfig
- GameDaysRequest
- GameDiscovery
- GameDiscoveryRequest
- GameEngagement
- GameMonetization
- GameMonitoring
- GameRef
- GameReport
- GameSale
- GameSecret
- GameSnapshot
- GetSnapshotRequest
- GrantPlayerRoleRequest
- GrantRequestRow
- GrantRuleRef
- Leaderboard
- LeaderboardEntry
- LeaderboardEntryRef
- ListActivityRequest
- ListActivityResponse
- ListBadgesResponse
- ListCollaboratorsResponse
- ListConfigsResponse
- ListDataStoreEntriesRequest
- ListDataStoreEntriesResponse
- ListDataStoresResponse
- ListExperimentsResponse
- ListGameReportsRequest
- ListGameReportsResponse
- ListGrantRequestsRequest
- ListGrantRequestsResponse
- ListLeaderboardEntriesRequest
- ListLeaderboardEntriesResponse
- ListLeaderboardsResponse
- ListManagedGamesRequest
- ListManagedGamesResponse
- ListPlacesResponse
- ListPlaceVersionsRequest
- ListPlaceVersionsResponse
- ListPlayerRolesRequest
- ListPlayerRolesResponse
- ListProductsRequest
- ListProductsResponse
- ListScriptBansRequest
- ListScriptBansResponse
- ListSecretsResponse
- ListServerKeysResponse
- ListServersResponse
- ListWebhookDeliveriesRequest
- LiveServer
- ManagedGame
- ManagedGameSummary
- ManagedPlace
- PlayerLookupRequest
- PlayerRoleGrant
- PlayerRoleRef
- PlayerScriptAccess
- ProductRow
- RankPosition
- RatingOption
- RatingQuestion
- ReviewGrantRequestRequest
- SaveBadgeRequest
- SaveGrantRuleRequest
- ScriptBan
- ScriptBanRef
- SecretNameRef
- ServerKey
- ServerKeyRef
- SetAudienceRequest
- SetConfigRequest
- SetDataStoreEntryRequest
- SetLeaderboardEntryRequest
- SetPlaceLiveVersionRequest
- SetSecretRequest
- ShutdownServersRequest
- ShutdownServersResponse
- SnapshotMetric
- SubmitContentRatingRequest
- UpdateChatSettingsRequest
- UpdateCollaboratorRequest
- UpdateGameDetailsRequest
- UpdatePlaceRequest
- UpdateProductRequest
- UpdateWebhookRequest
- WebhookDeliveryRef
- WebhookRef
- See also
Managing one game in the Creator Hub (create.roblox.com's experience dashboard): its details, audience and rating, places and versions, live servers, team, configs, secrets, webhooks, data stores, leaderboards, passes and products, analytics, activity history and moderation. Every call names the game with game_id (its public id, exp_…, as the catalog gives it). Every call checks the caller's role on that game (creator.collaborators): owner, editor, analyst or tester. Someone who isn't on the game's team (testers aren't: they only play) gets not_found, as if the game didn't exist; a team member whose role doesn't allow the call gets permission_denied. owner everything, including the team editor everything but the team analyst the game's header and its analytics only Ids of the things managed here are public ids: a type prefix and 26 base32 digits (cfg_..., sec_..., whk_..., whd_..., col_..., act_..., srk_..., prl_..., sbn_...). Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.
Summary#
| Method | Auth | Description |
|---|---|---|
| ListManagedGames | Account | The games the caller is on the team of (owner, editor or analyst), with their role. |
| GetGame | Game team | The game's header: details, the caller's role and what it allows, rating, chat, counts. |
| UpdateGameDetails | Game team | Publish settings |
| SetAudience | Game team | draft, private (team and testers only) or public. |
| GetContentRating | Game team | |
| SubmitContentRating | Game team | Answers the questionnaire; the rating comes from the answers. |
| ListPlaces | Game team | Configurations |
| CreatePlace | Game team | |
| UpdatePlace | Game team | |
| ListPlaceVersions | Game team | |
| SetPlaceLiveVersion | Game team | |
| GetChatSettings | Game team | |
| UpdateChatSettings | Game team | |
| ListServers | Game team | The game's open servers (sessions) with who is in them. |
| ShutdownServers | Game team | Shuts servers down: the listed ones, or all of them (only those on an old version with only_outdated). Players get {"type":"session_closed"} and their match ends. |
| ListCollaborators | Game team | |
| AddCollaborator | Game team | |
| UpdateCollaborator | Game team | |
| RemoveCollaborator | Game team | |
| ListConfigs | Game team | |
| SetConfig | Game team | Creates or replaces a config value (JSON). With expected_version (> 0, or -1 for "must not exist"), only when the stored version matches: otherwise failed_precondition. |
| DeleteConfig | Game team | |
| ListSecrets | Game team | Secrets are write-only: no call returns a value. The game's servers read them with a server key (GameRuntimeService.GetSecret). |
| SetSecret | Game team | |
| DeleteSecret | Game team | |
| ListServerKeys | Game team | |
| CreateServerKey | Game team | The key is in the response once and never again. |
| RevokeServerKey | Game team | |
| ListWebhooks | Game team | |
| CreateWebhook | Game team | The signing secret is in the response once (RotateWebhookSecret makes a new one). |
| UpdateWebhook | Game team | |
| DeleteWebhook | Game team | |
| RotateWebhookSecret | Game team | |
| TestWebhook | Game team | Sends a webhook.ping event now. |
| ListWebhookDeliveries | Game team | |
| RedeliverWebhook | Game team | Sends a delivery again (a new attempt, the same event id). |
| ListDataStores | Game team | |
| ListDataStoreEntries | Game team | |
| GetDataStoreEntry | Game team | |
| SetDataStoreEntry | Game team | |
| DeleteDataStoreEntry | Game team | |
| ListLeaderboards | Game team | |
| ListLeaderboardEntries | Game team | |
| SetLeaderboardEntry | Game team | |
| DeleteLeaderboardEntry | Game team | |
| ListPlayerRoles | Game team | Player roles: named game roles (builder, admin,...) the game's neo.toml grants live-script permissions to ([script.roles.<role>], [script.players] allowed = "role:<name>"). Editors and up. Sessions get them with each player (ScriptAccess), and running sessions hear of a change at once. query filters by username (a prefix, case-insensitive), role by role. |
| GrantPlayerRole | Game team | Grants a role to a player, named by username or user_id. A role is a lower-case letter, then up to 31 lower-case letters, digits or underscores; not player (every player holds it). |
| RevokePlayerRole | Game team | |
| GetPlayerScriptAccess | Game team | What the game's sessions are told about a player (by username or user_id): their relation to the game's owners, their roles, whether they're banned from live scripting. |
| GetMonetization | Game team | Monetization |
| ListProducts | Game team | game_pass or developer_product (empty: both). |
| CreateProduct | Game team | |
| UpdateProduct | Game team | |
| GetSnapshot | Game team | Analytics (analysts too) The snapshot: Day-1 retention, new users, average playtime, DAU and daily revenue over a date range, each against the range before it. |
| GetAudience | Game team | |
| GetEngagement | Game team | |
| GetMonitoring | Game team | |
| GetDiscovery | unknown | Discovery (analysts too): impressions, play-through, retention and plays by attestation against the platform's medians; the exploration pool's state for this game and what holds it back; where it ranks. |
| ListExperiments | unknown | Thumbnail and title tests (editors and up; analysts may list them). One test runs at a time; signed-in viewers are split evenly between the control and the variants. |
| CreateExperiment | unknown | |
| StopExperiment | unknown | Ends a running test without changing the game. |
| ApplyExperimentVariant | unknown | Ends the test and makes a variant's thumbnail or title the game's. |
| ListActivity | Game team | Activity history and moderation |
| ListReports | Game team | |
| ListScriptBans | Game team | Live scripts: players banned from live scripting in this game (they still play). Editors and up. A ban reaches the game's running sessions at once (the host stops the player's live scripts). |
| BanFromScripting | Game team | Bans a player (by username or user_id); the game's owners can't be banned. Banning someone already banned changes the reason. |
| UnbanFromScripting | Game team | |
| ListGrantRules | Game team | Grant rules. Everything a running game may give a player (items, badges, in-game currency) goes through a rule declared here; a peer host can't grant anything else, and requests over a rule's caps are refused or quarantined. Editors and up change rules; analysts and up read them and the requests. |
| SaveGrantRule | Game team | Creates a rule (empty rule_id) or changes one. |
| DeleteGrantRule | Game team | |
| ListGrantRequests | Game team | The grant requests the game made: violations (refused or quarantined) by default. |
| ReviewGrantRequest | Game team | Releases a quarantined grant (it's given now) or rejects it (editors and up). |
| ListBadges | Game team | The game's badges (awarded only through a badge grant rule). |
| SaveBadge | Game team |
Methods#
ListManagedGames#
The games the caller is on the team of (owner, editor or analyst), with their role.
POST /neo.platform.v1.CreatorGameService/ListManagedGames
Content-Type: application/jsonAuth: A signed-in account. Guests are refused.
Request: ListManagedGamesRequest. Response: ListManagedGamesResponse.
GetGame#
The game's header: details, the caller's role and what it allows, rating, chat, counts.
POST /neo.platform.v1.CreatorGameService/GetGame
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ManagedGame.
UpdateGameDetails#
Publish settings
POST /neo.platform.v1.CreatorGameService/UpdateGameDetails
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: UpdateGameDetailsRequest. Response: ManagedGame.
SetAudience#
draft, private (team and testers only) or public.
POST /neo.platform.v1.CreatorGameService/SetAudience
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SetAudienceRequest. Response: ManagedGame.
GetContentRating#
POST /neo.platform.v1.CreatorGameService/GetContentRating
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ContentRating.
SubmitContentRating#
Answers the questionnaire; the rating comes from the answers.
POST /neo.platform.v1.CreatorGameService/SubmitContentRating
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SubmitContentRatingRequest. Response: ContentRating.
ListPlaces#
Configurations
POST /neo.platform.v1.CreatorGameService/ListPlaces
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListPlacesResponse.
CreatePlace#
POST /neo.platform.v1.CreatorGameService/CreatePlace
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: CreatePlaceRequest. Response: ManagedPlace.
UpdatePlace#
POST /neo.platform.v1.CreatorGameService/UpdatePlace
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: UpdatePlaceRequest. Response: ManagedPlace.
ListPlaceVersions#
POST /neo.platform.v1.CreatorGameService/ListPlaceVersions
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListPlaceVersionsRequest. Response: ListPlaceVersionsResponse.
SetPlaceLiveVersion#
POST /neo.platform.v1.CreatorGameService/SetPlaceLiveVersion
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SetPlaceLiveVersionRequest. Response: ManagedPlace.
GetChatSettings#
POST /neo.platform.v1.CreatorGameService/GetChatSettings
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ChatSettings.
UpdateChatSettings#
POST /neo.platform.v1.CreatorGameService/UpdateChatSettings
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: UpdateChatSettingsRequest. Response: ChatSettings.
ListServers#
The game's open servers (sessions) with who is in them.
POST /neo.platform.v1.CreatorGameService/ListServers
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListServersResponse.
ShutdownServers#
Shuts servers down: the listed ones, or all of them (only those on an old version with only_outdated). Players get {"type":"session_closed"} and their match ends.
POST /neo.platform.v1.CreatorGameService/ShutdownServers
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ShutdownServersRequest. Response: ShutdownServersResponse.
ListCollaborators#
POST /neo.platform.v1.CreatorGameService/ListCollaborators
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListCollaboratorsResponse.
AddCollaborator#
POST /neo.platform.v1.CreatorGameService/AddCollaborator
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: AddCollaboratorRequest. Response: Collaborator.
UpdateCollaborator#
POST /neo.platform.v1.CreatorGameService/UpdateCollaborator
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: UpdateCollaboratorRequest. Response: Collaborator.
RemoveCollaborator#
POST /neo.platform.v1.CreatorGameService/RemoveCollaborator
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: CollaboratorRef. Response: ListCollaboratorsResponse.
ListConfigs#
POST /neo.platform.v1.CreatorGameService/ListConfigs
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListConfigsResponse.
SetConfig#
Creates or replaces a config value (JSON). With expected_version (> 0, or -1 for "must not exist"), only when the stored version matches: otherwise failed_precondition.
POST /neo.platform.v1.CreatorGameService/SetConfig
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SetConfigRequest. Response: GameConfig.
DeleteConfig#
POST /neo.platform.v1.CreatorGameService/DeleteConfig
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ConfigKeyRef. Response: ListConfigsResponse.
ListSecrets#
Secrets are write-only: no call returns a value. The game's servers read them with a server key (GameRuntimeService.GetSecret).
POST /neo.platform.v1.CreatorGameService/ListSecrets
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListSecretsResponse.
SetSecret#
POST /neo.platform.v1.CreatorGameService/SetSecret
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SetSecretRequest. Response: GameSecret.
DeleteSecret#
POST /neo.platform.v1.CreatorGameService/DeleteSecret
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SecretNameRef. Response: ListSecretsResponse.
ListServerKeys#
POST /neo.platform.v1.CreatorGameService/ListServerKeys
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListServerKeysResponse.
CreateServerKey#
The key is in the response once and never again.
POST /neo.platform.v1.CreatorGameService/CreateServerKey
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: CreateServerKeyRequest. Response: CreateServerKeyResponse.
RevokeServerKey#
POST /neo.platform.v1.CreatorGameService/RevokeServerKey
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ServerKeyRef. Response: ListServerKeysResponse.
ListWebhooks#
POST /neo.platform.v1.CreatorGameService/ListWebhooks
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListWebhooksResponse.
CreateWebhook#
The signing secret is in the response once (RotateWebhookSecret makes a new one).
POST /neo.platform.v1.CreatorGameService/CreateWebhook
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: CreateWebhookRequest. Response: CreateWebhookResponse.
UpdateWebhook#
POST /neo.platform.v1.CreatorGameService/UpdateWebhook
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: UpdateWebhookRequest. Response: Webhook.
DeleteWebhook#
POST /neo.platform.v1.CreatorGameService/DeleteWebhook
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: WebhookRef. Response: ListWebhooksResponse.
RotateWebhookSecret#
POST /neo.platform.v1.CreatorGameService/RotateWebhookSecret
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: WebhookRef. Response: CreateWebhookResponse.
TestWebhook#
Sends a webhook.ping event now.
POST /neo.platform.v1.CreatorGameService/TestWebhook
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: WebhookRef. Response: WebhookDelivery.
ListWebhookDeliveries#
POST /neo.platform.v1.CreatorGameService/ListWebhookDeliveries
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListWebhookDeliveriesRequest. Response: ListWebhookDeliveriesResponse.
RedeliverWebhook#
Sends a delivery again (a new attempt, the same event id).
POST /neo.platform.v1.CreatorGameService/RedeliverWebhook
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: WebhookDeliveryRef. Response: WebhookDelivery.
ListDataStores#
POST /neo.platform.v1.CreatorGameService/ListDataStores
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListDataStoresResponse.
ListDataStoreEntries#
POST /neo.platform.v1.CreatorGameService/ListDataStoreEntries
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListDataStoreEntriesRequest. Response: ListDataStoreEntriesResponse.
GetDataStoreEntry#
POST /neo.platform.v1.CreatorGameService/GetDataStoreEntry
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: DataStoreEntryRef. Response: DataStoreEntryDetail.
SetDataStoreEntry#
POST /neo.platform.v1.CreatorGameService/SetDataStoreEntry
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SetDataStoreEntryRequest. Response: DataStoreEntryDetail.
DeleteDataStoreEntry#
POST /neo.platform.v1.CreatorGameService/DeleteDataStoreEntry
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: DataStoreEntryRef. Response: ListDataStoreEntriesResponse.
ListLeaderboards#
POST /neo.platform.v1.CreatorGameService/ListLeaderboards
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListLeaderboardsResponse.
ListLeaderboardEntries#
POST /neo.platform.v1.CreatorGameService/ListLeaderboardEntries
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListLeaderboardEntriesRequest. Response: ListLeaderboardEntriesResponse.
SetLeaderboardEntry#
POST /neo.platform.v1.CreatorGameService/SetLeaderboardEntry
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SetLeaderboardEntryRequest. Response: LeaderboardEntry.
DeleteLeaderboardEntry#
POST /neo.platform.v1.CreatorGameService/DeleteLeaderboardEntry
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: LeaderboardEntryRef. Response: ListLeaderboardEntriesResponse.
ListPlayerRoles#
Player roles: named game roles (builder, admin,...) the game's neo.toml grants live-script permissions to ([script.roles.<role>], [script.players] allowed = "role:<name>"). Editors and up. Sessions get them with each player (ScriptAccess), and running sessions hear of a change at once. query filters by username (a prefix, case-insensitive), role by role.
POST /neo.platform.v1.CreatorGameService/ListPlayerRoles
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListPlayerRolesRequest. Response: ListPlayerRolesResponse.
GrantPlayerRole#
Grants a role to a player, named by username or user_id. A role is a lower-case letter, then up to 31 lower-case letters, digits or underscores; not player (every player holds it).
POST /neo.platform.v1.CreatorGameService/GrantPlayerRole
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GrantPlayerRoleRequest. Response: PlayerRoleGrant.
RevokePlayerRole#
POST /neo.platform.v1.CreatorGameService/RevokePlayerRole
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: PlayerRoleRef. Response: ListPlayerRolesResponse.
GetPlayerScriptAccess#
What the game's sessions are told about a player (by username or user_id): their relation to the game's owners, their roles, whether they're banned from live scripting.
POST /neo.platform.v1.CreatorGameService/GetPlayerScriptAccess
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: PlayerLookupRequest. Response: PlayerScriptAccess.
GetMonetization#
Monetization
POST /neo.platform.v1.CreatorGameService/GetMonetization
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameDaysRequest. Response: GameMonetization.
ListProducts#
game_pass or developer_product (empty: both).
POST /neo.platform.v1.CreatorGameService/ListProducts
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListProductsRequest. Response: ListProductsResponse.
CreateProduct#
POST /neo.platform.v1.CreatorGameService/CreateProduct
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: CreateProductRequest. Response: Item.
UpdateProduct#
POST /neo.platform.v1.CreatorGameService/UpdateProduct
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: UpdateProductRequest. Response: Item.
GetSnapshot#
Analytics (analysts too) The snapshot: Day-1 retention, new users, average playtime, DAU and daily revenue over a date range, each against the range before it.
POST /neo.platform.v1.CreatorGameService/GetSnapshot
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GetSnapshotRequest. Response: GameSnapshot.
GetAudience#
POST /neo.platform.v1.CreatorGameService/GetAudience
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameDaysRequest. Response: GameAudience.
GetEngagement#
POST /neo.platform.v1.CreatorGameService/GetEngagement
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameDaysRequest. Response: GameEngagement.
GetMonitoring#
POST /neo.platform.v1.CreatorGameService/GetMonitoring
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: GameMonitoring.
GetDiscovery#
Discovery (analysts too): impressions, play-through, retention and plays by attestation against the platform's medians; the exploration pool's state for this game and what holds it back; where it ranks.
POST /neo.platform.v1.CreatorGameService/GetDiscovery
Content-Type: application/jsonAuth: unknown
Request: GameDiscoveryRequest. Response: GameDiscovery.
ListExperiments#
Thumbnail and title tests (editors and up; analysts may list them). One test runs at a time; signed-in viewers are split evenly between the control and the variants.
POST /neo.platform.v1.CreatorGameService/ListExperiments
Content-Type: application/jsonAuth: unknown
Request: GameRef. Response: ListExperimentsResponse.
CreateExperiment#
POST /neo.platform.v1.CreatorGameService/CreateExperiment
Content-Type: application/jsonAuth: unknown
Request: CreateExperimentRequest. Response: Experiment.
StopExperiment#
Ends a running test without changing the game.
POST /neo.platform.v1.CreatorGameService/StopExperiment
Content-Type: application/jsonAuth: unknown
Request: ExperimentRef. Response: Experiment.
ApplyExperimentVariant#
Ends the test and makes a variant's thumbnail or title the game's.
POST /neo.platform.v1.CreatorGameService/ApplyExperimentVariant
Content-Type: application/jsonAuth: unknown
Request: ApplyExperimentVariantRequest. Response: Experiment.
ListActivity#
Activity history and moderation
POST /neo.platform.v1.CreatorGameService/ListActivity
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListActivityRequest. Response: ListActivityResponse.
ListReports#
POST /neo.platform.v1.CreatorGameService/ListReports
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListGameReportsRequest. Response: ListGameReportsResponse.
ListScriptBans#
Live scripts: players banned from live scripting in this game (they still play). Editors and up. A ban reaches the game's running sessions at once (the host stops the player's live scripts).
POST /neo.platform.v1.CreatorGameService/ListScriptBans
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListScriptBansRequest. Response: ListScriptBansResponse.
BanFromScripting#
Bans a player (by username or user_id); the game's owners can't be banned. Banning someone already banned changes the reason.
POST /neo.platform.v1.CreatorGameService/BanFromScripting
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: BanFromScriptingRequest. Response: ScriptBan.
UnbanFromScripting#
POST /neo.platform.v1.CreatorGameService/UnbanFromScripting
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ScriptBanRef. Response: ListScriptBansResponse.
ListGrantRules#
Grant rules. Everything a running game may give a player (items, badges, in-game currency) goes through a rule declared here; a peer host can't grant anything else, and requests over a rule's caps are refused or quarantined. Editors and up change rules; analysts and up read them and the requests.
POST /neo.platform.v1.CreatorGameService/ListGrantRules
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListGrantRulesResponse.
SaveGrantRule#
Creates a rule (empty rule_id) or changes one.
POST /neo.platform.v1.CreatorGameService/SaveGrantRule
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SaveGrantRuleRequest. Response: GrantRule.
DeleteGrantRule#
POST /neo.platform.v1.CreatorGameService/DeleteGrantRule
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GrantRuleRef. Response: ListGrantRulesResponse.
ListGrantRequests#
The grant requests the game made: violations (refused or quarantined) by default.
POST /neo.platform.v1.CreatorGameService/ListGrantRequests
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ListGrantRequestsRequest. Response: ListGrantRequestsResponse.
ReviewGrantRequest#
Releases a quarantined grant (it's given now) or rejects it (editors and up).
POST /neo.platform.v1.CreatorGameService/ReviewGrantRequest
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: ReviewGrantRequestRequest. Response: GrantRequestRow.
ListBadges#
The game's badges (awarded only through a badge grant rule).
POST /neo.platform.v1.CreatorGameService/ListBadges
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: GameRef. Response: ListBadgesResponse.
SaveBadge#
POST /neo.platform.v1.CreatorGameService/SaveBadge
Content-Type: application/jsonAuth: A signed-in account on the game's team (owner, editor or analyst: each method says which roles). Anyone else gets not_found, as if the game didn't exist.
Request: SaveBadgeRequest. Response: Badge.
Types#
ActivityEntry#
| Field | Type | Description |
|---|---|---|
id | string | |
action | string | |
targetKind | string | |
targetId | string | |
summary | string | |
actor | UserSummary | |
before | string | JSON text (empty when none) |
after | string | |
at | string |
AddCollaboratorRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
username | string | |
role | string |
ApplyExperimentVariantRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
experimentId | string | |
variantId | string | the variant to apply (its thumbnail or title becomes the game's); ends the test |
AudienceBucket#
| Field | Type | Description |
|---|---|---|
label | string | |
players | string (int64) |
BanFromScriptingRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
username | string | the player: by username (a leading @ is ignored) or by user id |
userId | string | |
reason | string | at most 500 characters |
ChatSettings#
| Field | Type | Description |
|---|---|---|
chatMode | string | |
updatedAt | string | |
updatedBy | UserSummary |
Collaborator#
| Field | Type | Description |
|---|---|---|
id | string | |
user | UserSummary | |
role | string | |
creator | boolean | the game's creator: always an owner, can't be removed |
addedAt | string | |
addedBy | UserSummary |
CollaboratorRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
collaboratorId | string |
ConfigKeyRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
key | string |
ContentRating#
| Field | Type | Description |
|---|---|---|
id | string | empty until answered |
questions | array of RatingQuestion | |
answers | object (map of string to string) | |
rating | string | |
descriptors | array of string | Why: e.g. "Mild violence", "Strong language". |
questionnaire | number | |
submittedAt | string | |
submittedBy | UserSummary |
CreateExperimentRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
kind | string | thumbnail or title |
name | string | |
variants | array of ExperimentVariantInput | 1-3 alternatives; the game's current thumbnail or title is the control |
CreatePlaceRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
name | string | |
hostingTier | string | |
maxPlayers | number |
CreateProductRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
kind | string | |
name | string | |
description | string | |
price | string (int64) |
CreateServerKeyRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
name | string |
CreateServerKeyResponse#
| Field | Type | Description |
|---|---|---|
key | ServerKey | |
secret | string |
CreateWebhookRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
url | string | |
events | array of string |
DataStoreEntry#
| Field | Type | Description |
|---|---|---|
scope | string | "global" or "user" |
userId | string | for "user" entries: whose |
key | string | |
version | string (int64) | |
size | string (int64) | |
updatedAt | string |
DataStoreEntryDetail#
| Field | Type | Description |
|---|---|---|
entry | DataStoreEntry | |
value | string | JSON text |
history | array of DataStoreVersion |
DataStoreEntryRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
store | string | |
scope | string | |
userId | string | |
key | string |
DataStoreInfo#
| Field | Type | Description |
|---|---|---|
name | string | |
entries | string (int64) | |
bytes | string (int64) | |
updatedAt | string |
DataStoreVersion#
| Field | Type | Description |
|---|---|---|
version | string (int64) | |
value | string | |
writtenAt | string | |
deleted | boolean |
DiscoverySource#
| Field | Type | Description |
|---|---|---|
source | string | |
plays | string (int64) |
Experiment#
| Field | Type | Description |
|---|---|---|
id | string | xpt_... |
kind | string | thumbnail or title |
name | string | |
status | string | running, stopped or applied |
variants | array of ExperimentVariant | |
startedAt | string | |
endedAt | string | |
createdBy | UserSummary | |
winnerVariantId | string | the variant applied when it ended (applied) |
significant | boolean | the leading variant is significantly better than the control (p < 0.05) |
ExperimentRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
experimentId | string |
ExperimentVariant#
| Field | Type | Description |
|---|---|---|
id | string | xvr_... |
label | string | |
position | number | 0: the control |
thumbnailUrl | string | |
title | string | |
impressions | string (int64) | results so far: impressions (signed-in viewers), discovered plays of a minute or more, and play-through (percent x100) with a 95% confidence interval |
plays | string (int64) | |
playThrough | string (int64) | |
playThroughLow | string (int64) | |
playThroughHigh | string (int64) | |
lift | string (int64) | against the control: the relative change (percent x100) and the two-sided p-value (x10000) |
pValue | string (int64) |
ExperimentVariantInput#
| Field | Type | Description |
|---|---|---|
label | string | |
thumbnailUrl | string | a thumbnail test: an uploaded image's URL (CatalogService.UploadContent) |
title | string | a title test: 3-60 characters |
ExplorationStatus#
| Field | Type | Description |
|---|---|---|
status | string | exploring, graduated, exhausted, grandfathered (public before the pool existed), or not_public / ineligible |
reason | string | new, updated or existing |
enteredAt | string | |
budget | string (int64) | qualified impressions: the budget, and how many it has had |
impressions | string (int64) | |
playThrough | string (int64) | the newest decision's measures (percent x100) and the genre medians they're held against |
d1Retention | string (int64) | |
d1Cohort | string (int64) | |
genrePlayThrough | string (int64) | |
genreD1Retention | string (int64) | |
heldBackBy | string | what kept it from graduating: sample (too few impressions or players yet), play_through, d1_retention, eligibility (the minimum bar: see missing), or empty |
missing | array of string | what the game still needs to enter the pool: a description, a thumbnail, a content rating |
decidedAt | string | |
boostUntil | string | the freshness boost after a substantial update (empty: none) |
GameAudience#
| Field | Type | Description |
|---|---|---|
ageBands | array of AudienceBucket | |
newPlayers | string (int64) | |
returningPlayers | string (int64) | |
players | string (int64) | |
newSeries | array of DailyPoint |
GameConfig#
| Field | Type | Description |
|---|---|---|
id | string | |
key | string | |
value | string | JSON text |
description | string | |
version | string (int64) | |
updatedAt | string | |
updatedBy | UserSummary |
GameDaysRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
days | number |
GameDiscovery#
| Field | Type | Description |
|---|---|---|
days | number | the window (days) and the measures over it |
impressions | string (int64) | |
discoveredPlays | string (int64) | plays of a minute or more that started from a discovery tile |
playThrough | string (int64) | percent x100: discovered plays per impression (signed-in viewers) |
platformPlayThrough | string (int64) | |
qualifiedPlays | string (int64) | |
medianSessionSeconds | string (int64) | |
platformMedianSessionSeconds | string (int64) | |
d1Retention | string (int64) | percent x100 |
d7Retention | string (int64) | |
platformD1Retention | string (int64) | |
attestedPlays | string (int64) | plays by attestation: attested, low trust (counted at a discount), unattested (not counted) |
lowTrustPlays | string (int64) | |
unattestedPlays | string (int64) | |
impressionsSeries | array of DailyPoint | |
playsSeries | array of DailyPoint | |
sources | array of DiscoverySource | where qualified plays came from (home, charts, search, direct,...) |
exploration | ExplorationStatus | |
ranks | array of RankPosition | where it ranks for adults on the web, at the newest refresh |
rankedAt | string |
GameDiscoveryRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
days | number | 7 to 90 days (default 28) |
GameEngagement#
| Field | Type | Description |
|---|---|---|
sessionLengths | array of AudienceBucket | |
sessionsPerPlayer | array of AudienceBucket | |
sessions | string (int64) | |
avgSessionSeconds | string (int64) | |
peakConcurrent | string (int64) | |
playtimeMinutes | array of DailyPoint |
GameMonetization#
| Field | Type | Description |
|---|---|---|
revenue | array of DailyPoint | |
revenueTotal | string (int64) | |
salesTotal | string (int64) | |
passes | string (int64) | |
products | string (int64) | |
sales | array of GameSale | |
payers | string (int64) | paying players in the period, and the share of active players they are (0-100) |
payerShare | number |
GameMonitoring#
| Field | Type | Description |
|---|---|---|
liveServers | string (int64) | |
playersNow | string (int64) | |
serversOutdated | string (int64) | |
datastoreBytes | string (int64) | |
datastoreMaxBytes | string (int64) | |
datastoreRequestsThisMinute | string (int64) | |
datastoreRequestsPerMinute | string (int64) | |
webhookDeliveries24h | string (int64) | |
webhookFailures24h | string (int64) | |
webhookPending | string (int64) | |
serversStarted | array of DailyPoint |
GameRef#
| Field | Type | Description |
|---|---|---|
gameId | string |
GameReport#
| Field | Type | Description |
|---|---|---|
id | string | |
targetKind | string | experience (the game itself) or user (a player, reported while in the game) |
category | string | |
details | string | |
status | string | open, actioned, dismissed |
createdAt | string | |
resolvedAt | string | |
resolution | string | |
reportedUser | UserSummary | for reports about a player |
GameSale#
| Field | Type | Description |
|---|---|---|
transactionId | string | |
itemId | string | |
itemName | string | |
kind | string | |
price | string (int64) | |
earned | string (int64) | |
createdAt | string |
GameSecret#
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
size | number | the value's length in bytes: the only thing ever shown of it |
createdAt | string | |
updatedAt | string | |
updatedBy | UserSummary | |
lastReadAt | string |
GameSnapshot#
| Field | Type | Description |
|---|---|---|
startDate | string | |
endDate | string | |
metrics | array of SnapshotMetric |
GetSnapshotRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
startDate | string | YYYY-MM-DD, inclusive (UTC days). Empty: the last 7 days. |
endDate | string |
GrantPlayerRoleRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
username | string | the player: by username (a leading @ is ignored) or by user id |
userId | string | |
role | string |
GrantRequestRow#
| Field | Type | Description |
|---|---|---|
id | string | |
ruleId | string | |
ruleName | string | |
outcome | string | granted, refused, quarantined, released, rejected |
reason | string | why it was refused or held (unknown_rule, rule_disabled, not_authority, player_not_in_session, wrong_event, bad_amount, daily_cap, daily_amount_cap, missing_receipt, receipt_used, missing_item, already_owned, already_awarded, protected_store_write, suspicious_session) |
violation | boolean | |
askedBy | UserSummary | |
via | string | game_token or server_key |
sessionId | string | |
player | UserSummary | |
amount | string (int64) | |
event | string | |
createdAt | string | |
reviewedBy | UserSummary | |
reviewedAt | string |
GrantRuleRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
ruleId | string |
Leaderboard#
| Field | Type | Description |
|---|---|---|
name | string | |
entries | string (int64) | |
top | string (int64) | |
updatedAt | string |
LeaderboardEntry#
| Field | Type | Description |
|---|---|---|
key | string | |
value | string (int64) | |
rank | string (int64) | |
user | UserSummary | when the key is a player's user id |
updatedAt | string |
LeaderboardEntryRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
store | string | |
key | string |
ListActivityRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
action | string | an action prefix, e.g. "config." (empty: everything) |
before | string | continue before this activity id |
limit | number |
ListActivityResponse#
| Field | Type | Description |
|---|---|---|
entries | array of ActivityEntry | |
next | string |
ListBadgesResponse#
| Field | Type | Description |
|---|---|---|
badges | array of Badge |
ListCollaboratorsResponse#
| Field | Type | Description |
|---|---|---|
collaborators | array of Collaborator |
ListConfigsResponse#
| Field | Type | Description |
|---|---|---|
configs | array of GameConfig |
ListDataStoreEntriesRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
store | string | |
scope | string | "global", "user" (every player's), or empty (both) |
prefix | string | |
after | string | |
limit | number |
ListDataStoreEntriesResponse#
| Field | Type | Description |
|---|---|---|
entries | array of DataStoreEntry | |
next | string |
ListDataStoresResponse#
| Field | Type | Description |
|---|---|---|
stores | array of DataStoreInfo | |
bytes | string (int64) | |
maxBytes | string (int64) | |
entries | string (int64) | |
requestsThisMinute | string (int64) | requests in the current minute, and the limit right now |
requestsPerMinute | string (int64) |
ListExperimentsResponse#
| Field | Type | Description |
|---|---|---|
experiments | array of Experiment |
ListGameReportsRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
status | string |
ListGameReportsResponse#
| Field | Type | Description |
|---|---|---|
reports | array of GameReport | |
open | string (int64) | |
moderation | string | |
moderationReason | string | |
versionsInReview | array of PlaceVersion |
ListGrantRequestsRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
filter | string | violations (default: refused or quarantined as cheating), quarantined, granted, all |
limit | number |
ListGrantRequestsResponse#
| Field | Type | Description |
|---|---|---|
requests | array of GrantRequestRow | |
violations7d | string (int64) | |
quarantined | string (int64) | |
granted7d | string (int64) |
ListLeaderboardEntriesRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
store | string | |
limit | number | |
offset | number | |
ascending | boolean |
ListLeaderboardEntriesResponse#
| Field | Type | Description |
|---|---|---|
entries | array of LeaderboardEntry | |
total | string (int64) |
ListLeaderboardsResponse#
| Field | Type | Description |
|---|---|---|
leaderboards | array of Leaderboard |
ListManagedGamesRequest#
No fields: send {}.
ListManagedGamesResponse#
| Field | Type | Description |
|---|---|---|
games | array of ManagedGameSummary |
ListPlacesResponse#
| Field | Type | Description |
|---|---|---|
places | array of ManagedPlace |
ListPlaceVersionsRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
placeId | string | |
limit | number | |
beforeNumber | string (int64) |
ListPlaceVersionsResponse#
| Field | Type | Description |
|---|---|---|
versions | array of PlaceVersion | |
liveVersionId | string |
ListPlayerRolesRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
query | string | a username prefix (case-insensitive; a leading @ is ignored) |
role | string | only this role (empty: every role) |
ListPlayerRolesResponse#
| Field | Type | Description |
|---|---|---|
grants | array of PlayerRoleGrant | |
roles | array of string | every role in use in the game, sorted (whatever the filters) |
ListProductsRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
kind | string |
ListProductsResponse#
| Field | Type | Description |
|---|---|---|
products | array of ProductRow |
ListScriptBansRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
query | string | a username prefix (case-insensitive; a leading @ is ignored) |
ListScriptBansResponse#
| Field | Type | Description |
|---|---|---|
bans | array of ScriptBan |
ListSecretsResponse#
| Field | Type | Description |
|---|---|---|
secrets | array of GameSecret | |
serverKeys | boolean |
ListServerKeysResponse#
| Field | Type | Description |
|---|---|---|
keys | array of ServerKey |
ListServersResponse#
| Field | Type | Description |
|---|---|---|
servers | array of LiveServer | |
players | string (int64) |
ListWebhookDeliveriesRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
webhookId | string | |
limit | number |
LiveServer#
| Field | Type | Description |
|---|---|---|
id | string | |
placeId | string | |
placeName | string | |
versionNumber | string (int64) | |
onLiveVersion | boolean | whether it runs the place's live version |
hostingTier | string | |
maxPlayers | number | |
host | UserSummary | |
players | array of UserSummary | |
startedAt | string |
ManagedGame#
| Field | Type | Description |
|---|---|---|
game | Experience | |
role | string | |
permissions | array of string | What the role allows: view, analytics, edit, team, moderation. |
rating | string | minimal, mild, moderate, restricted; empty until the questionnaire is answered. |
chatMode | string | on, quick_chat, off |
places | string (int64) | |
liveServers | string (int64) | |
likes | string (int64) | |
moderation | string | ok or taken_down (the platform's moderation) |
moderationReason | string | |
genre | string |
ManagedGameSummary#
| Field | Type | Description |
|---|---|---|
game | Experience | |
role | string | owner, editor, analyst |
ManagedPlace#
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
isStart | boolean | |
hostingTier | string | |
maxPlayers | number | |
liveVersion | PlaceVersion | |
versions | string (int64) | |
liveServers | string (int64) |
PlayerLookupRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
username | string | |
userId | string |
PlayerRoleGrant#
| Field | Type | Description |
|---|---|---|
id | string | |
user | UserSummary | |
role | string | |
grantedAt | string | |
grantedBy | UserSummary |
PlayerRoleRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
grantId | string |
PlayerScriptAccess#
| Field | Type | Description |
|---|---|---|
user | UserSummary | |
access | ScriptAccess |
ProductRow#
| Field | Type | Description |
|---|---|---|
item | Item | |
status | string | listed, delisted, review |
revenue | string (int64) |
RankPosition#
| Field | Type | Description |
|---|---|---|
sort | string | popular, trending, up_and_coming, top_rated, most_engaging, recommended |
position | number | 1-based; 0: not ranked |
of | number | games ranked in that sort for the segment |
RatingOption#
| Field | Type | Description |
|---|---|---|
value | string | |
label | string |
RatingQuestion#
| Field | Type | Description |
|---|---|---|
id | string | |
text | string | |
options | array of RatingOption |
ReviewGrantRequestRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
requestId | string | |
decision | string | release or reject |
SaveBadgeRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
badgeId | string | empty: a new badge |
name | string | |
description | string | |
enabled | boolean |
SaveGrantRuleRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
ruleId | string | empty: a new rule |
name | string | |
description | string | |
kind | string | |
itemId | string | |
badgeId | string | |
currency | string | |
event | string | |
maxAmount | string (int64) | |
maxPerPlayerPerDay | number | |
maxAmountPerPlayerPerDay | string (int64) | 0: max_amount x max_per_player_per_day |
precondition | string | |
requiresItemId | string | |
overCap | string | |
enabled | boolean |
ScriptBan#
| Field | Type | Description |
|---|---|---|
id | string | |
user | UserSummary | |
reason | string | why, for the team (never shown to the player) |
bannedAt | string | |
bannedBy | UserSummary |
ScriptBanRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
banId | string |
SecretNameRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
name | string |
ServerKey#
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
prefix | string | |
createdAt | string | |
lastUsedAt | string | |
createdBy | UserSummary |
ServerKeyRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
keyId | string |
SetAudienceRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
visibility | string |
SetConfigRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
key | string | |
value | string | |
description | string | |
expectedVersion | string (int64) |
SetDataStoreEntryRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
store | string | |
scope | string | |
userId | string | |
key | string | |
value | string | |
expectedVersion | string (int64) | > 0: only when the entry is at this version (0: no check) |
SetLeaderboardEntryRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
store | string | |
key | string | |
value | string (int64) |
SetPlaceLiveVersionRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
placeId | string | |
versionId | string |
SetSecretRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
name | string | |
value | string |
ShutdownServersRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
serverIds | array of string | empty: every open server of the game |
onlyOutdated | boolean | |
reason | string |
ShutdownServersResponse#
| Field | Type | Description |
|---|---|---|
servers | string (int64) | |
players | string (int64) |
SnapshotMetric#
| Field | Type | Description |
|---|---|---|
id | string | day1_retention, new_users, avg_playtime, dau, daily_revenue |
label | string | |
value | string (int64) | the value over the range (retention: percent x100; playtime: seconds per active user per day; dau and revenue: per day, x100 for two decimals) |
previous | string (int64) | |
unit | string | |
series | array of DailyPoint |
SubmitContentRatingRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
answers | object (map of string to string) |
UpdateChatSettingsRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
chatMode | string |
UpdateCollaboratorRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
collaboratorId | string | |
role | string |
UpdateGameDetailsRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
title | string | Empty fields are unchanged. |
description | string | |
genre | string | |
thumbnailUrl | string |
UpdatePlaceRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
placeId | string | |
name | string | Empty / 0: unchanged. |
hostingTier | string | |
maxPlayers | number |
UpdateProductRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
itemId | string | |
name | string | |
description | string | |
price | string (int64) | -1: unchanged |
status | string | listed or delisted; empty: unchanged |
UpdateWebhookRequest#
| Field | Type | Description |
|---|---|---|
gameId | string | |
webhookId | string | |
url | string | empty: unchanged |
events | array of string | |
active | string | "true" / "false"; empty: unchanged |
WebhookDeliveryRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
deliveryId | string |
WebhookRef#
| Field | Type | Description |
|---|---|---|
gameId | string | |
webhookId | string |