Cmdlets for HubSpot

Build 24.0.9032

OAuth のスコープおよびエンドポイント

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

HubSpot と連携する場合、アプリケーションはAPI とやりとりするために特定の権限が必要です。

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

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

スコープについて

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

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

HubSpot に必要なスコープ

スコープ 説明
automation 自動化ワークフローにアクセスします。読み書きのアクセスに必要です。
business-intelligence ソースとE メールの上位に位置するエンドポイントにアクセスします。読み書きのアクセスに必要です。
cms.source_code.read_write 開発者がWeb サイトやE メールのコードを記述するために必要なテンプレート、モジュール、その他のファイルをアップロードおよびダウンロードする機能を提供します。書き込みアクセスに必要です。
collector_graphql_query_execute GraphQL API エンドポイントを使用してHubSpot アカウントからデータをクエリします。読み書きのアクセスに必要です。
collector_graphql_query_read GraphQL などのGraphQL アプリケーションクライアントを介してイントロスペクションクエリを実行します。読み書きのアクセスに必要です。
content サイト、ランディングページ、CTA、メール、ブログ、キャンペーンにアクセスします。読み書きのアクセスに必要です。
conversations.read コミュニケーション受信トレイのスレッドの詳細を表示します。読み書きのアクセスに必要です。
conversations.visitor_identification.tokens.create HubSpot チャットウィジェットと対話する認証済みWeb サイト訪問者の識別トークンを取得します。読み書きのアクセスに必要です。
crm.import CRM にレコードをインポートできます。これには、新しいレコードの作成や、すべてのCRM データタイプ(コンタクト、会社、取引、チケットなど)の既存のレコードの変更が含まれます。データのアーカイブや削除は含まれません。読み書きのアクセスに必要です。
crm.lists.read コンタクトのリストの詳細を表示します。読み書きのアクセスに必要です。
crm.lists.write コンタクトのリストを作成、削除、または変更します。書き込みアクセスに必要です。
crm.objects.companies.read 会社に関するプロパティやその他の詳細を表示します。読み書きのアクセスに必要です。
crm.objects.companies.write プロパティを表示し、会社を作成、削除、または変更します。書き込みアクセスに必要です。
crm.objects.contracts.read コンタクトに関するプロパティやその他の詳細を表示します。読み書きのアクセスに必要です。
crm.objects.contracts.write プロパティを表示し、コンタクトを作成、削除、変更します。書き込みアクセスに必要です。
crm.objects.deals.read 取引に関するプロパティやその他の詳細を表示します。読み書きのアクセスに必要です。
crm.objects.deals.write プロパティを表示し、取引を作成、削除、または変更します。書き込みアクセスに必要です。
crm.objects.owners.read CRM レコードに割り当てられたユーザーの詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.companies.read 会社のプロパティ設定の詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.companies.write 会社のプロパティ設定を作成、削除、または変更します。書き込みアクセスに必要です。
crm.schemas.contacts.read コンタクトのプロパティ設定の詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.contacts.write コンタクトのプロパティ設定を作成、削除、または変更します。書き込みアクセスに必要です。
crm.schemas.deals.read 取引のプロパティ設定の詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.deals.write 取引のプロパティ設定を作成、削除、または変更します。書き込みアクセスに必要です。
e-commerce e コマース機能にアクセスします。読み書きのアクセスに必要です。
files ファイルマネージャーにアクセスします。読み書きのアクセスに必要です。
forms Forms エンドポイントにアクセスします。読み書きのアクセスに必要です。
forms-uploaded-files フォームから送信されたファイルをダウンロードします。読み書きのアクセスに必要です。
hubdb HubDB にアクセスします。読み書きのアクセスに必要です。
integration-sync ほとんどのCRM オブジェクトの同期を可能にする同期API を公開します。読み書きのアクセスに必要です。
oauth OAuth に必要な基本スコープ。読み書きのアクセスに必要です。
sales-email-read コンタクトに送信された1対1のE メールの詳細をすべて読み取るためのアクセス権を付与します。読み書きのアクセスに必要です。
settings.user.read HubSpot アカウントからユーザーとユーザーロールを取得します。読み書きのアクセスに必要です。
settings.user.teams.read HubSpot アカウントからチームを取得します。読み書きのアクセスに必要です。
social ソーシャル受信トレイにアクセスします。読み書きのアクセスに必要です。
tickets チケットにアクセスします。読み書きのアクセスに必要です。
timeline HubSpot CRM レコードのカスタムイベントを管理するためのアクセス権を付与します。これには、レコードの作成または更新が含まれます。読み書きのアクセスに必要です。
transactional-email トランザクションE メールおよびトランザクションE メールエンドポイントにアクセスします。読み書きのアクセスに必要です。

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

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

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

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

HubSpot に必要なエンドポイントドメイン

ドメイン 常に必須 説明
api.hubspot.com TRUE HubSpot API のベースURL。
app.hubspot.com FALSE HubSpot のOAuth 認可を行う際に使用するドメイン。

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