このページでは、CData Cloud でのGoogle Sheets への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Google Sheets への接続

接続の確立 は、CData Cloud にデータベースを作成するためのGoogle Sheets への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してGoogle Sheets からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Google Sheets に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Google Sheets への接続

以下のセクションでは、ユーザーとしての認証とサービスとしての認証について説明します。

ユーザーとして認証（OAuth）

以下のサブセクションでは、3つの一般的な認証フローを経由したユーザーアカウント（AuthScheme OAuth）からGoogle Sheets への認証方法について詳しく説明します。

• デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
• Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
• ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成についての情報と、埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。 Google Sheets で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Cloud は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

1. はじめてデータに接続する際、次の接続プロパティを設定します。
   • InitiateOAuth： REFRESH。
   • OAuthClientId：アプリケーション設定のクライアントId。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレット。
   • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
   • OAuthSettingsLocation：Cloud がOAuth 値を保存する場所のパス。これは接続間で維持されます。
2. その後のデータ接続では、以下を設定します。
   • InitiateOAuth
   • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId：アプリケーション設定のクライアントId。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレット。

3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

Google Sheets に必要なスコープおよびエンドポイントドメイン

これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。

このトピックでは、Google Sheets プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。

スコープについて

スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。

例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。

Google Sheets に必要なスコープ

エンドポイントドメインについて

エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。

これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。

Note： ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。

Google Sheets に必要なエンドポイントドメイン

カスタムOAuth アプリケーションの作成

• AuthScheme をOAuth に設定し、
• OAuthAccessToken を取得して設定し、
• 必要な設定パラメータを設定します。

（OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「Google Sheets への接続」の デスクトップ認証セクションを参照してください。）

ただし、Web 経由で接続するユーザー、およびユーザーの代わりにサービスアカウント経由で接続する場合は、カスタムOAuth 接続が必要になります。カスタムOAuth アプリケーションは、次のような場合にも有用です。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

プロシージャ

1. Google Cloud Console に移動します。
2. 左のナビゲーションペインで、ライブラリを選択します。コンソールはライブラリページを表示します。
3. 検索サービスを使用してGoogle Sheets API を見つけます。検索結果から"Google Sheets API" を選択します。
4. Google Sheets API ページで、有効にするをクリックします。

ユーザーアカウント

1. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
2. 左のナビゲーションペインで、認証情報を選択します。
3. 選択したプロジェクトに同意画面がない場合は、同意画面を設定をクリックします。Google Workspace アカウントを使用しない場合、User Type が外部の同意画面の作成に制限され、ユーザーサポートメールとデベロッパーの連絡先情報を指定する必要があります。追加情報は任意です。
4. 認証情報ページで認証情報を作成 -> OAuth クライアントID を選択します。
5. アプリケーションの種類メニューでウェブアプリケーションを選択します。
6. OAuth カスタムWeb アプリケーションの名前を指定します。
7. 承認済みのリダイレクトURI の下にあるURI を追加をクリックし、リダイレクトURI を入力します。
8. Enter をクリックします。
9. 作成をクリックします。

アプリケーションの作成が完了すると、Cloud コンソールは認証情報ページに戻ります。 ウィンドウが開き、クライアントId とクライアントシークレットが表示されます。

クライアントシークレットはGoogle Cloud コンソールからアクセス可能ですが、クライアントシークレットをメモしておくことをお勧めします。OAuthClientId とOAuthClientSecretを指定するには、クライアントシークレットとクライアントId の両方が必要です。

サービスアカウント

AuthScheme=OAuthJWT を使用する場合、サービスアカウントを作成する必要があります。

Google Cloud Console で：

• サービスアカウントフローを完了させるには、Google Cloud Console で秘密キーを生成します。 サービスアカウントフローにおいて、ドライバーはOAuthAccessToken へのJSON Web Token (JWT) を交換します。秘密キーはJWT の署名に必要です。ドライバーは、サービスアカウントに同じ権限を付与します。

• ここで新しいサービスアカウントを作成します。
  
  1. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
  2. 左のナビゲーションペインで、認証情報を選択します。
  3. 認証情報を作成 -> サービスアカウントに移動します。Cloud コンソールは サービスアカウントの作成ページを表示します。
  4. サービスアカウント名、サービスアカウントID、および任意でサービスアカウントの説明を入力します。
  5. 完了をクリックします。Cloud コンソールは認証情報ページに戻ります。
  6. サービスアカウントエリアで、作成したサービスアカウントを選択します
  7. 「キー」タブをクリックし、続けて鍵を追加 -> 新しい鍵を作成 をクリックします。
  8. OAuthJWTCert やOAuthJWTCertType のような、サポートされているキータイプを選択します。
  9. 作成をクリックします。

