記事テンプレート

ウェブサービスについて

より複雑な機能をアンケートに含めたい場合もあるでしょう。例えば、ニュースサイトのトップ10ヘッドラインをアンケートに取り込みたいとか、2回目のアンケート配信を自動化して、1回目のアンケートの回答者にちょうど2時間後にメール配信したいとか。Webサービスは、指定されたURLにリクエストを送ることで、それを可能にする。

ウェブサービスの追加

1. アンケートを編集中に、左のナビゲーションバーにあるアンケートフローアイコンをクリックします。
   
2. Add Belowをクリックするか、Add a New Element Hereをクリックしてください。
   
3. ウェブサービスを選択します。
4. URLフィールドに、外部WebサービスのURLを貼り付けます。
   
   Qtip:クエリ文字列を使用してエンドポイント URL にアンケート情報を渡すには、テキストの差し込みを使用します。
5. ウェブサービスのメソッドを選択します。それぞれの方法については、以下のセクションで詳しく説明する。

方法

Urlのウェブサービス機能では、お客様が指定したURLから情報を要求する一連のメソッドを選択することができます。

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

パラメーター

現在、リクエストに追加できるパラメータは3種類あります。

1. クエリーパラメーター：WebサービスURLの末尾にクエリ文字列を追加する代わりに、ここにクエリパラメータを記述します。
2. Body パラメータ：Body パラメータ: このパラメータは、GET または DELETE リクエストでは使用できません。これは2つのフォーマットオプションがあります:
   a)application/x-www-form-urlencoded：ボディパラメータをWebサービスの指定領域に入力するのではなく、指定したURLの末尾にクエリ文字列として追加します。
   b)application/json：キーをドット記法で入力します。例えば、APIコールでヘッダ[fromEmail]を指定するよう求められることがあります。ドット記法ではheader.fromEmailとなる。
   注意JSONオブジェクトのすべてのキーと値、およびJSON配列のすべての要素（テキストの差し込みを含む）は、二重引用符で囲む必要があります。
3. カスタムヘッダー：ここにURLヘッダーを挿入します。
   Qtip: 自分らしくいられること認証機能はカスタムヘッダに追加してください。

APIコールを使用する場合、どのようなパラメータを含めるべきかはドキュメントに記載されています。以下の例は、設定するボディ・パラメーターを示している。

ウェブサービスにパラメータを追加する

1. 前のセクションで説明した、Webサービスに送信するパラメータを追加する3つのオプションのいずれかを選択します。上記の例では、クエリーパラメーターを示しています。
2. 左側の「Parameter to Web Service」ボックスにパラメータ名を入力します。
3. 右側のValueボックスに対応するパラメータの値を入力します。
4. パラメータの右側にあるプラス（+）記号をクリックして、別のパラメータを追加します。
5. 完了したら適用をクリックします。

パラメータのテスト

URLを貼り付け、パラメータを設定したら、URLをテストして、どのようなフィールドを取り込むことができるかを確認することができます。

1. Test URL］をクリックして、外部Webサービスから取り出せる情報を確認します。
   
2. アンケート調査で使用または記録するフィールドを選択します。左にフィールド名、右に値の例が表示される。
   
3. 埋め込みデータを追加]をクリックして、選択したフィールドをデータに追加します。
   Qtip:Set Embedded Data列で、ウェブサービスのフィールドに関連付けられた埋め込みデータ名を変更することができます。埋め込みデータ名は等号（=）の左側にあり、緑色のEDアイコンで示される。右サイドは変更すべきではない。左側に設定したフィールド名は、データ上に表示されるフィールド名となります。
4. Fire and Forgetを選択すると、ウェブサービスの呼び出しから返されたデータは保存されません。この機能は、返されたデータを保存する必要がない場合に便利です。
   
   Qtip: Fire and Forget を使用すると、アンケートは応答を待つことなく Web サービスにリクエストすることができます。つまり、回答者はウェブサービスを利用することで、滞りなくアンケート調査を完了することができます。処理に時間がかかるウェブサービスリクエストがある場合、このオプションを使用することをお勧めしますが、埋め込みデータが保存されなくなるため、この機能はテスト中にのみ使用することをお勧めします。
5. 完了したら適用をクリックする。

TLSエラーの修正

2021年9月1日以降、TLS（Transport-Layer Security）エラーが発生したウェブサービスのリクエストは失敗します。TLSは、（プレーンなHTTPとは対照的に）HTTPS経由のウェブリクエストを安全にするもので、リクエストデータが第三者に見られるのを防ぎ、リクエストが正しい宛先に送信されるようにします。この変更は、クアルトリクス・プラットフォームのセキュリティ向上のための継続的な取り組みにおける重要なステップです。

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

• TLSエラーを修正する。TLSエラーの性質上、当社のサポートチームはその方法について具体的なガイダンスを提供することはできませんが、ネットワーク管理者はエラーを修正する方法を知っているはずです。
• フローエレメントのWebサービスリクエストを、HTTPSではなくHTTPで行うように変更する。例えば、URL「https://example.com」を「http://example.com」に変更することができる。この方法を取る場合は、HTTP URLがHTTPS URLにリダイレクトされないようにする必要があります。
  注意この方法では、ウェブサービスのリクエストデータが暗号化されずに送信されることに注意してください。

フロー要素のURLフィールドの次へtestボタンを使用して、Webサービス要素がこの変更に対応していることを確認できます。結果ウィンドウ（下図参照）で未加工データを表示しても、エラーは表示されないはずである。

この機能が利用可能なプロジェクトの種類

ライセンスの一部としてWebサービスにアクセシビリティがある限り、あらゆるタイプのプロジェクトのアンケートフローにWebサービスを追加できます。これには以下が該当します。

• アンケートプロジェクト
• エンゲージメント
• 360
• ライフサイクル
• アドホック従業員調査
• パルス
• XMソリューション
• コンジョイント
• MaxDiff