firestore.projects.databases.documents.write
POST {{baseUrl}}/v1/:database/documents:write?$.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>
Streams batches of document updates and deletes, in order.
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
{"labels"=>"<object>", "streamId"=>"<string>", "streamToken"=>"<byte>", "writes"=>[{"currentDocument"=>{"exists"=>"<boolean>", "updateTime"=>"<google-datetime>"}, "delete"=>"<string>", "transform"=>{"document"=>"<string>", "fieldTransforms"=>[{"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}, {"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}]}, "update"=>{"createTime"=>"magna", "name"=>"dolore ut ullamco incididunt proident", "updateTime"=>"elit esse dolore amet voluptate"}, "updateMask"=>{"fieldPaths"=>["<string>", "<string>"]}, "updateTransforms"=>[{"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}, {"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}]}, {"currentDocument"=>{"exists"=>"<boolean>", "updateTime"=>"<google-datetime>"}, "delete"=>"<string>", "transform"=>{"document"=>"<string>", "fieldTransforms"=>[{"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}, {"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}]}, "update"=>{"createTime"=>"et laborum", "name"=>"pariatur Excepteur cillum dolore", "updateTime"=>"exer"}, "updateMask"=>{"fieldPaths"=>["<string>", "<string>"]}, "updateTransforms"=>[{"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}, {"appendMissingElements"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "fieldPath"=>"<string>", "increment"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "maximum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "minimum"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "removeAllFromArray"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "setToServerValue"=>"<string>"}]}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"commitTime":"qui sed tempor et","streamId":"sed nisi adipisicing","streamToken":"oc","writeResults":[{"transformResults":[{"arrayValue":{"values":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"booleanValue":true,"bytesValue":"tempor fugiat labore","doubleValue":44669925.79104921,"geoPointValue":{"latitude":56105982.107580125,"longitude":48855442.39191243},"integerValue":"aliqua consectetur amet","mapValue":{"fields":{}},"nullValue":"NULL_VALUE","referenceValue":"veniam sunt laborum","stringValue":"dolore adipisicing exercitation quis cillum","timestampValue":"reprehenderit cupidatat offi"},{"arrayValue":{"values":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"booleanValue":true,"bytesValue":"pariatur consequat velit","doubleValue":-31653224.319579825,"geoPointValue":{"latitude":-31843217.496233627,"longitude":-13045351.606990159},"integerValue":"amet labore enim Ut","mapValue":{"fields":{}},"nullValue":"NULL_VALUE","referenceValue":"mollit amet in consectetur ut","stringValue":"aliquip","timestampValue":"aliqua Duis"}],"updateTime":"sint fugiat consectetur irure"},{"transformResults":[{"arrayValue":{"values":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"booleanValue":false,"bytesValue":"eiusmod dolor sed laboris","doubleValue":71434747.55022016,"geoPointValue":{"latitude":4794426.85388878,"longitude":-80106765.77027133},"integerValue":"occaecat sed","mapValue":{"fields":{}},"nullValue":"NULL_VALUE","referenceValue":"cupidatat Duis sint dolor","stringValue":"pariatur","timestampValue":"re"},{"arrayValue":{"values":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"booleanValue":true,"bytesValue":"elit do ad","doubleValue":-52325819.27911717,"geoPointValue":{"latitude":-76578189.25815381,"longitude":89406037.68201306},"integerValue":"consectetur consequat pariatur sint","mapValue":{"fields":{}},"nullValue":"NULL_VALUE","referenceValue":"ipsum et","stringValue":"si","timestampValue":"aliqua"}],"updateTime":"ea"}]}