Files: copy

Request

HTTP request

POST https://www.googleapis.com/drive/v2/files/fileId/copy

Parameters

Authorization

This request requires authorization with at least one of the following scopes:

Some scopes are restricted and require a security assessment for your app to use them. For more information, see the authentication and authorization page.

Request body

In the request body, supply a Files resource with the following properties:

Response

If successful, this method returns a Files resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

import com.google.api.services.drive.Drive;
import com.google.api.services.drive.model.File;

import java.io.IOException;
// ...

public class MyClass {

  // ...

  /**
   * Copy an existing file.
   *
   * @param service Drive API service instance.
   * @param originFileId ID of the origin file to copy.
   * @param copyTitle Title of the copy.
   * @return The copied file if successful, {@code null} otherwise.
   */
  private static File copyFile(Drive service, String originFileId,
      String copyTitle) {
    File copiedFile = new File();
    copiedFile.setTitle(copyTitle);
    try {
      return service.files().copy(originFileId, copiedFile).execute();
    } catch (IOException e) {
      System.out.println("An error occurred: " + e);
    }
    return null;
  }

  // ...

}

using Google.Apis.Drive.v2;
using Google.Apis.Drive.v2.Data;

using System.Net;
// ...

public class MyClass {

  // ...

  /// <summary>
  /// Copy an existing file.
  /// </summary>
  /// <param name="service">Drive API service instance.</param>
  /// <param name="originFileId">ID of the origin file to copy.</param>
  /// <param name="copyTitle">Title of the copy.</param>
  /// <returns>The copied file, null is returned if an API error occurred</returns>
  public static File CopyFile(DriveService service, String originFileId, String copyTitle) {
    File copiedFile = new File();
    copiedFile.Title = copyTitle;
    try {
      return service.Files.Copy(copiedFile, originFileId).Execute();
    } catch (Exception e) {
      Console.WriteLine("An error occurred: " + e.Message);
    }
    return null;
  }

  // ...

}

/**
 * Copy an existing file.
 *
 * @param Google_Service_Drive $service Drive API service instance.
 * @param String $originFileId ID of the origin file to copy.
 * @param String $copyTitle Title of the copy.
 * @return DriveFile The copied file. NULL is returned if an API error occurred.
 */
function copyFile($service, $originFileId, $copyTitle) {
  $copiedFile = new Google_Service_Drive_DriveFile();
  $copiedFile->setTitle($copyTitle);
  try {
    return $service->files->copy($originFileId, $copiedFile);
  } catch (Exception $e) {
    print "An error occurred: " . $e->getMessage();
  }
  return NULL;
}

from apiclient import errors
# ...

def copy_file(service, origin_file_id, copy_title):
  """Copy an existing file.

  Args:
    service: Drive API service instance.
    origin_file_id: ID of the origin file to copy.
    copy_title: Title of the copy.

  Returns:
    The copied file if successful, None otherwise.
  """
  copied_file = {'title': copy_title}
  try:
    return service.files().copy(
        fileId=origin_file_id, body=copied_file).execute()
  except errors.HttpError, error:
    print 'An error occurred: %s' % error
  return None

/**
 * Copy an existing file.
 *
 * @param {String} originFileId ID of the origin file to copy.
 * @param {String} copyTitle Title of the copy.
 */
function copyFile(originFileId, copyTitle) {
  var body = {'title': copyTitle};
  var request = gapi.client.drive.files.copy({
    'fileId': originFileId,
    'resource': body
  });
  request.execute(function(resp) {
    console.log('Copy ID: ' + resp.id);
  });
}

import (
  "google.golang.org/drive/v2"
  "fmt"
)

// CopyFile copies a file setting a new title on the copy
func CopyFile(d *drive.Service, fileId string,
    title string) (*drive.File, error) {
  f := &drive.File{Title: title}
  r, err := d.Files.Copy(fileId, f).Do()
  if err != nil {
    fmt.Printf("An error occurred: %v\n", err)
    return nil, err
  }
  return r, nil
}

#import "GTLDrive.h"
// ...

+ (void)copyFileWithService:(GTLServiceDrive *)service
               originFileId:(NSString *)originFileId
                  copyTitle:(NSString *)copyTitle
            completionBlock:(void (^)(GTLDriveFile *, NSError *))completionBlock {
  GTLDriveFile *copiedFile = [GTLDriveFile object];
  copiedFile.title = copyTitle;

  GTLQueryDrive *query =
    [GTLQueryDrive queryForFilesCopyWithObject:copiedFile fileId:originFileId];
  // queryTicket can be used to track the status of the request.
  GTLServiceTicket *queryTicket =
    [service executeQuery:query
        completionHandler:^(GTLServiceTicket *ticket, GTLDriveFile *file,
                            NSError *error) {
          if (error == nil) {
            completionBlock(file, nil);
          } else {
            NSLog(@"An error occurred: %@", error);
            completionBlock(nil, error);
          }
        }];
}

// ...

Try it!

Use the APIs Explorer below to call this method on live data and see the response.