Google Spreadsheet

Google Spreadsheetを操作するアクション一覧です。
CreateSpreadsheet
概要
CreateSpreadsheetは、スプレッドシートを新たに作成するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
title*
文字列
スプレッドシートのタイトル
test
provider*
文字列
利用するコネクション（GoogleSpreadsheet）のプロバイダーID
gsheet_1234abcd
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
作成したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
+create_spreadsheet_1:
  action>: CreateSpreadsheet
  title: test
  provider: gsheet_********************
# => {
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
#   "properties": {
#     "title": "test",
#     "locale": "ja_JP",
#     "autoRecalc": "ON_CHANGE",
#     "timeZone": "Etc/GMT",
#     "defaultFormat": {
#       "backgroundColor": {
#         "red": 1,
#         "green": 1,
#         "blue": 1
#       },
#       "padding": {
#         "top": 2,
#         "right": 3,
#         "bottom": 2,
#         "left": 3
#       },
#       "verticalAlignment": "BOTTOM",
#       "wrapStrategy": "OVERFLOW_CELL",
#       "textFormat": {
#         "foregroundColor": {},
#         "fontFamily": "arial,sans,sans-serif",
#         "fontSize": 10,
#         "bold": false,
#         "italic": false,
#         "strikethrough": false,
#         "underline": false
#       }
#     }
#   },
#   "sheets": [
#     {
#       "properties": {
#         "sheetId": 0,
#         "title": "シート1",
#         "index": 0,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     }
#   ],
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
#   "provider": "gsheet_********************"
# }
GetSpreadsheet
概要
GetSpreadsheetは、GoogleSpreadsheetオブジェクトを取得するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
利用するコネクション（GoogleSpreadsheet）のプロバイダーID
gsheet_1234abcd
spreadsheet_id*
文字列
使用するスプレッドシートIDまたはURL
1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33roまたはhttps://docs.google.com/a/tutorial.co.jp/spreadsheets/d/example/edit​
ranges
配列
取得したいシート名の配列。特定のシートから、さらに特定のセルのみ取得したい場合、A1記法で指定可能。
["シート1", "シート2!A1:B3"]
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
取得したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
+get_spreadsheet_1:
  action>: GetSpreadsheet
  provider: gsheet_********************
  spreadsheet_id: 1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro
# => {
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
#   "properties": {
#     "title": "test",
#     "locale": "ja_JP",
#     "autoRecalc": "ON_CHANGE",
#     "timeZone": "Etc/GMT",
#     "defaultFormat": {
#       "backgroundColor": {
#         "red": 1,
#         "green": 1,
#         "blue": 1
#       },
#       "padding": {
#         "top": 2,
#         "right": 3,
#         "bottom": 2,
#         "left": 3
#       },
#       "verticalAlignment": "BOTTOM",
#       "wrapStrategy": "OVERFLOW_CELL",
#       "textFormat": {
#         "foregroundColor": {},
#         "fontFamily": "arial,sans,sans-serif",
#         "fontSize": 10,
#         "bold": false,
#         "italic": false,
#         "strikethrough": false,
#         "underline": false
#       }
#     }
#   },
#   "sheets": [
#     {
#       "properties": {
#         "sheetId": 0,
#         "title": "シート1",
#         "index": 0,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     }
#   ],
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
#   "provider": "gsheet_********************"
# }
GetCells
概要
GetCellsは、セルの値を取得するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range*
文字列
取得する値のセルの範囲(A1記法)
!A1:D4
アウトプット
タイプ
型
概要
例
Array
配列
取得したセルの値を[行][列]の二次元配列で返します。
[['A1','B1'],['A2', 'B2']]
使用例
+get_cells_1:
  action>: GetCells
  spreadsheet: +get_spreadsheet_1
  range: '!A1:D4'
# => [
#   [
#     "",
#     "国語",
#     "数学",
#     "英語"
#   ],
#   [
#     "A杉",
#     "90",
#     "43",
#     "87"
#   ],
#   [
#     "B山",
#     "82",
#     "95",
#     "43"
#   ],
#   [
#     "C田",
#     "100",
#     "100",
#     "100"
#   ]
# ]
UpdateCells
概要
UpdateCellsは、セルの値を更新するアクションです。セルの値はすぐに更新されます。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range*
文字列
更新するセルの範囲(A1記法)
!A1:D4
values*
配列
書き込む値
[['A1','B1'],['A2', 'B2']]
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
更新されたスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
+update_cells_1:
  action>: UpdateCells
  spreadsheet: +get_spreadsheet_1
  range: 'シート1!A6:D6'
  values: [["平均","=SUM(B2:B5)","=SUM(C2:C5)","=SUM(D2:D5)"]]
