Serviço avançado do Drive

Com o serviço avançado do Drive, é possível usar a API Google Drive no Apps Script. Assim como o serviço integrado do Drive do Apps Script, essa API permite que os scripts criem, encontrem e modifiquem arquivos e pastas no Google Drive. Na maioria dos casos, o serviço integrado é mais fácil de usar, mas esse serviço avançado oferece alguns recursos extras, incluindo acesso a propriedades de arquivo personalizadas e revisões de arquivos e pastas.

Referência

Para informações detalhadas sobre esse serviço, consulte a documentação de referência da API Google Drive. Assim como todos os serviços avançados no Apps Script, o serviço avançado do Drive usa os mesmos objetos, métodos e parâmetros da API pública. Para mais informações, consulte Como as assinaturas de método são determinadas.

Para informar problemas e encontrar outras opções de suporte, consulte o guia de suporte da API Drive.

Código de amostra

Os exemplos de código nesta seção usam a versão 3 da API.

Fazer upload de arquivos

O exemplo de código a seguir mostra como salvar um arquivo no Drive de um usuário.

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);
  }
}

Listar pastas

O exemplo de código a seguir mostra como listar as pastas de nível superior no Drive do usuário. Observe o uso de tokens de página para acessar a lista completa de resultados.

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);
}

Listar revisões

O exemplo de código a seguir mostra como listar as revisões de um determinado arquivo. Alguns arquivos podem ter várias revisões. Use tokens de página para acessar a lista completa de resultados.

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;
  const 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);
}

Adicionar propriedades do arquivo

O exemplo de código a seguir usa o campo appProperties para adicionar uma propriedade personalizada a um arquivo. A propriedade personalizada só fica visível para o script. Para adicionar uma propriedade personalizada ao arquivo que também seja visível para outros apps, use o campo properties. Para mais informações, consulte Adicionar propriedades de arquivo personalizadas.

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);
  }
}