Method: documents.get

Récupère la dernière version du document spécifié.

Requête HTTP

GET https://docs.googleapis.com/v1/documents/{documentId}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
documentId

string

ID du document à récupérer.

Paramètres de requête

Paramètres
suggestionsViewMode

enum (SuggestionsViewMode)

Mode d'affichage des suggestions à appliquer au document. Cela permet d'afficher le document avec toutes les suggestions intégrées, acceptées ou refusées. Si aucune valeur n'est spécifiée, DEFAULT_FOR_CURRENT_ACCESS est utilisé.
includeTabsContent

boolean

Indique s'il faut remplir le champ Document.tabs au lieu des champs de contenu textuel tels que body et documentStyle sur Document.

  • Lorsque true : le contenu du document est inséré dans le champ Document.tabs au lieu des champs de contenu textuel dans Document.

  • Lorsque false : le contenu du premier onglet du document remplit les champs de contenu dans Document, à l'exception de Document.tabs. Si un document ne comporte qu'un seul onglet, celui-ci est utilisé pour remplir le contenu du document. Document.tabs sera vide.

Si vous utilisez un masque de champ qui fait référence au champ Document.tabs (ou à un sous-champ), l'API traite implicitement la requête comme si vous aviez défini includeTabsContent sur true.
commentsViewMode

enum (CommentsViewMode)

Mode d'affichage des commentaires à appliquer au document. Cela permet d'afficher le document avec ou sans les commentaires. Si aucune valeur n'est spécifiée, COMMENTS_VIEW_MODE_OMITTED est utilisé.

Si vous définissez commentsViewMode sur une valeur quelconque, vous devez également définir includeTabsContent sur true ou utiliser un masque de champ qui fait référence au champ Document.tabs (ou à un sous-champ).

Si vous définissez commentsViewMode sur COMMENTS_VIEW_MODE_INCLUDED, vous devez également définir explicitement suggestionsViewMode sur SUGGESTIONS_INLINE.

Si vous définissez commentsViewMode sur COMMENTS_VIEW_MODE_INCLUDED ou COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, vous ne pouvez pas définir suggestionsViewMode sur PREVIEW_WITHOUT_SUGGESTIONS ou PREVIEW_SUGGESTIONS_ACCEPTED.

Corps de la requête

Le corps de la requête doit être vide.

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/documents
  • https://www.googleapis.com/auth/documents.readonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file

Pour en savoir plus, consultez le guide d'autorisation.