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 le 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,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Champs
documentId

string

Uniquement en sortie. L'ID du document

title

string

Titre du document.

body

object (Body)

Uniquement en sortie. Corps principal du document.

headers

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

Uniquement en sortie. En-têtes du document, associés à un ID d'en-tête.

footers

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

Uniquement en sortie. Pieds de page du document, associés à un ID de pied de page.

footnotes

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

Uniquement en sortie. Notes de document du document, associées à un ID de note de bas de page.

documentStyle

object (DocumentStyle)

Uniquement en sortie. Style du document.

suggestedDocumentStyleChanges

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

Uniquement en sortie. Les modifications proposées pour le style du document sont associées à un ID de suggestion.

namedStyles

object (NamedStyles)

Uniquement en sortie. Styles nommés du document.

suggestedNamedStylesChanges

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

Uniquement en sortie. Les modifications suggérées aux styles nommés du document sont associées à un ID de suggestion.

lists

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

Uniquement en sortie. Listes du document, associées à un ID de liste.

namedRanges

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

Uniquement en sortie. Plages nommées dans le document, associées à un nom.

revisionId

string

Uniquement en sortie. ID de révision du document. Peut être utilisée dans les demandes 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 est autorisé à modifier le 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. La validité d'un ID de révision renvoyé n'est garantie que pendant 24 heures après son envoi. Il ne peut pas être partagé entre les utilisateurs. Si l'ID de révision n'est pas modifié entre les appels, cela signifie que le document n'a pas changé. À l'inverse, si l'ID a changé (pour le même document et le même utilisateur), cela signifie généralement que le document a été mis à jour. Toutefois, un changement d'identifiant peut également être dû à des facteurs internes, tels que les changements de format.

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 portant l'attribut SUGGESTIONS_INLINE.

inlineObjects

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

Uniquement en sortie. Objets intégrés dans le document, associés à un ID d'objet.

positionedObjects

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

Uniquement en sortie. Objets positionnés dans le document, associés à un ID d'objet.

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 sur les autorisations.