接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| AuthScheme | Google Sheets に接続する際に使用する認証の種類。 |
| APIKey | クライアントアプリケーションでOAuth 2.0を使用していない場合は、Google Cloud Platform プロジェクト内で有効になっているAPI を呼び出すときにAPI キーを含める必要があります。 |
| プロパティ | 説明 |
| Spreadsheet | 参照されるスプレッドシートの名前もしくはId のカンマ区切りのリスト。 |
| FolderName | FolderName='name1,name2' の形式でスプレッドシートを取得するフォルダの名前のカンマ区切りリスト。 |
| FolderId | FolderId='id1,id2,id3' の形式でスプレッドシートを取得するフォルダのId のカンマ区切りリスト。 |
| ShowTrashedFiles | ごみ箱の中のファイルをリストするかどうかを示します。 |
| SkipHiddenSheets | 非表示のシートをリストするかどうかを示します。 |
| SupportsAllDrives | ドライブのアイテムを取得するかどうかを決定します。 |
| UseIdAsTableName | Id をスプレッドシート名およびシート名として使用するかどうかを指定します。 |
| TeamDrive | TeamDrive='Shared drive 2, Shared drive 3'、またはTeamDrive='0BKwyFj1j9FOsUk9EVO, 0ANMIP9RIe1LQUk9PVA' の形式でスプレッドシートを取得するドライブの名前またはID。 |
| DomainSharedFilesOnly | 公開されるシートがユーザーのドメインに共有されるシートのみに限定されるかどうかを決定するboolean。 |
| RecurseFolders | FolderId / FolderName プロパティが定義されている場合に使用します。True に設定すると、ドライバーはネストされたフォルダ内のすべてのスプレッドシートを返し、そうでなければ、ドライバーはフォルダの直下のファイルのみを返します。デフォルトではfalse に設定されています。 |
| IgnoreErrorValues | 有効にすると、provider がエラー値を検出したフィールドはNULL として返されます。無効の場合、provider はいずれかのフィールドでエラー値が検出されるとエラーをスローします。 |
| プロパティ | 説明 |
| InitiateOAuth | OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthAccessToken | OAuth ネットワークへの認証後に受け取ったトークンで、ユーザーにアクセス権を付与します。 アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。 |
| DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。 |
| RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メール。 |
| OAuthSettingsLocation | OAuth 値が保存される設定ファイルの場所を指定します。OAuth 設定を中心的な場所に保管することで、ユーザーがログインするたびにOAuth 接続プロパティを手動で入力する必要がなくなります。また、資格情報を接続やプロセス間で共有することもできます。 |
| CallbackURL | OAuth 経由でGoogle Sheets への認証を行った後にユーザーが戻るURL。 |
| OAuthVerifier | OAuthAuthorizationURL から返された検証コードを指定します。ブラウザを起動できないヘッドレスサーバーでOAuth 認証を行う場合に使用します。 OAuthSettingsLocation および OAuthVerifier の両方が設定される必要があります。 |
| OAuthRefreshToken | 現在アクティブなOAuth アクセストークンを取得し、リフレッシュします。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期間を秒単位で指定します。ユーザーが操作を続けている限り、アクセスを維持するためにトークンを再発行することができます。 |
| OAuthTokenTimestamp | 現在のアクセストークンがいつ作成されたかを示すUnix エポックタイムスタンプをミリ秒単位で表示します。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| Logfile | provider が認証、クエリ実行、接続の詳細などのアクティビティを記録するログファイルのファイルパスを指定します。 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| MaxLogFileSize | 単一のログファイルの最大サイズをバイト単位で指定します。例えば、'10 MB' です。ファイルが上限に達すると、provider は日付と時刻を名前に付加した新しいログファイルを作成します。 |
| MaxLogFileCount | provider が保持するログファイルの最大数を指定します。上限に達すると、最も古いログファイルが削除され、新しいログファイルのためのスペースが作られます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| TypeDetectionScheme | カラムのデータ型を決定するための方法を指定します。 |
| Header | 最初の行を列ヘッダーとして使用するかどうかを示します。 |
| PrimaryKeyIdentifier | 主キーの名前を制御するには、このプロパティを設定します。 |
| DefineTables | Google スプレッドシート内でテーブルを定義 |
| Orientation | シート内のデータを水平方向に配置するか、垂直方向に配置するかを示します。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの対象となるテーブルの内容が、指定されたキャッシュデータベースに自動的にキャッシュされるかどうかを指定します。 |
| CacheProvider | ADO.NET プロバイダーの名前空間。指定されたプロバイダーは、すべてのキャッシュ操作のターゲットデータベースとして使用されます。 |
| CacheDriver | JDBC ドライバーのドライバークラス。指定されたドライバーは、すべてのキャッシュ操作のためにターゲットデータベースに接続するために使用されます。 |
| CacheConnection | 指定されたキャッシュデータベースの接続文字列。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | 指定されたキャッシュデータベース内の失効データに対する許容時間（秒単位）。 |
| Offline | ライブGoogle Sheets データの代わりに、指定されたキャッシュデータベースからデータを取得します。 |
| CacheMetadata | provider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| AutoAdjustRange | True に設定すると、更新/挿入/削除された値がシートの範囲外にある場合、ドライバーは自動的にディメンションを拡張します。 |
| AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| DateTimeRenderOption | 日付、時間および期間がアウトプットで表されるかを定義します。 ValueRenderOption がFormattedValue の場合には、これは無視されます。デフォルトのdatetime レンダリングオプションはSerialNumber です。 |
| InsertDataOption | 新しいデータがインプットされた際に、既存のデータがどのように変更されるかを決めます。 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| NullValueMode | 空のセルをnull として読み取るか、空として読み取るかを示します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Google Sheets から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PercentageToDecimal | パーセンテージの列をdecimal 表示するかどうかを決定するboolean。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Readonly | provider からGoogle Sheets への読み取り専用アクセスを切り替えます。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| RTK | provider のライセンスを取得するためのランタイムキーを指定します。設定されていないか無効な場合、provider は標準のライセンス方法をデフォルトとして使用します。このプロパティは、標準のライセンス方法がサポートされていないか、ランタイムキーが必要な環境でのみ使用してください。 |
| ShowEmptyRows | 空の行をプッシュするかどうかを示します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
| ValueInputOption | 挿入された値をどのように扱うべきかを定義します。 |
| ValueRenderOption | アウトプットで値がどのようにレンダリングされるかを定義します。 |
| WorkloadPoolId | Workload Identity Federation プールのID。 |
| WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
| WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |