Google Spreadsheet

Google Spreadsheetを操作するアクション一覧です。
CreateSpreadsheet
概要
CreateSpreadsheetは、スプレッドシートを新たに作成するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
title*
文字列
スプレッドシートのタイトル
test
provider*
文字列
利用するコネクション（GoogleSpreadsheet）のプロバイダーID
gsheet_1234abcd
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
作成したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
1
+create_spreadsheet_1:
2
  action>: CreateSpreadsheet
3
  title: test
4
  provider: gsheet_********************
5
# => {
6
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
7
#   "properties": {
8
#     "title": "test",
9
#     "locale": "ja_JP",
10
#     "autoRecalc": "ON_CHANGE",
11
#     "timeZone": "Etc/GMT",
12
#     "defaultFormat": {
13
#       "backgroundColor": {
14
#         "red": 1,
15
#         "green": 1,
16
#         "blue": 1
17
#       },
18
#       "padding": {
19
#         "top": 2,
20
#         "right": 3,
21
#         "bottom": 2,
22
#         "left": 3
23
#       },
24
#       "verticalAlignment": "BOTTOM",
25
#       "wrapStrategy": "OVERFLOW_CELL",
26
#       "textFormat": {
27
#         "foregroundColor": {},
28
#         "fontFamily": "arial,sans,sans-serif",
29
#         "fontSize": 10,
30
#         "bold": false,
31
#         "italic": false,
32
#         "strikethrough": false,
33
#         "underline": false
34
#       }
35
#     }
36
#   },
37
#   "sheets": [
38
#     {
39
#       "properties": {
40
#         "sheetId": 0,
41
#         "title": "シート1",
42
#         "index": 0,
43
#         "sheetType": "GRID",
44
#         "gridProperties": {
45
#           "rowCount": 1000,
46
#           "columnCount": 26
47
#         }
48
#       }
49
#     }
50
#   ],
51
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
52
#   "provider": "gsheet_********************"
53
# }
Copied!
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
スプレッドシート
取得したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
1
+get_spreadsheet_1:
2
  action>: GetSpreadsheet
3
  provider: gsheet_********************
4
  spreadsheet_id: 1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro
5
# => {
6
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
7
#   "properties": {
8
#     "title": "test",
9
#     "locale": "ja_JP",
10
#     "autoRecalc": "ON_CHANGE",
11
#     "timeZone": "Etc/GMT",
12
#     "defaultFormat": {
13
#       "backgroundColor": {
14
#         "red": 1,
15
#         "green": 1,
16
#         "blue": 1
17
#       },
18
#       "padding": {
19
#         "top": 2,
20
#         "right": 3,
21
#         "bottom": 2,
22
#         "left": 3
23
#       },
24
#       "verticalAlignment": "BOTTOM",
25
#       "wrapStrategy": "OVERFLOW_CELL",
26
#       "textFormat": {
27
#         "foregroundColor": {},
28
#         "fontFamily": "arial,sans,sans-serif",
29
#         "fontSize": 10,
30
#         "bold": false,
31
#         "italic": false,
32
#         "strikethrough": false,
33
#         "underline": false
34
#       }
35
#     }
36
#   },
37
#   "sheets": [
38
#     {
39
#       "properties": {
40
#         "sheetId": 0,
41
#         "title": "シート1",
42
#         "index": 0,
43
#         "sheetType": "GRID",
44
#         "gridProperties": {
45
#           "rowCount": 1000,
46
#           "columnCount": 26
47
#         }
48
#       }
49
#     }
50
#   ],
51
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
52
#   "provider": "gsheet_********************"
53
# }
Copied!
GetCells
概要
GetCellsは、セルの値を取得するアクションです。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range*
文字列
取得する値のセルの範囲(A1記法)
!A1:D4
アウトプット
タイプ
型
概要
例
Array
配列
取得したセルの値を[行][列]の二次元配列で返します。
[['A1','B1'],['A2', 'B2']]
使用例
1
+get_cells_1:
2
  action>: GetCells
3
  spreadsheet: +get_spreadsheet_1
4
  range: '!A1:D4'
