CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるGoogleContacts へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してGoogleContacts に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、GoogleContacts への接続を標準化し、構成することができます。
このページでは、CData Cloud でのGoogleContacts への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのGoogleContacts への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してGoogleContacts からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、GoogleContacts に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
各ユーザーやドメインの代わりに、Cloud がGoogle API にアクセスすることを許可します。
Google API への接続には、OAuth 認証標準を使用します。
Cloud は、認証にユーザーアカウントおよび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 仮想マシン上で実行している場合は、Cloud は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。
(OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「GoogleContacts への接続」の デスクトップ認証セクションを参照してください。)
ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。
カスタムOAuth アプリケーションは、次のような場合に有用です。
以下のセクションでは、Directory API を有効化し、ユーザーアカウント(OAuth)およびサービスアカウント(OAuth / JWT)用のカスタムOAuth アプリケーションを作成する方法について説明します。
AuthScheme がOAuth であり、Web アプリケーション上で認証する必要があるユーザーの場合は、必ずカスタムOAuth アプリケーションを作成する必要があります。 (デスクトップおよびヘッドレスフローでのカスタムOAuth アプリケーションの作成は任意です。)
以下の手順に従います。
Note: クライアントシークレットはGoogle Cloud コンソールからアクセス可能です。
新しいサービスアカウントを作成するには:
サービスアカウントフローを完了させるには、Google Cloud Console で秘密キーを生成します。サービスアカウントフローにおいて、ドライバーはOAuthAccessToken へのJSON Web Token (JWT) を交換します。秘密キーはJWT の署名に必要です。ドライバーには、サービスアカウントに付与されているのと同じ権限が与えられます。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、GoogleContacts API へのSQL の実行について詳しく説明します。
Cloud はGoogleContacts API をリレーショナルテーブル としてモデル化します。
ビュー は、GoogleContacts のいくつかの追加的なメタデータ情報を提供します。
ストアドプロシージャ は、GoogleContacts のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、GoogleContacts の操作を実行できます。
Cloud は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. |
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. |
ストアドプロシージャはファンクションライクなインターフェースで、GoogleContacts の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGoogleContacts から関連するレスポンスデータを返します。
Name | Description |
CopyOtherContactsToMyContacts | Copies an 'Other contact' to a new contact in the user's 'myContacts' group |
ModifyContactGroupMembers | Modify the members of a contact group owned by the authenticated user. |
UpdateOrDeleteContactPhoto | Update or Delete a contact's photo. |
Copies an 'Other contact' to a new contact in the user's 'myContacts' group
GoogleContacts は、EXEC クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。CopyOtherContactsToMyContacts で利用可能なカラムはId、FieldsToCopy、およびSources です。
次に例を示します。
EXECUTE CopyOtherContactsToMyContacts Id = 'c2583603548064626314', FieldsToCopy = 'emailAddresses, names, phoneNumbers', Sources = 'READ_SOURCE_TYPE_CONTACT'
Name | Type | Required | Description |
Id | String | True | The Id of the 'Other contact' to copy. |
FieldsToCopy | String | True | The fields to restrict which fields are copied into the new contact. Valid values are: emailAddresses,names,phoneNumbers |
Sources | String | True | A mask of what source types to return. Valid values are: READ_SOURCE_TYPE_UNSPECIFIED, READ_SOURCE_TYPE_PROFILE, READ_SOURCE_TYPE_CONTACT, READ_SOURCE_TYPE_DOMAIN_CONTACT |
Name | Type | Description |
Success | String | Returns True if contact group has been modified. |
Modify the members of a contact group owned by the authenticated user.
GoogleContacts は、EXEC クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。ModifyContactGroupMembers で利用可能なカラムはId、ResourceIdsToAdd、およびResourceIdsToRemove です。
Note:メンバーを追加できるシステム連絡先グループは、contactGroups/myContacts とcontactGroups/starred のみです。その他のシステム連絡先グループは非推奨で、連絡先の削除のみ可能です。
次に例を示します。
EXECUTE ModifyContactGroupMembers Id = 'starred', ResourceIdsToAdd = 'c8493601355484697130, c8493601355484697130', ResourceIdsToRemove = ''
Name | Type | Required | Description |
Id | String | True | The Id of the contact group to modify. |
ResourceIdsToAdd | String | False | A comma separated list of ids of the contact people to add. |
ResourceIdsToRemove | String | False | A comma separated list of ids of the contact people to remove. |
Name | Type | Description |
Success | String | Returns True if contact group has been modified. |
Update or Delete a contact's photo.
GoogleContacts は、EXEC クエリでは、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= 比較でのみ使用できます。UpdateOrDeleteContactPhoto で利用可能なカラムはId、Action、FileSource、およびUrl です。
Note:Id カラムが必須です。Action 属性は実行する操作を定義します。Action でサポートされている操作は'UPDATE、Delete' です。連絡先の写真を更新するには、FileSource またはURL のいずれかを指定する必要があります。
次に例を示します。
EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Update', FileSource = 'D:\GooglePeople_API_Outputs\contactphoto.png' EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Update', Url = 'https://play-lh.googleusercontent.com/-Xqd3k7aJqZY/AAAAAAAAAAI/AAAAAAAAAAA/AMZuuckWFzqX627ygMhiilKbqmIA-T_AsQ/photo.jpg' EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Delete'
Name | Type | Required | Description |
Id | String | True | The Id of the contact. |
Action | String | True | Update or Delete operation you want to perform on Contact Photo. Possible values: Update, Delete |
FileSource | String | False | The complete filepath of the photo to be uploaded. You need to specify either this field or URL. |
URL | String | False | An accessible URL the image will be downloaded from and then posted to the target. You need to specify either this field or FileSource. |
Name | Type | Description |
Success | String | Returns True if contact group has been modified. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、GoogleContacts のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリ(バッチ処理を含む)のクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、[My Contacts] テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='[My Contacts]'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、ModifyContactGroupMembers ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='ModifyContactGroupMembers' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、[My Contacts] テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='[My Contacts]'
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
名前 | タイプ | 説明 |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | インデックスを含むデータベースの名前。 |
SchemaName | String | インデックスを含むスキーマの名前。 |
TableName | String | インデックスを含むテーブルの名前。 |
IndexName | String | インデックス名。 |
ColumnName | String | インデックスに関連付けられたカラムの名前。 |
IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:googlecontacts:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | 接続プロパティ名。 |
ShortDescription | String | 簡単な説明。 |
Type | String | 接続プロパティのデータ型。 |
Default | String | 明示的に設定されていない場合のデフォルト値。 |
Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
Required | Boolean | プロパティが接続に必要かどうか。 |
Category | String | 接続プロパティのカテゴリ。 |
IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
Ordinal | Int32 | パラメータのインデックス。 |
CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
DIALECT | 使用するSQL ダイアレクトを示します。 | |
KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
AuthScheme | GoogleContacts に接続する際に使用する認証の種類。 |
プロパティ | 説明 |
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 を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | GoogleContacts に接続する際に使用する認証の種類。 |
GoogleContacts に接続する際に使用する認証の種類。
string
"Auto"
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
Scope | Specify scope to obtain the initial access and refresh token. |
Specify scope to obtain the initial access and refresh token.
string
"https://www.googleapis.com/auth/contacts.other.readonly https://www.googleapis.com/auth/contacts.readonly https://www.googleapis.com/auth/user.gender.read https://www.googleapis.com/auth/user.emails.read https://www.googleapis.com/auth/user.birthday.read https://www.googleapis.com/auth/user.addresses.read https://www.googleapis.com/auth/profile.language.read https://www.googleapis.com/auth/profile.agerange.read https://www.googleapis.com/auth/user.organization.read https://www.googleapis.com/auth/user.phonenumbers.read"
初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
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 証明書のストア。
string
""
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
CA | 証明機関の証明書。 |
ROOT | ルート証明書。 |
SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
string
"PEMKEY_BLOB"
このプロパティには次の値の一つを設定できます。
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 証明書のパスワード。
string
""
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
OAuth JWT 証明書のサブジェクト。
string
"*"
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。
それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの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 の発行者。
string
""
Java Web Token の発行者。 委任されたユーザーのE メールアドレスの値を入力します。
Java Web Token の発行者。 委任されたユーザーのE メールアドレスの値を入力します。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
string
""
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 サービスアカウントE メールの値を入力します。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 サービスアカウントE メールの値を入力します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
string
""
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。