SurveyMonkey コネクタリファレンス

備考

ベータ版

この機能はベータ版です。使用するには、ワークスペース管理者は プレビュー ページから Lakeflow Connect for SurveyMonkey を有効にする必要があります。Databricksのプレビューを管理するを参照してください。

Lakeflow Connect のマネージド SurveyMonkey コネクタは、default スキーマの 11 のソーステーブルをサポートしています。surveys、survey_details、および survey_responses テーブルは date_modified で増分同期され、他の 8 つのテーブルは完全更新を使用します。

サポートされているソーステーブル

SurveyMonkey コネクタは、すべて default ソーススキーマの下にある次のソーステーブルをサポートしています。

ソーステーブル	プライマリーキー	説明	同期モード	カーソルフィールド
`surveys`	`id`	認可ユーザーが所有するか、そのユーザーと共有されているアンケート（カウント、所有者、アンケート URL など）。	インクリメンタル	`date_modified`
`survey_details`	`id`	各調査のページと質問を含む、拡張された調査構造。	インクリメンタル	`date_modified`
`survey_collectors`	`id`	型、ステータス、応答カウントなど、各アンケートのコレクター。	フル更新のみ
`collectors`	`id`	サンキューページ、失格ページ、応答制限設定など、完全なコレクター設定。	フル更新のみ
`survey_responses`	`id`	回答、回答者のメタデータ、収集の詳細を含むアンケートの回答。	インクリメンタル	`date_modified`
`survey_folders`	`id`	各フォルダー内のアンケート数を含む、アカウント内のアンケートフォルダーを調査します。	フル更新のみ
`contacts`	`id`	アカウント内の連絡先（氏名、Eメールアドレス、電話番号を含む）。	フル更新のみ
`contact_lists`	`id`	アカウント内の連絡先リスト。	フル更新のみ
`contact_list_contacts`	`contact_list_id`, `id`	カスタムフィールドを含む、各コンタクトリストのコンタクト。	フル更新のみ
`collector_messages`	`collector_id`, `id`	タイプとステータスを含む、各コレクターの招待メッセージ。	フル更新のみ
`collector_recipients`	`collector_id`, `id`	各コレクターの招待の受信者（応答ステータスとメールステータスを含む）。	フル更新のみ

ソーステーブル	プライマリーキー	説明	同期モード	カーソルフィールド
`surveys`	`id`	認可ユーザーが所有するか、そのユーザーと共有されているアンケート（カウント、所有者、アンケート URL など）。	インクリメンタル	`date_modified`
`survey_details`	`id`	各調査のページと質問を含む、拡張された調査構造。	インクリメンタル	`date_modified`
`survey_collectors`	`id`	型、ステータス、応答カウントなど、各アンケートのコレクター。	フル更新のみ
`collectors`	`id`	サンキューページ、失格ページ、応答制限設定など、完全なコレクター設定。	フル更新のみ
`survey_responses`	`id`	回答、回答者のメタデータ、収集の詳細を含むアンケートの回答。	インクリメンタル	`date_modified`
`survey_folders`	`id`	各フォルダー内のアンケート数を含む、アカウント内のアンケートフォルダーを調査します。	フル更新のみ
`contacts`	`id`	アカウント内の連絡先（氏名、Eメールアドレス、電話番号を含む）。	フル更新のみ
`contact_lists`	`id`	アカウント内の連絡先リスト。	フル更新のみ
`contact_list_contacts`	`contact_list_id`, `id`	カスタムフィールドを含む、各コンタクトリストのコンタクト。	フル更新のみ
`collector_messages`	`collector_id`, `id`	タイプとステータスを含む、各コレクターの招待メッセージ。	フル更新のみ
`collector_recipients`	`collector_id`, `id`	各コレクターの招待の受信者（応答ステータスとメールステータスを含む）。	フル更新のみ

コネクターのオプション

使用方法については例をご覧ください。

オプション	Type	スコープ	必須	適用対象	説明
`start_datetime`	文字列 (`yyyy-MM-ddTHH:mm:ss`, UTC)	パイプライン	No	すべての増分テーブル（`surveys`、`survey_details`、`survey_responses`）	データを取り込む最も早い日付と時間。defaultは最初の同期の365日前です。各テーブルの最初の同期にのみ適用されます。以降の同期は、保存されたカーソルから再開されます。