キーは自動的にローカルデバイスにダウンロードされ、キーに固有の追加情報が表示されます。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

テーブルとしてのスプレッドシート

Cloud は、スプレッドシートおよび範囲をリレーショナルテーブルとしてモデル化します。

テーブル

テーブル は、スプレッドシートの構成をテーブルに反映するためのさまざまな設定オプションを示します。例えば、ヘッダーを操作する方法や、範囲をテーブルとしてクエリする方法を見つけることができます。

カラム では、列検出に関する詳細情報を提供しています。

ストアドプロシージャ

Cloud では、左上に揃えて配置されたスプレッドシートまたはユーザー指定の範囲をデータベーステーブルとして表すことができます。Header プロパティを設定することで、テーブルをどのようにリストするかを制御できます。

左上揃えのテーブル

• 左上揃えのテーブルは、ワークシートの名前で表されます。
• デフォルトの形式は、テーブルが左上に揃えて配置されていること、ワークシート内のデータの最初の行に列名が含まれていることを必要とします。つまり、Header 接続文字列プロパティがデフォルト値のtrue に設定されている必要があります。
• ヘッダーに特殊文字を含めることはできません。
• デフォルトでは、Cloud は、最初の空の行が見つかるまで、すべての行を返します。 Note：データ内に空の行があると、それ以降のデータは返されません。

Google Spreadsheet API の制限により、すべての列ヘッダーは空白にはできません。

ユーザー指定範囲

Note：範囲指定は、SELECT ステートメントとUPDATE ステートメントでのみ使用できます。DELETE コマンドとINSERT コマンドは範囲をサポートしていません。

Header プロパティを設定することで、列名を指定するか、列名を自動的に生成することができます。このプロパティは、コマンドで列を使用する方法に影響します。

Header=True (Default)

• 列は、Google スプレッドシートの最初の行で決定されます。スプレッドシートの最初の行に値がない場合、Cloud は、その要求の範囲内でのみ使用できる一意のアルファベット列名を作成します。
• また、Cloud は、Google サーバー上の行の一意URI に対応するId 列を各行に追加します。これは、更新および削除操作に使用されます。

Header=False

• 列は、指定された範囲またはワークシートのサイズに基づいて動的に割り当てられます。アルファベットの列名が自動生成されます。
• 各行のId 列は、シートの上から順に振られた行番号を表します。例えば、範囲A3:E6 を指定すると、行3、4、5、6 が返されます。

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

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

CData Cloud - Google Sheets Views

ユーザーのGoogle Drive に含まれるフォルダのクエリ。

Select

Cloud はGoogle Sheets API を使用して、サーバーサイドでサポートされているカラムおよび演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

サーバーサイドのフィルタリングをサポートするカラムと演算子は以下のとおりです。

• Name は'CONTAINS,=,!=' 演算子をサポートします。
• Description は'CONTAINS' 演算子をサポートします。
• ModifiedTime は'<=,<,=,!=,>,>=' 演算子をサポートします。
• OwnerEmail は'IN' 演算子をサポートします。
• Starred は'=,!=' 演算子をサポートします。
• Trashed は'=,!=' 演算子をサポートします。
• ParentIds は'IN' 演算子をサポートします。
• DriveId は'=' 演算子をサポートします。指定したドライブからすべてのフォルダを取得するために使用します。

  Note： 特定のドライブからクエリするには、SupportsAllDrives 接続プロパティを'true' に設定する必要があります。

サーバーサイドのフィルタリングをサポートするすべてのカラムは、AND およびOR 論理演算子と組み合わせることができます。例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Folders WHERE Name = 'example folder'

SELECT * FROM Folders WHERE OwnerEmail IN ('[email protected]', '[email protected]') AND ModifiedTime >= '2020-04-01T05:30:00'

Columns

Pseudo-Columns

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

ユーザーのスプレッドシートとその関連情報のリストを返します。

Columns

ユーザーのスプレッドシートとその関連情報のリストを返します。

Columns

ストアドプロシージャはファンクションライクなインターフェースで、Google Sheets の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGoogle Sheets から関連するレスポンスデータを返します。

CData Cloud - Google Sheets Stored Procedures

