Method: documents.create

Crée un document vierge à 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),
  "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 faisant partie d'un document.

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

string

Uniquement en sortie. ID de la 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. Ce champ n'est renseigné que si l'utilisateur est autorisé à modifier le document.

L'ID de révision n'est pas un numéro 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 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 changé. À 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 changements de 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 SUGGESTIONS_INLINE.
body

object (Body)

Uniquement en sortie. Corps principal du document.

Ancien champ: utilisez plutôt Document.tabs.documentTab.body, qui expose le contenu réel du document de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou non 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, associés par ID d'en-tête.

Ancien champ: utilisez plutôt Document.tabs.documentTab.headers, qui expose le contenu réel du document de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou qu'elle n'est pas configurée, 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 leur ID.

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

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

Uniquement en sortie. Les notes de bas de page du document, triées par ID de note de bas de page.

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

object (DocumentStyle)

Uniquement en sortie. Style du document.

Ancien champ: utilisez plutôt Document.tabs.documentTab.documentStyle, qui expose le contenu réel du document de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou non 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 apportées au style du document, triées par ID de suggestion.

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

object (NamedStyles)

Uniquement en sortie. Styles nommés du document.

Ancien champ: utilisez plutôt Document.tabs.documentTab.namedStyles, qui expose le contenu réel du document de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou non 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 apportées aux styles nommés du document, triées par ID de suggestion.

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

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

Uniquement en sortie. Les listes du document, triées par ID de liste.

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

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

Uniquement en sortie. Les plages nommées du document, triées par nom.

Ancien champ: utilisez plutôt Document.tabs.documentTab.namedRanges, qui expose le contenu réel du document de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou non 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.

Ancien champ: utilisez plutôt Document.tabs.documentTab.inlineObjects, qui expose le contenu réel du document de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou qu'elle n'est pas configurée, 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, avec clé correspondant à l'ID de l'objet.

Ancien champ: utilisez plutôt Document.tabs.documentTab.positionedObjects, qui expose le contenu réel du document de tous les onglets lorsque le paramètre includeTabsContent est défini sur true. Si la valeur est false ou non 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.

Champs d'application 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 relatif aux autorisations.