GET
/
v1
/
projects
/
{project}
/
sheets
/
{sheet}
{
  "name": "<string>",
  "title": "<string>",
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "content": "<string>",
  "contentSize": "<string>",
  "payload": {
    "type": "TYPE_UNSPECIFIED",
    "commands": [
      {
        "start": 123,
        "end": 123
      }
    ]
  },
  "engine": "ENGINE_UNSPECIFIED"
}

Path Parameters

project
string
required

The project id.

sheet
string
required

The sheet id.

Query Parameters

raw
boolean

By default, the content of the sheet is cut off, set the raw to true to retrieve the full content.

Response

OK

name
string
required

The name of the sheet resource, generated by the server. Canonical parent is project. Format: projects/{project}/sheets/{sheet}

title
string
required

The title of the sheet.

content
string<bytes>
required

The content of the sheet. By default, it will be cut off, if it doesn't match the content_size, you can set the raw to true in GetSheet request to retrieve the full content.

engine
enum<string>
required

The SQL dialect.

Available options:
ENGINE_UNSPECIFIED,
CLICKHOUSE,
MYSQL,
POSTGRES,
SNOWFLAKE,
SQLITE,
TIDB,
MONGODB,
REDIS,
ORACLE,
SPANNER,
MSSQL,
REDSHIFT,
MARIADB,
OCEANBASE,
STARROCKS,
DORIS,
HIVE,
ELASTICSEARCH,
BIGQUERY,
DYNAMODB,
DATABRICKS,
COCKROACHDB,
COSMOSDB,
TRINO,
CASSANDRA
creator
string

The creator of the Sheet. Format: users/{email}

createTime
string<date-time>

The create time of the sheet.

contentSize
string

content_size is the full size of the content, may not match the size of the content field.

payload
object