指定したスプレッドシートにBigQuery dataSource を追加します。このストアドプロシージャを実行するには、スコープがbigquery.readonly のカスタムOAuth アプリが必要です。

Input

Result Set Columns

シートにDataSource Table を追加します。このストアドプロシージャを実行するには、スコープがbigquery.readonly のカスタムOAuth アプリが必要です。

Input

Result Set Columns

既存のGoogle スプレッドシートにワークシートを追加します。

Input

Result Set Columns

スプレッドシートから別のスプレッドシートにシートをコピーします。

Input

Result Set Columns

ユーザーのGoogle Drive にスプレッドシートを作成します。

Input

Result Set Columns

既存のGoogle スプレッドシート内のワークシートを削除します。

Input

Result Set Columns

スプレッドシートを削除します。

Input

Result Set Columns

特定の範囲のセルをフォーマットします。

Input

Result Set Columns

指定されたSpreadsheetId およびSheetId のシートのプロパティを更新します。

Input

Result Set Columns

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Google Sheets のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリ（バッチ処理を含む）のクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Spreadsheet1_Sheet1 テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Spreadsheet1_Sheet1' 

Columns

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

ストアドプロシージャパラメータについて説明します。

次のクエリは、DownloadDocument ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadDocument' AND Direction=1 OR Direction=2

Columns

主キーおよび外部キーについて説明します。

次のクエリは、Spreadsheet1_Sheet1 テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Spreadsheet1_Sheet1' 
          

Columns

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Columns

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

Authentication

Connection

OAuth

JWT OAuth

SSL

Logging

Schema

Miscellaneous

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

Google Sheets に接続する際に使用する認証の種類。

Possible Values

データ型

string

デフォルト値

"OAuth"

解説

• Token：APIKey プロパティを介してトークンベースの認証を実行する場合に設定。
• OAuth：標準のユーザーアカウントを使用してOAuth 認証を実行する場合に設定。
• OAuthJWT：OAuth サービスアカウントを使用してOAuth 認証を実行する場合に設定。
• GCPInstanceAccount：Google Cloud Platform インスタンスからアクセストークンを取得する場合に設定。

クライアントアプリケーションでOAuth 2.0を使用していない場合は、Google Cloud Platform プロジェクト内で有効になっているAPI を呼び出すときにAPI キーを含める必要があります。

データ型

string

デフォルト値

""

解説

クライアントアプリケーションでOAuth 2.0を使用していない場合は、Google Cloud Platform プロジェクト内で有効になっているAPI を呼び出すときにAPI キーを含める必要があります。

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

参照されるスプレッドシートの名前もしくはId のカンマ区切りのリスト。

データ型

string

デフォルト値

""

解説

参照されるスプレッドシートの名前もしくはId のカンマ区切りのリスト。このデータを取得するには、Spreadsheets ビューをクエリします。

Note：スプレッドシートの名前を入力する際、先頭や末尾のスペースを含めて正確なスプレッドシート名を入力してください。 また、カンマの区切りの前後に余分なスペースを加えてないようにします。スプレッドシート名にカンマが含まれる場合は、バックスラッシュ'\' でエスケープしてください。

FolderName='name1,name2' の形式でスプレッドシートを取得するフォルダの名前のカンマ区切りリスト。

データ型

string

デフォルト値

""

解説

FolderName='name1,name2' の形式でスプレッドシートを取得するフォルダの名前のカンマ区切りリスト。

FolderId='id1,id2,id3' の形式でスプレッドシートを取得するフォルダのId のカンマ区切りリスト。

データ型

string

デフォルト値

""

解説

FolderId='id1,id2,id3' の形式でスプレッドシートを取得するフォルダのId のカンマ区切りリスト。

ごみ箱の中のファイルをリストするかどうかを示します。

データ型

bool

デフォルト値

false

解説

True の場合、ドライバーはごみ箱に置かれたファイル/スプレッドシートをリストします。

非表示のシートをリストするかどうかを示します。

データ型

bool

デフォルト値

false

解説

true の場合、ドライバーは非表示のシートをスキップします。

ドライブのアイテムを取得するかどうかを決定します。

データ型

bool

デフォルト値

false

解説

このプロパティを'true' に設定すると、任意のドライブスプレッドシートからクエリを実行できます。

Id をスプレッドシート名およびシート名として使用するかどうかを指定します。

データ型

bool

デフォルト値

false

解説

