ソーシャルコネクト API に関する FAQ

一般

開発者アカウントを有効化する方法を教えてください。

API および関連機能にアクセスするには、最初に開発者アカウントを有効化する必要があります。詳細については、個人設定設定を参照してください。

Social Connect API の使用を開始する方法を教えてください。

Qualtrics Social Connect APIステップバイステップガイドをご覧ください。

Social Connect API を使用するには、どのタイプのアカウントが必要ですか?

API へのアクセスは、すべての価格設定計画に含まれているわけではありません。ライセンスに含まれる内容について質問がある場合は、サポートにお問い合わせください。

プログラミング言語 x のクライアントライブラリはありますか?

Qualtricsではクライアントライブラリを提供していませんが、OAuthプロトコルのライブラリはほとんどすべての言語で存在します。http://oauth.net/code/を参照してください。

API をすばやくテストできますか。

API
コンソールを使用して API をテストできます。ここで、エンドポイントを選択し、必要なパラメータを入力します。API によって目的の結果が得られたかどうかを確認するための結果がすぐに表示されます。

API レート制限を増やすことはできますか。

API
レート制限の概要については、レートの制限を参照してください。現在のレート制限は、標準の使用ケースには十分ではありません。ただし、追加のレート制限が必要な場合は、サポートに連絡し、アプリケーションのユースケースおよび要求されたレート制限を説明してください。

API でのフィルタリングの仕組み

Social Connect API の複数のエンドポイントにより、フィルタ文字列パラメータを渡すことができます。

たとえば、メンションの一覧を取得するとします。メンションをフィルタリングして、特定のタグによるメンションのみが返されるようにすることができます。

フィルタパラメータは常に文字列です。この構文では、データの複数のプロパティ (前述の単語、タグ、ステータス、解決時間など) を検索し、ブール型構文とネストされた構文を使用してそれらのプロパティを組み合わせることができます。

Social Connect プラットフォームでフィルタを構築すると、フィルタにテキスト表現が関連付けられます。この表示は、フィルタ項目を選択した後にフィルタウィンドウに表示されます。このパラメータをコピーして、API 呼び出しで使用することができます。

Webhook の署名に使用される方法はどれですか。

詳細については、Webhook
を参照してください。

1 時間あたり 20 API 呼出に制限されるのはなぜですか。

API コンソールを使用する場合、レート制限は、他の API クライアントに対する標準的な 350 呼出/時間ではなく、1 時間あたり 20 認証呼出です。この 20 呼び出し制限が発生している場合は、API コンソールではなく、API アプリケーションのアクセストークンを使用していることを確認してください。

API 認証

API コールはどのように認証されますか。

Qualtricsでは標準のOAuth 2.0プロトコルを使用しています。詳細については、認証を参照してください。

アプリケーションに対して OAuth を実装する必要がありますか。

アプリケーションのユーザーが Qualtrics Social Connect アカウントを認証する必要がない場合は、代わりに自分のユーザーアカウントに対して OAuth トークンを生成できます。アプリケーションの概要に移動し、登録されたアプリケーションの横にある編集をクリックして、アクセストークンタブに移動します。自分の認証をクリックすると、現在ログインしているユーザ (権限あり) のアクセストークンが生成されます。このアクセストークンを使用して、API 要求に署名できます。

アクセストークンの有効期間はどれくらいですか。

詳細については、「認証」
ページを参照してください。

トークンを使用してアクセスできるアカウントおよびデータは何ですか?

OAuth アクセストークンは、特定の Social Connect ユーザに対して生成されます。このユーザは 1 つ以上のアカウントにアクセスできます (`/me/accounts` エンドポイントからどのアカウントかを確認できます)。アクセスできるデータは、ユーザ自身がアクセスできるアカウント、およびそのアカウントでのユーザロールによって異なります。

メンションの使用

Social Connect 受信ボックスから自分のアプリケーションにメンションを取得するにはどうすればよいですか。

