ウェブサービス

スイート
Customer Experience Employee Experience Strategy & Research
製品
Qualtrics
このページの内容

ウェブサービスについて

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

Qtip: このページにはクアルトリクスのAPIへの参照が含まれており、アクセスには特別な許可が必要な機能です。この機能へのアクセシビリティをご希望の場合は、ブランド管理者にお問い合わせください。
注意: ウェブサービスのセットアップには、高度なプログラミング知識が必要になることがよくあります。私たちのサポートチームは、ウェブサービスに情報を入れる基本的なことについては喜んでお手伝いいたしますが、プログラミングの面についてはサポートいたしかねます。その代わり、クアルトリクスXMコミュニティの経験豊富なユーザーにいつでも質問できます。

ウェブサービスの追加

アンケートを編集中に、左のナビゲーションバーにあるアンケートフローアイコンをクリックします。
左側のナビゲーションバーのアンケートフローアイコンをクリックして［アンケートフロー］に移動する
左側のナビゲーションバーのアンケートフローアイコンをクリックして［アンケートフロー］に移動する
Add Belowをクリックするか、Add a New Element Hereをクリックしてください。
Add Below」と「Add a New element Here」ボタン; 「What do you want to add?」メニューの「Web Service」オプション。
Add Below」と「Add a New element Here」ボタン; 「What do you want to add?」メニューの「Web Service」オプション。
ウェブサービスを選択します。
URLフィールドに、外部WebサービスのURLを貼り付けます。
メソッドが続くウェブサービスのURLのフィールド
メソッドが続くウェブサービスのURLのフィールド
Qtip:クエリ文字列を使用してエンドポイント URL にアンケート情報を渡すには、テキストの差し込みを使用します。
ウェブサービスのメソッドを選択します。それぞれの方法については、以下のセクションで詳しく説明する。

方法

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

メソッド・タイプ アクション 例
GET ウェブサービスはURLにアクセスし、情報を取得する。 連絡先リストのメンバーの情報を取得します。詳細については、Get ContactAPIコールを参照してください。
POST URLにアクセスし、そこに情報を保存する。 ライブラリメッセージを作成する。
PUT 既存の情報を更新または置き換える。 ユーザー名を変更する。これは、Update Userコールでできることの1つです。
PATCH 既存の情報を更新または置き換える。PUTとよく似ている。当社のウェブサービスはこの方法を提供していますが、当社のAPIはPATCHコールを使用していません。 サーバーに保存されているデータを変更する。
削除 情報を削除する。 ライブラリからグラフィックを削除します。

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

apiドキュメントの各呼び出しの次へリストされたメソッド
apiドキュメントの各呼び出しの次へリストされたメソッド

ウェブサービスへの認証情報の追加

アンケートのオプションとして、アンケートフローの Web サービスに認証情報を追加することができます。アンケート調査フロー Web サービスは、Basic、API キー、OAuth 2.0 メソッドに対応しており、ワークフロー内の Web サービスと認証情報を共有できます。

資格情報の設定

資格情報の選択」をクリックする。
メソッドの下、パラメーターの上にあるウェブサービスの資格情報ボタンを選択します。
メソッドの下、パラメーターの上にあるウェブサービスの資格情報ボタンを選択します。
既存のアカウント設定から選択することも、ユーザーアカウントの追加をクリックすることもできます。
ユーザーアカウントを設定する新しいウィンドウ
ユーザーアカウントを設定する新しいウィンドウ
Qtip:このウィンドウに表示されるアカウントには、ワークフローのウェブサービス用に作成されたものや、ブランド管理者が組織全体で使用するために作成したものが含まれます。
後でクレデンシャルを識別するために名前を付ける。
ウェブサービス認証情報の命名
ウェブサービス認証情報の命名
接続タイプを選択します：
  • Basic: ユーザー名とパスワードを入力します。
  • APIキー：APIを認証するための一意の識別子。
  • OAuth：認証情報を共有することなく、サーバーリソースへのサードパーティのアクセスを許可します。
このリンク先のページの手順に従って、選択したクレデンシャルをフォローアップする。
mTLSを使用するかどうかを決定する。詳細はリンク先のページで見てほしい。
ウェブサービスの認証情報の入力と保存
ウェブサービスの認証情報の入力と保存
アカウントの接続をクリックします。
［次へ］をクリックします。
ウィンドウ下部の次へボタン
ウィンドウ下部の次へボタン
認証情報はウェブサービスに表示されます。
認証機能を選択する代わりに、認証機能の名前が表示されます。
認証機能を選択する代わりに、認証機能の名前が表示されます。

クレデンシャルパラメータの設定

名前とテンプレートパラメータに加えて、クレデンシャルがリクエストのどこに追加されるかを調整できます。

資格情報の次へ3つの点をクリックします。
3ドットメニューが開く
3ドットメニューが開く
クレデンシャル・パラメータの構成」を選択する。
Parameter formatで、リクエストのどこにクレデンシャルを渡すかを選択します：
パラメータを設定する新しいウィンドウ
パラメータを設定する新しいウィンドウ
  • ヘッダー
  • クエリ
  • 本文
