firestore.projects.databases.documents.run Query

POST {{baseUrl}}/v1/{{parent}}:runQuery?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Runs a query.

Request Params

Key	Datatype	Description
`$.xgafv`	string	V1 error format.
`access_token`	string	OAuth access token.
`alt`	string	Data format for response.
`callback`	string	JSONP
`fields`	string	Selector specifying which fields to include in a partial response.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`oauth_token`	string	OAuth 2.0 token for the current user.
`prettyPrint`	string	Returns response with indentations and line breaks.
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"newTransaction"=>{"readOnly"=>{"readTime"=>"<google-datetime>"}, "readWrite"=>{"retryTransaction"=>"<byte>"}}, "readTime"=>"<google-datetime>", "structuredQuery"=>{"endAt"=>{"before"=>"<boolean>", "values"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "from"=>[{"allDescendants"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "collectionId"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"allDescendants"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "collectionId"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "limit"=>"<integer>", "offset"=>"<integer>", "orderBy"=>[{"direction"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "field"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, {"direction"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "field"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}], "select"=>{"fields"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "startAt"=>{"before"=>"<boolean>", "values"=>[{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, {"value"=>"<Error: Too many levels of nesting to fake this schema>"}]}, "where"=>{"compositeFilter"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldFilter"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "unaryFilter"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}, "transaction"=>"<byte>"}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

RESPONSES

status: OK

{&quot;document&quot;:{&quot;createTime&quot;:&quot;\u003cstring\u003e&quot;,&quot;fields&quot;:&quot;\u003cobject\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;updateTime&quot;:&quot;\u003cstring\u003e&quot;},&quot;readTime&quot;:&quot;velit&quot;,&quot;skippedResults&quot;:87039369,&quot;transaction&quot;:&quot;cillum ea aute sunt&quot;}