`/{account_id}/inbox/mention` エンドポイントを使用して、任意のトピックのすべてのメンションを取得します。この API サポートページでは、メンションのために取得される情報について説明します。

また、Social Connect の自動化レシピ機能を使用して、アプリケーションで Web フックを呼び出すワークフローを設計することもできます。

API によってツイートが返される詳細が不足しているのはなぜですか。

ツイートの場合、クアルトリクスはSocial Connect固有のデータとTwitterのツイートIDのみを返すことができます。これは、Twitter API の用語からの制限です。ツイート ID を持っている

ため、Twitter API にアクセスし、”/states/lookup” エンドポイントを使用してすべての詳細を取得することができます。

なぜFacebookの投稿が匿名化されているのか。

公開 Facebook 投稿 (Facebook ページのメッセージではなく、キーワード検索によって Social Connect で選択) は匿名です。これは Facebook API の制限です。

Social Connect に独自のメッセージを追加することはできますか？

Social Connect で監視するコンタクトフォームまたは内部フォーラムがある場合は、”/{account_id}/inbox/add” エンドポイントを呼び出して、カスタムメッセージを Social Connect に追加することができます。これらのメッセージは、受信ボックスおよびインサイトでアクセスできるようになります。

API を介して Social Connect に追加されたメッセージは、Social Connect 内から返信できません。カスタムシステムとのより緊密な統合が必要な場合は、サポートに連絡してください。

API を使用してケースをエクスポートすることはできますか。

ケースをエクスポートするには、通常のメンションエンドポイント (一覧のエクスポート/単一メンションの更新) を使用できます。依頼でケースのみを返す場合は、フィルタ ‘sub_category:case’ を使用することができます。

API のケースとメンションの違いは何ですか。

Social Connect では、「メンション」はメッセージの中心的なオブジェクトです（単一のツイート、単一のプライベートメッセージ、単一のコメント）。また、基本的にメンションの集まりである「ケース」という概念もあります。

ケースの主な用途は、特定のユーザからの複数のメッセージをグループ化し、エージェントから会話に応答することです。

技術的な観点から見ると、「ケースに関する会話」は、以下で構成されます。

• ケース自体 (メンションオブジェクトでもある)。
• ケースには、ラベル、ステータス、タイトルなどを含めることができます。
• 会話に含まれるメンションの一覧。
• ケースでグループ化されたメンション。

ケースおよびメンションの詳細については
、この API サポートページを参照してください。

Social Connect 送信ボックスにメッセージをインポートすることはできますか。

ソーシャルマネージャに対して新規投稿のドラフトを登録し、エンドポイント “/{account_id}/publisher/add” を使用して検証、編集、および公開することができます。

API を使用してメンションを編集することはできますか。

“/{account_id}/inbox/mention/{topic_id}/{id}” エンドポイントを使用して、既存のメンションを編集することができます。このエンドポイントの文書には、メンションのタグの更新、ノートの追加などの例が含まれています。

API を介して Engage で特定のユーザからすべてのデータを削除する方法を教えてください。

Social Connect アカウントにある特定の顧客のデータをすべて削除する場合は、以下の 2 つのタイプのデータを削除する必要があります。

1. システム内のそのユーザーからのすべてのメンション
2. Social Connect CRM に保存されているそのユーザに関する情報。

