Intercomをデータパイプラインソースとして設定 ​

Intercomをデータパイプラインソースとして設定し、顧客エンゲージメント、会話、ヘルプセンターのレコードを抽出して宛先に同期します。 このガイドを使用して、コネクションの設定、パイプラインの設定、オブジェクトの追加、同期動作の確認、および既知の制限事項の理解を行います。

コネクターはIntercom REST APIバージョン2.15を対象とし、認証にOAuth 2.0を使用します。

サポートされている機能 ​

Intercomをパイプラインソースとして使用する場合、次の機能がサポートされます。

• クラウド接続: コネクションの作成時に指定するAPIベースURLを使用して、HTTPS経由でIntercomに接続します。 オンプレミスエージェントは不要です。
• OAuth 2.0認証: IntercomのOAuth 2.0フローを通じてコネクションを認可します。 詳細については、サポートされているコネクションタイプを参照してください。
• 複数の同期モード: 増分同期とフルリフレッシュをサポートします。 詳細については、同期モードを参照してください。
• オブジェクトレベルの選択: 宛先で個別のテーブルとして同期するIntercomオブジェクトを選択します。 完全なリストについては、サポートされているオブジェクトを参照してください。
• スキーマドリフトの検出と処理: 新しいフィールドを自動同期でスキーマの変更を自動的に検出して適用するか、新しいフィールドをブロックでスキーマを固定します。
• フィールドレベルのデータ保護: 機密フィールドをそのままレプリケートするか、宛先に到達する前にハッシュ化します。
• 設定可能な同時実行: パイプラインがIntercomに対して実行する同時API操作数に上限を設定します。
• 構成可能な同期頻度: 時間ベースの間隔またはcron式を使用して同期をスケジュールします。 サポートされる最小間隔は15分です。

前提条件 ​

Intercomをデータパイプラインソースとして接続する前に、次の前提条件を満たしてください。

• 有効なIntercomワークスペースが必要です。
• Intercomワークスペースでアプリを認可する権限が必要です。
• データパイプライン機能が有効になっているWorkatoワークスペースが必要です。

必要なOAuth権限 ​

コネクターは、OAuth 2.0コネクション用にIntercomのDeveloper Hubで次の読み取り権限を要求します。 同期する予定のオブジェクトに適用されるすべての権限を付与します。

data_attributesには個別のスコープは必要ありません。 data_attributesの完全なコンテンツを同期するには、連絡先モデルと会社モデルを対象とするユーザーと会社の読み取りおよび一覧表示と、会話モデルを対象とする会話の読み取りの両方を付与します。

サポートされるコネクションタイプ ​

Intercomソースコネクターは、認証にOAuth 2.0（認可コードグラント） を使用します。 WorkatoはIntercomにリダイレクトしてコネクションを認可し、Intercomは長期間有効なベアラートークンを返します。 Intercom OAuthトークンは期限切れにならず、更新されません。 アプリがアンインストールされた、または権限が変更されたためにトークンが無効になった場合は、コネクションを再認可する必要があります。

Intercomに接続 ​

Intercomをデータパイプラインソースとして接続するには、次の手順を実行します。 このコネクションにより、パイプラインはIntercomインスタンスからレコードを抽出して同期できます。

パイプラインの設定 ​

Intercomをデータパイプラインソースとして設定するには、次の手順を実行します。

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

Intercomソースコネクターは、次のオブジェクトをサポートしています。 各オブジェクトの同期モードは、Intercom APIが増分更新メカニズムを公開しているかどうかによって異なります。 初回開始時に、このパイプラインでレコードを取得する開始日時フィールドは、APIレベルのフィルターをサポートするオブジェクトにのみ適用されます。

コアオブジェクト ​

拡張スコープオブジェクト ​

結合テーブルと子テーブル ​

次のテーブルは、親レコード上の配列またはネストされたオブジェクトから派生します。 これらには独立したIntercom APIエンドポイントがなく、親の抽出の一部として同期されます。

同期モード ​

