package nakama.api
Get desktop application:
View/edit binary Protocol Buffers messages
message
api.proto:34A user with additional account details. Always the current user.
optional user = 1
The user object.
string wallet = 2
The user's wallet data.
string email = 3
The email address of the user.
repeated devices = 4
The devices which belong to the user's account.
string custom_id = 5
The custom id in the user's account.
optional verify_time = 6
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user's email was verified.
optional disable_time = 7
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user's account was disabled/banned.
message
api.proto:60Send a Apple Sign In token to the server. Used with authenticate/link/unlink.
Used in:
string token = 1
The ID token received from Apple to validate.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:68Send a custom ID to the server. Used with authenticate/link/unlink.
Used in:
string id = 1
A custom identifier.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:76Send a device to the server. Used with authenticate/link/unlink and user.
Used in: ,
string id = 1
A device identifier. Should be obtained by a platform-specific device API.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:84Send an email with password to the server. Used with authenticate/link/unlink.
Used in:
string email = 1
A valid RFC-5322 email address.
string password = 2
A password for the user account.
Ignored with unlink operations.
map<string, string> vars = 3
Extra information that will be bundled in the session token.
message
api.proto:94Send a Facebook token to the server. Used with authenticate/link/unlink.
Used in: , ,
string token = 1
The OAuth token received from Facebook to access their profile API.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:102Send a Facebook Instant Game token to the server. Used with authenticate/link/unlink.
Used in:
string signed_player_info = 1
The OAuth token received from a Facebook Instant Game that may be decoded with the Application Secret (must be available with the nakama configuration)
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:110Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.
https://developer.apple.com/documentation/gamekit/gklocalplayer/1515407-generateidentityverificationsign
Used in:
string player_id = 1
Player ID (generated by GameCenter).
string bundle_id = 2
Bundle ID (generated by GameCenter).
int64 timestamp_seconds = 3
Time since UNIX epoch when the signature was created.
string salt = 4
A random "NSString" used to compute the hash and keep it randomized.
string signature = 5
The verification signature data generated.
string public_key_url = 6
The URL for the public encryption key.
map<string, string> vars = 7
Extra information that will be bundled in the session token.
message
api.proto:130Send a Google token to the server. Used with authenticate/link/unlink.
Used in:
string token = 1
The OAuth token received from Google to access their profile API.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:52Obtain a new authentication token using a refresh token.
string token = 1
Refresh token.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:138Send a Steam token to the server. Used with authenticate/link/unlink.
Used in: , ,
string token = 1
The account token received from Steam to access their profile API.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:146Add one or more friends to the current user.
repeated string ids = 1
The account id of a user.
repeated string usernames = 2
The account username of a user.
string metadata = 3
Optional metadata to add to friends.
message
api.proto:156Add users to a group.
string group_id = 1
The group to add users to.
repeated string user_ids = 2
The users to add.
message
api.proto:180Authenticate against the server with Apple Sign In.
optional account = 1
The Apple account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
message
api.proto:190Authenticate against the server with a custom ID.
optional account = 1
The custom account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
message
api.proto:200Authenticate against the server with a device ID.
optional account = 1
The device account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
message
api.proto:210Authenticate against the server with email+password.
optional account = 1
The email account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
message
api.proto:232Authenticate against the server with Facebook Instant Game token.
optional account = 1
The Facebook Instant Game account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
message
api.proto:220Authenticate against the server with Facebook.
optional account = 1
The Facebook account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
optional sync = 4
Import Facebook friends for the user.
message
api.proto:242Authenticate against the server with Apple's Game Center.
optional account = 1
The Game Center account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
message
api.proto:252Authenticate against the server with Google.
optional account = 1
The Google account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
message
api.proto:262Authenticate against the server with Steam.
optional account = 1
The Steam account details.
optional create = 2
Register the account if the user does not already exist.
string username = 3
Set the username on the account at register. Must be unique.
optional sync = 4
Import Steam friends for the user.
message
api.proto:274Ban users from a group.
string group_id = 1
The group to ban users from.
repeated string user_ids = 2
The users to ban.
message
api.proto:282Block one or more friends for the current user.
repeated string ids = 1
The account id of a user.
repeated string usernames = 2
The account username of a user.
message
api.proto:290A message sent on a channel.
Used in: ,
string channel_id = 1
The channel this message belongs to.
string message_id = 2
The unique ID of this message.
optional code = 3
The code representing a message type or category.
string sender_id = 4
Message sender, usually a user ID.
string username = 5
The username of the message sender, if any.
string content = 6
The content payload.
optional create_time = 7
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
optional update_time = 8
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
optional persistent = 9
True if the message was persisted to the channel's history, false otherwise.
string room_name = 10
The name of the chat room, or an empty string if this message was not sent through a chat room.
string group_id = 11
The ID of the group, or an empty string if this message was not sent through a group channel.
string user_id_one = 12
The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
string user_id_two = 13
The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
message
api.proto:320A list of channel messages, usually a result of a list operation.
repeated messages = 1
A list of messages.
string next_cursor = 2
The cursor to send when retrieving the next page, if any.
string prev_cursor = 3
The cursor to send when retrieving the previous page, if any.
string cacheable_cursor = 4
Cacheable cursor to list newer messages. Durable and designed to be stored, unlike next/prev cursors.
message
api.proto:332Create a group with the current user as owner.
string name = 1
A unique name for the group.
string description = 2
A description for the group.
string lang_tag = 3
The language expected to be a tag which follows the BCP-47 spec.
string avatar_url = 4
A URL for an avatar image.
bool open = 5
Mark a group as open or not where only admins can accept members.
int32 max_count = 6
Maximum number of group members.
message
api.proto:348Delete one or more friends for the current user.
repeated string ids = 1
The account id of a user.
repeated string usernames = 2
The account username of a user.
message
api.proto:356Delete a group the user has access to.
string group_id = 1
The id of a group.
message
api.proto:362Delete a leaderboard record.
string leaderboard_id = 1
The leaderboard ID to delete from.
message
api.proto:368Delete one or more notifications for the current user.
repeated string ids = 1
The id of notifications.
message
api.proto:380Storage objects to delete.
Used in:
string collection = 1
The collection which stores the object.
string key = 2
The key of the object within the collection.
string version = 3
The version hash of the object.
message
api.proto:390Batch delete storage objects.
repeated object_ids = 1
Batch of storage objects.
message
api.proto:374Delete a leaderboard record.
string tournament_id = 1
The tournament ID to delete from.
message
api.proto:917Demote a set of users in a group to the next role down.
string group_id = 1
The group ID to demote in.
repeated string user_ids = 2
The users to demote.
message
api.proto:396Represents an event to be passed through the server to registered event handlers.
string name = 1
An event name, type, category, or identifier.
map<string, string> properties = 2
Arbitrary event property values.
optional timestamp = 3
The time when the event was triggered.
bool external = 4
True if the event came directly from a client call, false otherwise.
message
api.proto:408A friend of a user.
Used in:
optional user = 1
The user object.
optional state = 2
The friend status.
one of "Friend.State".
optional update_time = 3
Time of the latest relationship update.
string metadata = 4
Metadata.
The friendship status.
FRIEND = 0
The user is a friend of the current user.
INVITE_SENT = 1
The current user has sent an invite to the user.
INVITE_RECEIVED = 2
The current user has received an invite from this user.
BLOCKED = 3
The current user has blocked this user.
message
api.proto:432A collection of zero or more friends of the user.
repeated friends = 1
The Friend objects.
string cursor = 2
Cursor for the next page of results, if any.
message
api.proto:440A List of friends of friends
repeated friends_of_friends = 1
User friends of friends.
string cursor = 2
Cursor for the next page of results, if any.
message
api.proto:442A friend of a friend.
Used in:
string referrer = 1
The user who referred its friend.
optional user = 2
User.
message
api.proto:465Fetch a subscription by product id.
string product_id = 1
Product id of the subscription
message
api.proto:455Fetch a batch of zero or more users from the server.
repeated string ids = 1
The account id of a user.
repeated string usernames = 2
The account username of a user.
repeated string facebook_ids = 3
The Facebook ID of a user.
message
api.proto:471A group in the server.
Used in: ,
string id = 1
The id of a group.
string creator_id = 2
The id of the user who created the group.
string name = 3
The unique name of the group.
string description = 4
A description for the group.
string lang_tag = 5
The language expected to be a tag which follows the BCP-47 spec.
string metadata = 6
Additional information stored as a JSON object.
string avatar_url = 7
A URL for an avatar image.
optional open = 8
Anyone can join open groups, otherwise only admins can accept members.
int32 edge_count = 9
The current count of all members in the group.
int32 max_count = 10
The maximum number of members allowed.
optional create_time = 11
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
optional update_time = 12
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
message
api.proto:499One or more groups returned from a listing operation.
repeated groups = 1
One or more groups.
string cursor = 2
A cursor used to get the next page.
message
api.proto:507A list of users belonging to a group, along with their role.
repeated group_users = 1
User-role pairs for a group.
string cursor = 2
Cursor for the next page of results, if any.
message
api.proto:509A single user-role pair.
Used in:
optional user = 1
User.
optional state = 2
Their relationship to the group.
The group role status.
SUPERADMIN = 0
The user is a superadmin with full control of the group.
ADMIN = 1
The user is an admin with additional privileges.
MEMBER = 2
The user is a regular member.
JOIN_REQUEST = 3
The user has requested to join the group
message
api.proto:535Import Facebook friends into the current user's account.
optional account = 1
The Facebook account details.
optional reset = 2
Reset the current user's friends list.
message
api.proto:543Import Facebook friends into the current user's account.
optional account = 1
The Facebook account details.
optional reset = 2
Reset the current user's friends list.
message
api.proto:551Immediately join an open group, or request to join a closed one.
string group_id = 1
The group ID to join. The group must already exist.
message
api.proto:557The request to join a tournament.
string tournament_id = 1
The ID of the tournament to join. The tournament must already exist.
message
api.proto:563Kick a set of users from a group.
string group_id = 1
The group ID to kick from.
repeated string user_ids = 2
The users to kick.
message
api.proto:571A leaderboard on the server.
Used in:
string id = 1
The ID of the leaderboard.
uint32 sort_order = 2
ASC(0) or DESC(1) sort mode of scores in the leaderboard.
Operator operator = 3
BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
uint32 prev_reset = 4
The UNIX time when the leaderboard was previously reset. A computed value.
uint32 next_reset = 5
The UNIX time when the leaderboard is next playable. A computed value.
string metadata = 6
Additional information stored as a JSON object.
optional create_time = 7
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
bool authoritative = 8
Whether the leaderboard was created authoritatively or not.
message
api.proto:591A list of leaderboards
repeated leaderboards = 1
The list of leaderboards returned.
string cursor = 2
A pagination cursor (optional).
message
api.proto:599Represents a complete leaderboard record with all scores and associated metadata.
Used in: ,
string leaderboard_id = 1
The ID of the leaderboard this score belongs to.
string owner_id = 2
The ID of the score owner, usually a user or group.
optional username = 3
The username of the score owner, if the owner is a user.
int64 score = 4
The score value.
int64 subscore = 5
An optional subscore value.
int32 num_score = 6
The number of submissions to this score record.
string metadata = 7
Metadata.
optional create_time = 8
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
optional update_time = 9
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
optional expiry_time = 10
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
int64 rank = 11
The rank of this record.
uint32 max_num_score = 12
The maximum number of score updates allowed by the owner.
message
api.proto:627A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
repeated records = 1
A list of leaderboard records.
repeated owner_records = 2
A batched set of leaderboard records belonging to specified owners.
string next_cursor = 3
The cursor to send when retrieving the next page, if any.
string prev_cursor = 4
The cursor to send when retrieving the previous page, if any.
int64 rank_count = 5
The total number of ranks available.
message
api.proto:641Leave a group.
string group_id = 1
The group ID to leave.
message
api.proto:647Link Facebook to the current user's account.
optional account = 1
The Facebook account details.
optional sync = 2
Import Facebook friends for the user.
message
api.proto:655Link Steam to the current user's account.
optional account = 1
The Facebook account details.
optional sync = 2
Import Steam friends for the user.
message
api.proto:663List a channel's message history.
string channel_id = 1
The channel ID to list from.
optional limit = 2
Max number of records to return. Between 1 and 100.
optional forward = 3
True if listing should be older messages to newer, false if reverse.
string cursor = 4
A pagination cursor, if any.
message
api.proto:684optional limit = 1
Max number of records to return. Between 1 and 100.
string cursor = 2
An optional next page cursor.
message
api.proto:675List friends for a user.
optional limit = 1
Max number of records to return. Between 1 and 1000.
optional state = 2
The friend state to list.
string cursor = 3
An optional next page cursor.
message
api.proto:708List all users that are part of a group.
string group_id = 1
The group ID to list from.
optional limit = 2
Max number of records to return. Between 1 and 100.
optional state = 3
The group user state to list.
string cursor = 4
An optional next page cursor.
message
api.proto:692List groups based on given filters.
string name = 1
List groups that contain this value in their names.
string cursor = 2
Optional pagination cursor.
optional limit = 3
Max number of groups to return. Between 1 and 100.
string lang_tag = 4
Language tag filter
optional members = 5
Number of group members
optional open = 6
Optional Open/Closed filter.
message
api.proto:720List leaerboard records from a given leaderboard around the owner.
string leaderboard_id = 1
The ID of the tournament to list for.
optional limit = 2
Max number of records to return. Between 1 and 100.
string owner_id = 3
The owner to retrieve records around.
optional expiry = 4
Expiry in seconds (since epoch) to begin fetching records from.
string cursor = 5
A next or previous page cursor.
message
api.proto:734List leaderboard records from a given leaderboard.
string leaderboard_id = 1
The ID of the leaderboard to list for.
repeated string owner_ids = 2
One or more owners to retrieve records for.
optional limit = 3
Max number of records to return. Between 1 and 100.
string cursor = 4
A next or previous page cursor.
optional expiry = 5
Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
message
api.proto:748List realtime matches.
optional limit = 1
Limit the number of returned matches.
optional authoritative = 2
Authoritative or relayed matches.
optional label = 3
Label filter.
optional min_size = 4
Minimum user count.
optional max_size = 5
Maximum user count.
optional query = 6
Arbitrary label query.
message
api.proto:764Get a list of unexpired notifications.
optional limit = 1
The number of notifications to get. Between 1 and 100.
string cacheable_cursor = 2
A cursor to page through notifications. May be cached by clients to get from point in time forwards.
value from NotificationList.cacheable_cursor.
message
api.proto:1427A request to list parties.
optional limit = 1
Limit the number of returned parties.
optional open = 2
Optionally filter by open/closed parties.
optional query = 3
Arbitrary label query.
optional cursor = 4
Cursor for the next page of results, if any.
message
api.proto:772List publicly readable storage objects in a given collection.
string user_id = 1
ID of the user.
string collection = 2
The collection which stores the object.
optional limit = 3
The number of storage objects to list. Between 1 and 100.
string cursor = 4
The cursor to page through results from.
value from StorageObjectList.cursor.
message
api.proto:784List user subscriptions.
optional limit = 1
Max number of results per page
string cursor = 2
Cursor to retrieve a page of records from
message
api.proto:792List tournament records from a given tournament around the owner.
string tournament_id = 1
The ID of the tournament to list for.
optional limit = 2
Max number of records to return. Between 1 and 100.
string owner_id = 3
The owner to retrieve records around.
optional expiry = 4
Expiry in seconds (since epoch) to begin fetching records from.
string cursor = 5
A next or previous page cursor.
message
api.proto:806List tournament records from a given tournament.
string tournament_id = 1
The ID of the tournament to list for.
repeated string owner_ids = 2
One or more owners to retrieve records for.
optional limit = 3
Max number of records to return. Between 1 and 100.
string cursor = 4
A next or previous page cursor.
optional expiry = 5
Expiry in seconds (since epoch) to begin fetching records from.
message
api.proto:820List active/upcoming tournaments based on given filters.
optional category_start = 1
The start of the categories to include. Defaults to 0.
optional category_end = 2
The end of the categories to include. Defaults to 128.
optional start_time = 3
The start time for tournaments. Defaults to epoch.
optional end_time = 4
The end time for tournaments. Defaults to +1 year from current Unix time.
optional limit = 6
Max number of records to return. Between 1 and 100.
string cursor = 8
A next page cursor for listings (optional).
message
api.proto:836List the groups a user is part of, and their relationship to each.
string user_id = 1
ID of the user.
optional limit = 2
Max number of records to return. Between 1 and 100.
optional state = 3
The user group state to list.
string cursor = 4
An optional next page cursor.
message
api.proto:848Represents a realtime match.
Used in:
string match_id = 1
The ID of the match, can be used to join.
bool authoritative = 2
True if it's an server-managed authoritative match, false otherwise.
optional label = 3
Match label, if any.
int32 size = 4
Current number of users in the match.
int32 tick_rate = 5
Tick Rate
string handler_name = 6
Handler name
message
api.proto:864A list of realtime matches.
repeated matches = 1
A number of matches corresponding to a list operation.
message
api.proto:870Matchmaker ticket completion stats
Used in:
optional create_time = 1
optional complete_time = 2
message
api.proto:876Matchmaker stats
int32 ticket_count = 1
optional oldest_ticket_create_time = 2
repeated completions = 3
message
api.proto:883A notification in the server.
Used in: ,
string id = 1
ID of the Notification.
string subject = 2
Subject of the notification.
string content = 3
Content of the notification in JSON.
int32 code = 4
Category code for this notification.
string sender_id = 5
ID of the sender, if a user. Otherwise 'null'.
optional create_time = 6
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the notification was created.
bool persistent = 7
True if this notification was persisted to the database.
message
api.proto:901A collection of zero or more notifications.
repeated notifications = 1
Collection of notifications.
string cacheable_cursor = 2
Use this cursor to paginate notifications. Cache this to catch up to new notifications.
Operator that can be used to override the one set in the leaderboard.
Used in: , , ,
NO_OVERRIDE = 0
Do not override the leaderboard operator.
BEST = 1
Override the leaderboard operator with BEST.
SET = 2
Override the leaderboard operator with SET.
INCREMENT = 3
Override the leaderboard operator with INCREMENT.
DECREMENT = 4
Override the leaderboard operator with DECREMENT.
message
api.proto:1439Incoming information about a party.
Used in:
string party_id = 1
Unique party identifier.
bool open = 2
Open flag.
bool hidden = 3
Hidden flag.
int32 max_size = 4
Maximum number of party members.
string label = 5
The party label, if any.
message
api.proto:1453A list of realtime matches.
repeated parties = 1
A number of parties corresponding to a list operation.
string cursor = 2
A cursor to send when retrieving the next page, if any.
message
api.proto:909Promote a set of users in a group to the next role up.
string group_id = 1
The group ID to promote in.
repeated string user_ids = 2
The users to promote.
message
api.proto:1331A list of validated purchases stored by Nakama.
repeated validated_purchases = 1
Stored validated purchases.
string cursor = 2
The cursor to send when retrieving the next page, if any.
string prev_cursor = 3
The cursor to send when retrieving the previous page, if any.
message
api.proto:925Storage objects to get.
Used in:
string collection = 1
The collection which stores the object.
string key = 2
The key of the object within the collection.
string user_id = 3
The user owner of the object.
message
api.proto:935Batch get storage objects.
repeated object_ids = 1
Batch of storage objects.
message
api.proto:941Execute an Lua function on the server.
Used in:
string id = 1
The identifier of the function.
string payload = 2
The payload of the function which must be a JSON object.
string http_key = 3
The authentication key used when executed as a non-client HTTP request.
message
api.proto:951A user's session used to authenticate messages.
bool created = 1
True if the corresponding account was just created, false otherwise.
string token = 2
Authentication credentials.
string refresh_token = 3
Refresh token that can be used for session token renewal.
message
api.proto:172Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
string token = 1
Session token to log out.
string refresh_token = 2
Refresh token to invalidate.
message
api.proto:164Authenticate against the server with a refresh token.
string token = 1
Refresh token.
map<string, string> vars = 2
Extra information that will be bundled in the session token.
message
api.proto:961An object within the storage engine.
Used in: ,
string collection = 1
The collection which stores the object.
string key = 2
The key of the object within the collection.
string user_id = 3
The user owner of the object.
string value = 4
The value of the object.
string version = 5
The version hash of the object.
int32 permission_read = 6
The read access permissions for the object.
int32 permission_write = 7
The write access permissions for the object.
optional create_time = 8
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
optional update_time = 9
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
message
api.proto:983A storage acknowledgement.
Used in:
string collection = 1
The collection which stores the object.
string key = 2
The key of the object within the collection.
string version = 3
The version hash of the object.
string user_id = 4
The owner of the object.
optional create_time = 5
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
optional update_time = 6
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
message
api.proto:999Batch of acknowledgements for the storage object write.
repeated acks = 1
Batch of storage write acknowledgements.
message
api.proto:1011List of storage objects.
repeated objects = 1
The list of storage objects.
string cursor = 2
The cursor for the next page of results, if any.
message
api.proto:1005Batch of storage objects.
repeated objects = 1
The batch of storage objects.
Environment where a purchase/subscription took place,
Used in: ,
UNKNOWN = 0
Unknown environment.
SANDBOX = 1
Sandbox/test environment.
PRODUCTION = 2
Production environment.
Validation Provider,
Used in: ,
APPLE_APP_STORE = 0
Apple App Store
GOOGLE_PLAY_STORE = 1
Google Play Store
HUAWEI_APP_GALLERY = 2
Huawei App Gallery
FACEBOOK_INSTANT_STORE = 3
Facebook Instant Store
message
api.proto:1341A list of validated subscriptions stored by Nakama.
repeated validated_subscriptions = 1
Stored validated subscriptions.
string cursor = 2
The cursor to send when retrieving the next page, if any.
string prev_cursor = 3
The cursor to send when retrieving the previous page, if any.
message
api.proto:1019A tournament on the server.
Used in:
string id = 1
The ID of the tournament.
string title = 2
The title for the tournament.
string description = 3
The description of the tournament. May be blank.
uint32 category = 4
The category of the tournament. e.g. "vip" could be category 1.
uint32 sort_order = 5
ASC (0) or DESC (1) sort mode of scores in the tournament.
uint32 size = 6
The current number of players in the tournament.
uint32 max_size = 7
The maximum number of players for the tournament.
uint32 max_num_score = 8
The maximum score updates allowed per player for the current tournament.
bool can_enter = 9
True if the tournament is active and can enter. A computed value.
uint32 end_active = 10
The UNIX time when the tournament stops being active until next reset. A computed value.
uint32 next_reset = 11
The UNIX time when the tournament is next playable. A computed value.
string metadata = 12
Additional information stored as a JSON object.
optional create_time = 13
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament was created.
optional start_time = 14
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will start.
optional end_time = 15
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will be stopped.
uint32 duration = 16
Duration of the tournament in seconds.
uint32 start_active = 17
The UNIX time when the tournament start being active. A computed value.
uint32 prev_reset = 18
The UNIX time when the tournament was last reset. A computed value.
Operator operator = 19
Operator.
bool authoritative = 20
Whether the leaderboard was created authoritatively or not.
bool join_required = 21
Whether the user must join the tournament before being able to submit scores.
message
api.proto:1065A list of tournaments.
repeated tournaments = 1
The list of tournaments returned.
string cursor = 2
A pagination cursor (optional).
message
api.proto:1073A set of tournament records which may be part of a tournament records page or a batch of individual records.
repeated records = 1
A list of tournament records.
repeated owner_records = 2
A batched set of tournament records belonging to specified owners.
string next_cursor = 3
The cursor to send when retireving the next page (optional).
string prev_cursor = 4
The cursor to send when retrieving the previous page (optional).
int64 rank_count = 5
The total number of ranks available.
message
api.proto:1087Update a user's account details.
optional username = 1
The username of the user's account.
optional display_name = 2
The display name of the user.
optional avatar_url = 3
A URL for an avatar image.
optional lang_tag = 4
The language expected to be a tag which follows the BCP-47 spec.
optional location = 5
The location set by the user.
optional timezone = 6
The timezone set by the user.
message
api.proto:1103Update fields in a given group.
string group_id = 1
The ID of the group to update.
optional name = 2
Name.
optional description = 3
Description string.
optional lang_tag = 4
Lang tag.
optional avatar_url = 5
Avatar URL.
optional open = 6
Open is true if anyone should be allowed to join, or false if joins must be approved by a group admin.
message
api.proto:1119A user in the server.
Used in: , , , ,
string id = 1
The id of the user's account.
string username = 2
The username of the user's account.
string display_name = 3
The display name of the user.
string avatar_url = 4
A URL for an avatar image.
string lang_tag = 5
The language expected to be a tag which follows the BCP-47 spec.
string location = 6
The location set by the user.
string timezone = 7
The timezone set by the user.
string metadata = 8
Additional information stored as a JSON object.
string facebook_id = 9
The Facebook id in the user's account.
string google_id = 10
The Google id in the user's account.
string gamecenter_id = 11
The Apple Game Center in of the user's account.
string steam_id = 12
The Steam id in the user's account.
bool online = 13
Indicates whether the user is currently online.
int32 edge_count = 14
Number of related edges to this user.
optional create_time = 15
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was created.
optional update_time = 16
The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was last updated.
string facebook_instant_game_id = 17
The Facebook Instant Game ID in the user's account.
string apple_id = 18
The Apple Sign In ID in the user's account.
message
api.proto:1159A list of groups belonging to a user, along with the user's role in each group.
repeated user_groups = 1
Group-role pairs for a user.
string cursor = 2
Cursor for the next page of results, if any.
message
api.proto:1161A single group-role pair.
Used in:
optional group = 1
Group.
optional state = 2
The user's relationship to the group.
The group role status.
SUPERADMIN = 0
The user is a superadmin with full control of the group.
ADMIN = 1
The user is an admin with additional privileges.
MEMBER = 2
The user is a regular member.
JOIN_REQUEST = 3
The user has requested to join the group
message
api.proto:1187A collection of zero or more users.
repeated users = 1
The User objects.
message
api.proto:1193Apple IAP Purchases validation request
string receipt = 1
Base64 encoded Apple receipt data payload.
optional persist = 2
Persist the purchase
message
api.proto:1235Facebook Instant IAP Purchase validation request
string signed_request = 1
Base64 encoded Facebook Instant signedRequest receipt data payload.
optional persist = 2
Persist the purchase
message
api.proto:1209Google IAP Purchase validation request
string purchase = 1
JSON encoded Google purchase payload.
optional persist = 2
Persist the purchase
message
api.proto:1225Huawei IAP Purchase validation request
string purchase = 1
JSON encoded Huawei InAppPurchaseData.
string signature = 2
InAppPurchaseData signature.
optional persist = 3
Persist the purchase
message
api.proto:1269Validate IAP response.
repeated validated_purchases = 1
Newly seen validated purchases.
message
api.proto:1201Apple Subscription validation request
string receipt = 1
Base64 encoded Apple receipt data payload.
optional persist = 2
Persist the subscription.
message
api.proto:1217Google Subscription validation request
string receipt = 1
JSON encoded Google purchase payload.
optional persist = 2
Persist the subscription.
message
api.proto:1275Validate Subscription response.
optional validated_subscription = 1
message
api.proto:1243Validated Purchase stored by Nakama.
Used in: ,
string user_id = 1
Purchase User ID.
string product_id = 2
Purchase Product ID.
string transaction_id = 3
Purchase Transaction ID.
StoreProvider store = 4
Store identifier
optional purchase_time = 5
Timestamp when the purchase was done.
optional create_time = 6
Timestamp when the receipt validation was stored in DB.
optional update_time = 7
Timestamp when the receipt validation was updated in DB.
optional refund_time = 8
Timestamp when the purchase was refunded. Set to UNIX
string provider_response = 9
Raw provider validation response.
StoreEnvironment environment = 10
Whether the purchase was done in production or sandbox environment.
bool seen_before = 11
Whether the purchase had already been validated by Nakama before.
message
api.proto:1301Used in: ,
string user_id = 1
Subscription User ID.
string product_id = 2
Purchase Product ID.
string original_transaction_id = 3
Purchase Original transaction ID (we only keep track of the original subscription, not subsequent renewals).
StoreProvider store = 4
Store identifier
optional purchase_time = 5
UNIX Timestamp when the purchase was done.
optional create_time = 6
UNIX Timestamp when the receipt validation was stored in DB.
optional update_time = 7
UNIX Timestamp when the receipt validation was updated in DB.
StoreEnvironment environment = 8
Whether the purchase was done in production or sandbox environment.
optional expiry_time = 9
Subscription expiration time. The subscription can still be auto-renewed to extend the expiration time further.
optional refund_time = 10
Subscription refund time. If this time is set, the subscription was refunded.
string provider_response = 11
Raw provider validation response body.
string provider_notification = 12
Raw provider notification body.
bool active = 13
Whether the subscription is currently active or not.
message
api.proto:1351A request to submit a score to a leaderboard.
string leaderboard_id = 1
The ID of the leaderboard to write to.
optional record = 2
Record input.
message
api.proto:1353Record values to write.
Used in:
int64 score = 1
The score value to submit.
int64 subscore = 2
An optional secondary value.
string metadata = 3
Optional record metadata.
Operator operator = 4
Operator override.
message
api.proto:1371The object to store.
Used in:
string collection = 1
The collection to store the object.
string key = 2
The key for the object within the collection.
string value = 3
The value of the object.
string version = 4
The version hash of the object to check. Possible values are: ["", "*", "#hash#"].
if-match and if-none-match
optional permission_read = 5
The read access permissions for the object.
optional permission_write = 6
The write access permissions for the object.
message
api.proto:1387Write objects to the storage engine.
repeated objects = 1
The objects to store on the server.
message
api.proto:1393A request to submit a score to a tournament.
string tournament_id = 1
The tournament ID to write the record for.
optional record = 2
Record input.
message
api.proto:1395Record values to write.
Used in:
int64 score = 1
The score value to submit.
int64 subscore = 2
An optional secondary value.
string metadata = 3
A JSON object of additional properties (optional).
Operator operator = 4
Operator override.