5
# => [
6
#   [
7
#     "",
8
#     "国語",
9
#     "数学",
10
#     "英語"
11
#   ],
12
#   [
13
#     "A杉",
14
#     "90",
15
#     "43",
16
#     "87"
17
#   ],
18
#   [
19
#     "B山",
20
#     "82",
21
#     "95",
22
#     "43"
23
#   ],
24
#   [
25
#     "C田",
26
#     "100",
27
#     "100",
28
#     "100"
29
#   ]
30
# ]
Copied!
UpdateCells
概要
UpdateCellsは、セルの値を更新するアクションです。セルの値はすぐに更新されます。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range*
文字列
更新するセルの範囲(A1記法)
!A1:D4
values*
配列
書き込む値
[['A1','B1'],['A2', 'B2']]
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
更新されたスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
1
+update_cells_1:
2
  action>: UpdateCells
3
  spreadsheet: +get_spreadsheet_1
4
  range: 'シート1!A6:D6'
5
  values: [["平均","=SUM(B2:B5)","=SUM(C2:C5)","=SUM(D2:D5)"]]
6
# => {
7
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
8
#   "properties": {
9
#     "title": "test",
10
#     "locale": "ja_JP",
11
#     "autoRecalc": "ON_CHANGE",
12
#     "timeZone": "Etc/GMT",
13
#     "defaultFormat": {
14
#       "backgroundColor": {
15
#         "red": 1,
16
#         "green": 1,
17
#         "blue": 1
18
#       },
19
#       "padding": {
20
#         "top": 2,
21
#         "right": 3,
22
#         "bottom": 2,
23
#         "left": 3
24
#       },
25
#       "verticalAlignment": "BOTTOM",
26
#       "wrapStrategy": "OVERFLOW_CELL",
27
#       "textFormat": {
28
#         "foregroundColor": {},
29
#         "fontFamily": "arial,sans,sans-serif",
30
#         "fontSize": 10,
31
#         "bold": false,
32
#         "italic": false,
33
#         "strikethrough": false,
34
#         "underline": false
35
#       }
36
#     }
37
#   },
38
#   "sheets": [
39
#     {
40
#       "properties": {
41
#         "sheetId": 0,
42
#         "title": "シート1",
43
#         "index": 0,
44
#         "sheetType": "GRID",
45
#         "gridProperties": {
46
#           "rowCount": 1000,
47
#           "columnCount": 26
48
#         }
49
#       }
50
#     }
51
#   ],
52
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
53
#   "provider": "gsheet_********************"
54
# }
Copied!
AppendValues
概要
AppendValuesは、指定した範囲が含む表の直後に値を追加するアクションです。シート名を指定した場合、シートの最後の空行に値を追加します。
詳しい仕様に関しましては、AppendValuesの挙動についてをご参照ください。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet*
スプレッドシート、文字列、オブジェクト
対象のスプレッドシート
+get_spreadsheet_1
range*
文字列
指定する表の範囲(A1記法)
シート1,シート1!A1:B4
values*
配列（2次元配列）
追加する値
[['A1','B1'],['A2', 'B2']]
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
更新されたスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
1
+append_values_1:
2
  action>: AppendValues
3
  spreadsheet: +get_spreadsheet_1
4
  range: '!A2:D5'
5
  values: [["E森","23","34","45"]]
6
# => {
7
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
8
#   "properties": {
9
#     "title": "test",
10
#     "locale": "ja_JP",
11
#     "autoRecalc": "ON_CHANGE",
12
#     "timeZone": "Etc/GMT",
13
#     "defaultFormat": {
14
#       "backgroundColor": {
15
#         "red": 1,
16
#         "green": 1,
17
#         "blue": 1
18
#       },
19
#       "padding": {
20
#         "top": 2,
21
#         "right": 3,
22
#         "bottom": 2,
23
#         "left": 3
24
#       },
25
#       "verticalAlignment": "BOTTOM",
26
#       "wrapStrategy": "OVERFLOW_CELL",
27
#       "textFormat": {
28
#         "foregroundColor": {},
29
#         "fontFamily": "arial,sans,sans-serif",
30
#         "fontSize": 10,
31
#         "bold": false,
32
#         "italic": false,
33
#         "strikethrough": false,
34
#         "underline": false
35
#       }
36
#     }
37
#   },
38
#   "sheets": [
39
#     {
40
#       "properties": {
41
#         "sheetId": 0,
42
#         "title": "シート1",
43
#         "index": 0,
44
#         "sheetType": "GRID",
45
#         "gridProperties": {
46
#           "rowCount": 1000,
47
#           "columnCount": 26
48
#         }
49
#       }
50
#     }
51
#   ],
52
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro/edit",
53
#   "provider": "gsheet_********************"
54
# }
Copied!
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
スプレッドシート
更新されたスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
1
# セルの値を削除
2
+clear_values_1:
3
  action>: ClearValues
