-
Customer Experience -
Employee Experience -
Brand Experience -
Core XM -
Design XM
Qualtrics APIドキュメントの使用
API 文書について
Qualtrics APIドキュメンテーションページには、現在提供されているすべてのドキュメントの詳細が記載されています。
このページでは、各セクションの内容と利用可能な内容の概要を説明しながら、ドキュメントをナビゲートする方法について説明します。
概要
APIの概要では、Qualtrics APIに関する一般情報と、ページ付けに関する情報を確認できます（例：リストの連絡先リクエストを実行し、連絡先が100件を超える場合、結果にはページ番号が付けられ、次の100個のページURLが表示されます。これはすべてのコレクションリクエストに適用されます）。
クアルトリクスサーバーの許可リスト
クアルトリクスサーバーの許可リストを参照してください。
ベース URL およびデータセンタ ID
このサブセクションでは、API 要求のベース URL に含める必要があるデータセンタ ID を検索する方法を示します。
クアルトリクスIDの検索
このサブセクションでは、API 要求の実行時に必要なさまざまな ID を見つけることができる場所を示します。このセクションで使用できない ID については、「要素を検査してQualtrics IDを検索する」を参照してください。
認証
認証サブセクションには、要求の認証に必要な情報、および API トークンの保護に関する提案の概要が示されています。認証プロセスの詳細については、API トークンの生成を参照してください。
パラメーター
パラメータサブセクションでは、使用する HTTP メソッド (GET、POST、PUT、または DELETE) に応じてパラメータを渡すさまざまなメソッドについて説明します。
回答数
応答サブセクションには、要求の実行時に返すことができるさまざまな HTTP 応答コードの例と、各応答コードに対して考えられる理由が含まれています。当社の API は常に JSON で応答を返します。ただし、使用可能な任意の形式でファイルを返すことができる応答エクスポート要求の場合を除きます。
Qualtrics API の使用
文書のこのセクションには、Python および Java のコードスニペットが含まれており、サーベイとユーザを管理したり、サーベイ結果を取得したりするためのワークフローを開発する際に役立ちます。
参照
参照セクションには、受入可能な日付と時刻の書式、言語コード、要求制限、およびイベントサブスクリプションに関する詳細に関する重要な情報が含まれています。イベントサブスクリプションを使用すると、イベントの発生後にパブリケーション URL に通知を送信できます (例: 応答の記録)。
リクエスト
ドキュメントを整理し、ユーザーが探している API 要求を見つけやすくするために、要求は以下のように分類されます。
- 組織
- 部署
- グループ
- ユーザー
- アンケート
- アンケートの回答のエクスポート
- 回答数
- 回答のインポート
- メッセージライブラリ
- グラフィックライブラリ
- 配信
- インサイトプラットフォームコンタクト
- イベントサブスクリプション
- XM Directory（ターゲットオーディエンス）
要求パラメータおよびオプション
各 API 要求には、名前、簡単な説明、使用可能なパラメータを一覧表示するテーブル、応答、cURL での要求例、および “Try It Out” ウィザードがあります。この情報の使用方法を理解すると、作業を合理化することができます。
名前、説明、および URL
API 要求に対して一覧表示される最初の 3 つは、HTTP 動詞、API 要求の名前、および要求の簡単な説明です。
要求 (または “定義”) で使用される URL が、HTTP 動詞の横に一覧表示されます。
URL で使用されるドリルダウン構造に注意してください。例：
- メーリングリストのリスト要求では、次の URL を使用します。 https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
- その後、その要求で返された ID を使用して、URL の末尾に ID を追加することで、特定のメーリングリストを取得できます。 https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
- そのメーリングリスト内の連絡先をリストするには、連絡先を末尾に追加します。 https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
- 特定のコンタクトを取得するには、前の要求で返された contactId を使用します。 https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId
本文パラメータの一覧
API 要求ごとに、使用可能な本文パラメータをすべて一覧表示するテーブルが表示されます (一部はオプション、一部は必須)。このテーブルには、以下の情報が含まれます。
- 各パラメータの名前
- 各パラメータに対して許可される形式
- パラメータが必要かどうか
- パラメータの簡単な説明
要求サンプル
マニュアルに記載されている要求サンプルでは、要求を cURL で書式設定する方法を示します。これらの要求には、ルート URL およびパラメータテーブルからのすべての必須パラメータが含まれます。
応答の例
このセクションでは、API 要求が成功した場合に受信できる内容の例を示します。たとえば、API 要求 Create User を使用している場合、応答は新たに作成されたユーザのユーザ ID になります。
API サイトでの API 要求の完了
API 文書を使用すると、API 要求を迅速かつ容易に実行することができます。（ほとんどのAPIリクエストにはクアルトリクスIDが必要です。）
- API キーと OAuth 2.0 のいずれかを選択します。
- API トークンフィールドにアカウントの API トークンを入力します。(または、OAuth 2.0 を選択した場合は対応する OAuth 2.0 情報)
- 追加パラメータを入力します。
- ユーザをクリックして、テストするサーバを選択します。最も正確にテストするため、これはアカウントのデータセンターと一致させる必要があります。
- API 要求の送信を押して、API 呼び出しをテストします。
依頼に必要な値を入力すると、”応答” にコールの出力が表示されます。
