firestore.projects.databases.documents.listen
POST {{baseUrl}}/v1/:database/documents:listen?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Listens to changes.
Request Params
| Key | Datatype | Required | 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
{"addTarget"=>{"documents"=>{"documents"=>["<string>", "<string>"]}, "once"=>"<boolean>", "query"=>{"parent"=>"<string>", "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>"}}}}, "readTime"=>"<google-datetime>", "resumeToken"=>"<byte>", "targetId"=>"<integer>"}, "labels"=>"<object>", "removeTarget"=>"<integer>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"documentChange":{"document":{"createTime":"mollit anim deserunt e","fields":{},"name":"incididunt","updateTime":"anim labore"},"removedTargetIds":[-56116428,65845908],"targetIds":[76313786,-72643873]},"documentDelete":{"document":"fugiat ut ad","readTime":"quis minim eiusmod voluptate","removedTargetIds":[16190133,90307424]},"documentRemove":{"document":"sunt veniam ipsum ut","readTime":"nulla ipsum consequat","removedTargetIds":[-26675942,-1816110]},"filter":{"count":-90269408,"targetId":-91305261},"targetChange":{"cause":{"code":-80676766,"message":"consectetur "},"readTime":"deserunt","resumeToken":"elit Duis quis aliquip minim","targetChangeType":"NO_CHANGE","targetIds":[-31375385,-83175764]}}