HubSpot エンティティからの読み取り
前提条件
読み取り元の HubSpot オブジェクト。連絡先またはタスクなどのオブジェクト名が必要です。次の表に、Sync ソースでサポートされているエンティティを示します。
Sync ソースに対応するエンティティ
| エンティティ | API バージョン | フィルタリング可能 | 制限をサポートする | Order By をサポートする | Select * をサポートする | パーティショニングをサポートする |
|---|---|---|---|---|---|---|
| キャンペーン | v1 | なし | あり | なし | あり | なし |
| Companies | v3 | はい | あり | あり | あり | あり |
| 問い合わせ | v3 | はい | あり | あり | あり | あり |
| Contact Lists | v1 | なし | あり | なし | あり | なし |
| Deals | v3 | はい | あり | あり | あり | あり |
| CRM Pipeline (Deal Pipelines) | v1 | なし | なし | なし | あり | なし |
| E メールイベント | v1 | なし | あり | なし | あり | なし |
| 呼び出し | v3 | はい | あり | あり | あり | はい |
| メモ | v3 | はい | あり | あり | あり | あり |
| Emails | v3 | はい | あり | あり | あり | あり |
| 会議 | v3 | はい | あり | あり | あり | あり |
| タスク | v3 | はい | あり | あり | あり | あり |
| Postal Mails | v3 | はい | あり | あり | あり | あり |
| Custom Objects | v3 | はい | あり | あり | あり | あり |
| Forms | v2 | なし | なし | なし | あり | なし |
| Owners | v3 | なし | あり | なし | あり | なし |
| 製品 | v3 | はい | あり | あり | あり | あり |
| Tickets | v3 | はい | あり | あり | あり | あり |
| ワークフロー | v3 | なし | なし | なし | あり | なし |
| 関連付け | v4 | あり | なし | なし | あり | なし |
| Associations Labels | v4 | なし | なし | なし | あり | なし |
例:
hubspot_read = glueContext.create_dynamic_frame.from_options( connection_type="hubspot", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "contact", "API_VERSION": "v3" }
Async ソースに対応するエンティティ
| エンティティ | API バージョン | フィルタリング可能 | 制限をサポートする | Order By をサポートする | Select * をサポートする | パーティショニングをサポートする |
|---|---|---|---|---|---|---|
| Companies | v3 | あり | なし | あり | あり | なし |
| 問い合わせ | v3 | あり | なし | あり | あり | なし |
| Deals | v3 | あり | なし | あり | あり | なし |
| 呼び出し | v3 | あり | なし | あり | あり | なし |
| メモ | v3 | あり | なし | あり | あり | なし |
| Emails | v3 | あり | なし | あり | あり | なし |
| 会議 | v3 | あり | なし | あり | あり | なし |
| タスク | v3 | あり | なし | あり | あり | なし |
| Postal Mails | v3 | あり | なし | あり | あり | なし |
| Custom Objects | v3 | あり | なし | あり | あり | なし |
| 製品 | v3 | あり | なし | あり | あり | なし |
| Tickets | v3 | あり | なし | あり | あり | なし |
例:
hubspot_read = glueContext.create_dynamic_frame.from_options( connection_type="hubspot", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "contact", "API_VERSION": "v3", "TRANSFER_MODE": "ASYNC" }
HubSpot エンティティとフィールドの詳細:
HubSpot API v4:
| エンティティ | API バージョン | フィールド | データ型 | サポートされている演算子 |
|---|---|---|---|---|
| Association Label | v4 | category | 文字列 | 該当なし |
| typeId | 整数 | 該当なし | ||
| ラベル | 文字列 | 該当なし | ||
| 関連付け | 送信元 | Struct | 該当なし | |
| id | 文字列 | "=" | ||
| 次のように変更します。 | リスト | 該当なし |
注記
Associations オブジェクトの場合、2 つのオブジェクト間の関連付けを取得するには、AWS Glue ジョブの作成時に必須フィルターを介して「from Id」 (最初のオブジェクトの ID) を指定する必要があります。この場合、IDs から複数の の関連付けを取得するには、where 句に複数の IDsを指定する必要があります。例えば、問い合わせ ID 「1」と「151」の Associationsを取得するには、フィルターを where id=1 AND id=151 として指定する必要があります。
HubSpot API v3:
| エンティティ | フィールド | データ型 | サポートされている演算子 |
|---|---|---|---|
| 所有者 | firstName | 文字列 | 該当なし |
| lastName | 文字列 | 該当なし | |
| createdAt | DateTime | 該当なし | |
| archived | ブール値 | 該当なし | |
| teams | リスト | 該当なし | |
| id | 文字列 | 該当なし | |
| userId | 整数 | 該当なし | |
| 文字列 | 該当なし | ||
| updatedAt | DateTime | 該当なし | |
| ワークフロー | 名前 | 文字列 | 該当なし |
| id | 整数 | 該当なし | |
| type | 文字列 | 該当なし | |
| 有効 | ブール値 | 該当なし | |
| insertedAt | Long | 該当なし | |
| updatedAt | Long | 該当なし | |
| contactListIds | Struct | 該当なし | |
| personaTagIds | リスト | 該当なし |
次のエンティティについて、HubSpot はメタデータを動的に取得するエンドポイントを提供するため、オペレータのサポートは各エンティティのデータ型レベルでキャプチャされます。
注記
DML_STATUS は、実行時にすべてのレコードに追加された仮想フィールドで、Sync モードでのそのステータス (CREATED/UPDATED) を決定します。CONTAINS/LIKE 演算子は Async モードではサポートされていません。
| エンティティ | データ型 | サポートされている演算子 |
|---|---|---|
| 連絡先 | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| Company | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| Deal | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| Ticket | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| 製品 | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| Custom Object | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| 電話 | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| E メール | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| 会議 | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| メモ | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| タスク | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし | |
| Postal Mail | 整数 | "=, !=, <, >, >=, <=" |
| Long | "=, !=, <, >, >=, <=" | |
| 文字列 | "=, !=, LIKE" | |
| 日付 | 該当なし | |
| DateTime | "between" | |
| ブール値 | "=" | |
| リスト | 該当なし | |
| Struct | 該当なし |
HubSpot API v2:
| エンティティ | フィールド | データ型 | サポートされている演算子 |
|---|---|---|---|
| フォーム | portalId | 整数 | 該当なし |
| guid | 文字列 | 該当なし | |
| 名前 | 文字列 | 該当なし | |
| method | 文字列 | 該当なし | |
| cssClass | 文字列 | 該当なし | |
| リダイレクト | 文字列 | 該当なし | |
| submitText | 文字列 | 該当なし | |
| notifyRecipients | 文字列 | 該当なし | |
| createdAt | Long | 該当なし | |
| updatedAt | Long | 該当なし | |
| ignoreCurrentValues | ブール値 | 該当なし | |
| deletable | ブール値 | 該当なし | |
| inlineMessage | ブール値 | 該当なし | |
| captchaEnabled | ブール値 | 該当なし | |
| cloneable | ブール値 | 該当なし | |
| formFieldGroups | リスト | 該当なし | |
| editable | ブール値 | 該当なし | |
| deletedAt | 整数 | 該当なし | |
| themeName | 文字列 | 該当なし | |
| parentId | 整数 | 該当なし | |
| style | 文字列 | 該当なし | |
| isPublished | ブール値 | 該当なし | |
| publishAt | 整数 | 該当なし | |
| unpublishAt | 整数 | 該当なし | |
| publishedAt | 整数 | 該当なし | |
| kickbackEmailWorkflowId | 文字列 | 該当なし | |
| kickbackEmailsJson | 整数 | 該当なし | |
| customUid | 文字列 | 該当なし | |
| createMarketableContact | ブール値 | 該当なし | |
| editVersion | 整数 | 該当なし | |
| thankYouMessageJson | 文字列 | 該当なし | |
| themeColor | 文字列 | 該当なし | |
| alwaysCreateNewCompany | ブール値 | 該当なし | |
| internalUpdatedAt | Long | 該当なし | |
| ビジネスユニット ID | 整数 | 該当なし | |
| portableKey | 文字列 | 該当なし | |
| paymentSessionTemplateIds | リスト | 該当なし | |
| selectedExternalOptions | リスト | 該当なし |
HubSpot API v1:
| エンティティ | フィールド | データ型 | サポートされている演算子 |
|---|---|---|---|
| キャンペーン | id | 整数 | 該当なし |
| appId | 整数 | 該当なし | |
| appName | 文字列 | 該当なし | |
| lastUpdatedTime | Long | 該当なし | |
| Contact_List | dynamic | ブール値 | 該当なし |
| 名前 | 文字列 | 該当なし | |
| portalId | 整数 | 該当なし | |
| createdAt | Long | 該当なし | |
| listId | 整数 | 該当なし | |
| updatedAt | Long | 該当なし | |
| ListType | 文字列 | 該当なし | |
| フィルター | リスト | 該当なし | |
| authorId | 整数 | 該当なし | |
| metaData | Struct | 該当なし | |
| archived | ブール値 | 該当なし | |
| ilsFilterBranch | 文字列 | 該当なし | |
| filterIds | リスト | 該当なし | |
| limitExempt | ブール値 | 該当なし | |
| 内部 | ブール値 | 該当なし | |
| readOnly | ブール値 | 該当なし | |
| parentId | 整数 | 該当なし | |
| Email_Event | id | 文字列 | 該当なし |
| type | 文字列 | 該当なし | |
| 受取人 | 文字列 | 該当なし | |
| portalId | 整数 | 該当なし | |
| appId | 整数 | 該当なし | |
| appName | 文字列 | 該当なし | |
| emailCampaignId | Long | 該当なし | |
| attempt | 整数 | 該当なし | |
| 作成済み | Long | 該当なし | |
| sentBy | Struct | 該当なし | |
| smtpId | 文字列 | 該当なし | |
| レスポンス | 文字列 | 該当なし | |
| subject | 文字列 | 該当なし | |
| cc | リスト | 該当なし | |
| bcc | リスト | 該当なし | |
| replyTo | リスト | 該当なし | |
| 送信元 | 文字列 | 該当なし | |
| dropReason | 文字列 | 該当なし | |
| dropMessage | 文字列 | 該当なし | |
| ブラウザ | Struct | 該当なし | |
| userAgent | 文字列 | 該当なし | |
| duration | Long | 該当なし | |
| location | Struct | 該当なし | |
| filteredEvent | ブール値 | 該当なし | |
| deviceType | 文字列 | 該当なし | |
| suppressedReason | 文字列 | 該当なし | |
| suppressedMessage | 文字列 | 該当なし | |
| CRM_Pipeline | pipelineId | 文字列 | 該当なし |
| createdAt | Long | 該当なし | |
| updatedAt | Long | 該当なし | |
| objectType | 文字列 | 該当なし | |
| ラベル | 文字列 | 該当なし | |
| displayOrder | 整数 | 該当なし | |
| ACTIVE | ブール値 | 該当なし | |
| ステージ | リスト | 該当なし | |
| objectTypeId | 文字列 | 該当なし | |
| デフォルト | ブール値 | 該当なし |
パーティショニングクエリ
Spark で同時実行を使用する場合は、追加の Spark オプション PARTITION_FIELD、LOWER_BOUND、UPPER_BOUND、および NUM_PARTITIONS を指定できます。これらのパラメータを使用すると、元のクエリは Spark タスクで同時に実行できるサブクエリの NUM_PARTITIONS の数に分割されます。
PARTITION_FIELD: クエリのパーティション化に使用するフィールドの名前。LOWER_BOUND: 選択したパーティションフィールドの包括的な下限値。DateTime フィールドでは、ISO 形式の値を受け入れます。
有効な値の例は次のとおりです:
“2024-01-01T10:00:00.115Z"UPPER_BOUND: 選択したパーティションフィールドの排他的上限値。NUM_PARTITIONS: パーティション数。
次の表に、エンティティパーティション分割フィールドのサポートの詳細を示します:
| エンティティ名 | パーティション分割フィールド | データ型 |
|---|---|---|
| contact | hs_object_id | Long |
| createdate、lastmodifieddate | DateTime | |
| company | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| deal | hs_object_id | Long |
| createate、hs_createdate、hs_lastmodifieddate | DateTime | |
| ticket | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| product | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| custom_object | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| call | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| hs_object_id | Long | |
| createate、hs_lastmodifieddate | DateTime | |
| 会議 | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| note | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| タスク | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime | |
| postal_mail | hs_object_id | Long |
| createate、hs_lastmodifieddate | DateTime |
例:
hubspot_read = glueContext.create_dynamic_frame.from_options( connection_type="hubspot", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "company", "API_VERSION": "v3", "PARTITION_FIELD": "hs_object_id" "LOWER_BOUND": "50" "UPPER_BOUND": "16726619290" "NUM_PARTITIONS": "10" }