Id をスプレッドシート名およびシート名として使用するかどうかを指定します。 SpreadsheetName_SheetName の代わりにシートで選択するには、次のようにします：SpreadsheetId_SheetId。例：SELECT * FROM 11696gdF5QUL1EnYikYiUeMTHRqA1111KbdYDoINqI_1151117664

TeamDrive='Shared drive 2, Shared drive 3'、またはTeamDrive='0BKwyFj1j9FOsUk9EVO, 0ANMIP9RIe1LQUk9PVA' の形式でスプレッドシートを取得するドライブの名前またはID。

データ型

string

デフォルト値

""

解説

TeamDrive='Shared drive 2, Shared drive 3'、またはTeamDrive='0BKwyFj1j9FOsUk9EVO, 0ANMIP9RIe1LQUk9PVA' の形式でスプレッドシートを取得するドライブの名前またはID。

公開されるシートがユーザーのドメインに共有されるシートのみに限定されるかどうかを決定するboolean。

データ型

bool

デフォルト値

false

解説

true の場合、ドライバーは、ユーザー独自のシートを除き、ユーザーのドメインに共有されているシートのみを取得して公開します。false の場合、ドライバーはユーザー独自のファイルと共有するファイルの両方を取得します。

FolderId / FolderName プロパティが定義されている場合に使用します。True に設定すると、ドライバーはネストされたフォルダ内のすべてのスプレッドシートを返し、そうでなければ、ドライバーはフォルダの直下のファイルのみを返します。デフォルトではfalse に設定されています。

データ型

bool

デフォルト値

false

解説

FolderId / FolderName プロパティが定義されている場合に使用します。True に設定すると、ドライバーはネストされたフォルダ内のすべてのスプレッドシートを返し、そうでなければ、ドライバーはフォルダの直下のファイルのみを返します。デフォルトではfalse に設定されています。

有効にすると、provider がエラー値を検出したフィールドはNULL として返されます。無効の場合、provider はいずれかのフィールドでエラー値が検出されるとエラーをスローします。

データ型

bool

デフォルト値

true

解説

このプロパティがtrue に設定されている場合、Cloud は値にエラーを含むフィールドをNULL として返します。

このプロパティがfalse に設定されている場合には、値にエラーが見つかった場合にCloud はエラーをスローします。

Cloud は以下のエラー値を確認します。

• #NULL!
• #N/A
• #DIV/0!
• #VALUE!
• #REF!
• #NAME?
• #NUM!
• #ERROR!

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

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。

データ型

string

デフォルト値

""

解説

サービスアカウントE メールは、スペース区切りのリストで指定する必要があります。

各サービスアカウントは、チェーン内の次のサービスアカウントのroles/iam.serviceAccountTokenCreator ロールを付与されている必要があります。

チェーンの最後のサービスアカウントは、リクエストするサービスアカウントのroles/iam.serviceAccountTokenCreator ロールが付与されている必要があります。 リクエストするサービスアカウントはRequestingServiceAccount プロパティで指定されたものです。

委任されたリクエストの場合、リクエストするサービスアカウントは、iam.serviceAccounts.getAccessToken 権限を持つ必要があることに注意してください。これは、serviceAccountTokenCreator ロールを介して付与することもできます。

委任されたリクエストを行うためのサービスアカウントのE メール。

データ型

string

デフォルト値

""

解説

委任されたリクエストで認証情報が要求されたアカウントのサービスアカウントのE メール。DelegatedServiceAccounts の委任されたサービスアカウントのリストを用いて、このプロパティは、委任されたリクエストを行うために使用されます。

このサービスアカウントには、IAM 権限iam.serviceAccounts.getAccessToken が必要です。

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

JWT 証明書のストア。

データ型

string

デフォルト値

""

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

Possible Values

データ型

string

デフォルト値

"GOOGLEJSONBLOB"

解説

このプロパティには次の値の一つを設定できます。

OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。

OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

データ型

string

デフォルト値

"*"

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

• サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
• 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
• 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。

Java Web Token の発行者。

データ型

string

デフォルト値

""

解説

Java Web Token の発行者。 サービスアカウントのE メールアドレスの値を入力します。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

データ型

string

デフォルト値

""

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。 アプリケーションが委任されたアクセスをリクエストするユーザーのE メールアドレスを入力します。

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

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

データ型

string

デフォルト値

""

解説

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

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

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

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

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

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

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

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

カラムのデータ型を決定するための方法を指定します。

Possible Values

データ型

string

デフォルト値

"RowScan"

解説

最初の行を列ヘッダーとして使用するかどうかを示します。

データ型

bool

デフォルト値

