【GAS】外部WebAPIから情報を取得する方法【URLFetchApp】

2022-02-062024-08-13

当ページのリンクには広告が含まれています。

WebAPIを使用して、外部から情報を取得したり、データを送信したい・・・。

そんな時はGASのURLFetchAppを使用すると簡単に行えます。

今回はGASから外部APIへアクセスする方法をご紹介いたします。

この記事におすすめの人

GASを使って、APIから情報を取得したい人

基本形 – URLFetchApp

公式ドキュメント

URL Fetch Service | Apps Script | Google Developers

https://developers.google.com/apps-script/reference/url-fetch

GASののプロジェクトを作成しURLFetchApp.fetchにてGETメソッドを送ってみます。

今回リクエストを送るのは、jsonplaceholderというサイトを活用します。このサイトは、レスポンスにJSONを返してくれる便利なサイトです。

https://jsonplaceholder.typicode.com/

用意されているリソース一覧は下記になります。

今回はpostsにある投稿を取得します。内容としてはこんな感じに取得できるはずです。

GASに記述します。

const myFunction = () => {
  const url = 'https://jsonplaceholder.typicode.com/'

  let response = UrlFetchApp.fetch(`${url}posts`)
  Logger.log(response)
}

Logger.log()で取得したログを確認してみると・・・

userId
id
title
body

などが取得できていることが確認できますね！

オプションの追加

情報を取得する際に、認証情報などのAPI_KEYをヘッダーに含める場合にも簡単です。

const myFunction = () => {
  const url = 'https://jsonplaceholder.typicode.com/'

  let options = {
     "method" : "GET",
     "headers" : {
       'Api-Key': xxxxxxxx
     },
     'followRedirects': false,
     'muteHttpExceptions': false
  }

  let response = UrlFetchApp.fetch(`${url}posts`, options)
  Logger.log(response)
}

optionsでの指定の通り、methodやheadersを追記して、fetch関数の第二引数に指定します。

POSTメソッド

POSTメソッドの場合も先ほどご紹介したoptionsのようにメソッドを指定してデータを送信します。

const myFunction = () => {
  const url = 'https://jsonplaceholder.typicode.com/'

  let post = {
    "userId": 1,
    "title": 'sample_title',
    "body": 'sample_body'
  }

  let options = {
     "method" : "POST",
     "content-type" : "Application/json",
     'payload' : JSON.stringify(post)
  }

  let response = UrlFetchApp.fetch(`${url}posts`, options)
  Logger.log(JSON.parse(response))
}

レスポンスを確認してみましょう。