Parameters (Connect-GoogleSheets Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| AuthScheme | Google Sheets に接続する際に使用する認証の種類。 |
| APIKey | クライアントアプリケーションでOAuth 2.0を使用していない場合は、Google Cloud Platform プロジェクト内で有効になっているAPI を呼び出すときにAPI キーを含める必要があります。 |
| Property | Description |
| 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 はいずれかのフィールドでエラー値が検出されるとエラーをスローします。 |
| Property | Description |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期限（秒単位）。 |
| OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。 |
| Property | Description |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| Property | Description |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| Property | Description |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| Property | Description |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| Property | Description |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| Property | Description |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| TypeDetectionScheme | カラムのデータ型を決定するための方法を指定します。 |
| Header | 最初の行を列ヘッダーとして使用するかどうかを示します。 |
| PrimaryKeyIdentifier | 主キーの名前を制御するには、このプロパティを設定します。 |
| DefineTables | Google スプレッドシート内でテーブルを定義 |
| Orientation | シート内のデータを水平方向に配置するか、垂直方向に配置するかを示します。 |
| Property | Description |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| Property | Description |
| AutoAdjustRange | True に設定すると、更新/挿入/削除された値がシートの範囲外にある場合、ドライバーは自動的にディメンションを拡張します。 |
| DateTimeRenderOption | 日付、時間および期間がアウトプットで表されるかを定義します。 ValueRenderOption がFormattedValue の場合には、これは無視されます。デフォルトのdatetime レンダリングオプションはSerialNumber です。 |
| InsertDataOption | 新しいデータがインプットされた際に、既存のデータがどのように変更されるかを決めます。 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| NullValueMode | 空のセルをnull として読み取るか、空として読み取るかを示します。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| Pagesize | Google Sheets から返されるページあたりの結果の最大数。 |
| PercentageToDecimal | パーセンテージの列をdecimal 表示するかどうかを決定するboolean。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| Readonly | このプロパティを使用して、provider からGoogle Sheets へのアクセスを読み取り専用に設定できます。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| ShowEmptyRows | 空の行をプッシュするかどうかを示します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
| ValueInputOption | 挿入された値をどのように扱うべきかを定義します。 |
| ValueRenderOption | アウトプットで値がどのようにレンダリングされるかを定義します。 |