AUTOROとGASを連携する

この記事では、Google Apps Script(GAS)とAUTOROを組み合わせて、業務自動化を行う際の基本的な考え方と注意点を説明します。

【この記事で扱うこと】

  • GASからAUTOROのワークフローを起動する方法
  • AUTOROからGASを呼び出す際の推奨の設定方法と注意点
GASでの実装について

GASからの具体的なコードの書き方(UrlFetchAppを使ったHTTPリクエストの送り方、スクリプトプロパティへのキーの保存方法、など)は、本記事内では触れておりません。
詳しくは、Google社の公式ドキュメントやGASの解説記事をあわせてご参照ください。

 GAS から AUTORO を起動する

GASのスクリプトから、AUTOROのREST APIを呼び出すことで、スプレッドシートの操作やフォームの送信などの任意のタイミングで、AUTOROのワークフローを実行できます。

AUTORO REST APIを利用するには、プロジェクトのAPIキー(access_key_idとsecret_access_key)が必要です。
APIキーは、プロジェクトオーナー権限を持つユーザーが、プロジェクト管理画面から発行できます。

 API キーの発行方法はこちらのヘルプセンター記事をご参照ください。

AUTORO APIの認証には、JWT(JSON Web Token)を使用します。
GASからトークンを取得する最も簡単な方法は、/v1/tokenエンドポイントに、 access_key_idとsecret_access_keyを送信する方法です。

エンドポイント

POST https://api.roboticcrowd.com/v1/token


パラメーター

パラメーター必須説明
access_key_idAPIキーのアクセスキーID
secret_access_keyAPIキーのシークレットアクセスキー
expires任意トークンの有効期間(秒)。
初期値は 600(10 分)。

secret_access_key はスクリプトプロパティ(PropertiesService)などに安全に保存し、コードの中に直接記載しないようにしてください。

トークンを取得したら、/v1/session_queuesエンドポイントを呼び出してワークフローを実行します。


エンドポイント

POST https://api.roboticcrowd.com/v1/session_queues


リクエストヘッダー

Authorization: Bearer [取得したJWTトークン]
Content-Type: application/json


リクエストボディ

{
  "workflow_id": 12345,
  "params": {
    "変数名1": "値1",
    "変数名2": "値2"
  }
}


パラメーター

パラメーター必須説明
workflow_id実行するワークフローのID(AUTOROのワークフロー詳細画面のURLから確認)
params任意ワークフロー内の変数に渡す初期値

実行キューが正常に作成されると、ステータスが queued、または、runningのレスポンスが返ります。

AUTORO REST API の詳細なリファレンスは、developer.autoro.ioをご参照ください。

 AUTORO から GAS を呼び出す

AUTOROのワークフロー内でスプレッドシートへの書き込みなどを行った後、GASのスクリプトを起動したいケースがあります。

AUTORO から確実に GAS スクリプトを実行するには、GAS スクリプトを Web アプリとしてデプロイし、AUTORO のワークフロー内からその URL にアクセスする方法が最も確実です。


GAS 側の設定手順

  1. GASのスクリプトエディタで doGet() または doPost() 関数を実装する
  2. 「デプロイ」→「新しいデプロイ」をクリック
  3. 種類として「ウェブアプリ」を選択
  4. 「次のユーザーとして実行」と「アクセスできるユーザー」を適切に設定する
  5. デプロイして発行された Web アプリの URL をコピーする


AUTORO 側の設定

AUTORO のワークフロー内で、OpenBrowserアクション(ブラウザを開く)などを使用して上記の Web アプリ URL に HTTP リクエストを送ることで GAS スクリプトを起動できます。
GAS側の設定によっては、URLにvalue等のパラメータを含めてGASへ渡すことも可能です。

GAS の インストーラブルトリガー(手動で設定するトリガー)を使用してください。


設定手順

  1.  GAS のスクリプトエディタを開く。
  2.  左メニューの「トリガー」をクリック。
  3.  右下の「トリガーを追加」をクリック。
  4.  イベントの種類で 「変更時」 を選択。
  5.  保存する。

この設定により、スプレッドシートに変更があったときに GAS スクリプトが実行されます。

※注意※「編集時」トリガーは API からの書き込みでは起動しません
「編集時」トリガーは、人間がスプレッドシートを直接編集したときに起動します。

GAS には onEdit() というシンプルトリガーがありますが、AUTORO との連携では 使用しないことを推奨します

シンプルトリガーは、実行できる操作に制限があり、外部サービスへのアクセスやユーザー認証が必要な処理ではエラーが発生しやすくなっています。
AUTORO が API 経由でスプレッドシートを操作した場合も同様にエラーとなる場合があります。

このページは役に立ちましたか?

CONTENTS