Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Gaming Services CLI

v1.6

Legacy
​
GitHub Repository

Unity Gaming Services CLI

v1.6

Legacy
​
Unity Gaming Services CLI
​
​
Cloud Save
  • Overview
  • Commands
    • Data Custom
      • List Custom Data Ids
      • Query Custom Data
    • Data Index
    • Data Player
  1. Overview
  3. Cloud Save

Query Custom Data

Query custom entity data using an existing index.
Read time 1 minute
Last updated 3 months ago
Query custom data. If no index is available to fulfill the query then the query will fail.
Authentication Required: 
Yes
ugs cloud-save data custom query [options]

Arguments

<visibility>
A string representing the visibility of the index. Must be one of 
default
or 
private
. 
<body>
The index query in JSON. If this is a file path, the content of the file is used; otherwise, the raw string is used.
Sample Query String 
--body "{"fields":\[{"key":"EXAMPLE_KEY","value":"example_value","op":"EQ","asc":true}],"returnKeys":\["EXAMPLE_KEY"],"offset":0,"limit":100,"sampleSize":100}"
Sample Query Body File
{  "fields": [    {      "key": "EXAMPLE_KEY",      "value": "example_value",      "op": "EQ",      "asc": true    }  ],  "returnKeys": [    "EXAMPLE_KEY"  ],  "offset": 0,  "limit": 100,  "sampleSize": 100}

Documentation

For more documentation on querying indexes, see the Unity Service API Docs.

Options

Option

Alias

Description

project-id-p, --project-idThe Unity cloud project ID.
environment-name-e, --environment-nameThe services environment name.
help-?, -h, --helpDisplay help and usage information.
quiet-q, --quietReduce logging to a minimum.
json-j, --jsonUse JSON as the output format.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • Arguments

    • Documentation

    • Options