Spotify データをHeroku Postgres にレプリケーションして、Salesforce Connect から利用する方法

宮本航太
宮本航太
プロダクトスペシャリスト
ETL / ELT ツールのCData Sync を使って、Spotify のデータのHeroku Postgres へのETL パイプラインをノーコードで作成する方法を解説します。



CData Sync は、いろいろなシナリオのデータレプリケーション（同期）を行うことができるスタンドアロンのアプリケーションです。例えば、sandbox および本番インスタンスのデータをデータベースに同期することができます。Spotify のデータ をHeroku 上のPostgreSQL に同期することで、Salesforce の通常オブジェクトに加えて、Salesforce 外部オブジェクト（Salesforce Connect）としてSpotify のデータへのアクセスが可能になります。

要件

本レプリケーション例では、次が必要です:

  1. CData Sync (試用版もしくは商用版)、およびSpotify のレプリケーションに必要なライセンス。
  2. Heroku Postgress を含むHeroku app および、Heroku Connect アドオン許可。
  3. Salesforce アカウント。

レプリケーション同期先の設定

CData Sync を使って、Spotify のデータ をHeroku 上のPostgreSQL データベースにレプリケーションできます。本記事では、Heroku 上の既存のPostgreSQL を使用します。PostgreSQL データベースをレプリケーション先に指定するには、［接続］タブから進みます。

  1. ［同期先］タブをクリックします。
  2. PostgreSQL を同期先として選択します。

    PostgreSQL への接続には、Port（デフォルトでは5432）、およびデータベース接続プロパティを設定し、サーバーに認証するuser およびpassword を設定します。データベースプロパティが指定されていない場合には、ユーザーのデフォルトデータベースに接続します。

  3. 接続のテスト］をクリックして、正しく接続できているかをテストします。 PostgreSQL データベースの接続設定。
  4. ［変更を保存］をクリックします。

Spotify 接続の設定

データソース側にSpotify を設定します。［接続］タブをクリックします。

  1. ［接続の追加］セクションで［データソース］タブを選択します。
  2. Spotify アイコンをデータソースとして選択します。プリインストールされたソースにSpotify がない場合には、追加データソースとしてダウンロードします。
  3. 接続プロパティに入力をします。

    OAuth 認証の設定

    Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。

    Spotify アプリケーションのセットアップ

    1. Spotify Developer Dashboard にアクセスします。
    2. Spotify アカウントでログインして Create app をクリックします。
    3. アプリ名、説明を入力し、Redirect URI を設定します（デスクトップアプリケーションの場合は 
      http://localhost:33333
      など）。
    4. アプリ設定から Client ID と Client Secret をコピーします。

    接続プロパティ

    以下の接続プロパティを設定して接続を確立してください：

    • AuthScheme：OAuth に設定します。
    • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId：Spotify アプリケーションの Client ID に設定します。
    • OAuthClientSecret：Spotify アプリケーションの Client Secret に設定します。
    • Scope：必要な OAuth スコープ（スペース区切り）に設定します。デフォルトには、このプロファイルのテーブルに必要なすべての読み取りスコープが含まれます。
    • CallbackURL：Spotify アプリケーションで設定したリダイレクト URI に設定します（例：http://localhost:33333）。

    接続文字列の例

    Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;

    利用可能な OAuth スコープ

    • user-read-private：ユーザーのサブスクリプション詳細と露骨なコンテンツ設定への読み取りアクセス。
    • user-read-email：ユーザーのメールアドレスへの読み取りアクセス。
    • user-library-read：ユーザーが保存したトラック、アルバム、エピソード、ショー、オーディオブックへの読み取りアクセス。
    • playlist-read-private：ユーザーの非公開プレイリストへの読み取りアクセス。
    • playlist-read-collaborative：ユーザーがフォローしているコラボレーティブプレイリストへの読み取りアクセス。
    • user-follow-read：現在のユーザーがフォローしているアーティストの一覧への読み取りアクセス。
    • user-read-playback-state：ユーザーのプレーヤー状態（デバイス、現在のトラック、再生位置）への読み取りアクセス。
    • user-read-currently-playing：ユーザーが現在再生中のコンテンツへの読み取りアクセス。
    • user-read-playback-history：ユーザーが最近再生したトラックへの読み取りアクセス。
    • user-top-read：ユーザーのトップアーティストとトラックへの読み取りアクセス。
    データソースの接続設定（NetSuite の例）。
  4. ［接続のテスト］をクリックして、正しく接続できているかをテストします。
  5. ［変更を保存］をクリックします。

Spotify インスタンス毎のクエリの設定

