Method: projects.databases.documents.createDocument

Crée un document.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Ressource parente. (par exemple, projects/{projectId}/databases/{databaseId}/documents ou projects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}).
collectionId

string

Obligatoire. ID de collection de la liste (par rapport à parent). Exemple : chatrooms.

Paramètres de requête

Paramètres
documentId

string

ID de document attribué par le client à utiliser pour ce document.

Facultatif. S'il n'est pas spécifié, un identifiant sera attribué par le service.
mask

object (DocumentMask)

Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si le document comporte un champ qui n'est pas présent dans ce masque, il ne sera pas renvoyé dans la réponse.

Corps de la requête

Le corps de la requête contient une instance Document.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Document.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.