# => {
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
#   "properties": {
#     "title": "test",
#     "locale": "ja_JP",
#     "autoRecalc": "ON_CHANGE",
#     "timeZone": "Etc/GMT",
#     "defaultFormat": {
#       "backgroundColor": {
#         "red": 1,
#         "green": 1,
#         "blue": 1
#       },
#       "padding": {
#         "top": 2,
#         "right": 3,
#         "bottom": 2,
#         "left": 3
#       },
#       "verticalAlignment": "BOTTOM",
#       "wrapStrategy": "OVERFLOW_CELL",
#       "textFormat": {
#         "foregroundColor": {},
#         "fontFamily": "arial,sans,sans-serif",
#         "fontSize": 10,
#         "bold": false,
#         "italic": false,
#         "strikethrough": false,
#         "underline": false
#       }
#     }
#   },
#   "sheets": [
#     {
#       "properties": {
#         "sheetId": 0,
#         "title": "シート1",
#         "index": 0,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     }
#   ],
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
#   "provider": "gsheet_********************"
# }
AppendValues
概要
AppendValuesは、指定した範囲が含む表の直後に値を追加するアクションです。シート名を指定した場合、シートの最後の空行に値を追加します。
詳しい仕様に関しましては、AppendValuesの挙動についてをご参照ください。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range*
文字列
指定する表の範囲(A1記法)
シート1,シート1!A1:B4
values*
配列（2次元配列）
追加する値
[['A1','B1'],['A2', 'B2']]
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
更新されたスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
+append_values_1:
  action>: AppendValues
  spreadsheet: +get_spreadsheet_1
  range: '!A2:D5'
  values: [["E森","23","34","45"]]
# => {
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
#   "properties": {
#     "title": "test",
#     "locale": "ja_JP",
#     "autoRecalc": "ON_CHANGE",
#     "timeZone": "Etc/GMT",
#     "defaultFormat": {
#       "backgroundColor": {
#         "red": 1,
#         "green": 1,
#         "blue": 1
#       },
#       "padding": {
#         "top": 2,
#         "right": 3,
#         "bottom": 2,
#         "left": 3
#       },
#       "verticalAlignment": "BOTTOM",
#       "wrapStrategy": "OVERFLOW_CELL",
#       "textFormat": {
#         "foregroundColor": {},
#         "fontFamily": "arial,sans,sans-serif",
#         "fontSize": 10,
#         "bold": false,
#         "italic": false,
#         "strikethrough": false,
#         "underline": false
#       }
#     }
#   },
#   "sheets": [
#     {
#       "properties": {
#         "sheetId": 0,
#         "title": "シート1",
#         "index": 0,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     }
#   ],
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
#   "provider": "gsheet_********************"
# }
AppendValuesの挙動について
rangeパラメーターに指定した範囲は、その範囲内にある「テーブル」を見つけるために使用されます。値は範囲内にある最後のテーブルの次の行に、テーブルの開始列と同じ列から追加されます。
以下のシートを例に、AppendValuesの実行結果を解説します。
例
シートにはA1:C2とB4:D6の2つのテーブルがあります。
次のようにrangeパラメーターを指定すると、値はB7を起点として追加されます。
シート名のみの指定: シート内の最後のテーブルは②であるため。
B4またはC5:D5: 両方とも②に含まれるため。
B2:D4: この範囲は①も含むが、範囲内の最後のテーブルは②であるため。
A3:G10: 範囲内にある最後のテーブルが②であるため。
次のようにrangeパラメーターを指定すると、値はB7以外を起点として追加されます。
A1: 範囲内のテーブルは①になるので、値はA3に追加されます。
E4: 範囲内にテーブルがないので、値はE4に追加されます。
こちらの解説はGoogle Sheets API のドキュメントを翻訳・加筆したものになります。詳細・原文は以下をご参照ください。
​Reading & Writing Cell Values | Sheets API | Google Developers​
ClearValues
概要
ClearValuesは、指定した範囲の値を削除するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range
文字列
削除する表の範囲(A1記法)
シート1!A1:B4
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
更新されたスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
# セルの値を削除
+clear_values_1:
  action>: ClearValues
  spreadsheet: +get_spreadsheet_1
  range: 'シート1!A1:B2'
