LINQPad でApprovalMax のデータを操作する方法

加藤龍彦
加藤龍彦
デジタルマーケティング
LINQPad からCData ADO.NET Providerを使ってApprovalMax に接続し、LINQクエリでデータを取得・操作する具体的な手順を解説します。



CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってApprovalMax の操作を実現します。この記事では、LINQPad から接続してLINQ クエリを実行する方法を説明します。

必要なもの

本記事の手順を実行してLINQPad からApprovalMax に接続するには、以下の3つの製品が必要になります。

  • ApprovalMax の環境
  • LINQPad
  • CData ADO.NET Provider for API。右側のサイドバーから30日間無償トライアルがダウンロードできます

データモデルの作成

CData ADO.NET Provider for API およびLINQPad をダウンロード・インストールしたら、Visual Studio で新しいクラスライブラリプロジェクトを作成します。

ADO.NET Provider の利用に必要となるEF 6を設定する方法については、ヘルプドキュメントを参照してください。

  1. プロジェクトを右クリックし、［追加］→［新しい項目］→［ADO.NET Entity Data Model］をクリックします。ダイアログが表示されたら、データベースから［Code First］を選択します。 ［New Connection］をクリックして、表示されたウィザードで接続文字列オプションを指定します。

    New Connectionを選択して新しい接続設定を作成

    2. まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。

    ApprovalMax API プロファイル設定

    ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

    まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。

    Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。

    以下の接続プロパティを設定すると、接続できるようになります。

    • AuthScheme：OAuth に設定します。
    • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
    • OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
    • CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
    • Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

    OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

    一般的な接続文字列は次のとおりです。 

    Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;

  2. 希望するテーブルおよびビューを選択して［Finish］をクリックし、データモデルを作成します。

    下部のFinishをクリックしてデータモデルを作成
  3. プロジェクトをビルドします。生成されたファイルを使ってLINQPad でApprovalMax 接続を作成できます。

LINQPad でApprovalMax のデータに接続

必要な接続プロパティを取得してデータモデルアセンブリを作成したら、以下の手順に従ってLINQPad でデータモデルを使いはじめましょう。

  1. LINQPad を開き［接続の追加］をクリックします。

    接続の追加をクリック

  2. ［Use a typed data context from your own assembly］オプションを選択します。

  3. ［Entity Framework DbContext］を選択します。

    下部のフィールドから［Entity Framework DbContext］を選択

  4. ［Path to Custom Assembly］ボックスの横にある［参照］をクリックして、プロジェクトフォルダを参照します。bin フォルダの下の.dll または.exe を参照します。

  5. DbContext の名前を選択します。
  6. 接続文字列をApp.Config に保存した場合は、App.Config へのパスを指定します。
DbContextの名前とApp.Configへのパスを指定

これでLINQPad 経由でApprovalMax にクエリできます。サポートされたLINQ クエリの例は、ヘルプドキュメントの「LINQ およびEntity Framework」を参照してください。

LINQPad からApprovalMaxに接続

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

API Driver で ApprovalMax のライブデータに接続

ApprovalMax に接続

この記事の内容

関連記事