オプション	Type	スコープ	必須	適用対象	説明
`start_datetime`	文字列 (`yyyy-MM-ddTHH:mm:ss`, UTC)	パイプライン	No	すべての増分テーブル（`surveys`、`survey_details`、`survey_responses`）	データを取り込む最も早い日付と時間。defaultは最初の同期の365日前です。各テーブルの最初の同期にのみ適用されます。以降の同期は、保存されたカーソルから再開されます。

アップグレード先テーブルのスキーマ

`surveys`

プライマリーキー: id

同期モード： 増分

カーソルフィールド： date_modified

フィールド	データ型
`id`	`STRING`
`title`	`STRING`
`nickname`	`STRING`
`language`	`STRING`
`category`	`STRING`
`theme_id`	`STRING`
`template_id`	`BIGINT`
`folder_id`	`STRING`
`question_count`	`BIGINT`
`page_count`	`BIGINT`
`response_count`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`is_owner`	`BOOLEAN`
`owner`	`STRING`
`footer`	`BOOLEAN`
`buttons_text`	`STRUCT<next_button STRING, prev_button STRING, exit_button STRING, done_button STRING>`
`custom_variables`	`VARIANT`
`href`	`STRING`
`analyze_url`	`STRING`
`edit_url`	`STRING`
`collect_url`	`STRING`
`summary_url`	`STRING`
`preview`	`STRING`

フィールド	データ型
`id`	`STRING`
`title`	`STRING`
`nickname`	`STRING`
`language`	`STRING`
`category`	`STRING`
`theme_id`	`STRING`
`template_id`	`BIGINT`
`folder_id`	`STRING`
`question_count`	`BIGINT`
`page_count`	`BIGINT`
`response_count`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`is_owner`	`BOOLEAN`
`owner`	`STRING`
`footer`	`BOOLEAN`
`buttons_text`	`STRUCT<next_button STRING, prev_button STRING, exit_button STRING, done_button STRING>`
`custom_variables`	`VARIANT`
`href`	`STRING`
`analyze_url`	`STRING`
`edit_url`	`STRING`
`collect_url`	`STRING`
`summary_url`	`STRING`
`preview`	`STRING`

注記

このテーブルにはVARIANT列があるため、slowly changing dimensions（SCD）タイプ2はサポートされていません。

`survey_details`

プライマリーキー: id

同期モード： 増分

カーソルフィールド： date_modified

フィールド	データ型
`id`	`STRING`
`title`	`STRING`
`nickname`	`STRING`
`language`	`STRING`
`folder_id`	`STRING`
`category`	`STRING`
`question_count`	`BIGINT`
`page_count`	`BIGINT`
`response_count`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`href`	`STRING`
`pages`	ARRAY<STRUCT<`id`: STRING, `title`: STRING, `description`: STRING, `position`: BIGINT, `question_count`: BIGINT, `href`: STRING, `questions`: ARRAY<STRUCT<`id`: STRING, `position`: BIGINT, `visible`: BOOLEAN, `family`: STRING, `subtype`: STRING, `layout`: STRING, `sorting`: STRING, `required`: STRING, `validation`: STRING, `forced_ranking`: BOOLEAN, `headings`: STRING, `answers`: STRING, `href`: STRING>>>>

フィールド	データ型
`id`	`STRING`
`title`	`STRING`
`nickname`	`STRING`
`language`	`STRING`
`folder_id`	`STRING`
`category`	`STRING`
`question_count`	`BIGINT`
`page_count`	`BIGINT`
`response_count`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`href`	`STRING`
`pages`	ARRAY<STRUCT<`id`: STRING, `title`: STRING, `description`: STRING, `position`: BIGINT, `question_count`: BIGINT, `href`: STRING, `questions`: ARRAY<STRUCT<`id`: STRING, `position`: BIGINT, `visible`: BOOLEAN, `family`: STRING, `subtype`: STRING, `layout`: STRING, `sorting`: STRING, `required`: STRING, `validation`: STRING, `forced_ranking`: BOOLEAN, `headings`: STRING, `answers`: STRING, `href`: STRING>>>>

