API
HTTP PUT
概要
このブロックは、指定されたURL(HTTPサーバー)へ、HTTPのPUTメソッドを使って要求(リクエスト)を送り、応答(レスポンス)としてリソース(データ)を取得します。
- リクエストには、任意のクエリーパラメーターやリクエストヘッダーを含められます。
- レスポンスは、変数に格納されます。
- 本ブロックを使うことで、HTTP PUTメソッドのWeb APIと連携可能です。
- レスポンスの"HTTP Status"が400番台・500番台のときは、ブロックの実行が失敗します。
プロパティ
プロパティ名 | 説明 |
---|---|
ブロック名 |
編集パネルに配置した当該ブロックの表示名が変更できます。 ブロックリストパネル中のブロック名は変更されません。 |
URL | リクエストするURLを指定します。 |
クエリーパラメーター |
クエリーパラメーターを指定します。キーとバリューの組み合わせで指定します。 |
パラメーター |
パラメーターを指定します。キーとバリューの組み合わせで指定します。 |
ブロックメモ | このブロックに関するメモが記載できます。このブロックの処理に影響しません。 |
エラー時の繰り返し回数 | リクエストエラー時の繰り返し回数を指定します。 |
繰り返し間隔 | リクエストエラー時の繰り返し間隔を秒単位で指定します。 |
レスポンスを格納する変数 |
HTTPサーバーが返すレスポンスを格納する変数を指定します。 変数に格納する値は、レスポンスのメッセージ・ボティのみです。レスポンスの「Content-Type」ヘッダーが「application/json」の場合は、メッセージ・ボディをデコードした結果を変数に格納します。 詳細については、「出力仕様>HTTP GET/HTTP POST/HTTP PUT」を参照してください。 |
リクエストヘッダー |
リクエストヘッダーを指定します。キーとバリューの組み合わせで指定します。 「Bearerトークン認証」や「Basci認証」などのように、Web APIによっては追加のリクエストヘッダーが必要な場合があります。このプロパティは、そのような場合に使用します。 以下は、「Bearerトークン認証」を指定した例です。 |
使用例
ここでは、JSONPlaceholderを使用して、「HTTP PUT」ブロックの使い方を紹介します
JSONPlaceholderは、ウェブ開発者がデータをモックアップするためのWebサービスで、JSON形式でデータを返します。RESTfulなAPIとして機能し、HTTPリクエスト(POST、GET、PUT、DELETEなど)を受け付けます。
JSONPlaceholderを使用したHTTP PUTの例について簡単に説明します。以下は、ブログなどの投稿記事を更新するAPIの仕様です。
- URL:https://jsonplaceholder.typicode.com/posts/{id}
{id}は、更新する投稿記事のIDです。 - パラメーター:
パラメーター名 説明 title 更新する投稿のタイトル body 更新する投稿の本文 userId 更新する投稿のユーザーID
これを、「HTTP PUT」ブロックで実現すると以下のようになります。
設定するプロパティと値は以下のとおりです。
プロパティ | 値 | ||||||||
---|---|---|---|---|---|---|---|---|---|
URL | https://jsonplaceholder.typicode.com/posts/1 |
||||||||
パラメーター |
|
||||||||
レスポンスを格納する変数 | response |
このブロックを実行すると、以下のようなレスポンスが返ってきます。
{ "title": "foo", "body": "bar", "userId": "1", "id": 1 }
名前 | 内容 |
---|---|
title | 更新された投稿のタイトル |
body | 更新された投稿の本文 |
userId | 更新された投稿のユーザーID |
id | 更新された投稿のID |
このレスポンスは、「HTTP PUT」ブロックの「レスポンスを格納する変数」プロパティで設定したresponseという名前の変数に格納されます。
この使用例では、変数に格納されたレスポンスをデータ更新の履歴としてBigQueryテーブルに格納することにします。
変数に格納されたデータをBigQueryテーブルに格納するには、BigQueryカテゴリーの「変数からテーブルへロード」ブロックを使用します。使用例は、以下のとおりです。
設定するプロパティと指定値は以下のとおりです。
プロパティ | 指定値 |
---|---|
投入データの変数 |
|
投入先のデータセット |
レスポンスデータ格納用のBigQueryデータセット |
投入先のテーブル |
レスポンスデータ格納用のBigQueryテーブル |
スキーマ設定 |
上図のように指定 |
この2つのブロックを組み合わせてフローの完成です。