4
  spreadsheet: +get_spreadsheet_1
5
  range: 'シート1!A1:B2'
6
# => {
7
#   "spreadsheetId": "spreadsheet_id",
8
#   "properties": {
9
#     "title": "spreadsheetテスト",
10
#     "locale": "ja_JP",
11
#     "autoRecalc": "ON_CHANGE",
12
#     "timeZone": "Asia/Tokyo",
13
#     "defaultFormat": {
14
#       "backgroundColor": {
15
#         "red": 1,
16
#         "green": 1,
17
#         "blue": 1
18
#       },
19
#       "padding": {
20
#         "top": 2,
21
#         "right": 3,
22
#         "bottom": 2,
23
#         "left": 3
24
#       },
25
#       "verticalAlignment": "BOTTOM",
26
#       "wrapStrategy": "OVERFLOW_CELL",
27
#       "textFormat": {
28
#         "foregroundColor": {},
29
#         "fontFamily": "arial,sans,sans-serif",
30
#         "fontSize": 10,
31
#         "bold": false,
32
#         "italic": false,
33
#         "strikethrough": false,
34
#         "underline": false,
35
#         "foregroundColorStyle": {
36
#           "rgbColor": {}
37
#         }
38
#       }
39
#     }
40
#   },
41
#   "sheets": [
42
#     {
43
#       "properties": {
44
#         "sheetId": 0,
45
#         "title": "シート1",
46
#         "index": 0,
47
#         "sheetType": "GRID",
48
#         "gridProperties": {
49
#           "rowCount": 1000,
50
#           "columnCount": 26
51
#         }
52
#       }
53
#     }
54
#   ],
55
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/spreadsheet_id/edit",
56
#   "provider": "gsheet_*******************"
57
# }
Copied!
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
スプレッドシート
取得したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
1
+get_spreadsheet_1:
2
  action>: DuplicateSheet
3
  source: +get_spreadsheet_1
4
  sheet: シート1
5
  destination: +get_spreadsheet_2
6
  as: 新しいシート
7
# => {
8
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
9
#   "properties": {
10
#     "title": "test",
11
#     "locale": "ja_JP",
12
#     "autoRecalc": "ON_CHANGE",
13
#     "timeZone": "Etc/GMT",
14
#     "defaultFormat": {
15
#       "backgroundColor": {
16
#         "red": 1,
17
#         "green": 1,
18
#         "blue": 1
19
#       },
20
#       "padding": {
21
#         "top": 2,
22
#         "right": 3,
23
#         "bottom": 2,
24
#         "left": 3
25
#       },
26
#       "verticalAlignment": "BOTTOM",
27
#       "wrapStrategy": "OVERFLOW_CELL",
28
#       "textFormat": {
29
#         "foregroundColor": {},
30
#         "fontFamily": "arial,sans,sans-serif",
31
#         "fontSize": 10,
32
#         "bold": false,
33
#         "italic": false,
34
#         "strikethrough": false,
35
#         "underline": false
36
#       }
37
#     }
38
#   },
39
#   "sheets": [
40
#     {
41
#       "properties": {
42
#         "sheetId": 0,
43
#         "title": "シート1",
44
#         "index": 0,
45
#         "sheetType": "GRID",
46
#         "gridProperties": {
47
#           "rowCount": 1000,
48
#           "columnCount": 26
49
#         }
50
#       }
51
#     },
52
#     {
53
#       "properties": {
54
#         "sheetId": 12349,
55
#         "title": "新しいシート",
56
#         "index": 1,
57
#         "sheetType": "GRID",
58
#         "gridProperties": {
59
#           "rowCount": 1000,
60
#           "columnCount": 26
61
#         }
62
#       }
63
#     }
64
#   ],
65
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/xxxx/edit",
66
#   "provider": "gsheet_********************"
67
# }
Copied!
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
使用例
1
+get_spreadsheet_1:
2
  action>: DownloadSheets
