Method: projects.databases.documents.createDocument

Cria um novo documento.

Solicitação HTTP

POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/**}/{collectionId}

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O recurso pai. Por exemplo: projects/{projectId}/databases/{databaseId}/documents ou projects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}

collectionId

string

Obrigatório. O ID da coleção, relativo a parent , a ser listado. Por exemplo: chatrooms .

Parâmetros de consulta

Parâmetros
documentId

string

O ID do documento atribuído pelo cliente a ser usado para este documento.

Opcional. Se não for especificado, um ID será atribuído pelo serviço.

mask

object ( DocumentMask )

Os campos a serem retornados. Se não for definido, retorna todos os campos.

Caso o documento possua um campo que não esteja presente nesta máscara, esse campo não será retornado na resposta.

Solicitar corpo

O corpo da solicitação contém uma instância de Document .

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de Document .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obter mais informações, consulte Visão geral da autenticação .