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>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Streams batches of document updates and deletes, in order.

Request Params

KeyDatatypeRequiredDescription
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI 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_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable 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_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy 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

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;commitTime&quot;:&quot;qui sed tempor et&quot;,&quot;streamId&quot;:&quot;sed nisi adipisicing&quot;,&quot;streamToken&quot;:&quot;oc&quot;,&quot;writeResults&quot;:[{&quot;transformResults&quot;:[{&quot;arrayValue&quot;:{&quot;values&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]},&quot;booleanValue&quot;:true,&quot;bytesValue&quot;:&quot;tempor fugiat labore&quot;,&quot;doubleValue&quot;:44669925.79104921,&quot;geoPointValue&quot;:{&quot;latitude&quot;:56105982.107580125,&quot;longitude&quot;:48855442.39191243},&quot;integerValue&quot;:&quot;aliqua consectetur amet&quot;,&quot;mapValue&quot;:{&quot;fields&quot;:{}},&quot;nullValue&quot;:&quot;NULL_VALUE&quot;,&quot;referenceValue&quot;:&quot;veniam sunt laborum&quot;,&quot;stringValue&quot;:&quot;dolore adipisicing exercitation quis cillum&quot;,&quot;timestampValue&quot;:&quot;reprehenderit cupidatat offi&quot;},{&quot;arrayValue&quot;:{&quot;values&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]},&quot;booleanValue&quot;:true,&quot;bytesValue&quot;:&quot;pariatur consequat velit&quot;,&quot;doubleValue&quot;:-31653224.319579825,&quot;geoPointValue&quot;:{&quot;latitude&quot;:-31843217.496233627,&quot;longitude&quot;:-13045351.606990159},&quot;integerValue&quot;:&quot;amet labore enim Ut&quot;,&quot;mapValue&quot;:{&quot;fields&quot;:{}},&quot;nullValue&quot;:&quot;NULL_VALUE&quot;,&quot;referenceValue&quot;:&quot;mollit amet in consectetur ut&quot;,&quot;stringValue&quot;:&quot;aliquip&quot;,&quot;timestampValue&quot;:&quot;aliqua Duis&quot;}],&quot;updateTime&quot;:&quot;sint fugiat consectetur irure&quot;},{&quot;transformResults&quot;:[{&quot;arrayValue&quot;:{&quot;values&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]},&quot;booleanValue&quot;:false,&quot;bytesValue&quot;:&quot;eiusmod dolor sed laboris&quot;,&quot;doubleValue&quot;:71434747.55022016,&quot;geoPointValue&quot;:{&quot;latitude&quot;:4794426.85388878,&quot;longitude&quot;:-80106765.77027133},&quot;integerValue&quot;:&quot;occaecat sed&quot;,&quot;mapValue&quot;:{&quot;fields&quot;:{}},&quot;nullValue&quot;:&quot;NULL_VALUE&quot;,&quot;referenceValue&quot;:&quot;cupidatat Duis sint dolor&quot;,&quot;stringValue&quot;:&quot;pariatur&quot;,&quot;timestampValue&quot;:&quot;re&quot;},{&quot;arrayValue&quot;:{&quot;values&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]},&quot;booleanValue&quot;:true,&quot;bytesValue&quot;:&quot;elit do ad&quot;,&quot;doubleValue&quot;:-52325819.27911717,&quot;geoPointValue&quot;:{&quot;latitude&quot;:-76578189.25815381,&quot;longitude&quot;:89406037.68201306},&quot;integerValue&quot;:&quot;consectetur consequat pariatur sint&quot;,&quot;mapValue&quot;:{&quot;fields&quot;:{}},&quot;nullValue&quot;:&quot;NULL_VALUE&quot;,&quot;referenceValue&quot;:&quot;ipsum et&quot;,&quot;stringValue&quot;:&quot;si&quot;,&quot;timestampValue&quot;:&quot;aliqua&quot;}],&quot;updateTime&quot;:&quot;ea&quot;}]}