*

APIs Explorer使ってみた

公開日: : 最終更新日:2015/05/29 投稿者: GCP

GoogleのAPI達

皆さん、APIs Explorer使ってますか?

GoogleはGmail, Google Drive, Google Calendarなど便利なサービスをたくさん提供しています。これらのサービスには、APIが用意されており、開発者がprogrammaticに利用し、Googleのサービスと連携したシステムを開発することができるようになっています。

ところで、実際に、GoogleのAPIを使用したシステムを開発する前に、どういうリクエストを送ると、どういう情報が取得できるのか確認したいという状況は、しばしばあると思います。GoogleはAPIs Explorerというサービスを提供しており、これを使うとウェブブラウザ上で、各種APIを簡単に試すことができます。今回は、このAPIs Explorerの使い方をご紹介します。

APIを探す

以下のURLがAPIs Explorerの入り口です。

https://developers.google.com/apisexplorer/

アクセスすると、下の画像のようにAPIの一覧が表示されます。(こんなにも、たくさんのAPIが公開されているのは、驚きですね!)

apis_list

この中から、試したいAPIを選択します。検索窓にキーワードを入力して、APIを検索することもできます。例えば、”calendar”と入力すると、以下のようになります。

apis_search

APIを試す

ここでは、Calendar APIの中の、イベントを挿入するメソッドcalendar.events.insertというメソッドを例に、APIs Explorerの使い方を説明します。上述の検索後の状態から”calendar.events.insert”を選択すると、以下のような画面に遷移します。

calencar.events.insert_1

 

APIを利用するためには、アプリケーションがデータにアクセスすることを承認しなければいけません。右上の「OFF」と表示されているボタンをクリックしてください。すると、以下のようなダイアログが表示されます。

calendar.events.insert_2

このダイアログでは、OAuth2.0を用いてユーザ認証を行い、アプリケーションがアクセスできるデータの範囲(スコープ)を選択、承認します。選択したメソッドを使用するのに必要なスコープは、デフォルトでチェックされているので、そのまま「Authorize」ボタンをクリックしてください。ダイアログが閉じたら、右上のボタンの表示が「ON」になっていることを確認してください。

次は、APIに送信するリクエストパラメータなどをフォームで設定します。リクエストパラメータの詳細は、それぞれのAPIのドキュメントを参照してください。calendar.events.insertのドキュメントはこちらです。項目名が赤字になっているcalendarIdは必須項目です。ここには、自分のGoogle Account(Eメールアドレス)を入力してください。

calencar.events.insert_3

また、calendar.events.insertはRequest bodyのstartとendも必須です。Request bodyの入力欄をクリックすると、プロパティ名を選択するプルダウンメニューが表示されます。

calendar.events.insert_4

end内のプルダウンメニューをクリックすると、date, dateTime, timeZoneの3つが表示されます。endはイベントの終了時間で、日付レベルで指定してたい場合はdateを、時間まで指定したい場合はdateTimeを選びます。また、オプションとして、timeZoneの指定ができます。dateを選択すると入力欄が表示されます。また、?マークにマウスオーバーするとヘルプが表示され、”yyyy-mm-dd”のフォーマットで入力しなければいけないことがわかります。

calendar.events.insert_5

endのdateを入力したら、同様にして、startのdateも入力しましょう。endよりも後の日付にならないように注意してください。イベントのタイトルと詳細くらいは入れておきたいので、一番下の「add a property」でsummaryを選択し、タイトルを入力、続いて同様にdescriptionを選択して、詳細を入力しましょう。以下は、calendarIdとRequest bodyをひと通り入力し終わった状態の画面です。

calendar.events.insert_6

入力が終わったら、「Execute」ボタンをクリックしてください。処理が実行され、画面の下の部分にリクエストとレスポンスの内容が表示されます。(なお、認証後から1時間以上経っていると、トークンが期限切れになり、認証エラーになります。その場合は、もう一度、右上のボタンから認証しなおしてください。)

calendar.events.insert_7

レスポンスには、登録されたイベントのIDや、登録した各プロパティの内容、登録日時、更新日時などが含まれていることがわかります。レスポンスの詳細についてはこちらのドキュメントを参照してください、。

実際にGoogle Calendarを見ると、イベントが登録されていることが確認できます。タイトルも指定したとおりになっていますね。

calendar.events.insert_8

また、イベントの詳細を開くと、説明の項目にdescriptionに入力した内容が反映されていることが確認できます。

calendar.events.insert_9

さて、ここまでは、正常に実行されるリクエストの例でしたが、不正なリクエストを送った場合に、どのようなエラーコードやエラーメッセージが返ってくるのかを、あらかじめ確認しておくために、APIs Explorerを使って試すというのもよいでしょう。例えば、startをendよりも後の日付にして、実行してみましょう。

calendar.events.insert_error_1

結果は以下のようになりました。エラーコードは400で、エラーメッセージは”The specified time range is empty.”でした。

calendar.events.insert_error_2.

まとめ

いかがでしたでしょうか。APIs Explorerを使うと、手軽にAPIを試し、結果を確認できることがおわかりいただけたかと思います。気になるAPIがあったら、まずはAPIs Explorerで試してみてはどうでしょうか。

また、GoogleのAPIを叩くなら、同じネットワーク内にある、Google Cloud Platform(GCP)を利用するのがお薦めです。GCPのことならクラウドエースにお任せ!

 

 

この記事を書いた人

hida
雑食エンジニア/にわかSF者

関連記事

2015/10/16 GCE vs AWS ベンチマーク

2015/10/16 GCE vs AWS ベンチマーク 本シリーズでは定期的に

記事を読む

S3からGCSへ簡単にファイル移行する方法

はじめに クラウドという言葉が当たり前になってきている現在、ファイルサーバは自前で持つ時代から、サ

記事を読む

2015/08/04 GCE vs AWS ベンチマーク

2015/08/04 GCE vs AWS ベンチマーク 本シリーズでは定期的に

記事を読む

2016/07/05 GCE vs AWS vs Azure ベンチマーク

2016/07/05 GCE vs EC2 vs Azureベンチマーク 本シリ

記事を読む

GCP×Zencoderで始める動画トランスコーディング

はじめに 以前apps-gcpでは、GCP(GoogleCloudPlatform)と連携可能なA

記事を読む

2016/07/26 GCE vs AWS vs Azure ベンチマーク

2016/07/26 GCE vs EC2 vs Azureベンチマーク 本シリ

記事を読む

Google ロードバランサーのチートレベル性能検証:リージョンまたぎ編(デモあり)

6月に発表され、現在Limited PreviewされているGCPのL7ロードバランサの機能を紹介し

記事を読む

GCEはどこまでディスクを拡張できるのか?手順は?

GCEではディスク容量を自由に設定することができますが、どこまで容量が増やすことができるのか

記事を読む

初心者のためのGCPプロジェクト始め方入門

GAE、GCE、BigQuery等のサービスを開始する場合、ユーザには共通でおこなわないといけない手

記事を読む

2015/03/19 GCE vs AWSベンチマーク

2015/03/19 GCE vs AWS ベンチマーク 本シリーズでは定期的にGCEとEC2のベ

記事を読む

PAGE TOP ↑