true

解説

true の場合は、最初の行が列ヘッダーとして使用されます。そうでない場合は、疑似列名（A、B、C など）が使用されます。

Header プロパティはOrientation プロパティと一緒に使用します。Header がfalse、Orientation がColumns に設定されている場合、列名はR1、R2、R3、etc. のようにレポートされます。

主キーの名前を制御するには、このプロパティを設定します。

データ型

string

デフォルト値

""

解説

行番号を持つ主キーカラムの名前を決定します。主キーのデフォルト値はId です。

クエリ対象のテーブルにID という名前のカラムがある場合、または主キーの名前を変更したい場合は、このプロパティを設定します。

Google スプレッドシート内でテーブルを定義

データ型

string

デフォルト値

""

解説

このプロパティを使って、テーブルとして表示するシートの範囲を定義します。値は、名前と値のペアのカンマ区切りリストで、[Table Name]=[Spreadsheet Name]_[Sheet Name]![Range] または[Table Name]=[Spreadsheet Name]_[Sheet Name]![Range] の形式になります。 Table Name はデータに使うテーブルの名前で、クエリを発行する際に使用されます。 Sheet Name はGoogle スプレッドシート内にあるシートの名前で、Range はテーブルのデータを含むセルの範囲です。

DefineTables 値の例を示します。DefineTables="Table1=Spreadsheet1_Sheet1!A1:N25,Table2=Spreadsheet1_Sheet2!C3:M53,Table4=xIsPcLs2-bF3AavQcSLCfzs3kGc_Sheet4!C20:N60"

シート内のデータを水平方向に配置するか、垂直方向に配置するかを示します。

Possible Values

データ型

string

デフォルト値

"Vertical"

解説

デフォルトでは、Cloud は垂直方向のスプレッドシートデータをモデル化しています。行はヘッダ行の下に垂直に配置されます。

行が左から右に配置されている場合は、これを"Horizontal" に設定します。最初の列は列名を含み、後続の列は行になります。

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

True に設定すると、更新/挿入/削除された値がシートの範囲外にある場合、ドライバーは自動的にディメンションを拡張します。

データ型

bool

デフォルト値

false

解説

True に設定すると、更新/挿入/削除された値がシートの範囲外にある場合、ドライバーは自動的にディメンションを拡張します。

AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。

データ型

string

デフォルト値

""

解説

このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。 例えば、この設定はユーザーのルートキーを使用してAWS で認証します：

AWSWorkloadIdentityConfig="AuhtScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"

日付、時間および期間がアウトプットで表されるかを定義します。 ValueRenderOption がFormattedValue の場合には、これは無視されます。デフォルトのdatetime レンダリングオプションはSerialNumber です。

Possible Values

データ型

string

デフォルト値

"SerialNumber"

解説

新しいデータがインプットされた際に、既存のデータがどのように変更されるかを決めます。

Possible Values

データ型

string

デフォルト値

"Overwrite"

解説

INSERT INTO Spreadsheet1_Sheet1(Id,Name, Amount) VALUES (2,'Test', 10)

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

空のセルをnull として読み取るか、空として読み取るかを示します。

Possible Values

データ型

string

デフォルト値

"ReadAsNull"

解説

NullValueMode は、空のGoogle Sheets セルをどのようにモデル化するかを制御します。空のセルは、設定されていないセル（null 文字列が含まれているセル）です。NullValueMode をReadAsNull に設定すると、空のセルに対してNULL が報告されます。NullValueMode をReadAsEmpty に設定すると、空のセルに対して空の文字列が報告されます。

Google Sheets から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

1000

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

パーセンテージの列をdecimal 表示するかどうかを決定するboolean。

データ型

bool

デフォルト値

false

解説

パーセンテージの列をdecimal 表示するかどうかを決定するboolean。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。

データ型

int

デフォルト値

50

解説

テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。

大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。

空の行をプッシュするかどうかを示します。

データ型

bool

デフォルト値

false

解説

true の場合、空の行が出力時にプッシュされます。

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

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

データ型

bool

デフォルト値

false

解説

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

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

挿入された値をどのように扱うべきかを定義します。

Possible Values

データ型

string

デフォルト値

"UserEntered"

解説

アウトプットで値がどのようにレンダリングされるかを定義します。

Possible Values

データ型

string

デフォルト値

"FormattedValue"

解説

Workload Identity Federation プールのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールのID。

Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。

Workload Identity Federation プールプロバイダーのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールプロバイダーのID。