Cmdlets for HubSpot

Build 24.0.9032

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.

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to HubSpot.
SchemaSpecify the HubSpot API version to use. HubSpotV4 is the latest API.
OAuthOptionalScopesA comma-separated set of optional scopes that give you permissions to your HubSpot account.
OAuthRequiredScopesA comma-separated set of permissions that your Hubspot app needs access to.

OAuth


PropertyDescription
InitiateOAuth接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthAccessTokenOAuth を使用して接続するためのアクセストークン。
OAuthSettingsLocationInitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。
CallbackURL認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。
OAuthVerifierOAuth 認可URL から返された検証コード。
OAuthRefreshToken対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。
OAuthExpiresInOAuth アクセストークンの有効期限(秒単位)。
OAuthTokenTimestamp現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。

SSL


PropertyDescription
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall


PropertyDescription
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy


PropertyDescription
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


PropertyDescription
Logfileログファイルの名前と場所を指定するファイルパス。
Verbosityログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。
LogModulesログファイルに含めるコアモジュール。
MaxLogFileSizeログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。
MaxLogFileCountログファイルの最大ファイル数を指定する文字列。

Schema


PropertyDescription
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Caching


PropertyDescription
AutoCacheSELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。
CacheLocationキャッシュデータベースへのパスとファイル名を指定します。
CacheToleranceAutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。
Offlineオフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。
CacheMetadataこのプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。

Miscellaneous


PropertyDescription
ArchivedSpecify whether to get archived or unarchived records.
CallPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Calls table.
ColumnSizesA file with a name=value comma separated list of column sizes.
CompanyPropertiesFileA file with a comma separated list of properties to select from HubSpot for the Companies table.
ContactPropertiesFileA file with a comma separated list of properties to select from HubSpot for the Contacts table.
DealPropertiesFileA file with a comma separated list of properties to select from HubSpot for the Deals table.
EmailPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Emails table.
ExpandAssociationsSpecify whether to expand or not the object Associations tables.
FeedbackSubmissionPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the FeedbackSubmissions table.
GenerateSchemaFilesスキーマを生成して保存するユーザーの好みのタイミングを示します。
GoalPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Goals table.
IncludeCustomTablesSpecify whether to get Custom HubSpot Objects or not.
LeadPropertiesFileA file or a CSV string for the columns to select from HubSpot for the Leads table.
LineItemPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the LineItems table.
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
MeetingPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Meetings table.
NotePropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Notes table.
NumberColumnModeSpecifies how to handle detected number columns.
OrderPropertiesFileA file or a CSV string for the columns to select from HubSpot for the Orders table.
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeThe maximum number of results to return per page from HubSpot.
ProductPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Products table.
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
QuotePropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Quotes table.
Readonlyこのプロパティを使用して、provider からHubSpot へのアクセスを読み取り専用に設定できます。
RTKライセンス供与で使用されるランタイムキー。
TaskPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Tasks table.
TicketPropertiesFileA file with a comma separated list of properties to select from HubSpot for the Tickets table.
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseDisplayNamesBoolean determining if the display names for the tables and columns should be used instead of the API names.
UseDropdownLabelsBoolean determining if dropdown labels should be used instead of internal values for enums.
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9032