CData Sync App は、Google Contacts データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
GoogleContacts コネクタはCData Sync アプリケーションから使用可能で、GoogleContacts からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、GoogleContacts への接続を作成します。GoogleContacts アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからGoogleContacts コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
各ユーザーやドメインの代わりに、Sync App がGoogle API にアクセスすることを許可します。
Google API への接続には、OAuth 認証標準を使用します。
Sync App は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。
以下のセクションでは、GoogleContacts の利用可能な認証スキームについて説明します。
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
アクセストークンとリフレッシュトークンを取得すると、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることができるようになります。
OAuth アクセストークンの自動リフレッシュ
ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。
GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
オプション1:Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定されたパスに暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
GCP 仮想マシン上で実行している場合は、Sync App は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。
このセクションでは、GoogleContacts Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、GoogleContacts にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、GoogleContacts API へのSQL の実行について詳しく説明します。
Sync App はGoogleContacts API をリレーショナルテーブル としてモデル化します。
ビュー は、GoogleContacts のいくつかの追加的なメタデータ情報を提供します。
ストアドプロシージャ は、GoogleContacts のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、GoogleContacts の操作を実行できます。
Sync App はGoogleContacts のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、GoogleContacts テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
Name | Description |
ContactGroups | Create, update, delete and query Contact Groups. |
Contacts | Set the name of this table to any of your ContactGroups(GroupName) to create, update, delete, and query Google contacts. |
Create, update, delete and query Contact Groups.
ContactGroups テーブルはWHERE 句でId およびMemberCount カラムをサポートしています。サポートされている演算子はId は '=, in'、MemberCount は'=' です。
次に例を示します。
SELECT * FROM [ContactGroups] WHERE Id = 'myContacts' SELECT * FROM [ContactGroups] WHERE Id = '45a15a878be3580a' SELECT * FROM [ContactGroups] WHERE Id = '4fe7dbbd0d26cc95' AND MemberCount = 10
新しいContactGroup の作成には、Name が必要です。ClientData カラムにデータを挿入することもできます。
INSERT INTO [ContactGroups] (Name) VALUES ('Contacts Group Test')
ContactGroup のClientData を挿入するには、#TEMP テーブルを使用するか、JSON 構造を作成して挿入する値を指定します。
INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 1','sfsdfsds45rf') INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 2','2jfk24g78w2jbdk') INSERT INTO ContactGroups (Name,ClientData) VALUES ('Insert ClientData to a Contact Group 2','ClientData#TEMP')
INSERT INTO ContactGroups (Name, ClientData) VALUES ('Testing Insert ClientData in Contact Group via client data columns','[{"key": "Client Data 1","value": "sdfjkbq36"},{"key": "Client Data 2","value": "df32jkbk"}]')
ContactGroups 行のName、ClientData を更新することが可能です(My Contacts、Coworkers、およびFriends などのシステムグループ(GroupType As SYSTEM_CONTACT_GROUP)を除く)。
UPDATE [ContactGroups] SET Name = 'Salsa Friends' WHERE Id = '674ddb258de3ef81'
ContactGroup の削除には、Id が必要です。
DELETE FROM [ContactGroups] WHERE Id = '674ddb258de3ef81'
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the contact group. |
ResourceName | String | True |
The ResourceName of the contact group. |
ETag | String | True |
The HTTP entity tag of the resource. |
Name | String | False |
The name of the contact group. |
GroupType | String | True |
The contact group type. |
FormattedName | String | True |
The group name formatted in the viewer's account locale. |
MemberCount | Integer | True |
The total number of contacts in the group irrespective of max members in specified in the request. |
MemberResourceNames | String | True |
The list of contact person resource names that are members of the contact group. |
MetadataUpdatedTime | Datetime | True |
The metadata of the contact group. |
MetadataDeleted | Boolean | True |
The metadata of the contact group. |
ClientData | String | False |
The group's client data. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ClientDataKey | String |
The client specified key of the client data. |
ClientDataValue | String |
The client specified value of the client data. |
Set the name of this table to any of your ContactGroups(GroupName) to create, update, delete, and query Google contacts.
Contact テーブルはWHERE 句でId をサポートしています。Id でサポートされている演算子は'=, IN' です。
例:
SELECT * FROM [My Contacts] WHERE Id = '567931ee88efc109' SELECT * FROM [My Contacts] WHERE Id IN ('567931ee88efc109','79733d1ee88efc109') SELECT * FROM [My Contacts] WHERE SearchTerms = 'Yash'
Contacts テーブルには、read-only でない限り、どの項目でも挿入が可能です。セミコロンで区切られたいくつかの特定のフィールドに複数の値を追加できます。
INSERT INTO [My Contacts](GivenName, FamilyName, HomeEmailAddresses, WorkEmailAddresses, WorkPhoneNumbers, HomePhoneNumbers, HomeAddresses) VALUES ('Elizabeth', 'Bennet', '[email protected]', '[email protected]', '(206)555-1212' , '(206)555-1213', '1600 Amphitheatre Pkwy Mountain View')
連絡先に組織の詳細を挿入するには、#Temp テーブルを使用して組織のフィールドを挿入します。組織のフィールドはContactOrganaizations ビューに表示されます。
例:
INSERT INTO ContactOrganizations#TEMP (Current, Department, Domain, JobDescrption, Location, Name, StartDate) VALUES (true, 'Engineering', 'QA', 'Big Data Engineer', 'Bangalore', 'Tech Mahindra', '2021-03-01') INSERT INTO ContactOrganizations#TEMP (Current, Department, Domain, JobDescrption, Location, Name, StartDate, EndDate) VALUES (false, 'Engineering', 'QA', 'Software Consultant', 'Bangalore', 'CData', '2019-05-23', '2020-02-17') INSERT INTO [My Contacts] (GivenName, Organizations) VALUES ('Karan', 'ContactOrganizations#TEMP')
複数の連絡先を一度に挿入するには、#TEMP テーブルを使用して挿入します。
例:
INSERT INTO MyContacts#TEMP (GivenName, FamilyName, HomeAddresses) VALUES ('Ankit', 'Singh', 'Bangalore India; Indore India') INSERT INTO MyContacts#TEMP (GivenName, MiddleName, HomeAddresses) VALUES ('Aman', '', 'Bangalore India; Indore India') INSERT INTO [My Contacts] (GivenName,HomeAddresses) SELECT GivenName,HomeAddresses FROM MyContacts#TEMP
Contacts テーブルには、read-only でない限り、どの項目でも更新が可能です。セミコロンで区切られたいくつかの特定のフィールドに複数の値を追加できます。
UPDATE [My Contacts] SET GivenName = 'Elizabeth', FamilyName = 'Bennet', MobilePhoneNumbers = '+355696969999;+355676555001' WHERE Id = '48b8b9158b1db34d' UPDATE [My Contacts] SET HomeAddresses='Electronic City Bangalore India; Brilliant Solitaire Indore India' WHERE Id='c6545017396039868174'
複数の連絡先の詳細を一度に更新するには、#TEMP テーブルを使用します。
例:
INSERT INTO MyContacts#TEMP (Id, GivenName, HomeAddresses) VALUES ('c9197613024342508599','Ankit','Bangalore India; Indore India') INSERT INTO MyContacts#TEMP (Id, GivenName, HomeAddresses) VALUES ('c2042847992816525584','Aman','Bangalore India; Indore India') UPDATE [My Contacts] (Id, GivenName, HomeAddresses) SELECT Id, GivenName, HomeAddresses FROM MyContacts#TEMP
連絡先の削除には、Id が必要です。
DELETE FROM [My Contacts] WHERE Id = '567931ee88efc109'
複数の連絡先を一度に削除するには、#TEMP テーブルを使用します。
例:
INSERT INTO MyContacts#TEMP(Id) VALUES ('c9197613024342508599') Insert INTO MyContacts#TEMP(Id) VALUES ('c2042847992816525584') DELETE FROM [My Contacts] WHERE EXISTS SELECT Id FROM MyContacts#TEMP
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the contact. |
ResourceName | String | True |
The ResourceName of the contact. |
Etag | String | True |
The ETag of the resource. (Note that the quotation marks are part of the ETag.) |
NamePrefix | String | True |
The honorific prefixes, such as Mrs. or Dr. |
FullName | String | True |
The display name formatted according to the locale specified by the viewer's account |
GivenName | String | False |
The given name of the contact. |
MiddleName | String | False |
The middle name of the contact. |
FamilyName | String | False |
The family name of the contact. |
NameSuffix | String | False |
The honorific suffixes, such as Jr. |
PhoneticNamePrefix | String | True |
The Phonetic honorific prefixes, such as Mrs. or Dr. |
PhoneticFullName | String | False |
The Phonetic display name formatted according to the locale specified by the viewer's account. |
PhoneticGivenName | String | False |
The Phonetic given name of the contact. |
PhoneticMiddleName | String | False |
The Phonetic middle name of the contact. |
PhoneticFamilyName | String | False |
The Phonetic family name of the contact. |
PhoneticNameSuffix | String | False |
The Phonetic honorific suffixes, such as Jr. |
NickNames | String | False |
The nickname of the contact. |
Birthday | Date | False |
The birthday of the contact. The format of the date is yyyy-mm-dd. |
GenderAddressMeAs | String | False |
The type of pronoun that should be used to address the contact. |
Gender | String | False |
The gender for the contact. |
Photos | String | True |
The contact's photo. |
UnlabeledEmailAddresses | String | False |
The unlabeled email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
HomeEmailAddresses | String | False |
The home email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
WorkEmailAddresses | String | False |
The work email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
OtherEmailAddresses | String | False |
The other email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
CustomEmailAddressTypes | String | False |
The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by semi-colon. |
CustomEmailAddresses | String | False |
The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by semi-colon. |
UnlabeledPhoneNumbers | String | False |
The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
HomePhoneNumbers | String | False |
The home phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkPhoneNumbers | String | False |
The work phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
MobilePhoneNumbers | String | False |
The mobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
OtherPhoneNumbers | String | False |
The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
HomeFaxes | String | False |
The workFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkFaxes | String | False |
The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
OtherFaxes | String | False |
The pager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
Pagers | String | False |
The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkMobilePhoneNumbers | String | False |
The workPager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkPagers | String | False |
The main phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
MainPhoneNumbers | String | False |
The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
GoogleVoicePhoneNumbers | String | False |
The other phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
CustomPhoneNumberTypes | String | False |
The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by semi-colon. |
CustomPhoneNumbers | String | False |
The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by semi-colon. |
UnlabeledAddresses | String | False |
The unlabeled addresses of the contact. Multiple addresses should be separated by semi-colon. |
HomeAddresses | String | False |
The home addresses of the contact. Multiple addresses should be separated by semi-colon. |
WorkAddresses | String | False |
The work addresses of the contact. Multiple addresses should be separated by semi-colon. |
OtherAddresses | String | False |
The other addresses of the contact. Multiple addresses should be separated by semi-colon. |
CustomAddressTypes | String | False |
The custom type of the address. This attribute should be used along with CustomAddresses. Multiple custom types should be separated by semi-colon. |
CustomAddresses | String | False |
The custom value of the address. This attribute should be used along with CustomAddressTypes. Multiple custom emailAddresses should be separated by semi-colon. |
AgeRanges | String | True |
An age range of a contact. |
Biography | String | False |
The short biography of the contact. |
BiographyContentType | String | False |
The content type of the biography of the contact. |
HomeCalendarUrls | String | True |
The home calendar urls of the contact. Multiple calendar urls should be separated by semi-colon. |
FreeBusyCalendarUrls | String | True |
The freeBusy calendar urls of the contact. Multiple calendar urls should be separated by semi-colon. |
WorkCalendarUrls | String | True |
The work calendar urls of the contact. Multiple calendar urls should be separated by semi-colon. |
CustomCalendarUrlTypes | String | True |
The custom type of the address. This attribute should be used along with CustomCalendarUrls. Multiple custom types should be separated by semi-colon. |
CustomCalendarUrls | String | True |
The custom value of the address. This attribute should be used along with CustomCalendarUrlTypes. Multiple custom calendar urls should be separated by semi-colon. |
ClientData | String | False |
The group's client data. |
CoverPhotos | String | True |
A contact's cover photo. |
UnlabeledEvents | String | False |
The dates of unlabeled events. Multiple dates should be separated by semi-colon. |
AnniversaryEvents | String | False |
The dates of anniversary events. Multiple dates should be separated by semi-colon. |
OtherEvents | String | False |
The dates of other events. Multiple dates should be separated by semi-colon. |
CustomEventTypes | String | False |
The custom type of an event. Multiple types should be separated by semi-colon. |
CustomEvents | String | False |
The custom value of an event. Multiple custom event dates should be separated by semi-colon. |
AccountExternalIds | String | False |
The account externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
CustomerExternalIds | String | False |
The customer externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
LoginIdExternalIds | String | False |
The loginId externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
NetworkExternalIds | String | False |
The network externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
OrganizationExternalIds | String | False |
The organization externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
CustomExternalIdTypes | String | False |
The custom type of the externalId. This attribute should be used along with CustomExternalIds. Multiple types should be separated by semi-colon. |
CustomExternalIds | String | False |
The custom value of the externalId. This attribute should be used along with CustomExternalIdTypes. Multiple externalIds should be separated by semi-colon. |
FileAses | String | True |
The name that should be used to sort the contact in a list. |
ImClientsProtocols | String | True |
The semi-colon separated list of ImClients Protocols. Multiple protocols should be separated by semi-colon. |
ImClientsUsernames | String | True |
The semi-colon separated list of ImClients Usernames. Multiple usernames should be separated by semi-colon. |
Interests | String | False |
The contact's interests. |
Locales | String | False |
The contact's locales. |
DeskLocations | String | False |
The desk locations of the contact. Multiple locations should be separated by semi-colon. |
GrewUpLocations | String | False |
The grewUp locations of the contact. Multiple locations should be separated by semi-colon. |
CustomLocationTypes | String | False |
The custom types of the location. The attribute should be used along with CustomLocations. Multiple locations should be separated by semi-colon. |
CustomLocations | String | False |
The custom value of the location. The attribute should be used along with CustomLocationsTypes. Multiple locations should be separated by semi-colon. |
Memberships | String | True |
The resource name for the contact group, assigned by the server. Only contactGroupResourceName can be used for modifying memberships. Any contact group membership can be removed, but only user group or 'myContacts' or 'starred' system groups memberships can be added. A contact must always have at least one contact group membership. |
MiscKeywordTypes | String | False |
The miscellaneous keyword types. Multiple types should be separated by semi-colon. Allowed Values are : TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER 使用できる値は次のとおりです。TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER |
MiscKeywordValues | String | False |
The miscellaneous keywords. Multiple miscellaneous keywords should be separated by semi-colon. |
Occupations | String | False |
The contact's occupations |
Organizations | String | False |
The organizations of the contact. |
RelationshipTypes | String | True |
The contact's relation to the other person. This attribute should be used along with RelationValues. Multiple types should be separated by semi-colon. |
RelationshipValues | String | True |
The name of the other person this relation refers to. This attribute should be used along with RelationTypes. Multiple names should be separated by semi-colon. |
UnlabeledSipAddresses | String | False |
The dates of anniversary events. Multiple dates should be separated by semi-colon. |
HomeSipAddresses | String | False |
The home sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
WorkSipAddresses | String | False |
The work sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
MobileSipAddresses | String | False |
The mobile sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
OtherSipAddresses | String | False |
The other sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
CustomSipAddressTypes | String | False |
The custom type of the sipAddress. This attribute should be used along with CustomSipAddresses. Multiple types should be separated by semi-colon. |
CustomSipAddresses | String | False |
The custom value of the sipAddress. This attribute should be used along with CustomSipAddressTypes. Multiple sipAddresses should be separated by semi-colon. |
Skills | String | True |
The skills that the contact has. |
UnlabeledUrls | String | False |
The unlabeled website urls of the contact. Multiple urls should be separated by semi-colon. |
HomeUrls | String | False |
The home website urls of the contact. Multiple urls should be separated by semi-colon. |
WorkUrls | String | False |
The work website urls of the contact. Multiple urls should be separated by semi-colon. |
BlogUrls | String | False |
The blog website urls of the contact. Multiple urls should be separated by semi-colon. |
ProfileUrls | String | False |
The profile website urls of the contact. Multiple urls should be separated by semi-colon. |
HomePageUrls | String | False |
The homePage website urls of the contact. Multiple urls should be separated by semi-colon. |
FtpUrls | String | False |
The ftp website urls of the contact. Multiple urls should be separated by semi-colon. |
ReservationsUrls | String | False |
The reservations website urls of the contact. Multiple urls should be separated by semi-colon. |
OtherUrls | String | False |
The appInstall Page website urls of the contact. Multiple urls should be separated by semi-colon. |
AppInstallPageUrls | String | False |
The other website urls of the contact. Multiple urls should be separated by semi-colon. |
CustomUrlTypes | String | False |
The custom type of the website url. This attribute values should be used along with CustomUrls. Multiple urls should be separated by semi-colon. |
CustomUrls | String | False |
The custom value of the website url. This attribute values should be used along with CustomUrlTypes. Multiple urls should be separated by semi-colon. |
UnlabeledCountry | String | True |
The unlabeled country of the contact. Multiple addresses should be separated by semi-colon. |
UnlabeledCity | String | True |
The unlabeled city of the contact. Multiple addresses should be separated by semi-colon. |
UnlabeledCountryCode | String | True |
The unlabeled country code of the contact. Multiple addresses should be separated by semi-colon. |
UnlabeledExtendedAddress | String | True |
The unlabeled extended address of the contact. Multiple addresses should be separated by semi-colon. |
UnlabeledPostalCode | String | True |
The unlabeled postal code of the contact. Multiple addresses should be separated by semi-colon. |
UnlabeledRegion | String | True |
The unlabeled region of the contact. Multiple addresses should be separated by semi-colon. |
UnlabeledStreetAddress | String | True |
The unlabeled street address of the contact. Multiple addresses should be separated by semi-colon. |
HomeCountry | String | True |
The home country of the contact. Multiple addresses should be separated by semi-colon. |
HomeCity | String | True |
The home city of the contact. Multiple addresses should be separated by semi-colon. |
HomeCountryCode | String | True |
The home country code of the contact. Multiple addresses should be separated by semi-colon. |
HomeExtendedAddress | String | True |
The home extended address of the contact. Multiple addresses should be separated by semi-colon. |
HomePostalCode | String | True |
The home postal code of the contact. Multiple addresses should be separated by semi-colon. |
HomeRegion | String | True |
The home region of the contact. Multiple addresses should be separated by semi-colon. |
HomeStreetAddress | String | True |
The home street address of the contact. Multiple addresses should be separated by semi-colon. |
WorkCountry | String | True |
The work country of the contact. Multiple addresses should be separated by semi-colon. |
WorkCity | String | True |
The work city of the contact. Multiple addresses should be separated by semi-colon. |
WorkCountryCode | String | True |
The work country code of the contact. Multiple addresses should be separated by semi-colon. |
WorkExtendedAddress | String | True |
The work extended address of the contact. Multiple addresses should be separated by semi-colon. |
WorkPostalCode | String | True |
The work postal code of the contact. Multiple addresses should be separated by semi-colon. |
WorkRegion | String | True |
The work region of the contact. Multiple addresses should be separated by semi-colon. |
WorkStreetAddress | String | True |
The work street address of the contact. Multiple addresses should be separated by semi-colon. |
OtherCountry | String | True |
The other country of the contact. Multiple addresses should be separated by semi-colon. |
OtherCity | String | True |
The other city of the contact. Multiple addresses should be separated by semi-colon. |
OtherCountryCode | String | True |
The other country code of the contact. Multiple addresses should be separated by semi-colon. |
OtherExtendedAddress | String | True |
The other extended address of the contact. Multiple addresses should be separated by semi-colon. |
OtherPostalCode | String | True |
The other postal code of the contact. Multiple addresses should be separated by semi-colon. |
OtherRegion | String | True |
The other region of the contact. Multiple addresses should be separated by semi-colon. |
OtherStreetAddress | String | True |
The other street address of the contact. Multiple addresses should be separated by semi-colon. |
CustomCountry | String | True |
The custom country of the contact. Multiple addresses should be separated by semi-colon. |
CustomCity | String | True |
The custom city of the contact. Multiple addresses should be separated by semi-colon. |
CustomCountryCode | String | True |
The custom country code of the contact. Multiple addresses should be separated by semi-colon. |
CustomExtendedAddress | String | True |
The custom extended address of the contact. Multiple addresses should be separated by semi-colon. |
CustomPostalCode | String | True |
The custom postal code of the contact. Multiple addresses should be separated by semi-colon. |
CustomRegion | String | True |
The custom region of the contact. Multiple addresses should be separated by semi-colon. |
CustomStreetAddress | String | True |
The custom street address of the contact. Multiple addresses should be separated by semi-colon. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
SearchTerms | String |
The query matches on a contact's names, nickNames, emailAddresses, phoneNumbers, and organizations fields that are from the CONTACT source. Maximum 10 matching rows will be returned. |
ClientDataKey | String |
The client specified key of the client data. |
ClientDataValue | String |
The client specified value of the client data. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
Name | Description |
ContactOrganizations | This view specifies all the details of the Contact's Organizations |
GroupMembers | Query contact group resource names |
OtherContacts | The view specifies all the details of Other Contacts |
PeopleConnections | This view specifies all the details of People Connections |
This view specifies all the details of the Contact's Organizations
ContactOrganizations ビューはWHERE 句でId カラムをサポートしています。Id でサポートされている演算子は'=, IN' です。
例:
SELECT * FROM [ContactOrganizations] WHERE Id = '567931ee88efc109' SELECT * FROM [ContactOrganizations] WHERE Id IN ('567931ee88efc109','79733d1ee88efc109')
Name | Type | Description |
Id | String | The Id of the contact. |
ResourceName | String | The resource name of the contact. |
Current | Boolean | True if organization is the person's current organization |
Department | String | The person's department at the organization. |
Domain | String | The domain name associated with the organization |
FormattedType | String | The type of the organization translated and formatted in the viewer's account locale |
JobDescription | String | The person's job description at the organization. |
Location | String | The location of the organization office the person works at. |
Name | String | The name of the organization. |
PhoneticName | String | The phonetic name of the organization. |
StartDate | Date | The start date when the person joined the organization. |
EndDate | Date | The end date when the person left the organization. |
Symbol | String | The symbol associated with the organization. |
Title | String | The contact's job title at the organization. |
Type | String | The type of the organization. |
Query contact group resource names
GroupMembers ビューはWHERE 句でId およびMemberCount カラムをサポートしています。このビューにはId が必須です。
次に例を示します。
SELECT * FROM [GroupMembers] WHERE Id = '4fe7dbbd0d26cc95'
Name | Type | Description |
Id | String | The Id of the contact group. |
MemberCount | Integer | The total number of contacts in the group irrespective of max members in specified in the request. |
ContactId | String | The list of contact person resource names that are members of the contact group. |
The view specifies all the details of Other Contacts
SELECT * FROM [OtherContacts] WHERE SearchTerms = 'Yash'
Name | Type | Description |
Id [KEY] | String | The Id of the contact. |
ResourceName | String | The ResourceName of the contact. |
Etag | String | The ETag of the resource. (Note that the quotation marks are part of the ETag.) |
NamePrefix | String | The honorific prefixes, such as Mrs. or Dr. |
FullName | String | The display name formatted according to the locale specified by the viewer's account |
GivenName | String | The given name of the contact. |
MiddleName | String | The middle name of the contact. |
FamilyName | String | The family name of the contact. |
NameSuffix | String | The honorific suffixes, such as Jr. |
PhoneticNamePrefix | String | The Phonetic honorific prefixes, such as Mrs. or Dr. |
PhoneticFullName | String | The Phonetic display name formatted according to the locale specified by the viewer's account. |
PhoneticGivenName | String | The Phonetic given name of the contact. |
PhoneticMiddleName | String | The Phonetic middle name of the contact. |
PhoneticFamilyName | String | The Phonetic family name of the contact. |
PhoneticNameSuffix | String | The Phonetic honorific suffixes, such as Jr. |
UnlabeledEmailAddresses | String | The unlabeled email addresses of the contact. Multiple email addresses should be separated by comma. |
HomeEmailAddresses | String | The home email addresses of the contact. Multiple email addresses should be separated by comma. |
WorkEmailAddresses | String | The work email addresses of the contact. Multiple email addresses should be separated by comma. |
OtherEmailAddresses | String | The other email addresses of the contact. Multiple email addresses should be separated by comma. |
CustomEmailAddressTypes | String | The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by comma. |
CustomEmailAddresses | String | The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by comma. |
UnlabeledPhoneNumbers | String | The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
HomePhoneNumbers | String | The home phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
WorkPhoneNumbers | String | The work phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
MobilePhoneNumbers | String | The mobile phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
HomeFaxes | String | The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
WorkFaxes | String | The workFax phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
OtherFaxes | String | The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
Pagers | String | The pager phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
WorkMobilePhoneNumbers | String | The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
WorkPagers | String | The workPager phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
MainPhoneNumbers | String | The main phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
GoogleVoicePhoneNumbers | String | The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
OtherPhoneNumbers | String | The other phone numbers of the contacts. Multiple phone numbers should be separated by comma. |
CustomPhoneNumberTypes | String | The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by comma. |
CustomPhoneNumbers | String | The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by comma. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
SearchTerms | String | The query matches on a contact's names, emailAddresses, and phoneNumbers fields that are from the OTHER_CONTACT source. Maximum 10 matching rows will be returned. |
This view specifies all the details of People Connections
Name | Type | Description |
Id [KEY] | String | The Id of the contact. |
ResourceName | String | The ResourceName of the contact. |
Etag | String | The ETag of the resource. (Note that the quotation marks are part of the ETag.) |
NamePrefix | String | The honorific prefixes, such as Mrs. or Dr. |
FullName | String | The display name formatted according to the locale specified by the viewer's account |
GivenName | String | The given name of the contact. |
MiddleName | String | The middle name of the contact. |
FamilyName | String | The family name of the contact. |
NameSuffix | String | The honorific suffixes, such as Jr. |
PhoneticNamePrefix | String | The Phonetic honorific prefixes, such as Mrs. or Dr. |
PhoneticFullName | String | The Phonetic display name formatted according to the locale specified by the viewer's account. |
PhoneticGivenName | String | The Phonetic given name of the contact. |
PhoneticMiddleName | String | The Phonetic middle name of the contact. |
PhoneticFamilyName | String | The Phonetic family name of the contact. |
PhoneticNameSuffix | String | The Phonetic honorific suffixes, such as Jr. |
NickNames | String | The nickname of the contact. |
Birthday | Date | The birthday of the contact. The format of the date is yyyy-mm-dd. |
GenderAddressMeAs | String | The type of pronoun that should be used to address the contact. |
Gender | String | The gender for the contact. |
Photos | String | The contact's photo. |
UnlabeledEmailAddresses | String | The unlabeled email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
HomeEmailAddresses | String | The home email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
WorkEmailAddresses | String | The work email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
OtherEmailAddresses | String | The other email addresses of the contact. Multiple email addresses should be separated by semi-colon. |
CustomEmailAddressTypes | String | The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by semi-colon. |
CustomEmailAddresses | String | The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by semi-colon. |
UnlabeledPhoneNumbers | String | The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
HomePhoneNumbers | String | The home phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkPhoneNumbers | String | The work phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
MobilePhoneNumbers | String | The mobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
OtherPhoneNumbers | String | The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
HomeFaxes | String | The workFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkFaxes | String | The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
OtherFaxes | String | The pager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
Pagers | String | The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkMobilePhoneNumbers | String | The workPager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
WorkPagers | String | The main phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
MainPhoneNumbers | String | The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
GoogleVoicePhoneNumbers | String | The other phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon. |
CustomPhoneNumberTypes | String | The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by semi-colon. |
CustomPhoneNumbers | String | The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by semi-colon. |
UnlabeledAddresses | String | The unlabeled addresses of the contact. Multiple addresses should be separated by semi-colon. |
HomeAddresses | String | The home addresses of the contact. Multiple addresses should be separated by semi-colon. |
WorkAddresses | String | The work addresses of the contact. Multiple addresses should be separated by semi-colon. |
OtherAddresses | String | The other addresses of the contact. Multiple addresses should be separated by semi-colon. |
CustomAddressTypes | String | The custom type of the address. This attribute should be used along with CustomAddresses. Multiple custom types should be separated by semi-colon. |
CustomAddresses | String | The custom value of the address. This attribute should be used along with CustomAddressTypes. Multiple custom emailAddresses should be separated by semi-colon. |
AgeRanges | String | An age range of a contact. |
Biography | String | The short biography of the contact. |
BiographyContentType | String | The content type of the biography of the contact. |
HomeCalendarUrls | String | The home calendar urls of the contact. Multiple calendar urls should be separated by semi-colon. |
FreeBusyCalendarUrls | String | The freeBusy calendar urls of the contact. Multiple calendar urls should be separated by semi-colon. |
WorkCalendarUrls | String | The work calendar urls of the contact. Multiple calendar urls should be separated by semi-colon. |
CustomCalendarUrlTypes | String | The custom type of the address. This attribute should be used along with CustomCalendarUrls. Multiple custom types should be separated by semi-colon. |
CustomCalendarUrls | String | The custom value of the address. This attribute should be used along with CustomCalendarUrlTypes. Multiple custom calendar urls should be separated by semi-colon. |
ClientData | String | The group's client data. |
CoverPhotos | String | A contact's cover photo. |
UnlabeledEvents | String | The dates of unlabeled events. Multiple dates should be separated by semi-colon. |
AnniversaryEvents | String | The dates of anniversary events. Multiple dates should be separated by semi-colon. |
OtherEvents | String | The dates of other events. Multiple dates should be separated by semi-colon. |
CustomEventTypes | String | The custom type of an event. Multiple types should be separated by semi-colon. |
CustomEvents | String | The custom value of an event. Multiple custom event dates should be separated by semi-colon. |
AccountExternalIds | String | The account externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
CustomerExternalIds | String | The customer externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
LoginIdExternalIds | String | The loginId externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
NetworkExternalIds | String | The network externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
OrganizationExternalIds | String | The organization externalIds of the contact. Multiple externalIds should be separated by semi-colon. |
CustomExternalIdTypes | String | The custom type of the externalId. This attribute should be used along with CustomExternalIds. Multiple types should be separated by semi-colon. |
CustomExternalIds | String | The custom value of the externalId. This attribute should be used along with CustomExternalIdTypes. Multiple externalIds should be separated by semi-colon. |
FileAses | String | The name that should be used to sort the contact in a list. |
ImClientsProtocols | String | The custom type of the imClient. This attribute should be used along with CustomImClients. Multiple custom types should be separated by semi-colon. |
ImClientsUsernames | String | The custom value of the imClient. This attribute should be used along with CustomImClientTypes. Multiple custom imClients should be separated by semi-colon. |
Interests | String | The contact's interests. |
Locales | String | The contact's locales. |
DeskLocations | String | The desk locations of the contact. Multiple locations should be separated by semi-colon. |
GrewUpLocations | String | The grewUp locations of the contact. Multiple locations should be separated by semi-colon. |
CustomLocationTypes | String | The custom types of the location. The attribute should be used along with CustomLocations. Multiple locations should be separated by semi-colon. |
CustomLocations | String | The custom value of the location. The attribute should be used along with CustomLocationsTypes. Multiple locations should be separated by semi-colon. |
Memberships | String | The resource name for the contact group, assigned by the server. Only contactGroupResourceName can be used for modifying memberships. Any contact group membership can be removed, but only user group or 'myContacts' or 'starred' system groups memberships can be added. A contact must always have at least one contact group membership. |
MiscKeywordTypes | String | The miscellaneous keyword types. Multiple types should be separated by semi-colon. Allowed Values are : TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER
使用できる値は次のとおりです。TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER |
MiscKeywordValues | String | The miscellaneous keywords. Multiple miscellaneous keywords should be separated by semi-colon. |
Occupations | String | The contact's occupations |
Organizations | String | The organizations of the contact. |
RelationshipTypes | String | The contact's relation to the other person. This attribute should be used along with RelationValues. Multiple types should be separated by semi-colon. |
RelationshipValues | String | The name of the other person this relation refers to. This attribute should be used along with RelationTypes. Multiple names should be separated by semi-colon. |
UnlabeledSipAddresses | String | The unlabeled sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
HomeSipAddresses | String | The home sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
WorkSipAddresses | String | The work sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
MobileSipAddresses | String | The mobile sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
OtherSipAddresses | String | The other sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon. |
CustomSipAddressTypes | String | The custom type of the sipAddress. This attribute should be used along with CustomSipAddresses. Multiple types should be separated by semi-colon. |
CustomSipAddresses | String | The custom value of the sipAddress. This attribute should be used along with CustomSipAddressTypes. Multiple sipAddresses should be separated by semi-colon. |
Skills | String | The skills that the contact has. |
UnlabeledUrls | String | The unlabeled website urls of the contact. Multiple urls should be separated by semi-colon. |
HomeUrls | String | The home website urls of the contact. Multiple urls should be separated by semi-colon. |
WorkUrls | String | The work website urls of the contact. Multiple urls should be separated by semi-colon. |
BlogUrls | String | The blog website urls of the contact. Multiple urls should be separated by semi-colon. |
ProfileUrls | String | The profile website urls of the contact. Multiple urls should be separated by semi-colon. |
HomePageUrls | String | The homePage website urls of the contact. Multiple urls should be separated by semi-colon. |
FtpUrls | String | The ftp website urls of the contact. Multiple urls should be separated by semi-colon. |
ReservationsUrls | String | The reservations website urls of the contact. Multiple urls should be separated by semi-colon. |
OtherUrls | String | The appInstall Page website urls of the contact. Multiple urls should be separated by semi-colon. |
AppInstallPageUrls | String | The other website urls of the contact. Multiple urls should be separated by semi-colon. |
CustomUrlTypes | String | The custom type of the website url. This attribute values should be used along with CustomUrls. Multiple urls should be separated by semi-colon. |
CustomUrls | String | The custom value of the website url. This attribute values should be used along with CustomUrlTypes. Multiple urls should be separated by semi-colon. |
プロパティ | 説明 |
AuthScheme | GoogleContacts に接続する際に使用する認証の種類。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | Specify scope to obtain the initial access and refresh token. |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
OAuthJWTIssuer | Java Web Token の発行者。 |
OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | GoogleContacts に接続する際に使用する認証の種類。 |
GoogleContacts に接続する際に使用する認証の種類。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | Specify scope to obtain the initial access and refresh token. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
Specify scope to obtain the initial access and refresh token.
初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
Specify scope to obtain the initial access and refresh token.
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
OAuthJWTIssuer | Java Web Token の発行者。 |
OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
JWT 証明書のストア。
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
CA | 証明機関の証明書。 |
ROOT | ルート証明書。 |
SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
このプロパティには次の値の一つを設定できます。
USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。 |
MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。 |
PFXFILE | この証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。 |
PFXBLOB | この証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
JKSFILE | この証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。 |
JKSBLOB | この証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類はJava のみで利用できます。 |
PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
PPKFILE | この証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。 |
XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
OAuth JWT 証明書のパスワード。
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
OAuth JWT 証明書のサブジェクト。
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。
それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。
フィールド | 説明 |
CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
O | 法人名 |
OU | 法人の部署名 |
L | 法人の住所(市町村名) |
S | 法人の住所(都道府県) |
C | 国名 |
E | Eメールアドレス |
フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。
Java Web Token の発行者。
Java Web Token の発行者。通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 はGoogleContacts への接続を開き、プロキシを経由して通信が行われます。 |
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 | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するには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 を設定します。
認証タイプは、次のどれかになります。
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 を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\GoogleContacts Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、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 | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM [My Contacts] WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"