Raw Request
このメソッドは、未加工のHTTPリクエストを実行し、フロー構築者がHTTPリクエストのすべての要素をコントロール可能にします。これにより、フローからXMLサービスやHTMLサービスを呼び出せるほか、他のさまざまな高度な使用法が可能になります。
その他のAPIコネクター機能は、一般的なJSONベースのサービスで使いやすいように最適化されています。Raw Request関数カードには一層の柔軟性があります。
このカード(または任意のカード)を通過するデータは実行履歴に記録され、他のWorkflows管理者に公開される可能性があります。フロー内では、アクセストークンなどの機密情報の入力、読み取り、処理をテキスト形式で行わないでください。この情報は、セキュアにコネクターに保存します。
次に、この関数カードの使用例をいくつか示します。
-
XMLサービスを呼び出す:XML Build関数を使用して自分のリクエストを含むXML文字列を作成し、Raw Request関数カードのBody(本文)入力にドラッグします。次に、XML Parse関数を使ってBody(本文)出力を解析し、JSON応答を作成してフローの以後の部分で使用できます。これは、HTMLサービスでも機能します。
-
リストでJSON APIを呼び出す:API Connector関数では、bodyでJSONオブジェクトを渡すことが暗黙的に要求されます。Bodyセクションに作成する各入力は、リクエスト本文のキーとなります。Raw Request関数カードを使用すれば、オブジェクトのリストなど、オブジェクト以外のものを渡すことができます。List関数を使って目的のリストを作成し、JSON Stringify関数カードを呼び出してRaw Request関数カードのBody(本文)入力となる文字列を作成します。
-
プログラムでクエリを構築する:実行時にクエリ文字列を決定するロジックを作成できます。オブジェクト関数カードを使ってフロー内にクエリオブジェクトを作成し、そのオブジェクトをRaw Request関数カードのQuery(クエリ)入力にドラッグします。クエリオブジェクトは、次のようにURLクエリ文字列に変換されます。クエリオブジェクトが{ "x": "one", "y": "two"}であれば、クエリ文字列は?x=oney=twoとなります。
-
プログラムでヘッダーを構築する:他のAPI Connector関数では、ヘッダーのフィールド名を設計時に定義することが暗黙的に要求されます。値は動的でもかまいませんが、ヘッダーのフィールド名は固定です。フロー内でフィールド名を定義するには、Object関数を使ってフロー内にHeaders(ヘッダー)オブジェクトを作成し、オブジェクトをRaw Request関数カードのHeaders(ヘッダー)入力にドラッグします。たとえば、ヘッダーオブジェクトが{ "Accept": "text/plain" }であれば、リクエストのヘッダー文字列は「Accept: text/plain」となります。
-
動的キーでJSON APIを呼び出す:API Connector Post関数では、リクエスト本文のキーを設計時に作成することが暗黙的に要求されます。実行時にリクエスト本文を入力パラメーターに基づいて構築するには、Object関数カードを使ってオブジェクトを構築し、JSON Stringify関数カードに渡します。次に、その文字列をRaw Request関数カードのBody(本文)入力にドラッグします。
Raw Request関数には、あらゆるHTTP呼び出しを成形できる柔軟性があります。必要な柔軟性が他のHTTP関数では得られないときは、Raw Request関数カードの使用を試してください。
入力
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
URL | HTTPリクエストのURL。 | テキスト | TRUE |
Method(方式) | HTTPメソッド。GET、POST、PUT、PATCH、またはDELETEのオプションがあります。 | ドロップダウン | TRUE |
Headers(ヘッダー) | リクエストのヘッダーを表すオブジェクト。ヘッダーの各キーは、"key: value"としてヘッダー文字列に渡されます(例:"Accept: text/plain")。 | オブジェクト | FALSE |
Query(クエリ) | URLクエリ文字列を表すオブジェクト。URL文字列にはヘッダーの各キーが追加され、url?key1=value1key2=value2...のようになります。 | オブジェクト | FALSE |
Body(本文) | HTTPリクエスト本文。 | テキスト | FALSE |
出力
フィールド | 定義 | タイプ |
---|---|---|
Response (レスポンス) | ||
Status Code(ステータスコード) |
操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
Headers(ヘッダー) | 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。ヘッダーは、{"Content-type":"application/json"}のようになります。 | オブジェクト |
Body(本文) |
選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。 |
テキスト |