Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1338139174.7 KB
projects

Creates a new document.

post/v1/{+parent}/{collectionId}

Path parameters

parentstring required

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

collectionIdstring required

Required. The collection ID, relative to parent, to list. For example: chatrooms.

Query parameters

documentIdstring

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

mask.fieldPathsstring[]

The list of field paths in the mask. See Document.fields for a field path syntax reference.

requestOptions.requestTagsstring[]

Optional. The request tags for the request.

Request body

createTimestring google-datetime

Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the read_time of a query.

updateTimestring google-datetime

Output only. The time at which the document was last changed. This value is initially set to the create_time then increases monotonically with each change to the document. It can also be compared to values from other documents and the read_time of a query.

fieldsobject

The document's fields. The map keys represent field names. Field names matching the regular expression __.*__ are reserved. Reserved field names are forbidden except in certain documented contexts. The field names, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For map_value, the field path is represented by a dot-delimited (.) string of segments. Each segment is either a simple field name (defined below) or a quoted field name. For example, the structured field "foo" : { map_value: { "x&y" : { string_value: "hello" }}} would be represented by the field path foo.`x&y`. A simple field name contains only characters a to z, A to Z, 0 to 9, or _, and must not start with 0 to 9. For example, foo_bar_17. A quoted field name starts and ends with ` and may contain any character. Some characters, including `, must be escaped using a \. For example, `x&y` represents x&y and `bak\`tik` represents bak`tik.

namestring

The resource name of the document, for example projects/{project_id}/databases/{database_id}/documents/{document_path}.

Response

Successful response