senmai

README

Senmai

A Wrapper Client for Google Spreadsheet API (Sheets API)

PREPARATION

Service Account and Key File

1. Create a service account on Google Cloud Platform. Refer: https://cloud.google.com/iam/docs/creating-managing-service-accounts
2. Generate and Download a key file (json) that relates the service account you created. Refer: https://cloud.google.com/iam/docs/creating-managing-service-account-keys

Sheets API

1. Enable Sheets API on your project. Refer: https://console.developers.google.com/apis/api/sheets.googleapis.com/overview

Spreadsheet

1. Create a spreadsheet on your google drive.
2. Specify your table schema on the spreadsheet. Row '1' is column name cell. And rows '2' or greater are data cell. Cell '1A' must be 'id'.
3. Invite the service account as a editor, without notification.

SYNOPSIS

Init Senmai Client

	// KeyFile path of your key file you generated at PREPARATION section 
	const KeyFile = "/path/to/identity.json"

	// SpreadsheetID is identity string of spreadsheet that you want to manipulate. Refer: https://developers.google.com/sheets/api/guides/concepts
	const SpreadsheetID = "1234567890qwertyuiopASDFGHJKL"

	// SheetName is a name of a sheet you want to manipulate 
	SheetName = "book"

	// Init Senmai Client
	sm, err := senmai.New(KeyFile)
	if err != nil {
		log.Fatal(err.Error())
	}

Get Table struct

	// Get Table struct that named "book"
	book, err := sm.GetTable(SpreadsheetID, SheetName)
	if err != nil {
		log.Fatal(err.Error())
	}

Fetch a row

	// Fetch
	row, err := book.FetchRow("mybook0001")
	if err != nil {
		log.Fatal(err.Error())
	}
	fmt.Printf("%#v\n", row)

Update a row

	// Update
	row.Cols["price_yen"] = "4000"
	err = row.Update()
	if err != nil {
		log.Fatal(err.Error())
	}

Create a new row

	// Build a new row struct
	b1 := book.NewRow()

	// Fill-in field values
	b1.Cols = map[string]string{
		"id":         "mybook0003",
		"name":       "Slack: Getting Past Burnout, Busywork, and the Myth of Total Efficiency",
		"author":     "Tom DeMarco",
		"price_yen":  "2800",
	}

	// Insert into spreadsheet
	err = b1.Insert()
	if err != nil {
		log.Fatal(err.Error())
	}

Documentation

Index

• type Row
  • func (row Row) Insert() error
  • func (row Row) Update() error
• type Senmai
  • func New(credentialsFile string) (*Senmai, error)
  • func (s Senmai) GetTable(spreadsheetID string, sheetName string) (*Table, error)
• type Table
  • func (t Table) FetchRow(id string) (*Row, error)
  • func (t Table) GetRows() int
  • func (t Table) NewRow() *Row

Types

type Row

type Row struct {
	Cols map[string]string
	// contains filtered or unexported fields
}

Row row struct

func (Row) Insert

func (row Row) Insert() error

Insert insert this row into sheet

func (Row) Update

func (row Row) Update() error

Update update this row

type Senmai

type Senmai struct {
	Client *herschel.Client
}

Senmai A wrapper client for Google Sheets API

func New

func New(credentialsFile string) (*Senmai, error)

New init a Senmai wrapper client

func (Senmai) GetTable

func (s Senmai) GetTable(spreadsheetID string, sheetName string) (*Table, error)

GetTable build and return table struct

type Table

type Table struct {
	Fields        []string
	SpreadsheetID string
	SheetName     string
	// contains filtered or unexported fields
}

Table table struct

func (Table) FetchRow

func (t Table) FetchRow(id string) (*Row, error)

FetchRow fetch a row that exact matched to 'A' column

func (Table) GetRows

func (t Table) GetRows() int

GetRows return row count of table

func (Table) NewRow

func (t Table) NewRow() *Row

NewRow build and return a new Row struct that relates this table