ウェブサービス

Web サービスについて

アンケートに、より複雑な機能を含めたい場合があります。ニュースウェブサイトから上位10件の見出しをアンケートに取り込んだり、2つ目のアンケート配信を自動化して最初のアンケートの回答者にメールで送信したりする場合もあります。Web サービスでは、指定された URL に対して要求を行うだけで、これを行うことができます。

Web サービスの追加

1. アンケートの編集中に、左側のナビゲーションバーの［アンケートフロー］アイコンをクリックします。
   
2. ［下に追加］または［こちらに新しい要素を追加］をクリックします。
   
3. Web サービスを選択します。
4. [URL] フィールドに、外部 Web サービスの URL を貼り付けます。
   
   ヒント：テキストの差し込みを使用すると、クエリ文字列を介してエンドポイントURLにアンケート情報を渡すことができます。
5. Web サービスのメソッドを選択します。さまざまな方法については、以下のセクションで詳しく説明します。

メソッド

当社の Web サービス機能では、一連のメソッドから選択して、指定した URL から情報を要求することができます。

API コールを使用している場合は、以下のスクリーンショットに示すように、ドキュメントによって使用するメソッドが示されます。

パラメーター

現在、要求に追加できるパラメータには 3 つのタイプがあります。

1. クエリパラメータ: Web サービス URL の末尾にクエリ文字列を追加する代わりに、ここにクエリパラメータを配置します。
2. 本文パラメータ: このパラメータは、GET 要求または DELETE 要求には使用できません。以下の 2 つの書式設定オプションがあります。
   a) application/x-www-form-urlencoded: Web サービスの指定された領域に本文パラメータを入力するのではなく、指定した URL の最後にクエリ文字列として追加します。
   b) application/json: ドット表記にキーを入力します。たとえば、API 呼び出しでヘッダー [fromEmail] の指定を求められる場合があります。ドット表記では、header.fromEmail になります。
   注意: JSON オブジェクトのすべてのキーと値、および JSON 配列 (差し込みテキストを含む) のすべての要素には、二重引用符が必要です。
3. カスタムヘッダ: ここに URL ヘッダを挿入します。

API 呼び出しを使用している場合は、含めるパラメータの種類がドキュメントに記載されています。以下の例は、設定するボディパラメータを示しています。

Web サービスへのパラメータの追加

1. 前のセクションで示した Web サービスに送信する 3 パラメータの追加オプションのいずれかを選択します。上記の例では、クエリパラメータを示しています。
2. 左側の Web サービスへのパラメータボックスにパラメータの名前を入力します。
3. 右側の [値] ボックスに、パラメータの対応する値を入力します。
4. 別のパラメータを追加するには、パラメータの右側にあるプラス (+) 記号をクリックします。
5. 終了したら、[適用] をクリックします。

パラメータのテスト

URL をペーストしてパラメータを設定したら、URL をテストして、取り込むことができる項目を確認することができます。

1. URL のテストをクリックして、外部 Web サービスから取得できる情報を確認します。
   
2. アンケートで使用または記録するフィールドを選択します。項目名が左側に表示され、対応するサンプル値が右側に表示されます。
   
3. ［埋め込みデータを追加］をクリックして選択したフィールドをデータに追加します。
   ヒント：［埋め込みデータの設定］列で、ウェブサービスのフィールドに関連付けられている埋め込みデータ名を変更できます。埋め込みデータ名は等号 (=) 記号の左にあり、緑色の ED アイコンで示されます。右側は変更しないでください。左側で設定する名前は、データに表示されるフィールドの名前になります。
4. Fire and Forget を選択すると、Web サービス呼出から返されるデータは保存されません。この機能は、返されたデータを保存する必要がない場合に役立ちます。
   
   ヒント：［起動］と［忘れ］を選択すると、回答を待たずに、アンケートでウェブサービスにリクエストできます。つまり、回答者は、ウェブサービスのためにアンケート全体に遅滞なく回答できます。このオプションは、処理に時間がかかる Web サービスリクエストがある場合に使用できますが、埋め込みデータが保存されないようにするため、この機能はテスト中にのみ使用することをお奨めします。
5. 完了したら、適用をクリックします。

TLS エラーの修正

2021 年 9 月 1 日以降、トランスポートレイヤセキュリティ (TLS) エラーがある Web サービス要求は失敗します。TLS は、(プレーン HTTP ではなく) HTTPS を介した Web 要求を安全にするものです。これにより、要求データがサードパーティに表示されなくなり、要求が正しい宛先に送信されるようになります。TLSエラーを無視すると、これらのセキュリティ上のメリットが効果的に解消されます。この変更は、Qualtricsプラットフォームのセキュリティを向上させるための継続的な取り組みの重要なステップです。

各 TLS エラーを解決するには、以下のいずれかを実行する必要があります。

• TLS エラーを修正します。TLS エラーの性質により、サポートチームはその方法についての具体的なガイダンスを提供できませんが、ネットワーク管理者はエラーの修正方法を把握することができます。
• HTTPS ではなく HTTP を介して行われるフローエレメント Web サービス要求を変更します。たとえば、URL “https://example.com” を “http://example.com” に変更できます。このアプローチを使用する場合は、HTTP URL が HTTPS URL にリダイレクトされないようにする必要もあります。
  注意：このアプローチにより、Web サービスリクエストデータが暗号化されずに送信されることに注意してください。

Flow 要素の [URL] フィールドの横にある [テスト] ボタンを使用して、Web サービス要素がこの変更の準備ができていることを確認できます。結果ウィンドウ (下にも表示) にローデータを表示しても、エラーは表示されません。