3
  spreadsheet: +get_spreadsheet_1
4
  sheetname: シート1
5
  type: pdf
6
  # => "/tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/download/spreadsheetname-シート1.pdf"
Copied!
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'
使用例
1
+get_blank_rows_1:
2
  action>: GetBlankRows
3
  spreadsheet: +get_spreadsheet_1
4
  range: Sheet1!A1:D10
5
  findAll: true
6
  # => ['Sheet1!A1:D1', 'Sheet1!A4:D4', 'Sheet1!A5:D5']
7
​
8
+get_blank_rows_1:
9
  action>: GetBlankRows
10
  spreadsheet: +get_spreadsheet_1
11
  range: Sheet1!A1:D10
12
  findAll: false
13
  # => 'Sheet1!A1:D1'
Copied!
AppendSheet
概要
AppendSheetは、スプレッドシートに１つ新たにシートを追加するアクションです。追加して作成されたスプレッドシートオブジェクトを出力します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
spreadsheet
Spreadsheet*
GetSpreadsheetで取得した Spreadsheetオブジェクト。コピー元のスプレッドシートです。
+get_spreadsheet_1
name
文字列
新しいシート名。指定なしの場合、Google Sheetsのデフォルトのシート名になります。
10月（デフォルトでは、 「シート３」のような名前になります。）
アウトプット
タイプ
型
概要
例
Spreadsheet
スプレッドシート
取得したスプレッドシートオブジェクト
※使用例のアウトプット参照
使用例
1
+append_sheet_1:
2
  action>: AppendSheet
3
  spreadsheet: +get_spreadsheet_1
4
  name: 新しいシート
5
​
6
# => {
7
#   "spreadsheetId": "1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro",
8
#   "properties": {
9
#     "title": "test",
10
#     "locale": "ja_JP",
11
#     "autoRecalc": "ON_CHANGE",
12
#     "timeZone": "Etc/GMT",
13
#     "defaultFormat": {
14
#       "backgroundColor": {
15
#         "red": 1,
16
#         "green": 1,
17
#         "blue": 1
18
#       },
19
#       "padding": {
20
#         "top": 2,
21
#         "right": 3,
22
#         "bottom": 2,
23
#         "left": 3
24
#       },
25
#       "verticalAlignment": "BOTTOM",
26
#       "wrapStrategy": "OVERFLOW_CELL",
27
#       "textFormat": {
28
#         "foregroundColor": {},
29
#         "fontFamily": "arial,sans,sans-serif",
30
#         "fontSize": 10,
31
#         "bold": false,
32
#         "italic": false,
33
#         "strikethrough": false,
34
#         "underline": false
35
#       }
36
#     }
37
#   },
38
#   "sheets": [
39
#     {
40
#       "properties": {
41
#         "sheetId": 0,
42
#         "title": "シート1",
43
#         "index": 0,
44
#         "sheetType": "GRID",
45
#         "gridProperties": {
46
#           "rowCount": 1000,
47
#           "columnCount": 26
48
#         }
49
#       }
50
#     },
51
#     {
52
#       "properties": {
53
#         "sheetId": 12349,
54
#         "title": "新しいシート",
55
#         "index": 1,
56
#         "sheetType": "GRID",
57
#         "gridProperties": {
58
#           "rowCount": 1000,
59
#           "columnCount": 26
60
#         }
61
#       }
62
#     }
63
#   ],
64
#   "spreadsheetUrl": "https://docs.google.com/a/tutorial.co.jp/spreadsheets/d/xxxx/edit",
65
#   "provider": "gsheet_********************"
66
# }
Copied!
Actions - Previous
Marketing
Next - Actions
Google Calendar
Last modified 7mo ago