Google Spreadsheet
Google Spreadsheetを操作するアクション一覧です。
CreateSpreadsheetは、スプレッドシートを新たに作成するアクションです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
title* | 文字列 | スプレッドシートのタイトル | test |
provider* | 文字列 | 利用するコネクション（GoogleSpreadsheet）のプロバイダーID | gsheet_1234abcd |
タイプ | 型 | 概要 | 例 |
Spreadsheet | スプレッドシート | 作成したスプレッドシートオブジェクト | ※使用例のアウトプット参照 |
+create_spreadsheet_1:action>: CreateSpreadsheettitle: testprovider: 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は、GoogleSpreadsheetオブジェクトを取得するアクションです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
provider* | 文字列 | 利用するコネクション（GoogleSpreadsheet）のプロバイダーID | gsheet_1234abcd |
spreadsheet_id* | 文字列 | 使用するスプレッドシートID | 1zTG_XHbCnC5a5BD5k5WWxdbcYpnEDv4_FfdAPaE33ro |
タイプ | 型 | 概要 | 例 |
Spreadsheet | スプレッドシート | 取得したスプレッドシートオブジェクト | ※使用例のアウトプット参照 |
+get_spreadsheet_1:action>: GetSpreadsheetprovider: 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は、セルの値を取得するアクションです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
spreadsheet* | スプレッドシート、文字列、オブジェクト | 対象のスプレッドシート | +get_spreadsheet_1 |
range* | 文字列 | 取得する値のセルの範囲(A1記法) | !A1:D4 |
タイプ | 型 | 概要 | 例 |
Array | 配列 | 取得したセルの値を[行][列]の二次元配列で返します。 | [['A1','B1'],['A2', 'B2']] |
+get_cells_1:action>: GetCellsspreadsheet: +get_spreadsheet_1range: '!A1:D4'# => [# [# "",# "国語",# "数学",# "英語"# ],# [# "A杉",# "90",# "43",# "87"# ],# [# "B山",# "82",# "95",# "43"# ],# [# "C田",# "100",# "100",# "100"# ]# ]
UpdateCellsは、セルの値を更新するアクションです。セルの値はすぐに更新されます。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
spreadsheet* | スプレッドシート、文字列、オブジェクト | 対象のスプレッドシート | +get_spreadsheet_1 |
range* | 文字列 | 更新するセルの範囲(A1記法) | !A1:D4 |
values* | 配列 | 書き込む値 | [['A1','B1'],['A2', 'B2']] |
タイプ | 型 | 概要 | 例 |
Spreadsheet | スプレッドシート | 更新されたスプレッドシートオブジェクト | ※使用例のアウトプット参照 |
+update_cells_1:action>: UpdateCellsspreadsheet: +get_spreadsheet_1range: 'シート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の挙動についてをご参照ください。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
spreadsheet* | スプレッドシート、文字列、オブジェクト | 対象のスプレッドシート | +get_spreadsheet_1 |
range* | 文字列 | 指定する表の範囲(A1記法) |
|
values* | 配列（2次元配列） | 追加する値 |
|
タイプ | 型 | 概要 | 例 |
Spreadsheet | スプレッドシート | 更新されたスプレッドシートオブジェクト | ※使用例のアウトプット参照 |
+append_values_1:action>: AppendValuesspreadsheet: +get_spreadsheet_1range: '!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_********************"# }
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
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>: DuplicateSheetsource: +get_spreadsheet_1sheet: シート1destination: +get_spreadsheet_2as: 新しいシート# => {# "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は、スプレッドシートをダウンロードするアクションです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
spreadsheet* | スプレッドシート、文字列、オブジェクト | 対象のスプレッドシート | +get_spreadsheet_1 |
sheetname | 文字列 | ダウンロードするシート名。シート名を指定しない場合、XLSX、PDF、ODS形式は全てのシートをダウンロードします。CSV、TSV形式はスプレッドシートの一番左のシートをダウンロードします。 | シート1 |
type | セレクト | ダウンロード形式 | XLSX、PDF、CSV、TSV、ODS |
タイプ | 型 | 概要 | 例 |
File | 文字列 | ファイル名は | /tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/download/spreadsheetname-シート1.pdf |
+get_spreadsheet_1:action>: DownloadSheetsspreadsheet: +get_spreadsheet_1sheetname: シート1type: pdf# => "/tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/download/spreadsheetname-シート1.pdf"
GetBlankRowsは、指定した範囲内にある空行を取得するアクションです。
*は、必須パラメーター
名前 | 型 | 概要 | 例 |
spreadsheet* | スプレッドシート、文字列、オブジェクト | 対象のスプレッドシート | +get_spreadsheet_1 |
range* | 文字列 | 指定する表の範囲(A1記法)。 |
|
findAll | 真理値 | trueの場合、範囲内の空行を全て取得します。falseの場合、範囲内にある最初の空行を取得します。 | デフォルトは |
タイプ | 型 | 概要 | 例 |
Anything | 配列または文字列 | 空行を1行ごとにA1記法で出力します。rangeパラメーターにシート名のみを指定した場合、シートに存在する表の範囲内にある空行を返します。findAllパラメーターがtrueの場合は配列で、falseの場合は文字列で返却されます。 | trueの場合： |
+get_blank_rows_1:action>: GetBlankRowsspreadsheet: +get_spreadsheet_1range: Sheet1!A1:D10findAll: true# => ['Sheet1!A1:D1', 'Sheet1!A4:D4', 'Sheet1!A5:D5']+get_blank_rows_1:action>: GetBlankRowsspreadsheet: +get_spreadsheet_1range: Sheet1!A1:D10findAll: false# => 'Sheet1!A1:D1'
