GASでfunction呼び出し！gasの関数呼び出しの引数設定方法

GASでのfunctionの呼び出し方と引数設定方法

本記事では、GASでの関数の作成方法、作成した関数の呼び出しと引数設定方法をソースコード付きで解説します。

作成した関数は、GoogleSpreadSheet上のセルの上でも利用できるため、活用方法は非常に広いです！

例）testという関数を定義し、スプレッドシート上で利用したイメージ

GASでの関数作成方法

新しい関数を作成するには、functionキーワードを文頭に書き、その次に関数名、その次の（）内に引数を記載して使用します。以下は関数の定義の例です。

function greet(name) {
  console.log("Hello, " + name + "!");
}

上記のコードでは、greetという名前の関数を定義しています。この関数はnameという引数を受け取り、その値を使ってメッセージをログに出力します。

定義した関数を呼び出すには、関数名にカッコを付けて引数を渡します。例えば、以下のように呼び出すことができます。

function main(){
　greet("Alice");
}

上記の呼び出しでは、name引数に"Alice"という値が渡されます。

GASでの関数の戻り値の設定方法

関数の最後に、return を記載することで、戻り値を設定することができます。

先ほどのgreet関数で最後にOK!と返す設定をした場合は下記のようになります。

function greet(name) {
  console.log("Hello, " + name + "!");
　return "OK!"
}

function main(){
　var result = greet("Alice");
  //OK!と表示される
  console.log(result);
}

GASを呼び出す際の引数の設定方法

引数とは、関数に渡す値のことです。引数の設定方法には以下の3つがあります。

引数が複数ある関数の場合

関数を呼び出す際は、関数作成の際に設定されたのと同じ引数の数を設定する必要があります。

複数の引数が設定されているPlus()関数を作成した場合の例を見てください。

//関数の新規作成
function Plus(num1,num2)
{
  return num1 + num2
}

//作成した関数を呼び出し
function main()
{
 var number1 = 1
 var number2 = 2
 var result = Plus(1,2)
}

変数を使って引数を指定する方法

変数に値を代入し、関数呼び出し時に変数を引数として渡すこともできます。

例えば、以下のようなコードで変数を使用してprocessData()関数にデータを渡すことができます。

var data = {name: "John", age: 30};
processData(data);

配列やオブジェクトを引数として渡す方法

配列やオブジェクトを引数として渡すことも可能です。例えば、以下のようなコードでsumArray()関数に配列を渡して合計値を計算することができます。

var numbers = [1, 2, 3, 4, 5];
var total = sumArray(numbers);

注意点とベストプラクティス

• 関数が期待する引数の型やデータ形式に合わせて値を設定することが重要です。正しい型や形式の引数を渡すことで正しい結果を得ることができます。
• 関数が返す値を設定する場合はを適切に受け取り、必要な処理を行いましょう。返り値を無視したり、処理を適切に行わないと意図した結果を得ることができません。

まとめ

本記事では、GASでの関数呼び出しと引数設定方法について解説しました。