CData Sync App は、Google Contacts データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
GoogleContacts コネクタはCData Sync アプリケーションから使用可能で、GoogleContacts からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、People API を使用してGoogle Contacts への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
各ユーザーやドメインの代わりに、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 はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、GoogleContacts API へのSQL の実行について詳しく説明します。
Sync App はGoogleContacts API をリレーショナルテーブル としてモデル化します。
ビュー は、GoogleContacts のいくつかの追加的なメタデータ情報を提供します。
ストアドプロシージャ は、GoogleContacts のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、GoogleContacts の操作を実行できます。
Sync App はGoogleContacts のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| 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. |
| MaxMembers | String |
Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members. |
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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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 を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。 |
| RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メール。 |
| 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 | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| WorkloadPoolId | Workload Identity Federation プールのID。 |
| WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
| WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | GoogleContacts に接続する際に使用する認証の種類。 |
GoogleContacts に接続する際に使用する認証の種類。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。 |
| RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メール。 |
| Scope | Specify scope to obtain the initial access and refresh token. |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。
サービスアカウントE メールは、スペース区切りのリストで指定する必要があります。
各サービスアカウントは、チェーン内の次のサービスアカウントのroles/iam.serviceAccountTokenCreator ロールを付与されている必要があります。
チェーンの最後のサービスアカウントは、リクエストするサービスアカウントのroles/iam.serviceAccountTokenCreator ロールが付与されている必要があります。 リクエストするサービスアカウントはRequestingServiceAccount プロパティで指定されたものです。
委任されたリクエストの場合、リクエストするサービスアカウントは、iam.serviceAccounts.getAccessToken 権限を持つ必要があることに注意してください。これは、serviceAccountTokenCreator ロールを介して付与することもできます。
委任されたリクエストを行うためのサービスアカウントのE メール。
委任されたリクエストで認証情報が要求されたアカウントのサービスアカウントのE メール。DelegatedServiceAccounts の委任されたサービスアカウントのリストを用いて、このプロパティは、委任されたリクエストを行うために使用されます。
このサービスアカウントには、IAM 権限iam.serviceAccounts.getAccessToken が必要です。
Specify scope to obtain the initial access and refresh token.
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。 InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、要求するスコープを変更したい場合は、このプロパティまたはScope 入力を使用する必要があります。
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 形式の証明書を含む文字列の名前です。 |
| BCFKSFILE | この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。 |
| BCFKSBLOB | この証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。 |
OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。
OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。
値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所(市町村名) |
| S | 法人の住所(都道府県) |
| C | 国名 |
| E | E メールアドレス |
フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。
Java Web Token の発行者。
Java Web Token の発行者。 サービスアカウントの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 | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がGoogleContacts への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がGoogleContacts への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がGoogleContacts にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\GoogleContacts Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| WorkloadPoolId | Workload Identity Federation プールのID。 |
| WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
| WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |
AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。
例えば、この設定はユーザーのルートキーを使用してAWS で認証します:
AWSWorkloadIdentityConfig="AuhtScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM [My Contacts] WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。
Workload Identity Federation プールのID。
Workload Identity Federation プールのID。
Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
Workload Identity Federation プールプロバイダーのID。
Workload Identity Federation プールプロバイダーのID。