Qualtrics Platform
Customer Journey Optimizer
XM Discover
Qualtrics Social Connect

一般的な API ユースケース

API の使用ケースについて

このページでは、他のクアルトリクスのお客様がQualtrics APIをどのように活用しているかについて説明します。以下に、お客様が使用している一般的な API 要求、および各要求に関連するユースケースの一覧を示します。

注意: API 拡張を実装するには、プログラミングの知識が必要な場合があります。クアルトリクスサポートチームでは、カスタムコーディングに関するサポートやコンサルティングは提供していません。ただし、コミュニティの経験豊かなユーザー（英語）に尋ねてみることは可能です。カスタムコーディングサービスの詳細については、クアルトリクスの営業担当にお問い合わせください。

一般的な方法

ウェブサービス

API 要求の構築は、このプロセスではカスタムコードの実装が必要であるため、通常、組織の IT スペシャリストによって実行されます。ただし、カスタムコードの代わりにQualtricsアンケートを使用して自動化できる場合もあります。以下のステップは、このプロセスを実現する方法を示しています。

ヒント：クアルトリクス内からAPIリクエストの構築を自動化するには、APIリクエストの作成と、ウェブサービスについて理解する必要があります。さらに、参加者の必要な個人情報（自由回答欄 – フォームの質問など）を収集するアンケートの質問を含める必要があります。

アンケートが作成されたら、以下の手順に従います。

［アンケート］タブに移動して、［アンケートフロー］を開きます。
［下に追加］または［こちらに新しい要素を追加］をクリックします。
Web サービスを選択します。
文書の Definition セクションから API 要求の URL を挿入します。
使用するメソッド (GET、PUT、POST、DELETE など) を選択します。
注意：PATCHはウェブサービス要素で使用できますが、Qualtrics APIでは使用できません。
[カスタムヘッダーを追加] をクリックして Web サービスに送信します。
ヘッダ -> Web サービスフィールドに X-API-TOKEN と入力し、値フィールドにトークンを入力します。
プラス (+) 記号をクリックして、API 要求に必要なすべてのヘッダーパラメータを追加します。
メソッドを POST または PUT に設定した場合は、[Web サービスに送信する本文パラメータの追加] をクリックし、必要なパラメータと値をすべて入力します。
各パラメータの値を右側に設定します。
ヒント：動的データを含む値（［名］、［姓］、［メールアドレス］など）にテキストの差し込みを使用します。
Web サービスエレメントで API v2.x を使用している場合は、Add a query parameter to send to web service をクリックして、要求の URL パラメータおよび値を追加する必要があります。

JSON

要求の本文を介してパラメータを JSON として渡すことができます。この方法を使用する場合は、Content-Type (application/json または text/json) を指定する必要があることに注意してください。通常、このプロセスではカスタムコードの実装が必要であるため、この方法は組織の IT スペシャリストが行います。

クエリ文字列

注意: API v3 要求はトークンとしてクエリ文字列として書式設定できず、他のパラメータは要求のヘッダおよび本文を介して渡す必要があるため、注意してください。API v2.x を使用している場合は、標準のクエリ文字列構文を使用して API 要求パラメータを渡すことができます。ルート URL から開始し、必要な各パラメータを末尾に追加します。

ルート URL:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.phpルート URL に追加される最初のパラメータには

、”?” を含めます。パラメータの名前、等号、およびパラメータの値 (? など) が続きます。バージョン = 2.4)。先頭のアンパサンド “&” を使用して後続のすべてのパラメータを追加します (例: &Request=importPanel)。

ルート URL + 必須パラメータ:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Version=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML

上記と同じプロセスに従って、URL へのその他の追加パラメータの追加または追加を続行します。必要なパラメーターをすべて含めると、要求が完了します。

ルート URL + 必須パラメータ + 追加パラメータ:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Version=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML
&LibraryID=UR_12345678901234567890amp;ColumnHeaders=1&Email=3&A%2F%Filrop%2F%Filtr&1%FicName%FicD1%FicD1%FicD1%

4%3