パラメータ名を指定する。
パラメータ・テンプレートを入力する。
［保存］をクリックします。

クレデンシャルの交換と削除

次のオプションについては、資格情報の次へ3つの点をクリックしてください：

アンケートフローWebサービス資格情報の名前の次へ3ドットメニューが開きました。
アンケートフローWebサービス資格情報の名前の次へ3ドットメニューが開きました。
  • クレデンシャル・パラメータを構成する：上記のとおり。
  • 置き換える：ウェブサービスに保存された認証情報の異なるセットを選択または追加する。
  • 削除する：ウェブサービスから認証情報を削除します。これが、ウェブサービスを認可から非認可に切り替える方法だ。

アカウントのマネージャー

クレデンシャルウィンドウでは、3つの点をクリックしてアカウント（個々のクレデンシャル）を管理できます。オプションは次のとおりです。

アカウント開設の次へ3つの点
アカウント開設の次へ3つの点
  • アカウント名を変更
  • アクセスを管理
  • アカウントを削除
  • アカウントの編集（認証タイプなど、アカウント設定の変更）

一部のオプションはご利用いただけない場合があります。例えば、アカウントを作成していない場合、削除できないことがあります。ブランド管理者でない場合、アカウントへのユーザーアクセスを管理することはできません。

マネージャーとしての資格情報の管理

ブランド管理者は、Webサービスの資格情報を作成し、組織全体でどのユーザーに使用を許可するかを制御できます。

詳細を見るには、エクステンション管理をご覧ください。拡張子はWebServiceといい、スペースは入れない。

パラメーター

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

以下の強調表示のあるウェブサービス：クエリ・パラメータの追加、ボディ・パラメータの追加、カスタム・ヘッダの追加
以下の強調表示のあるウェブサービス：クエリ・パラメータの追加、ボディ・パラメータの追加、カスタム・ヘッダの追加
クエリーパラメーター：WebサービスURLの末尾にクエリ文字列を追加する代わりに、ここにクエリパラメータを記述します。
Body パラメータ：Body パラメータ: このパラメータは、GET または DELETE リクエストでは使用できません。ITには2つのフォーマットオプションがある：
  • application/x-www-form-urlencoded：ボディパラメータをWebサービスの指定領域に入力するのではなく、指定したURLの末尾にクエリ文字列として追加します。
  • application/jsonを指定します：リクエスト・ボディの各パラメータを入力し、型と値を指定する。配列やオブジェクトのような入れ子になったパラメータでは、ドット記法を使用してキーを入力するか、生のJSONとして値を直接入力することができます：
    • この画像はドット記法によるボディ・パラメーターを示している。
      ドット記法を用いてボディ・パラメータを渡すウェブ・サービス要素
      ドット記法を用いてボディ・パラメータを渡すウェブ・サービス要素
    • この画像は、同じボディ・パラメーターを生のJSONで表示しています。
      ボディパラメータに生の JSON フォーマットを使用する Web サービス要素。
      ボディパラメータに生の JSON フォーマットを使用する Web サービス要素。
      注意: JSONオブジェクトのすべてのキーと値、およびJSON配列のすべての要素（テキストの差し込みを含む）は、二重引用符で囲む必要があります。
カスタムヘッダー：ここにURLヘッダーを挿入します。
Qtip: 自分らしくいられること認証機能はカスタムヘッダに追加してください。

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

API ドキュメントでは、Body Params を示す矢印が表示されます。
API ドキュメントでは、Body Params を示す矢印が表示されます。

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

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

パラメータのテスト

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

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

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サービス要素がこの変更に対応していることを確認できます。結果ウィンドウ（下図参照）で未加工データを表示しても、エラーは表示されないはずである。

未加工データを表示するにはここをクリックしてください。ダイアログの左下には、View raw dataというボタンがある。
未加工データを表示するにはここをクリックしてください。ダイアログの左下には、View raw dataというボタンがある。
注意してください: エラーを修正するために Web サービスエレメントを更新した場合は、その変更をアンケート調査にも公開する必要があります。 締切後に古いアンケートバージョンを使用して進行中のアンケートセッションが行われることを避けるため、できるだけ早くエラーを解決することをお勧めします。代わりに別の方法（たとえば、WebサービスエレメントがターゲットとするサーバーのTLS設定を修正する）でエラーを解決する場合は、公開の必要はありません。

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

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

当サポートサイトの日本語のコンテンツは英語原文より機械翻訳されており、補助的な参照を目的としています。機械翻訳の精度は十分な注意を払っていますが、もし、英語・日本語翻訳が異なる場合は英語版が正となります。英語原文と機械翻訳の間に矛盾があっても、法的拘束力はありません。

この記事は役に立ちましたか

いただいたフィードバックはこのページの改善の目的のみに利用します。

素晴らしい！ フィードバックありがとうございます！

フィードバックありがとうございます！