`survey_collectors`

プライマリーキー: id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`survey_id`	`STRING`
`name`	`STRING`
`type`	`STRING`
`status`	`STRING`
`response_count`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`url`	`STRING`
`href`	`STRING`

`collectors`

プライマリーキー: id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`survey_id`	`STRING`
`status`	`STRING`
`type`	`STRING`
`name`	`STRING`
`thank_you_message`	`STRING`
`thank_you_page`	`VARIANT`
`disqualification_type`	`STRING`
`disqualification_message`	`STRING`
`disqualification_url`	`STRING`
`close_date`	`TIMESTAMP`
`closed_page_message`	`STRING`
`redirect_url`	`STRING`
`redirect_type`	`STRING`
`display_survey_results`	`BOOLEAN`
`edit_response_type`	`STRING`
`anonymous_type`	`STRING`
`allow_multiple_responses`	`BOOLEAN`
`password_enabled`	`BOOLEAN`
`respondent_authentication`	`BOOLEAN`
`response_limit`	`BIGINT`
`sender_email`	`STRING`
`response_count`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`url`	`STRING`
`href`	`STRING`

フィールド	データ型
`id`	`STRING`
`survey_id`	`STRING`
`status`	`STRING`
`type`	`STRING`
`name`	`STRING`
`thank_you_message`	`STRING`
`thank_you_page`	`VARIANT`
`disqualification_type`	`STRING`
`disqualification_message`	`STRING`
`disqualification_url`	`STRING`
`close_date`	`TIMESTAMP`
`closed_page_message`	`STRING`
`redirect_url`	`STRING`
`redirect_type`	`STRING`
`display_survey_results`	`BOOLEAN`
`edit_response_type`	`STRING`
`anonymous_type`	`STRING`
`allow_multiple_responses`	`BOOLEAN`
`password_enabled`	`BOOLEAN`
`respondent_authentication`	`BOOLEAN`
`response_limit`	`BIGINT`
`sender_email`	`STRING`
`response_count`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`url`	`STRING`
`href`	`STRING`

注記

このテーブルは、VARIANT列があるため、SCDタイプ2をサポートしません。

`survey_responses`

プライマリーキー: id

同期モード： 増分

カーソルフィールド： date_modified

フィールド	データ型
`id`	`STRING`
`survey_id`	`STRING`
`collector_id`	`STRING`
`recipient_id`	`STRING`
`collection_mode`	`STRING`
`response_status`	`STRING`
`custom_value`	`STRING`
`first_name`	`STRING`
`last_name`	`STRING`
`email_address`	`STRING`
`ip_address`	`STRING`
`language`	`STRING`
`total_time`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`logic_path`	`VARIANT`
`metadata`	`VARIANT`
`custom_variables`	`VARIANT`
`page_path`	`VARIANT`
`pages`	`VARIANT`
`edit_url`	`STRING`
`analyze_url`	`STRING`
`href`	`STRING`

フィールド	データ型
`id`	`STRING`
`survey_id`	`STRING`
`collector_id`	`STRING`
`recipient_id`	`STRING`
`collection_mode`	`STRING`
`response_status`	`STRING`
`custom_value`	`STRING`
`first_name`	`STRING`
`last_name`	`STRING`
`email_address`	`STRING`
`ip_address`	`STRING`
`language`	`STRING`
`total_time`	`BIGINT`
`date_created`	`TIMESTAMP`
`date_modified`	`TIMESTAMP`
`logic_path`	`VARIANT`
`metadata`	`VARIANT`
`custom_variables`	`VARIANT`
`page_path`	`VARIANT`
`pages`	`VARIANT`
`edit_url`	`STRING`
`analyze_url`	`STRING`
`href`	`STRING`

注記

このテーブルは、VARIANT列があるため、SCDタイプ2をサポートしません。

`survey_folders`

プライマリーキー: id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`title`	`STRING`
`num_surveys`	`BIGINT`
`href`	`STRING`

注記

データリージョン が ca に設定されている接続には、このテーブルを含めないでください。SurveyMonkey調査フォルダEndpointはカナダのユーザーには利用できないため、パイプラインの更新は失敗します。「SurveyMonkey調査フォルダAPIリファレンス」を参照してください。

`contacts`

プライマリーキー: id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`first_name`	`STRING`
`last_name`	`STRING`
`email`	`STRING`
`phone_number`	`STRING`
`href`	`STRING`

`contact_lists`

プライマリーキー: id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`name`	`STRING`
`href`	`STRING`

`contact_list_contacts`

主キー： contact_list_id、 id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`contact_list_id`	`STRING`
`first_name`	`STRING`
`last_name`	`STRING`
`email`	`STRING`
`phone_number`	`STRING`
`custom_fields`	`VARIANT`
`href`	`STRING`

注記

このテーブルは、VARIANT列があるため、SCDタイプ2をサポートしません。

`collector_messages`

主キー： collector_id、 id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`collector_id`	`STRING`
`type`	`STRING`
`status`	`STRING`
`href`	`STRING`

`collector_recipients`

主キー： collector_id、 id

同期モード： 完全更新のみ

フィールド	データ型
`id`	`STRING`
`collector_id`	`STRING`
`email`	`STRING`
`phone_number`	`STRING`
`survey_response_status`	`STRING`
`mail_status`	`STRING`
`custom_fields`	`VARIANT`
`remove_link`	`STRING`
`extra_fields`	`VARIANT`
`survey_link`	`STRING`
`href`	`STRING`

フィールド	データ型
`id`	`STRING`
`collector_id`	`STRING`
`email`	`STRING`
`phone_number`	`STRING`
`survey_response_status`	`STRING`
`mail_status`	`STRING`
`custom_fields`	`VARIANT`
`remove_link`	`STRING`
`extra_fields`	`VARIANT`
`survey_link`	`STRING`
`href`	`STRING`

注記

このテーブルは、VARIANT列があるため、SCDタイプ2をサポートしません。

必要なOAuth権限

SurveyMonkeyアプリには、次の範囲が必要です。接続はサインイン時にそれらすべてを要求するため、アプリの設定の スコープ でそれぞれをオンにします。情報については、 SurveyMonkey API スコープリファレンスを参照してください。

権限	必須条件
アンケートを表示 (`surveys_read`)	`surveys`、`survey_details`、`survey_folders`、およびコネクタが調査ごとに読み取るすべてのテーブル：`survey_collectors`、`collectors`、`survey_responses`、`collector_messages`、 `collector_recipients`
コレクターを表示 (`collectors_read`)	`survey_collectors`、`collectors`、`collector_messages`、 `collector_recipients`
連絡先の表示 (`contacts_read`)	`contacts`、`contact_lists`、 `contact_list_contacts`
応答を表示 (`responses_read`)	サインイン時にリクエストされました。それを直接必要とするテーブルはありません。
応答の詳細を表示 (`responses_read_detail`)	`survey_responses`

権限	必須条件
アンケートを表示 (`surveys_read`)	`surveys`、`survey_details`、`survey_folders`、およびコネクタが調査ごとに読み取るすべてのテーブル：`survey_collectors`、`collectors`、`survey_responses`、`collector_messages`、 `collector_recipients`
コレクターを表示 (`collectors_read`)	`survey_collectors`、`collectors`、`collector_messages`、 `collector_recipients`
連絡先の表示 (`contacts_read`)	`contacts`、`contact_lists`、 `contact_list_contacts`
応答を表示 (`responses_read`)	サインイン時にリクエストされました。それを直接必要とするテーブルはありません。
応答の詳細を表示 (`responses_read_detail`)	`survey_responses`

サポートされているソーステーブル​

コネクターのオプション​

アップグレード先テーブルのスキーマ​

surveys​

survey_details​

survey_collectors​

collectors​

survey_responses​

survey_folders​

contacts​

contact_lists​

contact_list_contacts​

collector_messages​

collector_recipients​

必要なOAuth権限​

サポートされているソーステーブル

コネクターのオプション

アップグレード先テーブルのスキーマ

`surveys`

`survey_details`

`survey_collectors`

`collectors`

`survey_responses`

`survey_folders`

`contacts`

`contact_lists`

`contact_list_contacts`

`collector_messages`

`collector_recipients`

必要なOAuth権限