クエリ文字列の詳細については、サポートページクエリ文字列を使用した情報の転送を参照してください。

アンケートプラットフォーム

連絡先リストのインポートを自動化しています

連絡先のインポート作成リクエストを使用して、連絡先をクアルトリクスアカウントに一括インポートできます。このリクエストを通じて、個人のJSONリストをCRMからクアルトリクスにインポートできます。これらのコンタクトをインポートするには、JSON ファイルをアップロードして Content-Type ヘッダパラメータを multipart/form-data に設定するか、要求本文にコンタクトを含め、Content-Type を application/json に設定します。

コンタクト登録の自動化

新しい連絡先メンバーで連絡先リストを手動で更新するのではなく、［連絡先を作成］リクエストを使用してプロセスを自動化できます。この申請により、既存の連絡先一覧に新しい連絡先が追加されます。このリクエストには、メーリングリストIDと、連絡先に追加するその他のフィールドが必要です。これらは、要求本文を通過し、Content-Type を application/json に設定する必要があります。

独自の個別リンクの生成

Qualtricsのメーラーではなく、内部のメーラーでアンケートを配信する必要がある場合があります。Qualtrics APIを使用すると、クアルトリクスメーラーを使用せずに回答者の個人情報を追跡する個別リンクを作成できます。

このタスクを実行するには、［配信リンクの作成］と［配信リンク］の2つのAPIリクエストを使用する必要があります。開始する前に、連絡先リストを手動で、またはAPIリクエスト連絡先インポートの作成を使用して、クアルトリクスにインポートする必要があります。

配信および配信リンクの登録要求に関連するパラメータは、以下のとおりです。

メーリングリストID（各配信はメーリングリストにリンクされます）
アンケートID
テキスト (配信の名称)
アクション (ここでの値は CreateDistribution である必要があります)

注意: 有効期限が指定されていない場合 (これはオプションのパラメータです)、リンクは 60 日後に有効期限が切れます。

CRM にインポートする準備としてデータダウンロードを自動化

多くのアンケートのデータを毎日必要とする場合は、APIを使用して回答を取得できます。API v3 では、データを取得するために一連の 3 つの要求が使用されます。

回答のエクスポートを作成: この要求によってエクスポートプロセスが開始され、ファイル形式およびその他の基本設定を指定するために使用されます。これにより、回答エクスポート ID が返されます。
応答エクスポート進捗の取得: この要求は、最初の要求で提供された応答エクスポート ID を使用してエクスポートの進捗をチェックするために使用されます。percentComplete が 100 になると、最後の要求を使用してファイルを取得できます。
応答エクスポートファイルの取得: ファイルの準備ができたら、この要求を使用してファイルをダウンロードできます。圧縮ファイルとしてエクスポートされます。データセンタ ID が URL で正しくない場合、ほとんどの API 要求は機能しますが、この要求は機能しないことに注意してください。このリクエストで正しいデータセンター ID を使用していることを確認してください。

この一連の要求によってローデータがダウンロードされるため、データを簡単に取得して、CRM やデータウェアハウスなどに応答をインポートすることができます。

XM Directory

連絡先の更新（リストのディレクトリの連絡先とディレクトリの連絡先を更新）

API を使用してコンタクトを更新することが必要になる場合があります。そのためには、コンタクトのコンタクト ID が必要です。List Directory Contacts API 要求では、コンタクトのコンタクト ID を検索することができます。このコンタクト ID は、後で API 要求に使用できます。まず、APIリクエストのリストディレクトリの連絡先について説明し、次に［ディレクトリの連絡先を更新］について説明します。

リストのディレクトリの連絡先リクエストに必要なのは、ディレクトリIDだけです。リストディレクトリの連絡先申請の結果は連絡先の連絡先IDを受信し、ディレクトリ連絡先の更新などのリクエストに使用できます。

ディレクトリコンタクト更新依頼には、ディレクトリ ID とコンタクト ID の 2 つの主要パラメータが必要です。ディレクトリ連絡先の更新依頼により、指定したコンタクトが、依頼のパラメータに基づいて変更した情報で更新されます。