earthpg:GAS専門のプログラミングスクール

すぐに始められる!GASでAPIを呼び出しする基本と注意点

GASでAPI呼び出しをやってみたいんだけど、どこから始めたらいいのかな?…
猫男
猫男
catman
catman
catmanの出番だな。GASでのAPI呼び出しについて教えよう!まずは基本からだ。

GASでAPIを呼び出し始める基本

GASを使ってAPIを呼び出すためには、UrlFetchAppという便利なクラスを使う。

これはGoogle Apps Scriptの中で、外部サービスと通信するためのものだ。

基本的なAPI呼び出しの流れ

こんな感じでスクリプトを書けば、外部APIにアクセスできるぞ。

function fetchAPI() {
   const url = 'https://api.example.com/data';
   const response = UrlFetchApp.fetch(url);
   Logger.log(response.getContentText());
}

これは単純にURLを指定し、その結果を取得してログに出力するだけのコードだが、これがAPI呼び出しの基本だ。

GASのAPI呼び出しの回数と制限

なるほど。でも、GASでAPI呼び出しの回数制限ってどうなってるんだろう?気になるなぁ…
猫男
猫男
catman
catman
GASにはAPI呼び出しの回数に制限がある。これは日次や1時間ごとの制限が設定されているから気をつけるんだ。例えば、無料ユーザーであれば1日2000回までのようなことがあったりする。

API呼び出しの回数制限を避けるためには、呼び出し頻度を調整したり、利用したいAPIに対して適切なプランを選ぶことが重要だ。

GASで外部APIを呼び出すセットアップ

catman
catman
次に、外部API呼び出しのために準備が必要なことだ!

リクエストの設定

外部APIを呼び出す際には、リクエストの設定が重要だ。以下のスクリプトのようにGETメソッド、ヘッダーを指定する。

function advancedFetchAPI() {
   const url = 'https://api.example.com/data';
   const options = {
     method: 'GET',
     headers: {
       'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
     }
   };
   const response = UrlFetchApp.fetch(url, options);
   Logger.log(response.getContentText());
}

APIを利用するサービスによっては、認証情報が必要だ。これはヘッダーとしてトークンを渡す例だ。

練習問題

  • GASでAPIを呼び出す際に使用するクラスは何でしょうか?
  • 外部APIを呼び出すためには何が必要ですか?スクリプトで示してください。
  • API呼び出しの際にはどのような制限があるでしょうか?

解答・解説

問題1の解答

GASでAPIを呼び出す際に使用するクラスはUrlFetchAppです。これは外部APIとの通信を行う際に使用します。

問題2の解答

外部APIを呼び出すためにはリクエストの詳細な設定が必要です。以下のコードはその例です。

const url = 'https://api.example.com/data';
const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
};
const response = UrlFetchApp.fetch(url, options);

methodはHTTPメソッドを指定し、headersで必要なヘッダー情報を追加することができます。

問題3の解答

API呼び出しの際には、Googleの設定した呼び出し回数の制限(例:無料プランでの1日の最大呼び出し回数)があります。

回数を超えた場合はAPIを呼び出せなくなるので計画的に利用する必要があります。