Service Drive avancé

pour gérer les fichiers et les dossiers, y compris les propriétés personnalisées et les révisions.

Le service Drive avancé vous permet d'utiliser l'API Google Drive dans Google Apps Script. Tout comme le service Drive intégré d'Apps Script, cette API permet aux scripts de créer, de rechercher et de modifier des fichiers et des dossiers dans Google Drive. Dans la plupart des cas, le service intégré est plus facile à utiliser, mais ce service avancé offre quelques fonctionnalités supplémentaires, y compris l'accès aux propriétés de fichier personnalisées ainsi qu'aux révisions des fichiers et des dossiers.

Il s'agit d'un service avancé qui doit être activé avant utilisation.

Référence

Pour en savoir plus sur ce service, consultez la documentation de référence de l'API Drive. Comme tous les services avancés d'Apps Script, le service Drive avancé utilise les mêmes objets, méthodes et paramètres que l'API publique. Pour en savoir plus, consultez Déterminer les signatures de méthode. De plus, les méthodes nommées delete dans l'API Drive sont nommées remove dans le service avancé (par exemple, Drive.Permissions.remove()), car delete est un mot réservé en JavaScript.

Pour signaler des problèmes et trouver d'autres ressources d'assistance, consultez le guide d'assistance de l'API Drive.

Exemple de code

Les exemples de code de cette section utilisent la version 3 de l'API.

Importer des fichiers

L'exemple de code suivant montre comment enregistrer un fichier dans le Drive d'un utilisateur.

advanced/drive.gs
/**
 * Uploads a new file to the user's Drive.
 */
function uploadFile() {
  try {
    // Makes a request to fetch a URL.
    const image = UrlFetchApp.fetch("http://goo.gl/nd7zjB").getBlob();
    let file = {
      name: "google_logo.png",
      mimeType: "image/png",
    };
    // Create a file in the user's Drive.
    file = Drive.Files.create(file, image, { fields: "id,size" });
    console.log("ID: %s, File size (bytes): %s", file.id, file.size);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed to upload file with error %s", err.message);
  }
}

Créer un dossier

L'exemple de code suivant montre comment créer un dossier dans Drive.

/**
 * Creates a new folder.
 */
function createFolder() {
  var folderMetadata = {
    'name': 'New Folder',
    'mimeType': 'application/vnd.google-apps.folder'
  };
  var folder = Drive.Files.create(folderMetadata);
  Logger.log('Folder ID: ' + folder.id);
}

Rechercher des fichiers

L'exemple de code suivant montre comment rechercher des fichiers à l'aide d'une chaîne de requête.

/**
 * Searches for files with a specific name.
 */
function searchFiles() {
  var query = 'name contains "Project Plan" and trashed = false';
  var files = Drive.Files.list({
    'q': query,
    'fields': 'files(id, name, mimeType)'
  });
  if (files.files && files.files.length > 0) {
    for (var i = 0; i < files.files.length; i++) {
      var file = files.files[i];
      Logger.log('%s (ID: %s)', file.name, file.id);
    }
  } else {
    Logger.log('No files found.');
  }
}

Répertorier les dossiers

L'exemple de code suivant montre comment lister les dossiers de premier niveau dans le Drive de l'utilisateur. Notez l'utilisation de jetons de page pour accéder à la liste complète des résultats.

advanced/drive.gs
/**
 * Lists the top-level folders in the user's Drive.
 */
function listRootFolders() {
  const query =
    '"root" in parents and trashed = false and ' +
    'mimeType = "application/vnd.google-apps.folder"';
  let folders;
  let pageToken = null;
  do {
    try {
      folders = Drive.Files.list({
        q: query,
        pageSize: 100,
        pageToken: pageToken,
      });
      if (!folders.files || folders.files.length === 0) {
        console.log("All folders found.");
        return;
      }
      for (let i = 0; i < folders.files.length; i++) {
        const folder = folders.files[i];
        console.log("%s (ID: %s)", folder.name, folder.id);
      }
      pageToken = folders.nextPageToken;
    } catch (err) {
      // TODO (developer) - Handle exception
      console.log("Failed with error %s", err.message);
    }
  } while (pageToken);
}

Lister les révisions

L'exemple de code suivant montre comment lister les révisions d'un fichier donné. Notez que certains fichiers peuvent comporter plusieurs révisions. Vous devez utiliser des jetons de page pour accéder à la liste complète des résultats.

advanced/drive.gs
/**
 * Lists the revisions of a given file.
 * @param {string} fileId The ID of the file to list revisions for.
 */
function listRevisions(fileId) {
  let revisions;
  let pageToken = null;
  do {
    try {
      revisions = Drive.Revisions.list(fileId, {
        fields: "revisions(modifiedTime,size),nextPageToken",
      });
      if (!revisions.revisions || revisions.revisions.length === 0) {
        console.log("All revisions found.");
        return;
      }
      for (let i = 0; i < revisions.revisions.length; i++) {
        const revision = revisions.revisions[i];
        const date = new Date(revision.modifiedTime);
        console.log(
          "Date: %s, File size (bytes): %s",
          date.toLocaleString(),
          revision.size,
        );
      }
      pageToken = revisions.nextPageToken;
    } catch (err) {
      // TODO (developer) - Handle exception
      console.log("Failed with error %s", err.message);
    }
  } while (pageToken);
}

Ajouter des propriétés de fichier

L'exemple de code suivant utilise le champ appProperties pour ajouter une propriété personnalisée à un fichier. La propriété personnalisée n'est visible que par le script. Pour ajouter une propriété personnalisée au fichier qui est également visible par d'autres applications, utilisez plutôt le champ properties. Pour en savoir plus, consultez Ajouter des propriétés de fichier personnalisées.

advanced/drive.gs
/**
 * Adds a custom app property to a file. Unlike Apps Script's DocumentProperties,
 * Drive's custom file properties can be accessed outside of Apps Script and
 * by other applications; however, appProperties are only visible to the script.
 * @param {string} fileId The ID of the file to add the app property to.
 */
function addAppProperty(fileId) {
  try {
    let file = {
      appProperties: {
        department: "Sales",
      },
    };
    // Updates a file to add an app property.
    file = Drive.Files.update(file, fileId, null, {
      fields: "id,appProperties",
    });
    console.log(
      "ID: %s, appProperties: %s",
      file.id,
      JSON.stringify(file.appProperties, null, 2),
    );
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed with error %s", err.message);
  }
}

Ajouter un utilisateur à un fichier

L'exemple de code suivant montre comment ajouter un utilisateur en tant qu'éditeur à un fichier et supprimer la notification par e-mail.

/**
 * Adds a user to a file as an editor without sending an email notification.
 */
function addEditor() {
  var fileId = '1234567890abcdefghijklmnopqrstuvwxyz';
  var userEmail = 'bob@example.com';
  var request = {
    'role': 'writer',
    'type': 'user',
    'emailAddress': userEmail
  };
  Drive.Permissions.create(request, fileId, {
    'sendNotificationEmail': false
  });
}