POST
/
v1
/
worksheets:search
{
  "worksheets": [
    {
      "name": "<string>",
      "project": "<string>",
      "database": "<string>",
      "title": "<string>",
      "creator": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "content": "<string>",
      "contentSize": "<string>",
      "visibility": "VISIBILITY_UNSPECIFIED",
      "starred": true
    }
  ],
  "nextPageToken": "<string>"
}

Body

application/json
​
filter
string

To filter the search result. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filter:

  • creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
  • starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
  • visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.

For example: creator == "users/{email}" creator != "users/{email}" starred == true starred == false visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"] visibility == "PRIVATE"

​
pageSize
integer

Not used. The maximum number of worksheets to return. The service may return fewer than this value. If unspecified, at most 10 worksheets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

Not used. A page token, received from a previous SearchWorksheets call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchWorksheets must match the call that provided the page token.

Response

OK

​
worksheets
object[]

The worksheets that matched the search criteria.

​
nextPageToken
string

Not used. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.