特定のユーザからのすべてのメンションを検索するには、”/{account_id}/inbox/mention” エンドポイントを使用し、特定の権限 ID (例 🙂 をフィルタリングします。”author.id:123″。メンションの一覧を取得したら、”/{account_id}/inbox/mention/{topic_id}/{id}” エンドポイントを使用してメンションを削除することができます。

エージェントが Social Connect CRM でコンタクトの追加コンタクトデータを保存したかどうかを確認するには、”/{account_id}/inbox/contact/{service}/{service_id}” に対して GET 要求を行います。応答オブジェクトに contact.id が含まれている場合、このユーザのコンタクトが存在することを意味します。応答に contact.id プロパティが含まれていない場合は、ソーシャルコネクト CRM にデータが保存されていないことを意味します。

contact.id を取得したら、 /{account_id}/inbox/contact/{contact_id} エンドポイントに対して DELETE 要求を行い、すべての情報を削除することができます。

連絡先の操作 

メンションまたはケースから連絡先詳細を検索する方法を教えてください。

メンションまたはケースが API によって返される場合、“action_link” オブジェクトの一覧が含まれます。アクションリンクには、Web アプリケーションの他の API エンドポイントまたは URL がこのオブジェクトに関連する現在のオブジェクトに関する情報が含まれます。メンションおよびケースの場合、含まれているアクションリンクの 1 つが、メンションまたはケースの作成者の連絡先詳細を取得できる場所です。

/{account_id}/inbox/cases エンドポイントを使用する場合は、デフォルトでメンションの作成者の連絡先オブジェクトが含まれます。クアルトリクスには、メンション用の完全な連絡先オブジェクトは含まれていませんが、アクションリンクを介して、別のAPI呼び出しを行うことで、このオブジェクトを取り込むことができます。

出版

Clarabridge Engage API を使用してソーシャルチャネルに公開することはできますか。

いいえ。API をサードパーティプラットフォームに直接公開することはできません。つまり、Social Connect APIを使ってツイートやFacebookのコメントを公開することはできない。

ただし、Social Connect API を使用して、承認用のドラフトまたはキューメッセージを作成することができます。これらは、Social Connect インターフェイスを介して承認または公開されたときに公開されます。メッセージのドラフトのエンドポイントは /{account_id}/publisher/add です。

ユーザ管理

API を使用してユーザのステータスを変更することはできますか。

いいえ。API を使用してユーザのステータスを変更することはできません。ステータスは変更できませんが、名前、会社、電子メール、アバター、および営業時間スケジュールは /{account_id}/settings/user/{id} エンドポイントを使用して変更することができます。

API を使用してユーザのユーザロールを変更することはできますか。

API を使用して、ユーザのユーザロールを変更することができます。ただし、セキュリティ上の理由から、ユーザロールを Administrator に変更することはできません。他のすべてのユーザロールは、 /{account_id}/settings/user/{id} エンドポイントを介してに変更できます。

API を使用して新規ユーザを作成することはできますか。

セキュリティ上の理由から、これは API を介して行うことはできません。

ソーシャルプロファイルの使用

トピックのソーシャルプロファイルに関する情報を取得することはできますか。

“/{account_id}/inbox/contact/{service}/{service_id}” エンドポイントを使用して、特定のソーシャルプロファイルに関する情報を取得することができます。これには、Social Connect CRM 内のその人物について入力した詳細 (性別、電子メール、このユーザに追加したカスタム属性など) が含まれます。

インサイトの使用

Clarabridge Engage から統計を取得することはできますか。

2 つの異なる API エンドポイントを使用して、インサイトからデータをプルすることができます。

1. “/{account_id}/dashboards/export/{dashboard_id}” エンドポイントにより、特定のダッシュボードのすべてのウィジェットからデータが返されます。自分またはユーザがカスタムダッシュボードを設定したら、このエンドポイントを使用して、その背後にあるデータを取得することができます。
2. “/{account_id}/insights/facets” エンドポイントは、Social Connect のチャートビルダ機能に相当する API として機能します。

問題

自分のアカウント ID はどこにありますか。

認証されると、ユーザが “/me/accounts” エンドポイントを介してアクセスできるすべてのアカウント (およびその ID) の一覧を取得できます。

トピック ID はどこにありますか?

認証されると、ユーザが “/me/accounts” エンドポイントを介してアクセスできるすべてのトピック (およびそれらの ID) の一覧を取得できます。

自分のユーザ ID はどこにありますか?

認証されると、”/me” エンドポイントを使用して認証ユーザ (ユーザの ID を含む) に関する詳細を取得することができます。