Data Sync はレプリケーションをコントロールするSQL クエリを簡単なGUI 操作で設定できます。 レプリケーションジョブ設定には、［ジョブ］タブに進み、［ジョブを追加］ボタンをクリックします。 次にデータソースおよび同期先をそれぞれドロップダウンから選択します。 レプリケーションジョブのソースおよび同期先を選択。

テーブル全体をレプリケーションする

テーブル全体をレプリケーションするには、［テーブル］セクションで［テーブルを追加］をクリックします。表示されたテーブルリストからレプリケーションするテーブルをチェックします。

テーブル全体をレプリケーション（NetSuite の例）。

テーブルをカスタマイズしてレプリケーションする

レプリケーションはテーブル全体ではなく、カスタマイズが可能です。［変更］機能を使えば、レプリケーションするカラムの指定、同期先でのカラム名を変更しての保存、ソースデータの各種加工が可能です。レプリケーションのカスタマイズには、ジョブの［変更］ボタンをクリックしてカスタマイズウィンドウを開いて操作を行います:

  • チェックボックスでフィールドを追加もしくは削除 Choose which fields to replicate.
  • カラムリストの下に新しく計算されたフィールドを追加する Add a computed field.
  • フィルタセクションを利用してフィルタを追加する Add a replication filter.

インターフェースを使って変更を行うと、レプリケーションのSQL クエリは以下のようなシンプルなものから： 

REPLICATE [Albums]

次のような複雑なものになります: 

REPLICATE [Albums] SELECT [], [] FROM [Albums] WHERE [Id] = 4aawyAB9vmqN3uQ7FjRGTy

レプリケーションのスケジュール起動設定

［スケジュール］セクションでは、レプリケーションジョブの自動起動スケジュール設定が可能です。反復同期間隔は、15分おきから毎月1回までの間で設定が可能です。

レプリケーションジョブを設定したら、［変更を保存］ボタンを押して保存します。複数のSpotify のデータ のジョブを作成して、Salesforce の外部オブジェクトとして利用可能です。

外部オブジェクトとしてSpotify データレプリケーションにアクセス

Spotify のデータ がHeroku 上のPostgreSQL データベースとしてレプリケーションされたので、Heroku のOData インターフェースを設定し、Salesforce Connect から外部オブジェクトとしてデータ連携できるようにします。

Heroku のOData Service を設定します

まずは、Heroku 上のPostgreSQL データベースに複製されたSpotify のデータ への接続のために、データベースに対しHeroku External Object を設定します。

  1. Heroku ダッシュボードで、［Connect Add-on］ をクリックします。
  2. ［External Objects］を指定します。はじめてHeroku External Object を使用する場合には、OData Server のログインクレデンシャルを作成するようにナビゲートされます。
  3. OData service URL およびクレデンシャルを確認します。このクレデンシャルをSalesforce Connect 接続時に利用します。
  4. ［Data Sources］において、前のプロセスで作成したレプリケーション済みデータベースを設定します。
Heroku Connect でのOData サービスの設定。

詳しくは、こちらのHeroku documentation を参照してください。

Salesforce の外部データソースの設定

Heroku のOData サービスの設定が終わったら、Salesforce Connect を使って、複製されたSpotify のデータ のデータに外部データソースとして連携します。

  1. Salesforce で設定をクリックします。
  2. Administration (管理)セクションで、［データ］→［外部データソース］をクリック。
  3. データソースパラメータプロパティを設定します:
    • External Data Source: Salesforce UI に表示される名前
    • Name: API の一位の識別子
    • Type: Salesforce Connect: OData 4.0
    • URL: Heroku Connect のOData エンドポイント
    • Format: JSON
  4. 認証の設定:
    • Identity Type: Named Principal
    • Authentication Protocol: Password Authentication
    • Username: Heroku Connect username
    • Password: Heroku Connect password
  5. ［保存］をクリック。
Salesforce 外部オブジェクトの設定。

Spotify オブジェクトの同期

Salesforce の外部データソース登録が終わったら、次の方法でSpotify 外部データソースに変更を反映させます。Spotify テーブルの定義とSpotify 外部オブジェクトの定義を同期します。

  1. 作成した外部データソースのリンクをクリック。
  2. ［Validate and Sync］をクリック
  3. Spotify テーブルを選択して、［同期］をクリックします。
外部データソースの同期。

Salesforce オブジェクトとしてSpotify データにアクセス

これで、レプリケーションされたSpotify エンティティに対して、Salesforce の通常オブジェクトと同じように外部オブジェクトとしてアクセスが可能になりました。

是非、CData Sync の30日の無償評価版 をダウンロードして、Salesforce との連携をお試しください！

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData Sync

この記事の内容

関連記事