Parameters (Connect-HubSpot 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 | The type of authentication to use when connecting to HubSpot. |
Schema | Specify the HubSpot API version to use. HubSpotV4 is the latest API. |
OAuthOptionalScopes | A comma-separated set of optional scopes that give you permissions to your HubSpot account. |
OAuthRequiredScopes | A comma-separated set of permissions that your Hubspot app needs access to. |
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 |
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 です。 |
Property | Description |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
Property | Description |
Archived | Specify whether to get archived or unarchived records. |
CallPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Calls table. |
ColumnSizes | A file with a name=value comma separated list of column sizes. |
CompanyPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Companies table. |
ContactPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Contacts table. |
DealPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Deals table. |
EmailPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Emails table. |
ExpandAssociations | Specify whether to expand or not the object Associations tables. |
FeedbackSubmissionPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the FeedbackSubmissions table. |
GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
GoalPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Goals table. |
IncludeCustomTables | Specify whether to get Custom HubSpot Objects or not. |
LeadPropertiesFile | A file or a CSV string for the columns to select from HubSpot for the Leads table. |
LineItemPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the LineItems table. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
MeetingPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Meetings table. |
NotePropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Notes table. |
NumberColumnMode | Specifies how to handle detected number columns. |
OrderPropertiesFile | A file or a CSV string for the columns to select from HubSpot for the Orders table. |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | The maximum number of results to return per page from HubSpot. |
ProductPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Products table. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
QuotePropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Quotes table. |
Readonly | このプロパティを使用して、provider からHubSpot へのアクセスを読み取り専用に設定できます。 |
RTK | ライセンス供与で使用されるランタイムキー。 |
TaskPropertiesFile | A file or value with a comma separated list of properties to select from HubSpot for the Tasks table. |
TicketPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Tickets table. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseDisplayNames | Boolean determining if the display names for the tables and columns should be used instead of the API names. |
UseDropdownLabels | Boolean determining if dropdown labels should be used instead of internal values for enums. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |