SurveyMonkeyをデータパイプラインのソースとして構成する
SurveyMonkeyをデータパイプラインのソースとしてセットアップし、アンケート、アンケート構造、回答、解答、およびコレクターを宛先に抽出します。
このガイドを使用して、コネクションの設定、パイプラインの設定、オブジェクトの追加、同期動作の確認、および既知の制限事項の理解を行います。
サポートされている機能
SurveyMonkeyをパイプラインソースとして使用すると、次の機能がサポートされます。
- クラウド接続: アカウントのデータセンター向けAPIホスト経由でHTTPSを使用してSurveyMonkeyに接続します。オンプレミスエージェントは不要です。
- フル同期および増分同期: すべてのオブジェクトでフル同期をサポートし、
surveys、survey_responses、collectorsでは増分同期をサポートします。詳細については、同期モードを参照してください。 - オブジェクトレベルの選択: SurveyMonkeyオブジェクトから、アンケート、アンケート構造、回答、解答、およびコレクターを選択し、宛先で個別のテーブルとして同期します。完全なリストについては、サポート対象オブジェクトを参照してください。
- 削除追跡: フル同期オブジェクト上の削除済みレコードと、
survey_questions内の削除済み質問を検出します。詳細については、削除追跡を参照してください。 - スキーマドリフトの検出と処理: 新しいフィールドを自動同期でスキーマの変更を自動的に検出して適用するか、新しいフィールドをブロックでスキーマを固定します。
- フィールドレベルのデータ保護:データがデスティネーションに到達する前に、機密フィールドをハッシュ化するか、そのままレプリケートします。
- 構成可能な同期頻度: 時間ベースの間隔またはcron式を使用して同期をスケジュールします。サポートされる最小間隔は
15分です。
前提条件
SurveyMonkeyをデータパイプラインのソースとして接続するには、次のものが必要です。
- SurveyMonkeyアカウント。
survey_responsesとresponse_answersを同期するには有料プランが必要です。詳細はResponses require a paid planを参照してください。 - OAuth 2.0コネクションを認可するためのSurveyMonkeyアカウント認証情報。 Workatoは、権限に関する問題を回避するため、管理者アカウントの使用を推奨します。
- SurveyMonkeyアカウントが米国以外のデータセンターにホストされている場合は、custom OAuth profileが必要です。
必須スコープ
Custom OAuth profilesの背後にあるSurveyMonkeyアプリは、users_read、surveys_read、collectors_read、responses_read、responses_read_detailスコープを付与する必要があります。アカウントのコンタクトフィールドラベルをcollector_recipientsのカスタムフィールド列のカラムラベルとして同期するには、contacts_readスコープを追加します。
サポートされるコネクションタイプ
SurveyMonkeyのデータパイプラインはOAuth 2.0認証をサポートしています。 SurveyMonkeyにサインインして、Workatoによるアカウントデータの読み取りを許可します。独自のSurveyMonkeyアプリ経由で認可する場合、または米国以外のデータセンターに接続する場合は、custom OAuth profileを使用します。
ドラフトアプリはデータパイプラインに適さない
SurveyMonkeyは、ドラフト状態のアプリに対し、APIリクエスト数を1日に少数に制限しています。データパイプラインは実行のたびに多数のAPIリクエストを行うため、ドラフトアプリに基づくcustom OAuth profileは日次上限に達して失敗する可能性があります。詳細はSurveyMonkeyのRequest and Response Limitsガイドを参照してください。
SurveyMonkeyに接続する
SurveyMonkeyをデータパイプラインのソースとして接続するには、次の手順を実行します。
SurveyMonkeyに接続する
作成 > コネクションをクリックするか、Cを2回押します。
SurveyMonkeyを検索し、アプリとして選択します。
Workatoの接続先であるSurveyMonkeyアカウントを識別するコネクション名を入力します。
コネクションを保存する予定のプロジェクトまたはフォルダを選択するには、ロケーションドロップダウンメニューを使用します。
データセンタードロップダウンメニューを使用して、SurveyMonkeyアカウントをホストするデータセンターを選択します。デフォルトは米国です。米国外のデータセンターに接続するには、Custom OAuth profilesを使用する必要があります。
任意。 Custom OAuth profileドロップダウンメニューを使用して、コネクション用のCustom OAuth profilesを選択します。アプリへのすべてのリクエストでは、ここで指定したプロファイルが使用されます。
接続をクリックして、SurveyMonkeyの認可ウィンドウを開きます。
アカウントの認証情報を使用してSurveyMonkeyにサインインします。権限に関する問題を避けるため、管理者アカウントの使用をお勧めします。
利用規約を読み、認可をクリックしてコネクションのセットアップを完了します。
回答の表示要件
認可の際にView answers along with responsesを選択して、アンケート回答の解答を取得します。 Completed survey responseトリガー、Send survey invite via email and wait for responseアクション、およびsurvey_responsesとresponse_answersデータパイプラインオブジェクトには、この権限が必要です。
WorkatoによるSurveyMonkeyアカウントへのアクセスを認可します。
パイプラインの設定
SurveyMonkeyをデータパイプラインのソースとして構成するには、次の手順を実行します。
作成 > データパイプラインを選択するか、C+Iを押します。
データパイプライン名フィールドにデータパイプラインの名前を入力します。
データパイプライン設定
ロケーションドロップダウンメニューを使用して、データパイプラインを保存するプロジェクトを選択します。
ビルドを開始をクリックします。
Extract new/updated records from source app トリガーをクリックします。このトリガーでは、パイプラインがSurveyMonkeyからデータを取得する方法を定義します。
ソースアプリから新規/更新済みレコードを抽出トリガーを設定
Your Connected Source Apps ドロップダウンメニューを使用して、SurveyMonkey を選択します。
このパイプラインで使用するSurveyMonkeyのコネクションを選択します。または、+ 新規コネクションをクリックして、新しいコネクションを作成します。
オブジェクトを追加をクリックして、新しいオブジェクトを追加パネルを開きます。
オブジェクトを追加
利用可能なSurveyMonkeyオブジェクトの一覧を検索または参照し、同期するオブジェクトを選択して、Addをクリックします。
完全同期のみのオブジェクト
survey_pagesやresponse_answersなど、増分カーソルを持たないオブジェクトには、オブジェクト一覧でFull syncとラベル付けされ、常にフル同期されます。詳細については、同期モードを参照してください。
任意。オブジェクトの横にある歯車アイコンをクリックして、そのオブジェクトの同期モード設定を開きます。 Sync modeドロップダウンメニューを使用してFull syncまたはIncrementalを選択し、Saveをクリックします。増分同期をサポートしているのはsurveys、survey_responses、collectorsのみです。
選択した各オブジェクトのスキーマを確認してカスタマイズします。パイプラインは、オブジェクトを選択するとそのオブジェクトのスキーマを自動的に取得します。これにより、デスティネーションがソースと一致します。
オブジェクトを展開して、関連フィールドを表示します。使用可能なすべてのデータを抽出するにはすべてのフィールドを選択したままにし、データ抽出とスキーマレプリケーションから除外するには特定のフィールドの選択を解除します。
任意。オブジェクトを展開し、各フィールドの処理方法を選択して、フィールドレベルのデータ保護を設定します。
- そのまま複製: ソースのデータ値が宛先に同一に複製されます。
- ハッシュ: 宛先に同期する前に、フィールド内の機密データ値をハッシュ化します。
Workatoでは、個人を特定できる情報(PII)やその他の機密フィールドをハッシュ化することを推奨します。 PIIが一般的に含まれるフィールドのリストについては、機密データの処理を参照してください。
オブジェクトを追加を再度クリックして、さらにオブジェクトを追加します。この手順を繰り返して、パイプラインにSurveyMonkeyのオブジェクトをさらに追加します。
スキーマ変更の処理方法を選択ドロップダウンメニューを使用して、スキーマドリフトの処理オプションを選択します。
- 新しいフィールドを自動同期: ソースに追加された新しいフィールドを自動的に検出して同期します。
- 新しいフィールドをブロック: パイプラインの開始後、スキーマを固定します。新しいフィールドは手動で追加する必要があります。このオプションを使用すると、ソーススキーマが更新された場合に宛先が同期されなくなる可能性があります。
詳細については、スキーマのレプリケーションとスキーマドリフトの管理を参照してください。
任意。同時実行制限フィールドに値を入力して、同時実行操作数の上限を設定します。 Workatoによって設定されたデフォルトの制限を使用するには、このフィールドを空白のままにします。最大値は100です。
Frequency(頻度)フィールドで、標準の時間ベースのスケジュールを選択するか、カスタムcron式を定義します。これにより、パイプラインがSurveyMonkeyから送信先にデータを同期する頻度が決まります。
SurveyMonkeyオブジェクトでは、開始日がオブジェクトごとに異なる形で適用されます。詳細はThe start date applies differently by objectを参照してください。
サポートされるオブジェクト
SurveyMonkeyのデータパイプラインは、SurveyMonkey REST API v3からデータを同期します。次の表に、サポートされているオブジェクトをカテゴリー別に示します。各オブジェクトは、宛先内の個別のテーブルとして同期されます。
アンケートおよびアンケート構造
| オブジェクト | 同期モード | 削除追跡 |
|---|---|---|
surveys | 完全同期、増分 | いいえ |
survey_pages | Full sync | はい |
survey_questions | Full sync | はい |
question_options | Full sync | はい |
question_sub_rows | Full sync | はい |
survey_pages、survey_questions、question_options、question_sub_rowsには、各アンケートの構造が保存されます。 question_optionsには各質問の選択肢が含まれ、question_sub_rowsには行列形式など複数行の質問の各行が含まれます。
レスポンス
survey_responsesとresponse_answersにはSurveyMonkeyの有料プランが必要です。詳細はResponses require a paid planを参照してください。
| オブジェクト | 同期モード | 削除追跡 |
|---|---|---|
survey_responses | 完全同期、増分 | いいえ |
response_answers | Full sync | はい |
response_answersには、各回答内の各解答ごとに1行のレコードが含まれます。選択された解答を選択肢テキストに解決するには、response_answersをquestion_optionsのquestion_idおよびchoice_id(question_options.idと一致)で結合します。
コレクター
| オブジェクト | 同期モード | 削除追跡 |
|---|---|---|
collectors | 完全同期、増分 | いいえ |
collector_recipients | Full sync | はい |
collector_recipientsには、メールおよびSMSコレクターの受信者のみが含まれます。ウェブリンクや埋め込みアンケートなど、その他のコレクタータイプには受信者リストがありません。
同期モード
SurveyMonkeyのデータパイプラインは、フル同期と増分同期をサポートしています。同期モードは、オブジェクトをパイプラインに追加する際にオブジェクトごとに設定します。
フル同期
フル同期では、選択したオブジェクトについて、SurveyMonkeyから利用可能なすべてのレコードを読み取ります。 SurveyMonkeyが最終更新タイムスタンプを公開していないため、アンケート構造オブジェクト、response_answers、collector_recipientsはフル同期を使用します。
すべてのSurveyMonkeyオブジェクトには主キーがあるため、フル同期では既存の宛先テーブルに対してマージが行われ、SurveyMonkeyで削除されたレコードもテーブル内に残ります。
増分同期
増分同期では、date_modifiedフィールドをカーソルとして使用し、最後に成功した実行以降に変更されたレコードのみを抽出します。
surveys: 前回の実行以降に更新されたアンケートを抽出します。survey_responses: アンケートごとに個別のカーソルを保持し、各実行で全アンケートをチェックするため、親アンケートが変更されていない場合でも、新規および編集済みの回答が同期されます。collectors: 前回の実行以降に更新されたコレクターを抽出します。
各増分実行では、ウィンドウ境界で変更されたレコードを取りこぼさないよう、前回ウィンドウの最後の5分間を再読み込みします。宛先側のアップサート動作により、主キーに基づいて再読み込みされたレコードの重複が排除されます。
削除追跡
SurveyMonkeyのAPIは、削除されたアンケート、回答、コレクターを報告しません。 Workatoは、次の方法で削除を追跡します。
- フル同期オブジェクト: SurveyMonkeyに存在しなくなったレコードを、宛先側で削除済みとしてマークします。削除は削除時点ではなく、次回のフル同期時に検出されます。
survey_questions: SurveyMonkeyは削除された質問もAPI内に保持し、そのvisibleフィールドをfalseに設定します。 Workatoは、これらの質問に対して_workato_is_deletedをtrueに設定します。- 増分オブジェクト:
surveys、survey_responses、collectorsについては削除が検出されません。増分実行では変更されたレコードのみを取得するため、削除されたレコードは宛先に残ります。
スキーマとデータ型の処理
SurveyMonkeyからデータを同期する際、スキーマおよびデータ型について次の点を考慮します。
ネストされたフィールド
ネストされている、または可変構造のフィールドは、SnowflakeのVARIANTなど、宛先のネイティブJSON型に格納されたJSONオブジェクトとして同期されます。これらのフィールドには、survey_questions上のheadings、answers、validationと、survey_responses上のmetadata、logic_path、page_path、custom_variablesが含まれます。 Workatoは、これらをフラット化して個別のカラムに分割しません。 custom_variablesのキーはアンケートごとに異なります。
タイムスタンプ
SurveyMonkeyは、アンケートのタイムスタンプをタイムゾーンオフセットなしで返し、回答およびコレクターのタイムスタンプはオフセット付きで返します。 Workatoは、surveys上のdate_createdおよびdate_modifiedを、タイムゾーンなしのUTCタイムスタンプとして同期します。同じフィールドは、survey_responsesおよびcollectorsではタイムゾーン付きタイムスタンプとして同期されます。
回答キー
response_answersは、response_id、question_id、row_id、col_id、choice_id、other_idから成る複合主キーを使用します。質問タイプに適用されないキー列には、nullではなく空文字列が格納されます。たとえば、単一選択質問ではrow_idおよびcol_idは空になります。
コレクター受信者のカスタムフィールド
collector_recipientsには、custom_field_1からcustom_field_6までのカスタムフィールド列が含まれており、SurveyMonkeyアカウント内の最初の6つのコンタクトカスタムフィールドに対応します。コネクションにcontacts_readスコープが付与されている場合、Workatoはこれらの列にアカウントのカスタムフィールドラベルを設定します。
合成列
Workatoは、survey_questionsの宛先テーブルに対し、次の合成カラムを追加します。
| 列 | タイプ | 目的 |
|---|---|---|
_workato_is_deleted | ブーリアン | SurveyMonkeyが質問を削除済みとしてマークした場合(visibleがfalse)、trueに設定されます。 |
機密データの処理
SurveyMonkeyオブジェクトには、個人を特定できる情報(PII)が含まれる可能性があります。次のオブジェクトには、一般的に機密フィールドが含まれています。
| オブジェクト | 機密フィールド |
|---|---|
survey_responses | first_name、last_name、email_address、ip_address、custom_value、custom_variables、metadata |
response_answers | テキスト |
collectors | email |
collector_recipients | email、phone_number、custom_field_1からcustom_field_6 |
response_answers.textには、自由記述式の解答が含まれ、氏名や連絡先情報などの個人情報が含まれる場合があります。 custom_variablesにはアンケートに渡した任意の値が含まれる可能性があり、metadataには回答者のリファラーURLやユーザーエージェントが含まれます。
パイプライン設定中にフィールドレベルのデータ保護でHashオプションを使用し、PIIが宛先に到達する前に保護します。詳細については、パイプラインを構成手順を参照してください。
制限事項
SurveyMonkeyをデータパイプラインのソースとして使用する場合、次の制限が適用されます。
回答には有料プランが必要
SurveyMonkeyは、回答の詳細を有料プランのアカウントにのみ提供します。無料プランアカウントでは、survey_responsesおよびresponse_answersの同期は失敗します。これらのオブジェクトをパイプラインから削除するか、SurveyMonkeyプランを有料プランにアップグレードしてください。
開始日はオブジェクトごとに異なる形で適用される
When first started, this pipeline should pick up records fromで指定した日付は、SurveyMonkeyオブジェクトに対して次のように適用されます。
- アンケートオブジェクト:
surveys、survey_pages、survey_questions、question_options、question_sub_rowsには、この日付以降に更新されたアンケートのみが含まれます。その結果、これらのアンケートが引き続き回答を収集中であっても、アンケート構造オブジェクトには古いアンケートは含まれません。 - 回答およびコレクター:
survey_responsesおよびcollectorsは、最初の増分同期時に、各レコードのdate_modified値にこの日付を適用します。これらのオブジェクトのフル同期では開始日は無視され、すべてのレコードが抽出されます。 - 解答および受信者:
response_answersおよびcollector_recipientsは開始日を無視し、毎回すべてのレコードを抽出します。
すべてのアンケートの構造を同期する場合は、このフィールドを空のままにします。
1,000問を超えるアンケート
SurveyMonkeyは、1,000問を超えるアンケートの構造を返しません。 Workatoは、これらのアンケートについてはアンケート構造オブジェクトの同期をスキップし、そのほかの同期を続行します。これらのアンケートに対するsurveysレコードは引き続き同期されます。
プレビュー回答は同期されない
survey_responsesおよびresponse_answersには、コレクタープレビュリンクやアンケートビルダーのプレビューモードから送信されたテスト回答は含まれません。手動入力や編集済みの回答を含め、それ以外のすべての回答は同期されます。
コレクター受信者データ
collector_recipientsには、受信者の名および姓は含まれません。これは、SurveyMonkeyが受信者一覧でこれらを返さないためです。カスタムフィールド値が同期されるのは、アカウント内の最初の6個のコンタクトカスタムフィールドのみです。
最小同期頻度
サポートされる最小同期間隔は15分です。
最終更新日: