クアルトリクスAPIドキュメントの使用方法
このページの内容
APIドキュメントについて
クアルトリクスAPIドキュメントのページでは、現在ご利用いただけるドキュメントの詳細をご覧いただけます。
このページでは、各セクションで説明されている内容や利用可能なサービスについて説明します。
概要
API概要では、クアルトリクスAPI全般に関する情報と、ページネーション（連絡先リストリクエストを実行し、連絡先が100件以上ある場合、結果はページネーションされ、次の100件を取得するためにnextPage URLが提供されます。）
クアルトリクスサーバーの許可リスト
クアルトリクスサーバーの許可」を参照してください。
ベースURLとデータセンターID
このサブセクションでは、APIリクエストのベースURLに含める必要があるデータセンターIDを見つける方法を示します。
クアルトリクスIDの検索
このサブセクションでは、APIリクエストを実行する際に必要となる様々なIDの場所を示します。このセクションで利用できないIDについては、要素を検査してクアルトリクスIDを見つけるをご覧ください。
認証
認証機能のサブセクションでは、リクエストを認証するために必要な情報と、APIトークンを保護するための提案について概説します。認証機能の詳細については、「Apiトークンの生成」を参照してください。
パラメーター
Parametersサブセクションでは、使用されるHTTPメソッド（GET、POST、PUT、またはDELETE）に応じてパラメータを渡すためのさまざまなメソッドについて説明します。
回答
回答サブセクションには、リクエストを実行したときに返されるさまざまなHTTPレスポンスコードの例と、各レスポンスコードの考えられる理由が含まれています。当社のApiは常にJSONで回答を返しますが、レスポンスエクスポートリクエストの場合は例外です。
Qtip: ドキュメントにオプションとして回答または以前のバージョンからのアップグレードが表示されない場合は、APIセクションのリストの一番下にあるView All 7を選択してください。
クアルトリクスAPIを使う
このセクションでは、Python と Java によるコードスニペットを紹介し、アンケート調査やユーザーの管理、アンケート結果の取得などのワークフロー育成に役立つ情報を提供します。
警告: カスタムコーディング機能はそのまま提供されるため、実装にはプログラミングの知識が必要になる場合があります。クアルトリクスサポートチームでは、カスタムコーディングに関するサポートやコンサルティングは提供していません。その代わり、クアルトリクスXMコミュニティの経験豊富なユーザーにいつでも質問できます。カスタムコーディングサービスの詳細をお知りになりたい場合は、クアルトリクス営業担当までご連絡ください。
参照
リファレンス」セクションには、使用可能な日付と時刻のフォーマット、言語コード、リクエストの制限、イベントサブスクリプションの詳細に関する重要な情報が記載されています。イベントサブスクリプションでは、イベントが発生すると (例えば、記録された回答)、パブリケーション URL に通知を送信できます。
リクエスト
ドキュメントを整理し、ユーザーが探しているAPIリクエストを見つけやすくするために、リクエストは以下のように分類されている：
- 組織
- 部署
- グループ
- ユーザー
- アンケート
- アンケート調査の回答をエクスポートする
- 回答
- 回答のインポート
- メッセージライブラリ
- グラフィックライブラリ
- 配信
- インサイト プラットフォーム 連絡先
- イベントサブスクリプション
- XM Directory（ターゲットオーディエンス）
リクエスト・パラメータとオプション
各APIリクエストには、名前、簡単な説明、可能なパラメータをリストしたテーブル、回答、cURLでのリクエスト例、そして “Try It Out “ウィザードがあります。この情報の使い方を理解することで、仕事を効率化することができる。
名前、説明、URL
どのAPIリクエストに対しても、最初にリストされるのはHTTP動詞、APIリクエストの名前、リクエストの簡単な説明の3つである。
リクエスト(または “定義”)で使われたURLはHTTP動詞の次へリストされる。
URLに使われているドリルダウン構造に注目してほしい。例：
- メーリングリストリクエストは以下のURLを使用します： https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
- そして、そのリクエストで返された ID を URL の末尾につけることで、特定のメーリングリストを取得することができます： https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
- メーリングリスト内の連絡先をリストアップするには、最後にcontactsを追加します： https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
- 特定の連絡先を取得するには、前のリクエストで返されたcontactIdを使用します： https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId
ボディパラメータのリスト
それぞれのapiリクエストに対して、使用可能なすべてのボディパラメータのリストが表示されます（いくつかはオプションで、いくつかは必須です）。この表には以下の情報が記載されている：
- 各パラメーター名
- 各パラメータで使用可能なフォーマット
- パラメータが必要かどうか
- パラメータの簡単な説明
注意: すべてのパラメータ名と値は大文字と小文字を区別します。
サンプルを請求する
ドキュメントに記載されているリクエストサンプルは、cURLでどのようにリクエストをフォーマットするかを示しています。これらのリクエストは、ルートURLとparametersテーブルのすべての必須 パラメータを含む。
Qtip: IDはあくまで例であり、実際のIDではないので、例のリクエストは実際には機能しませんが、自分のアカウントのIDに置き換えるだけでよいことに注意してください。
回答例
このセクションでは、APIリクエストが成功した場合に期待できる受信内容の例を示します。たとえば、APIリクエストのCreate Userを使用している場合、レスポンスには新しく作成されたユーザーのユーザーIDが返されます。
APIサイトでのAPIリクエストの完了
当社のAPI Documentationを使用すると、迅速かつ簡単にAPIリクエストを実行できます。(ほとんどのAPIリクエストにはクアルトリクスIDが必要です。）
注意: apiをテストするときは注意してください。APIコールを実行するために最低限必要な情報を入力すると、このモーダルでAPIリクエストが完了します。必須フィールドはAPIコールによって異なり、コールのページにリストされています。
Qtip: 各パラメータにどのような値が受け入れられるかを知るには、 リクエストのパラメータの表を参照してください。また、ドキュメントのcURLの例を参照することもできる。
リクエストに必要な値を入力したら、”回答 “の下にコールの出力が表示されます。
注意: このテスト機能では動作しないリクエストもあります。これはリクエストのページに表示されます。
素晴らしい！ フィードバックありがとうございます！
フィードバックありがとうございます！