Class Document

Document

Document contenant un ou plusieurs objets Tab, chacun contenant du texte enrichi et des éléments tels que des tableaux et des listes.

Vous pouvez ouvrir ou créer des documents à l'aide de DocumentApp. 

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

// Create and open a document.
doc = DocumentApp.create('Document Title');

Les méthodes de la classe Document qui accèdent directement au contenu textuel et le modifient fonctionnent sur l'onglet actif (dans les scripts liés à un document particulier) ou sur le premier onglet (si aucun onglet actif n'est disponible). Les scripts qui s'appuient sur ces méthodes (par exemple, getBody()) peuvent être migrés pour prendre en charge les onglets à l'aide de getTabs(), puis de Tab.asDocumentTab().

Méthodes

MéthodeType renvoyéBrève description
addBookmark(position)BookmarkAjoute un Bookmark à l'Position donné au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addEditor(emailAddress)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditor(user)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditors(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des éditeurs de Document.
addFooter()FooterSectionAjoute une section de pied de page, si elle n'existe pas, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addHeader()HeaderSectionAjoute une section d'en-tête, si elle n'existe pas, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addNamedRange(name, range)NamedRangeAjoute un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure, dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif.
addViewer(emailAddress)DocumentAjoute l'utilisateur spécifié à la liste des spectateurs de Document.
addViewer(user)DocumentAjoute l'utilisateur spécifié à la liste des spectateurs de Document.
addViewers(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des spectateurs de Document.
getActiveTab()Tab|nullObtient le Tab actuellement actif de l'utilisateur dans le document.
getAs(contentType)BlobRécupère le contenu Document actuel sous forme de blob du type spécifié.
getBlob()BlobRécupère le contenu actuel de Document en tant que blob.
getBody()BodyRécupère le Body du premier onglet ou, pour les scripts liés à un document, le DocumentBodySection de l'onglet actif.
getBookmark(id)Bookmark|nullRécupère le Bookmark avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
getBookmarks()Bookmark[]Obtient tous les objets Bookmark du premier onglet ou, pour les scripts associés à un document, de l'onglet actif.
getCursor()Position|nullRécupère le curseur de l'utilisateur dans l'onglet actif.
getEditors()User[]Obtient la liste des éditeurs pour ce Document.
getFooter()FooterSection|nullRécupère la section de pied de page du premier onglet ou, pour les scripts liés à un document, la section de pied de page de l'onglet actif.
getFootnotes()Footnote[]Récupère tous les éléments Footnote dans le corps du premier onglet ou, pour les scripts associés à un document, dans le corps de l'onglet actif.
getHeader()HeaderSection|nullRécupère la section d'en-tête du premier onglet ou, pour les scripts liés à un document, la section d'en-tête de l'onglet actif.
getId()StringRécupère l'identifiant unique du document.
getLanguage()String|nullObtient le code de langue du document.
getName()StringRécupère le titre du document.
getNamedRangeById(id)NamedRange|nullRécupère le NamedRange avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
getNamedRanges()NamedRange[]Obtient tous les objets NamedRange du premier onglet ou, pour les scripts associés à un document, de l'onglet actif.
getNamedRanges(name)NamedRange[]Obtient tous les objets NamedRange portant le nom donné dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif.
getSelection()Range|nullRécupère la sélection de l'utilisateur dans l'onglet actif.
getSupportedLanguageCodes()String[]Récupère tous les codes de langue compatibles avec les fichiers Google Docs.
getTab(tabId)Tab|nullRécupère le Tab avec l'ID spécifié.
getTabs()Tab[]Obtient tous les Tab non imbriqués qui font partie du document.
getUrl()StringRécupère l'URL permettant d'accéder au document actuel.
getViewers()User[]Obtient la liste des lecteurs et des commentateurs pour ce Document.
newPosition(element, offset)PositionCrée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à un élément spécifique du premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
newRange()RangeBuilderCrée un compilateur utilisé pour construire des objets Range à partir d'éléments d'onglet dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif.
removeEditor(emailAddress)DocumentSupprime l'utilisateur donné de la liste des éditeurs pour le Document.
removeEditor(user)DocumentSupprime l'utilisateur donné de la liste des éditeurs pour le Document.
removeViewer(emailAddress)DocumentSupprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le Document.
removeViewer(user)DocumentSupprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le Document.
saveAndClose()voidEnregistre le Document actuel.
setActiveTab(tabId)voidDéfinit le Tab sélectionné par l'utilisateur dans le document actuel sur l'onglet portant l'ID spécifié.
setCursor(position)DocumentDéfinit le curseur de l'utilisateur, en fonction d'un Position.
setLanguage(languageCode)DocumentDéfinit le code de langue du document.
setName(name)DocumentDéfinit le titre du document.
setSelection(range)DocumentDéfinit la sélection de l'utilisateur dans l'onglet actif, en fonction d'un Range.

Documentation détaillée

addBookmark(position)

Ajoute un Bookmark à l'Position donné au premier onglet ou, pour les scripts liés à un document, à l'onglet actif. Pour ajouter un favori à un onglet, utilisez la méthode DocumentTab.addBookmark(position). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

Paramètres

NomTypeDescription
positionPositionPosition du nouveau favori.

Renvois

Bookmark : le nouveau signet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(emailAddress)

Ajoute l'utilisateur donné à la liste des éditeurs pour Document. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(user)

Ajoute l'utilisateur donné à la liste des éditeurs pour Document. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de Document. Si l'un des utilisateurs figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

Ajoute une section de pied de page, si elle n'existe pas, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif. Pour ajouter une section de pied de page à un onglet, utilisez la méthode DocumentTab.addFooter(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Renvois

FooterSection : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addHeader()

Ajoute une section d'en-tête, si elle n'existe pas, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif. Pour ajouter une section d'en-tête à un onglet, utilisez la méthode DocumentTab.addHeader(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Renvois

HeaderSection : en-tête de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addNamedRange(name, range)

Ajoute un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure, dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif. Pour ajouter un NamedRange dans un onglet, utilisez la méthode DocumentTab.addNamedRange(name, range). Les noms ne sont pas nécessairement uniques. Plusieurs plages différentes dans le même document peuvent partager le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans le document, comme un ID en HTML. Une fois que vous avez ajouté un NamedRange à un document, vous ne pouvez plus le modifier. Vous pouvez uniquement le supprimer.

Tout script qui accède au document peut accéder à un NamedRange. Pour éviter les conflits involontaires entre les scripts, pensez à ajouter un préfixe unique aux noms de plages. 

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Paramètres

NomTypeDescription
nameStringNom de la plage (il n'est pas nécessaire qu'il soit unique). Les noms de plages doivent comporter entre 1 et 256 caractères.
rangeRangePlage d'éléments à associer au nom. La plage peut être la sélection active, un résultat de recherche ou une plage construite manuellement avec newRange().

Renvois

NamedRange : le NamedRange.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(emailAddress)

Ajoute l'utilisateur spécifié à la liste des spectateurs de Document. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(user)

Ajoute l'utilisateur spécifié à la liste des spectateurs de Document. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewers(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de Document. Si l'un des utilisateurs figurait déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour lui.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getActiveTab()

Obtient le Tab actuellement actif de l'utilisateur dans le document. Un script ne peut accéder qu'à l'onglet actif de l'utilisateur qui l'exécute, et uniquement s'il est lié au document. 

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

Renvois

Tab|null : Tab actuellement actif de l'utilisateur ou null si le script n'est pas lié au document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAs(contentType)

Récupère le contenu Document actuel sous forme de blob du type spécifié. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Les types 'application/pdf' et 'text/markdown' sont acceptés.

Renvois

Blob : document actuel sous forme de blob.

getBlob()

Récupère le contenu actuel de Document en tant que blob. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

Renvois

Blob : document actuel sous forme de blob.

getBody()

Récupère le Body du premier onglet ou, pour les scripts liés à un document, le DocumentBodySection de l'onglet actif. Pour obtenir le DocumentBodySection d'un onglet, utilisez la méthode DocumentTab.getBody().

Les onglets peuvent contenir différents types de sections (par exemple, HeaderSection, FooterSection). La section active d'un onglet est Body.

Les méthodes d'élément dans Document sont déléguées à Body actif. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Renvois

Body : section du corps de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmark(id)

Récupère le Bookmark avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif. Pour obtenir un signet dans n'importe quel onglet, utilisez la méthode DocumentTab.getBookmark(id). Cette méthode renvoie null si aucun Bookmark de ce type n'existe dans l'onglet. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the
// console. otherwise, logs 'No bookmark exists with the given ID.' to the
// console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Paramètres

NomTypeDescription
idStringID de Bookmark.

Renvois

Bookmark|null : Bookmark avec l'ID donné, ou null si aucun Bookmark de ce type n'existe dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmarks()

Obtient tous les objets Bookmark du premier onglet ou, pour les scripts associés à un document, de l'onglet actif. Pour obtenir tous les signets d'un onglet, utilisez la méthode DocumentTab.getBookmarks(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Renvois

Bookmark[] : tableau des objets Bookmark dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getCursor()

Récupère le curseur de l'utilisateur dans l'onglet actif. Un script ne peut accéder au curseur que de l'utilisateur qui l'exécute, et uniquement s'il est lié au document. 

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Renvois

Position|null : représentation du curseur de l'utilisateur ou null si l'utilisateur n'a pas placé de curseur dans l'onglet ou si le script n'est pas lié au document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getEditors()

Obtient la liste des éditeurs pour ce Document.

Renvois

User[] : tableau des utilisateurs disposant des droits de modification.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

Récupère la section de pied de page du premier onglet ou, pour les scripts liés à un document, la section de pied de page de l'onglet actif. Pour obtenir la section de pied de page d'un onglet, utilisez la méthode DocumentTab.getFooter(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

Renvois

FooterSection|null : pied de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFootnotes()

Récupère tous les éléments Footnote dans le corps du premier onglet ou, pour les scripts associés à un document, dans le corps de l'onglet actif. Pour obtenir toutes les notes de bas de page d'un onglet, utilisez la méthode DocumentTab.getFootnotes().

Les appels à getFootnotes entraînent une itération sur les éléments de l'onglet. Pour les grands onglets, évitez les appels inutiles à cette méthode. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Renvois

Footnote[] : notes de bas de page de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getHeader()

Récupère la section d'en-tête du premier onglet ou, pour les scripts liés à un document, la section d'en-tête de l'onglet actif. Pour obtenir la section d'en-tête d'un onglet, utilisez la méthode DocumentTab.getHeader(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

Renvois

HeaderSection|null : en-tête de l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getId()

Récupère l'identifiant unique du document. L'ID de document est utilisé avec DocumentApp.openById() pour ouvrir une instance de document spécifique.

Renvois

String : ID du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLanguage()

Obtient le code de langue du document. Il s'agit de la langue affichée dans l'menu Fichier > Langue de l'éditeur de documents, qui peut ne pas correspondre à la langue réelle du document.

Renvois

String|null : langue du document ou null si elle n'est pas définie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getName()

Récupère le titre du document.

Renvois

String : titre du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRangeById(id)

Récupère le NamedRange avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif. Pour obtenir le NamedRange avec l'ID donné dans n'importe quel onglet, utilisez la méthode DocumentTab.getNamedRangeById(id). Cette méthode renvoie null si aucun NamedRange de ce type n'existe dans l'onglet. Les noms ne sont pas nécessairement uniques, même dans les onglets. Plusieurs plages différentes d'un même onglet peuvent partager le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans l'onglet, comme un ID en HTML.

Paramètres

NomTypeDescription
idStringID de la plage, unique dans l'onglet.

Renvois

NamedRange|null : NamedRange avec l'ID donné, ou null si aucune plage de ce type n'existe dans l'onglet.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges()

Obtient tous les objets NamedRange du premier onglet ou, pour les scripts associés à un document, de l'onglet actif. Pour obtenir tous les objets NamedRange d'un onglet, utilisez la méthode DocumentTab.getNamedRanges().

Un NamedRange est accessible par n'importe quel script qui accède à l'onglet. Pour éviter les conflits involontaires entre les scripts, pensez à faire précéder les noms de plages d'une chaîne unique.

Renvois

NamedRange[] : tableau des objets NamedRange dans l'onglet, pouvant inclure plusieurs plages portant le même nom.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges(name)

Obtient tous les objets NamedRange portant le nom donné dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif. Pour obtenir tous les objets NamedRange dans un onglet, utilisez la méthode DocumentTab.getNamedRanges(name). Les noms ne sont pas nécessairement uniques, même dans les différents onglets. Plusieurs plages différentes d'un même onglet peuvent partager le même nom, comme une classe en HTML. En revanche, les ID sont uniques dans l'onglet, comme un ID en HTML.

Un NamedRange est accessible par n'importe quel script qui accède au document. Pour éviter les conflits involontaires entre les scripts, pensez à préfixer les noms de plages avec une chaîne unique.

Paramètres

NomTypeDescription
nameStringNom de la plage, qui n'est pas nécessairement unique.

Renvois

NamedRange[] : tableau des objets NamedRange dans l'onglet portant le nom spécifié.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSelection()

Récupère la sélection de l'utilisateur dans l'onglet actif. Un script ne peut accéder à la sélection de l'utilisateur qui l'exécute que s'il est associé au document. 

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Renvois

Range|null : représentation de la sélection de l'utilisateur, ou null si l'utilisateur n'a rien sélectionné dans l'onglet, si seule la fin d'un paragraphe est sélectionnée, si seule la fin d'un paragraphe et une nouvelle ligne sont sélectionnées, ou si le script n'est pas lié au document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSupportedLanguageCodes()

Récupère tous les codes de langue compatibles avec les fichiers Google Docs.

Renvois

String[] : tableau de codes de langue.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTab(tabId)

Récupère le Tab avec l'ID spécifié. Cette méthode renvoie null si aucun Tab de ce type n'existe. Peut accéder aux onglets à n'importe quel niveau d'imbrication.

Paramètres

NomTypeDescription
tabIdStringID de l'onglet à obtenir.

Renvois

Tab|null : Tab avec l'ID spécifié, ou null si aucun Tab de ce type n'existe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTabs()

Obtient tous les Tab non imbriqués qui font partie du document.

Les onglets peuvent contenir des onglets enfants, c'est-à-dire des onglets imbriqués dans d'autres onglets. Les onglets enfants sont accessibles à l'aide de Tab.getChildTabs().

Renvois

Tab[] : liste de tous les Tab qui font partie du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUrl()

Récupère l'URL permettant d'accéder au document actuel. 

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

Renvois

String : URL permettant d'accéder au document actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getViewers()

Obtient la liste des lecteurs et des commentateurs pour ce Document.

Renvois

User[] : tableau d'utilisateurs disposant de l'autorisation d'afficher ou de commenter.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newPosition(element, offset)

Crée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à un élément spécifique du premier onglet ou, pour les scripts liés à un document, à l'onglet actif. Pour créer un Position par rapport à un emplacement dans un onglet, utilisez la méthode DocumentTab.newPosition(element, offset). Le curseur de l'utilisateur est représenté par un Position, entre autres utilisations. 

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Paramètres

NomTypeDescription
elementElementÉlément qui doit contenir le nouveau Position. Il doit s'agir d'un élément Text ou d'un élément conteneur comme Paragraph.
offsetIntegerPour les éléments Text, le nombre de caractères avant Position ; pour les autres éléments, le nombre d'éléments enfants avant Position dans le même élément conteneur.

Renvois

Position : le nouveau Position.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newRange()

Crée un compilateur utilisé pour construire des objets Range à partir d'éléments d'onglet dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif. Pour créer un compilateur utilisé pour construire des objets DocumentRange à partir d'éléments d'onglet dans n'importe quel onglet, utilisez la méthode DocumentTab.newRange(). 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Renvois

RangeBuilder : le nouveau compilateur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(emailAddress)

Supprime l'utilisateur donné de la liste des éditeurs pour le Document. Cette méthode n'empêche pas les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(user)

Supprime l'utilisateur donné de la liste des éditeurs pour le Document. Cette méthode n'empêche pas les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(emailAddress)

Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le Document. Cette méthode n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur ou un commentateur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder).Document

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

Document : ce Document pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(user)

Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le Document. Cette méthode n'a aucun effet si l'utilisateur est un éditeur et non un lecteur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder).

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Document : ce Document pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

saveAndClose()

Enregistre le Document actuel. Entraîne le vidage et l'application des mises à jour en attente.

La méthode saveAndClose() est automatiquement appelée à la fin de l'exécution du script pour chaque Document modifiable ouvert.

Il est impossible de modifier un Document fermé. Utilisez DocumentApp.openById() pour rouvrir un document donné et le modifier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setActiveTab(tabId)

Définit le Tab sélectionné par l'utilisateur dans le document actuel sur l'onglet portant l'ID spécifié. 

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

Paramètres

NomTypeDescription
tabIdStringID de l'onglet à définir comme actif.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setCursor(position)

Définit le curseur de l'utilisateur, en fonction d'un Position. Un script ne peut accéder au curseur de l'utilisateur qui l'exécute que s'il est lié au document.

Si vous fournissez un Position à partir d'un Tab inactif, l'onglet actif de l'utilisateur est modifié. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Paramètres

NomTypeDescription
positionPositionNouvel emplacement du curseur.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLanguage(languageCode)

Définit le code de langue du document. Il s'agit de la langue affichée dans l'menu Fichier > Langue de l'éditeur de documents, qui peut ne pas correspondre à la langue réelle du document. Utilisez getSupportedLanguageCodes() pour obtenir tous les codes de langue valides.

Paramètres

NomTypeDescription
languageCodeStringCode de langue.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setName(name)

Définit le titre du document.

Paramètres

NomTypeDescription
nameStringNouveau titre du document.

Renvois

Document : document actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSelection(range)

Définit la sélection de l'utilisateur dans l'onglet actif, en fonction d'un Range. Un script ne peut accéder à la sélection de l'utilisateur qui l'exécute que s'il est associé au document. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Paramètres

NomTypeDescription
rangeRangeNouvelle plage d'éléments à sélectionner.

Renvois

Document : ce Document, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents