SurveyMonkey への接続を追加

SurveyMonkey への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. SurveyMonkey アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSurveyMonkey コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

SurveyMonkey への接続

SurveyMonkey は、アンケートデータに接続する2つの方法を提供します。

• Basic 認証を使用するには、プライベートアプリケーションを登録して個人用アクセストークンを取得します。
• OAuth で接続するには、SurveyMonkey に付属している埋め込みOAuth 認証情報を使用するか、カスタムOAuth アプリケーションを作成します。 詳しくは、以下のOAuth 認証を参照してください。

SurveyMonkey への認証

Basic 認証

Basic 認証を使用するには、プライベートアプリケーションを登録して個人用アクセストークンを取得する必要があります。

個人用アクセストークンを取得したら、以下のプロパティを設定します。

• AuthScheme = AccessToken
• AccessToken = アプリケーション設定で生成されたAccessToken を入力。

OAuth 認証

SurveyMonkey は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーション からの接続を簡単にします。Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

すべての認証フローで、OAuth 経由で接続するにはAuthScheme をOAuth に設定する必要があります。（これは、接続に埋め込みOAuth 認証情報を使用するか、カスタムOAuth アプリケーションを作成するかに関係なく適用されます。）

以下のサブセクションでは、利用可能なOAuth フローでのSurveyMonkey への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

SurveyMonkey で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

The Sync App offers the possibility to select surveys as relational tables.

Creating Surveys

You can create your own Surveys by performing the following steps:

1. In SurveyMonkey, go to the home page and click "Create Survey" on the vertical navigation bar.
2. Either start a new survey from scratch or pick one of the many templates SurveyMonkey offers.
3. Design and create new questions for your survey.
4. When finished, pick one of the options to share your survey and start receiving data from it.

Selecting Responses from Your Survey

To access the responses to your surveys, append _Responses to your table name, MySurvey_Responses in the query below.

SELECT RespondentId, QuestionText, ChoiceId, ChoiceText, ChoiceWeight FROM MySurvey_Responses

Selecting Questions from Your Survey

To access your survey questions, append _Questions to your table name, MySurvey_Questions in the query below.

SELECT QuestionId, QuestionFamily, QuestionSubtype, QuestionText, AnswerText FROM MySurvey_Questions

このセクションでは、SurveyMonkey Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、SurveyMonkey にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

アカウント内の任意のアンケートや関連データにアクセスできます。CData Sync App は、SurveyMonkey API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。

これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単に拡張できるシンプルな形式のコンフィギュレーションファイルです。

クエリ処理の使用

Sync App は、SurveyMonkey API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをSync App 内で処理します。次のセクションでは、API の制限と要件を説明します。

ビュー

Sync App は、アンケートおよび分析をリレーショナルビュー としてモデル化します。ビューは、一般的には読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

SurveyMonkey Connector for CData Sync ビュー

Name	Description
CollectorMessages	Shows information regarding messages sent from a collector.
CollectorRecipients	Shows information regarding recipients of all or specific messages sent from a collector.
Collectors	Shows collector information.
CollectorStats	Shows statistics regarding all or specific messages sent from a collector.
ContactLists	Shows contact list information.
Contacts	Shows contact information.
Pages	Shows information regarding pages for a survey.
RollupQuestions	Shows rolled up individual stats information for a survey.
Rollups	Shows rolled up stats information for a survey.
SurveyQuestions	Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.
SurveyResponses	Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.
Surveys	Shows information regarding surveys.

Shows information regarding messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorMessages WHERE CollectorId = '175305200'

SELECT * FROM CollectorMessages WHERE CollectorId = '175305200' AND Id = '57071816'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the message.
CollectorId	String	The Id of the collector this message belongs to.
Status	String	The status of this message.
Type	String	Message type: 'invite', 'reminder', or 'thank_you'.
Subject	String	The subject of this message. Only available if resource is being queried by Id.
Body	String	The html body of this message. Only available if resource is being queried by Id.
DateCreated	Datetime	Date message was created. Only available if resource is being queried by Id.
ScheduledDate	Datetime	Date message is scheduled to be sent. If Null, message has not been scheduled to send. Only available if resource is being queried by Id.
EmbedFirstQuestion	Boolean	Whether to embed the first question to the message. Only available if resource is being queried by Id.
EditMessageLink	String	The link to the resource to edit this message. Only available if resource is being queried by Id.
IsBrandingEnabled	Boolean	Whether branding is enabled for this message. Only available if resource is being queried by Id.
IsScheduled	Boolean	Whether this message is scheduled. Only available if resource is being queried by Id.
RecipientStatus	String	Recipient filter: 'reminder' or 'thank_you'. Only available if resource is being queried by Id.

Shows information regarding recipients of all or specific messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200'

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND MessageId = '57071816'

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND Id = '4496877899'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the recipient.
CollectorId	String	The Id of the collector this recipient belongs to.
MessageId	String	The Id of the message this recipient belongs to. Null if it doesn't belong to a specific message.
Email	String	Email of recipient added to collector.
SurveyResponseStatus	String	If the recipient has completed the survey: 'not_responded', 'partially_responded', 'completely_responded'.
MailStatus	String	If an invite message to the recipient has been: 'sent', 'not_sent', or is 'processing'.
SurveyLink	String	Link to the survey in the invite.
RemoveLink	String	Unsubscribe link.

Shows collector information.

Table Specific Information

Select

You must specify the survey Id or the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM Collectors WHERE SurveyId = '126748712'

SELECT * FROM Collectors WHERE Id = '175305200'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the collector.
SurveyId	String	The Id of the Survey this collector belongs to. Only shows up if filtering Collectors by SurveyId.
Name	String	The name of the collector.
Status	String	Collector status: 'open' or 'closed'. Only available if resource is being queried by Id.
Type	String	Collector type: 'weblink' or 'email'. Only available if resource is being queried by Id.
ThankYouMessage	String	Message for thank you page. Only available if resource is being queried by Id.
DisqualificationMessage	String	Message for disqualification page. Only available if resource is being queried by Id.
ClosedPageMessage	String	Message shown when someone visits a closed survey. Only available if resource is being queried by Id.
DisplaySurveyResults	Boolean	Shows respondents survey instant results when they complete the survey. Only available if resource is being queried by Id.
EditResponseTypes	String	When respondents can edit their response: 'until_complete', 'never', or 'always'. Only available if resource is being queried by Id.
AnonymousType	String	Turns off IP tracking. For email collectors, also removes respondent email address and name from response: 'not_anonymous', 'partially_anonymous', 'fully_anonymous'. Only available if resource is being queried by Id.
SenderEmail	String	Sender email for email collectors. User's email is used if null. Only available if resource is being queried by Id.
Url	String	If collector is a Web Collector (type 'weblink') then the url for the collector. Only available if resource is being queried by Id.
RedirectType	String	Determines survey end page behavior: url (redirects to URL set in redirect_url or if none is set, shows standard SurveyMonkey thank you page), close (closes the survey window or tab), or loop (loops the survey back to the beginning, only available for weblink collectors with allow_multiple_responses:true). Only available if resource is being queried by Id.
RedirectUrl	String	Redirects respondent to this url upon survey completion. Only available if resource is being queried by Id.
AllowMultipleResponses	Boolean	Allows respondents to take a survey more than once from the same browser on the same computer. Only available for weblink collectors. Only available if resource is being queried by Id.
PasswordEnabled	Boolean	True if the collector is password protected. Only available for weblink collectors. Only available if resource is being queried by Id.
DateModified	Datetime	Date collector was last modified. Only available if resource is being queried by Id.
DateCreated	Datetime	Date collector was created. Only available if resource is being queried by Id.
CloseDate	Datetime	Close date of collector. Only available if resource is being queried by Id.

Shows statistics regarding all or specific messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorStats WHERE CollectorId = '175305200'

SELECT * FROM CollectorStats WHERE CollectorId = '175305200' AND MessageId = '57071816'

Columns

Name	Type	Description
CollectorId	String	The Id of the collector these statistics belongs to.
MessageId	String	The Id of the message these statistics belong to. Null if they don't belong to a specific message.
Recipients	Integer	Count of recipients included in the stats.
CompletelyResponded	Integer	Count of recipients who have completed a survey response.
NotResponded	Integer	Count of recipients who have not started the survey.
PartiallyResponded	Integer	Count of recipients who have begun the survey but not completed it.
Opened	Integer	Count of recipients that have opened the message.
OptedOut	Integer	Count of recipients that have clicked on the opt out link.
NotSent	Integer	Count of recipients that have been added but their message has not been delivered.
Sent	Integer	Count of recipients that messages have been sent to.
Bounced	Integer	Count of recipients with messages that bounced.
LinkClicked	Integer	Count of messages where the included survey link was clicked on.

Shows contact list information.

Select

The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM ContactLists WHERE Id = '123740269'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the contact list.
Name	String	The name of the contact list.

Shows contact information.

Select

The Sync App will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = '2842583326'

SELECT * FROM Contacts WHERE ContactListId = '123679423'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the contact.
ContactListId	String	Use this to filter contacts only from the given ContactListId.
FirstName	String	The first name of the contact.
LastName	String	The last name of the contact.
Email	String	The email of the contact.
CustomField1	String	The value of the first custom field for this contact.
CustomField2	String	The value of the second custom field for this contact.
CustomField3	String	The value of the third custom field for this contact.
CustomField4	String	The value of the fourth custom field for this contact.
CustomField5	String	The value of the fifth custom field for this contact.
CustomField6	String	The value of the sixth custom field for this contact.

Shows information regarding pages for a survey.

Table Specific Information

Select

You must specify the survey Id for this view to see page information for the survey. The Sync App will execute other filters client-side in memory.

For example, the following query is processed server side:

SELECT * FROM Pages WHERE SurveyId = '1231231'
 
SELECT * FROM Pages WHERE SurveyId = '1231231' AND Id = '1234567'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the page.
SurveyId	String	The Id of the survey.
Title	String	The title of the page.
Description	String	The description of the page.
Position	Integer	The ordinal position of the page.
QuestionCount	Integer	The number of questions in this page.

Shows rolled up individual stats information for a survey.

Select

You must specify the survey Id for this view to see roll up stats for the survey. The Sync App will execute other filters client-side in memory.

For example, the following query is processed server side:

SELECT * FROM RollupQuestions WHERE SurveyId = '1231231' 

Columns

Name	Type	Description
SurveyId	String	The Id of the survey.
QuestionId	String	The Id of the question
ResponseCount	Integer	Number of people which answered by selecting this choice.
ResponseTextCount	Integer	Number of people which answered by writing in a text.
ChoiceId	String	The Id of the response.
Other	Boolean	Whether the selected choice was an other response.
Ordinal	Int	The number of the order this choice appears in the list of choices. Ordinals are used to get a meaningful representation for stats like maximum, minimum, average, median, and standard deviation.
Max	Double	The maximum value of the ordinals of the answered choices.
Min	Double	The minimum value of the ordinals of the answered choices.
Mean	Double	The average value of the ordinals of the answered choices.
Median	Double	The median value of the ordinals of the answered choices.
Std	Double	The standard deviation value of the ordinals of the answered choices.

Shows rolled up stats information for a survey.

Table Specific Information

Select

You must specify the survey Id for this view to see roll up stats for the survey. The Sync App will execute other filters client-side in memory. For example, the following query is processed server side:

SELECT * FROM Rollups WHERE SurveyId = '1231231' 

Columns

Name	Type	Description
SurveyId	String	The id of the survey.
QuestionId	String	The id of the question
Family	String	The family this question belongs to.
Subtype	String	The subtype this question belongs to.
Answered	Integer	Number of people who answered this question by picking one of the given choices.
AnsweredOther	Integer	Number of people who answered this question by picking the other option.
Skipped	Integer	Number of people who skipped this question.

Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.

Select

To query the SurveyQuestions view, you must use the name of the survey and append '_Questions' to the end. For some question types when the specific id is not applicable the value will be represented as '0'

SELECT * FROM [Volunteer Feedback Template_Questions]

SELECT * FROM [Benefits Template_Questions]

Columns

Name	Type	Description
SurveyId	String	The id of the survey.
QuestionId	String	The id of the question.
QuestionPosition	Integer	The position of that query in the Survey.
QuestionText	String	The text of the question.
QuestionFamily	String	The family of the question.
QuestionSubtype	String	The subtype of the question.
ChoiceId	String	The id of the choice.
ChoiceText	String	The text of the choice.
ChoiceWeight	String	The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore	Int	This field is dynamic and maps to the corresponding report field.
RowId	String	The id of the row.
RowText	String	The text of the row.
ColId	String	The id of the column.
ColText	String	The text of the column.
PageId	String	The id of the page.
PageTitle	String	The title of the page.

Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.

Select

To query the SurveyResponses view, you must use the name of the survey and append '_Responses' to the end.

The Sync App uses the SurveyMonkey APIs to filter results by the following columns and operators:

• DateCreated/DateModified and TotalTime: > and <
• RespondentId: =
• QuestionId: = and IN
• ResponseStatus, IpAddress, and TotalTimeUnit: =

The Sync App processes other filters client-side within the Sync App.

For example, the following queries are processed server side:

SELECT * FROM [Volunteer Feedback Template_Responses]

SELECT * FROM [Benefits Template_Responses]

SELECT * FROM [Benefits Template_Responses] WHERE RespondentId = '1234567890'

SELECT * FROM [Benefits Template_Responses] WHERE RespondentId IN ('1234567890', '0987654321')

SELECT * FROM [Benefits Template_Responses] WHERE DateCreated > '2018-01-01' AND DateCreated < '2018-01-30'

SELECT * FROM [Benefits Template_Responses] WHERE QuestionId = '213965574'

SELECT * FROM [Benefits Template_Responses] WHERE QuestionId IN ('213965574', '213963957')

SELECT * FROM [Benefits Template_Responses] WHERE TotalTime > 5 AND TotalTime < 10 AND TotalTimeUnit = 'minute'

SELECT * FROM [Benefits Template_Responses] WHERE IpAddress = '192.168.0.1'

SELECT * FROM [Benefits Template_Responses] WHERE ResponseStatus = 'completed'

Note: When selecting a specific respondent, the aggregate column "Metadata" will be populated with a JsonObject and its elements can be accessed using the JSON_EXTRACT function in the SQLQuery.

Columns

Name	Type	Description
RespondentId	String	The id of the respondent, the person who answered this question.
SurveyId	String	The id of the survey.
RecipientId	String	The id of the recipient.
PageId	String	The id of the page.
QuestionId	String	The id of the question.
QuestionText	String	The text of the question.
ChoiceId	String	The id of the choice.
ChoiceText	String	The text of the choice.
ChoiceWeight	String	The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore	Int	This field is dynamic and maps to the corresponding report field.
IsCorrectChoice	Boolean	This field is dynamic and maps to the corresponding report field.
RowId	String	The id of the row.
RowText	String	The text of the row.
ColId	String	The id of the column.
ColText	String	The text of the column.
OtherId	String	The id of the other field.
OtherText	String	The text of the other field.
AnswerText	String	The text of the answer (in the case of an open-ended question).
CollectionMode	String	The mode of collection.
CollectorId	String	The id of the collector the response was taken for.
TotalTime	String	Total time spent on this survey.
ResponseStatus	String	The status of the response. Valid values are `completed`, `partial`, `overquota`, and `disqualified`.
DateCreated	Datetime	Date and time when survey was created.
DateModified	Datetime	Date and time when survey was last modified.
CustomValue	Integer	A custom value for this response.
EditUrl	String	Survey edit URL.
AnalyzeUrl	String	Survey analyze URL.
IpAddress	String	The IP address of the respondent.
QuizCorrectAnswers	Int	This field is dynamic and maps to the corresponding report field.
QuizIncorrectAnswers	Int	This field is dynamic and maps to the corresponding report field.
QuizPartiallyCorrectAnswers	Int	This field is dynamic and maps to the corresponding report field.
QuizTotalScore	Int	This field is dynamic and maps to the corresponding report field.
QuizTotalQuestions	Int	This field is dynamic and maps to the corresponding report field.
QuizMaxScore	Int	This field is dynamic and maps to the corresponding report field.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
TotalTimeUnit	String	The unit of time you want to filter total time values with. Valids units are `second`, `minute`, and `hour`. If not specified, it will use `second` as a default value. This only affects the filtering on SurveyMonkey's end. The values returned for TotalTime from the API will still be in seconds despite what value is being sent for TotalTimeUnit.

Shows information regarding surveys.

Columns

Name	Type	Description
Id [KEY]	String	The Id of the survey.
Title	String	The title of the survey.
Nickname	String	The nickname of the survey.
Category	String	The Category of the survey.
DateCreated	Datetime	The Date that the survey was created.
DateModified	Datetime	The Date that the survey was modified.
FolderId	String	If specified, adds the survey to the folder with that id.
IsOwner	Boolean	Is Owner of the survey.
Language	String	Language of the survey.
QuestionCount	Int	The number of questions in survey.
ResponseCount	Int	The number of responses survey has received.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to SurveyMonkey.
AccessToken	The Access Token of the SurveyMonkey application.

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope	The Scope supplied from the app settings.
AccessURL	The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account.

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	SurveyMonkey から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
ShowCustomVariables	A boolean determining if custom variables and their values should be listed when querying Survey_Responses.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to SurveyMonkey.
AccessToken	The Access Token of the SurveyMonkey application.

The type of authentication to use when connecting to SurveyMonkey.

解説

• OAuth: Set to this to perform OAuth authentication.
• AccessToken: Set this to perform Access Token authentication. Provide value for [AccessToken] connection property.

The Access Token of the SurveyMonkey application.

解説

The Access Token of the SurveyMonkey application.

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Scope	The Scope supplied from the app settings.
AccessURL	The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account.

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

The Scope supplied from the app settings.

解説

The Scope supplied from the app settings. Recommended to be specified when using a custom app.

The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account.

解説

The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account. By default takes the value returned when performing the GetOAuthAccessToken procedure. Change this if you are using the AccessToken AuthScheme and your accounts datacenter AccessURL is different from https://api.surveymonkey.net.

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はSurveyMonkey への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\SurveyMonkey Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

Platform	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	SurveyMonkey から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
ShowCustomVariables	A boolean determining if custom variables and their values should be listed when querying Survey_Responses.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

SurveyMonkey から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、SurveyMonkey から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

A boolean determining if custom variables and their values should be listed when querying Survey_Responses.

解説

A boolean determining if custom variables and their values should be listed when querying Survey_Responses.

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM MySurvey_Responses WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

指定されたパスは引用符で囲まれていないことに注意してください。

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

解説

SurveyMonkey テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。