Method: projects.databases.documents.createDocument

Cria um novo documento.

Solicitação HTTP

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

O URL usa a 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 neste 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 definido, retorna todos os campos.

Se o documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta.

Corpo da solicitação

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Document.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.