【GAS】onEditの使い方、onedit(e) とは？【コピペで使えるサンプルコード】

GAS基本メソッド

05.30

この記事は約4分で読めます。

onEdit(e)の使い方は、関数名(function)に「onEdit(e)」とすると使えるようになります。
eventから情報を引っ張ってくることが可能です。

function onEdit(e){
//処理
}

onEditの(e)とは、ユーザーがスプレッドシートの変更・編集を行なった時に実行される、編集時のイベントを拾うためのスクリプトです。

onEdit(e)が実行される条件
onEdit(e)が実行されないもの
onEdit(e)のe(event-イベント)で拾えるもの
onEditの使い方、コピペで使えるサンプルコード
onEditが動かない、トラブルやエラーが起きた

onEdit(e)が実行される条件

全シート全セルが対象で実行されるため、
実行された時に特定のセルに対する処理を書くことで、
特定セルが編集された時に実行させるということができるようになります。

function onEdit(e){
編集時の情報取得;
if文やswitch文で特定のセルを指定して実行;
}

値の入力やコピペ、削除など、
基本的にユーザーが手動で行なった全てのことに対して実行されます。

onEdit(e)が実行されないもの

関数やGASなどによって自動実行されたものや、
importrangeのような参照をしている場合は、
参照値が変わっても、編集とは見なされず実行されません。

参照値の変更で実行させるには少し手間が必要になります。
onEditを参照でも実行させる方法はこちらで解説しています。
トリガーやonEditで実行されない処理を実行させる

onEdit(e)のe(event-イベント)で拾えるもの

onEdit(e)のイベントで拾えるもので、よく使用するオブジェクトです。

onEditのeventで取得できるオブジェクト	内容
e.source.getName()	アクティブスプレッドシートを取得
e.source.getActiveSheet()	アクティブシートを取得
e.source.getSheetName()	アクティブシート名を取得
e.source.getSheetByName('シート名')	シート名を指定して取得
e.value	編集されたセルの値を取得
e.range.getValue()	編集されたセルの値を取得
e.oldValue	編集される前のセルの値を取得
e.range.getRow()	編集されたセルの行数を取得
e.range.getColumn()	編集されたセルの列数を取得

//evant(e)からアクティブスプレッドシートを取得
var ss = e.source.getName();

//evant(e)からアクティブシートを取得
var sheet = e.source.getActiveSheet();

//evant(e)からアクティブシート名を取得
var sheetN = e.source.getSheetName();

//evant(e)からシート名を指定して取得
var sheet1 = e.source.getSheetByName('シート1');

//編集されたセルの値を取得
var value1 = e.value;
var value2 = e.range.getValue(); 

//編集される前のセルの値を取得
var oldvalue = e.oldValue;

//編集されたセルの行数を取得
var row = e.range.getRow();

//編集されたセルの列数を取得
var col = e.range.getColumn();