# => {
#   "spreadsheetId": "spreadsheet_id",
#   "properties": {
#     "title": "spreadsheetテスト",
#     "locale": "ja_JP",
#     "autoRecalc": "ON_CHANGE",
#     "timeZone": "Asia/Tokyo",
#     "defaultFormat": {
#       "backgroundColor": {
#         "red": 1,
#         "green": 1,
#         "blue": 1
#       },
#       "padding": {
#         "top": 2,
#         "right": 3,
#         "bottom": 2,
#         "left": 3
#       },
#       "verticalAlignment": "BOTTOM",
#       "wrapStrategy": "OVERFLOW_CELL",
#       "textFormat": {
#         "foregroundColor": {},
#         "fontFamily": "arial,sans,sans-serif",
#         "fontSize": 10,
#         "bold": false,
#         "italic": false,
#         "strikethrough": false,
#         "underline": false,
#         "foregroundColorStyle": {
#           "rgbColor": {}
#         }
#       }
#     }
#   },
#   "sheets": [
#     {
#       "properties": {
#         "sheetId": 0,
#         "title": "シート1",
#         "index": 0,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     }
#   ],
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/spreadsheet_id/edit",
#   "provider": "gsheet_*******************"
# }
DuplicateSheet
概要
DuplicateSheetは、スプレッドシート内の一つのシートをコピーするアクションです。コピーして作成された先のスプレッドシートオブジェクトを出力します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
source
Spreadsheet*
GetSpreadsheetで取得した Spreadsheetオブジェクト。コピー元のスプレッドシートです。
+get_spreadsheet_1
sheet
文字列*
コピーするシート名、もしくは、シートID。spreadsheet内の既存のシートである必要があります。
シート1
destination
Spreadsheet
コピー先のspreadsheetオブジェクト。設定なしの場合は、同じスプレッドシート内にコピーします。
get_spreadsheet_2 (デフォルトは、コピー元のspreadsheetが使われます。)
as
文字列
コピー先での新しいシート名。指定なしの場合、Google Sheetsのデフォルトのコピー名になります。
10月（デフォルトでは、 「xxx のコピー」のような名前になります。）
＊spreadsheetを取得した権限でコピーされるので、コピー先のスプレッドシートの書き込み権限の無いとエラーになります。
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
取得したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
+get_spreadsheet_1:
  action>: DuplicateSheet
  source: +get_spreadsheet_1
  sheet: シート1
  destination: +get_spreadsheet_2
  as: 新しいシート
# => {
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
#   "properties": {
#     "title": "test",
#     "locale": "ja_JP",
#     "autoRecalc": "ON_CHANGE",
#     "timeZone": "Etc/GMT",
#     "defaultFormat": {
#       "backgroundColor": {
#         "red": 1,
#         "green": 1,
#         "blue": 1
#       },
#       "padding": {
#         "top": 2,
#         "right": 3,
#         "bottom": 2,
#         "left": 3
#       },
#       "verticalAlignment": "BOTTOM",
#       "wrapStrategy": "OVERFLOW_CELL",
#       "textFormat": {
#         "foregroundColor": {},
#         "fontFamily": "arial,sans,sans-serif",
#         "fontSize": 10,
#         "bold": false,
#         "italic": false,
#         "strikethrough": false,
#         "underline": false
#       }
#     }
#   },
#   "sheets": [
#     {
#       "properties": {
#         "sheetId": 0,
#         "title": "シート1",
#         "index": 0,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     },
#     {
#       "properties": {
#         "sheetId": 12349,
#         "title": "新しいシート",
#         "index": 1,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     }
#   ],
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/xxxx/edit",
#   "provider": "gsheet_********************"
# }
DownloadSheets
概要
DownloadSheetsは、スプレッドシートをダウンロードするアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
sheetname
文字列
ダウンロードするシート名。シート名を指定しない場合、XLSX、PDF、ODS形式は全てのシートをダウンロードします。CSV、TSV形式はスプレッドシートの一番左のシートをダウンロードします。
シート1
type
セレクト
ダウンロード形式
XLSX、PDF、CSV、TSV、ODS
アウトプット
タイプ
型
概要
例
File
文字列
ファイル名は スプレッドシート名-シート名.pdfの形式で出力されます。シート名を指定しない場合はスプレッドシート名.pdfの形式になります。（拡張子はtypeで指定したものになります）
/tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/download/spreadsheetname-シート1.pdf
使用例
+get_spreadsheet_1:
  action>: DownloadSheets
  spreadsheet: +get_spreadsheet_1
  sheetname: シート1
  type: pdf
  # => "/tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/download/spreadsheetname-シート1.pdf"
GetBlankRows
概要
GetBlankRowsは、指定した範囲内にある空行を取得するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range*
文字列
指定する表の範囲(A1記法)。
シート1,シート1!A1:B4
findAll
真理値
trueの場合、範囲内の空行を全て取得します。falseの場合、範囲内にある最初の空行を取得します。
デフォルトはtrue
アウトプット
タイプ
型
概要
例
Anything
配列または文字列
空行を1行ごとにA1記法で出力します。rangeパラメーターにシート名のみを指定した場合、シートに存在する表の範囲内にある空行を返します。findAllパラメーターがtrueの場合は配列で、falseの場合は文字列で返却されます。
trueの場合：['Sheet1!A1:B1', 'Sheet1!A4:B4', ...] falseの場合：'Sheet1!A1:B1'
使用例
+get_blank_rows_1:
  action>: GetBlankRows
  spreadsheet: +get_spreadsheet_1
  range: Sheet1!A1:D10
  findAll: true
  # => ['Sheet1!A1:D1', 'Sheet1!A4:D4', 'Sheet1!A5:D5']