Intercomソースコネクターは、一部のオブジェクトでは増分同期をサポートし、その他のオブジェクトではフルリフレッシュをサポートします。 各オブジェクトの同期モードは、前回の実行以降に変更されたレコードのみを取得する方法をIntercomのAPIが公開しているかどうかによって異なります。

増分同期 ​

サポートされているオブジェクトでは、コネクターは前回の正常実行以降に作成または更新されたレコードのみを取得します。 Workatoは、オブジェクトの主キーによって宛先のレコードを重複排除します。 初回開始時に、このパイプラインでレコードを取得する開始日時フィールドは、初回実行の開始点を設定します。

増分同期をサポートするオブジェクトのリストについては、サポートされているオブジェクトを参照してください。

完全更新 ​

増分同期をサポートしていないオブジェクトの場合、コネクターは実行のたびにすべてのレコードを再同期します。 初回開始時に、このパイプラインでレコードを取得する開始日時フィールドは、フルリフレッシュオブジェクトには適用されません。

削除追跡 ​

コネクターは削除を追跡しません。 Intercomで削除されたレコードは、フルリフレッシュスケジュールのオブジェクトで次回のフルリフレッシュが行われるまで宛先に残ります。 増分同期オブジェクトから削除されたレコードは、宛先に無期限に残ります。

スキーマとデータ型の処理 ​

このセクションでは、コネクターがIntercomのデータ型、カスタムフィールド、ネストされたオブジェクトを宛先でどのように表現するかについて説明します。 これを使用して宛先スキーマを計画し、コネクターがどのフィールドを保持、JSONとしてシリアル化、または省略するかを理解します。

タイムスタンプ ​

IntercomはタイムスタンプをUnixエポック整数（1970-01-01からの秒数）として返します。 コネクターは、これらを宛先で整数として保持します。

カスタム属性 ​

Contacts、Companies、Conversationsは、ユーザー定義のカスタム属性をサポートします。 Intercomは、これらを各オブジェクトのcustom_attributesキー値マップに保存します。 コネクターは、custom_attributesを宛先の単一のJSON文字列列として保存します。 コネクターは、個々のカスタム属性キーを名前付き列に展開しません。これは、Intercomで新しい属性が追加されるたびにスキーマドリフトが発生するためです。

同じ原則に基づき、Ticketsのカスタムフィールドはticket_attributesにJSON文字列列として保存されます。

data_attributesオブジェクトを使用して、ワークスペースに設定されている完全なカスタム属性スキーマを検出します。 コネクターは、連絡先、会社、会話モデルのdata_attributesを取得します。

ネストされたオブジェクト ​

一部のネストされたリレーションシップは、個別の結合テーブルまたは子テーブルとして出力されます。 リストについては、結合テーブルと子テーブルセクションを参照してください。

親レコード上のその他のネストされたオブジェクトは、JSON文字列列としてシリアル化されます。 例:

• 連絡先: location, social_profiles, avatar
• 会話: source, first_contact_reply, sla_applied, statistics, conversation_rating, ai_agent, linked_objects
• 会社: plan

購読タイプの翻訳 ​

各subscription_typesレコードには、購読のデフォルト言語の名前と説明を記述するdefault_translationオブジェクトがあります。 コネクターはdefault_translationをJSON文字列列として保存し、直接クエリできるようにnameとdescriptionの値も個別のトップレベル列として公開します。

添付ファイル ​

会話パーツとメッセージには、ファイル添付が含まれる場合があります。 添付ファイルはサポートされていません。 コネクターは、添付ファイルのバイナリデータや添付ファイルURLを同期しません。

スキーマドリフト ​

スキーマドリフト処理オプションで新しいフィールドを自動同期を選択すると、コネクターはIntercomによってAPIバージョンのアップグレードで追加された新しい標準フィールドを自動的に取得します。 新しいフィールドをブロックを選択すると、パイプラインの開始後にスキーマが固定されるため、新しいフィールドを手動で追加する必要があります。

個人を特定できる情報 ​

複数のIntercomオブジェクトには、個人を特定できる情報が含まれます。 宛先でプレーンテキストとして必要としないフィールドには、ハッシュフィールドレベルデータ保護オプションを適用します。 次の表は、オブジェクト別に機密フィールドを示しています。