hakucho

README

hakucho

Google Drive helper methods library for Golang

How to use

c, err := NewClient("/path/to/credentials.json", "/path/to/token.json")
if err != nil {
  log.Fatalf("client init error: %s", err)
}

files, err := c.ListFiles([]string{"id", "name", "createdTime"}, 20)
if err != nil {
  log.Fatalf("list error: %s", err)
}

for _, f := range files {
  log.Printf("%s\n", f.Name)
}

Search files

files, err := c.ListFiles([]string{"id", "createdTime", "name"}, 5, option.MimeType("text/csv"), option.FullTextContains("Guitar"))
if err != nil {
  log.Printf("Failed to get list of files: %s", err)
}

for i, f := range files {
  log.Printf("File %02d: %s(%s)\n", i, f.Name, f.CreatedTime)
}

Available fields

https://developers.google.com/drive/api/v3/reference/files

Available options

• option.OnlyFolders()
• option.ParentFolder("parent folder id")
• option.ParentIn("some folder 1", "some folder 2")
• option.NameContains("memo")
• option.FullTextContains("memo")
• option.MimeType("text/csv")
• option.OrderBy("createdTime")

Upload File

// File will be created in root folder
uploadedFile, err := c.UploadFile("/path/to/file", "sample.txt")

// File will be created under selected folder
uploadedFile, err := c.UploadFileToFolder("/path/to/file", "sample.txt", "parent folder id")

Grant permission to user

// User can read the file
err := c.GrantUserReaderPemission(uploadedFile.Id, "1@example.com", false)

// User can read & write the file
err := c.GrantUserWriterPemission(uploadedFile.Id, "1@example.com", false)

Delete File

err = c.DeleteFile(uploadedFile.Id)

Create Folder

// Folder will be created in root folder
folder, err := c.CreateFolder("folder 1")

// Folder will be created under selected folder
folder, err := c.CreateSubFolder(parentFolder.Id, "folder 1")

Documentation

Index

• type Client
  • func NewClient(credPath string, tokenPath string) (*Client, error)
  • func (c *Client) AddParentFolder(fileID string, folderID string) error
  • func (c *Client) CreateFolder(folderName string) (*drive.File, error)
  • func (c *Client) CreateSubFolder(parentFolderID string, folderName string) (*drive.File, error)
  • func (c *Client) DeleteFile(fileID string) error
  • func (c *Client) GetFile(fileID string, fileFields []string) (*drive.File, error)
  • func (c *Client) GrantUserReaderPemission(fileID string, email string, sendEmail bool) error
  • func (c *Client) GrantUserWriterPemission(fileID string, email string, sendEmail bool) error
  • func (c *Client) ListFiles(fileFields []string, limit int64, options ...option.ListOption) ([]*drive.File, error)
  • func (c *Client) ListPermissions(fileID string) ([]*drive.Permission, error)
  • func (c *Client) UploadFile(localFile string, uploadFilename string, options ...option.UploadOption) (*drive.File, error)
  • func (c *Client) UploadFileToFolder(localFile string, uploadFilename string, folderID string, ...) (*drive.File, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides apis for Google Drive

func NewClient

func NewClient(credPath string, tokenPath string) (*Client, error)

NewClient creates a new client.

func (*Client) AddParentFolder

func (c *Client) AddParentFolder(fileID string, folderID string) error

func (*Client) CreateFolder

func (c *Client) CreateFolder(folderName string) (*drive.File, error)

CreateFolder creates new folder

func (*Client) CreateSubFolder

func (c *Client) CreateSubFolder(parentFolderID string, folderName string) (*drive.File, error)

CreateSubFolder creates new folder and set parent folder id of it

func (*Client) DeleteFile

func (c *Client) DeleteFile(fileID string) error

func (*Client) GetFile

func (c *Client) GetFile(fileID string, fileFields []string) (*drive.File, error)

func (*Client) GrantUserReaderPemission

func (c *Client) GrantUserReaderPemission(fileID string, email string, sendEmail bool) error

func (*Client) GrantUserWriterPemission

func (c *Client) GrantUserWriterPemission(fileID string, email string, sendEmail bool) error

func (*Client) ListFiles

func (c *Client) ListFiles(fileFields []string, limit int64, options ...option.ListOption) ([]*drive.File, error)

func (*Client) ListPermissions

func (c *Client) ListPermissions(fileID string) ([]*drive.Permission, error)

func (*Client) UploadFile

func (c *Client) UploadFile(localFile string, uploadFilename string, options ...option.UploadOption) (*drive.File, error)

UploadFile uploads file to Google Drive

func (*Client) UploadFileToFolder

func (c *Client) UploadFileToFolder(localFile string, uploadFilename string, folderID string, options ...option.UploadOption) (*drive.File, error)