Method: documents.create

Crée un document vide à l'aide du titre indiqué dans la requête. Les autres champs de la requête, y compris tout contenu fourni, sont ignorés.

Renvoie le document créé.

Requête HTTP

POST https://docs.googleapis.com/v1/documents

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Champs
documentId

string

Uniquement en sortie. ID du document.
title

string

Titre du document.
tabs[]

object (Tab)

Onglets qui font partie d'un document.

Les onglets peuvent contenir des onglets enfants, un onglet imbriqué dans un autre onglet. Les onglets enfants sont représentés par le champ Tab.childTabs.
revisionId

string

Uniquement en sortie. ID de révision du document. Peut être utilisé dans les requêtes de mise à jour pour spécifier la révision d'un document à laquelle appliquer les mises à jour et le comportement de la requête si le document a été modifié depuis cette révision. N'est renseigné que si l'utilisateur dispose d'un accès en modification au document.

L'ID de révision n'est pas un nombre séquentiel, mais une chaîne opaque. Le format de l'ID de révision peut changer au fil du temps. Un ID de révision renvoyé n'est garanti valide que pendant 24 heures après son renvoi et ne peut pas être partagé entre les utilisateurs. Si l'ID de révision reste inchangé entre les appels, cela signifie que le document n'a pas été modifié. À l'inverse, un ID modifié (pour le même document et le même utilisateur) signifie généralement que le document a été mis à jour. Toutefois, un ID modifié peut également être dû à des facteurs internes, tels que des modifications du format de l'ID.
suggestionsViewMode

enum (SuggestionsViewMode)

Uniquement en sortie. Mode d'affichage des suggestions appliqué au document.

Remarque : Lorsque vous modifiez un document, les modifications doivent être basées sur un document avec SUGGESTIONS_INLINE.
commentsViewMode

enum (CommentsViewMode)

Uniquement en sortie. Mode d'affichage des commentaires appliqué au document.

comments[]

object (CommentThread)

Uniquement en sortie. Commentaires associés au document. N'est renseigné que si le paramètre commentsViewMode est défini pour exiger des commentaires (par exemple, COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

Uniquement en sortie. Suggestions associées au document. N'est renseigné que si le paramètre commentsViewMode est défini pour exiger des commentaires (par exemple, COMMENTS_VIEW_MODE_INCLUDED).

body

object (Body)

Uniquement en sortie. Corps principal du document.

Champ hérité : utilisez plutôt Document.tabs.documentTab.body, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
headers

map (key: string, value: object (Header))

Uniquement en sortie. En-têtes du document, indexés par ID d'en-tête.

Champ hérité : utilisez plutôt Document.tabs.documentTab.headers, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
footers

map (key: string, value: object (Footer))

Uniquement en sortie. Pieds de page du document, indexés par ID de pied de page.

Champ hérité : utilisez plutôt Document.tabs.documentTab.footers, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
footnotes

map (key: string, value: object (Footnote))

Uniquement en sortie. Notes de bas de page du document, indexées par ID de note de bas de page.

Champ hérité : utilisez plutôt Document.tabs.documentTab.footnotes, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
documentStyle

object (DocumentStyle)

Uniquement en sortie. Style du document.

Champ hérité : utilisez plutôt Document.tabs.documentTab.documentStyle, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Uniquement en sortie. Modifications suggérées du style du document, indexées par ID de suggestion.

Champ hérité : utilisez plutôt Document.tabs.documentTab.suggestedDocumentStyleChanges, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
namedStyles

object (NamedStyles)

Uniquement en sortie. Styles nommés du document.

Champ hérité : utilisez plutôt Document.tabs.documentTab.namedStyles, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Uniquement en sortie. Modifications suggérées des styles nommés du document, indexées par ID de suggestion.

Champ hérité : utilisez plutôt Document.tabs.documentTab.suggestedNamedStylesChanges, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
lists

map (key: string, value: object (List))

Uniquement en sortie. Listes du document, indexées par ID de liste.

Champ hérité : utilisez plutôt Document.tabs.documentTab.lists, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
namedRanges

map (key: string, value: object (NamedRanges))

Uniquement en sortie. Plages nommées du document, indexées par nom.

Champ hérité : utilisez plutôt Document.tabs.documentTab.namedRanges, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
inlineObjects

map (key: string, value: object (InlineObject))

Uniquement en sortie. Objets intégrés au document, indexés par ID d'objet.

Champ hérité : utilisez plutôt Document.tabs.documentTab.inlineObjects, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.
positionedObjects

map (key: string, value: object (PositionedObject))

Uniquement en sortie. Objets positionnés dans le document, indexés par ID d'objet.

Champ hérité : utilisez plutôt Document.tabs.documentTab.positionedObjects, qui expose le contenu réel du document à partir de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou n'est pas définie, ce champ contient des informations sur le premier onglet du document.

Corps de la réponse

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

Niveaux d'accès des autorisations

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

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Pour en savoir plus, consultez le guide sur l'autorisation.