​
+get_blank_rows_1:
  action>: GetBlankRows
  spreadsheet: +get_spreadsheet_1
  range: Sheet1!A1:D10
  findAll: false
  # => 'Sheet1!A1:D1'
AppendSheet
概要
AppendSheetは、スプレッドシートに１つ新たにシートを追加するアクションです。追加して作成されたスプレッドシートオブジェクトを出力します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet
Spreadsheet*
GetSpreadsheetで取得した Spreadsheetオブジェクト。コピー元のスプレッドシートです。
+get_spreadsheet_1
name
文字列
新しいシート名。指定なしの場合、Google Sheetsのデフォルトのシート名になります。
10月（デフォルトでは、 「シート３」のような名前になります。）
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
取得したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
+append_sheet_1:
  action>: AppendSheet
  spreadsheet: +get_spreadsheet_1
  name: 新しいシート
​
# => {
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
#   "properties": {
#     "title": "test",
#     "locale": "ja_JP",
#     "autoRecalc": "ON_CHANGE",
#     "timeZone": "Etc/GMT",
#     "defaultFormat": {
#       "backgroundColor": {
#         "red": 1,
#         "green": 1,
#         "blue": 1
#       },
#       "padding": {
#         "top": 2,
#         "right": 3,
#         "bottom": 2,
#         "left": 3
#       },
#       "verticalAlignment": "BOTTOM",
#       "wrapStrategy": "OVERFLOW_CELL",
#       "textFormat": {
#         "foregroundColor": {},
#         "fontFamily": "arial,sans,sans-serif",
#         "fontSize": 10,
#         "bold": false,
#         "italic": false,
#         "strikethrough": false,
#         "underline": false
#       }
#     }
#   },
#   "sheets": [
#     {
#       "properties": {
#         "sheetId": 0,
#         "title": "シート1",
#         "index": 0,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     },
#     {
#       "properties": {
#         "sheetId": 12349,
#         "title": "新しいシート",
#         "index": 1,
#         "sheetType": "GRID",
#         "gridProperties": {
#           "rowCount": 1000,
#           "columnCount": 26
#         }
#       }
#     }
#   ],
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/xxxx/edit",
#   "provider": "gsheet_********************"
# }

Actions - Previous

Marketing

Next - Actions

Google Calendar

Last updated 2 months ago

名前	型	概要	例
title*	文字列	スプレッドシートのタイトル	test
provider*	文字列	利用するコネクション（GoogleSpreadsheet）のプロバイダーID	gsheet_1234abcd

タイプ	型	概要	例
Spreadsheet	スプレッドシート	作成したスプレッドシートオブジェクト	※使用例のアウトプット参照

名前	型	概要	例
spreadsheet*	スプレッドシート、文字列、オブジェクト	対象のスプレッドシート	+get_spreadsheet_1
range*	文字列	取得する値のセルの範囲(A1記法)	!A1:D4

タイプ	型	概要	例
Array	配列	取得したセルの値を[行][列]の二次元配列で返します。	[['A1','B1'],['A2', 'B2']]

名前	型	概要	例
source	Spreadsheet*	GetSpreadsheetで取得した Spreadsheetオブジェクト。コピー元のスプレッドシートです。	+get_spreadsheet_1
sheet	文字列*	コピーするシート名、もしくは、シートID。spreadsheet内の既存のシートである必要があります。	シート1
destination	Spreadsheet	コピー先のspreadsheetオブジェクト。設定なしの場合は、同じスプレッドシート内にコピーします。	get_spreadsheet_2 (デフォルトは、コピー元のspreadsheetが使われます。)
as	文字列	コピー先での新しいシート名。指定なしの場合、Google Sheetsのデフォルトのコピー名になります。	10月（デフォルトでは、「xxx のコピー」のような名前になります。）

タイプ	型	概要	例
File	文字列	ファイル名は `スプレッドシート名-シート名.pdf`の形式で出力されます。シート名を指定しない場合は`スプレッドシート名.pdf`の形式になります。（拡張子はtypeで指定したものになります）	/tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/download/spreadsheetname-シート1.pdf

タイプ	型	概要	例
Anything	配列または文字列	空行を1行ごとにA1記法で出力します。rangeパラメーターにシート名のみを指定した場合、シートに存在する表の範囲内にある空行を返します。findAllパラメーターがtrueの場合は配列で、falseの場合は文字列で返却されます。	trueの場合：`['Sheet1!A1:B1', 'Sheet1!A4:B4', ...]` falseの場合：`'Sheet1!A1:B1'`