GASで外部APIを使用する UrlFetchAppクラス - ゼロからはじめるアパレルDX

こんにちは。テックブログの萱場です。

今回はGASでAPIを叩くためのオブジェクトであるUrlFetchAppクラスを使って、GASからどの様にAPIを叩くかを簡単に説明したいと思います。

細かい仕様などは、公式ドキュメントがあるので、こちらにリンクを貼っておきます。

https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app?hl=ja

簡単な書式は以下になります。

UrlFetchApp.fetch(url,  パラメーター)

↓ 以下の様にすることで、リクエストしたレスポンスを文字列として取得できます。

let response = UrlFetchApp.fetch(url,  パラメーター).getContentText();

パラメーターは色々あるのですが、よく使うのが、methodとpayloadです。

methodは、HTTPリクエストのメソッド(“GET”や”POST”)を指定し、payloadは、リクエストの本文(内容)を記述します。

パラメータはオブジェクトとして定義します。

// URLの定義
let url = "https//example.com"

// payloadの定義
let payload = {
        'キー1': 値1,
        'キー2': 値2,
        'キー3': 値3,
                :
                :
                :
        };

// パラメーターの定義
let options = {
        'method' : 'post',
        'payload' : payload
        };

// HTTPリクエストを行う
let response = UrlFetchApp.fetch(url,  パラメーター).getContentText();

URLに関しては、テンプレートリテラルを使用すれば、HTTPリクエストを送るURLのパラメータを分離して変数に応じたURLを定義できます。

このfetch関数を使用すれば、シートでデータを編集して、それらの情報をGASを上で取得・加工した後に、API経由でシステムにPOSTするということも可能です。

最後に

最後までお読みいただきありがとうございました。

ぜひ、GASを活用してみて下さい。

株式会社デザインXでは、アパレル業界のお客様に向けて、ECサイトや業務基幹システム(ERP)の開発・導入支援を行っております。ご興味をお持ちの方は、是非下記リンクよりお気軽にお問い合わせください。

また、株式会社デザインXでは、ソフトウェアエンジニア・社内SEなど、共に働く仲間を募集しています。テクノロジーでアパレル業界のBtoBビジネスを変えたいという熱意をお持ちの方、お待ちしております。ご興味のある方は、以下のリンクからお問い合わせください！