Entity Framework 6 からAdobe Analytics のデータに連携

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでAdobe Analytics にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Adobe Analytics Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   Adobe Analytics への接続

   それでは、Adobe Analytics に接続していきましょう。接続するには、GlobalCompanyId およびRSID を識別する必要があります。デフォルトでは、ドライバーが会社とレポートスイートの識別を自動で試みますが、これらの値を明示的に指定することも可能です。詳しい手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「Adobe Analytics への接続」セクションをご確認ください。

   Adobe Analytics への認証

   続いて、認証方法を設定しましょう。Adobe Analytics はOAuth 認証標準を利用しており、OAuth またはサービスアカウントで認証できます。

   ユーザーアカウント（OAuth）

   ユーザーアカウントでの認証では、すべてのフローでAuthScheme をOAuth に設定する必要があります。詳しい認証手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「Adobe Analytics への認証」セクションをご参照ください。

   サービスアカウント

   サービスアカウントではサイレント認証が利用でき、ブラウザでのユーザー認証が不要です。このフローを使用するには、アプリケーションを作成する必要があります。アプリケーションの作成および認可については、ドキュメントの「カスタムOAuth アプリの作成」をご確認ください。これにより、サービスアカウントにアクセス権があるAdobe Analytics データに接続できるようになります。

   サービスアカウントを使用したServer-to-Server OAuth で認証するには、AuthScheme をOAuthClient に設定します。接続には以下のプロパティを設定してください。

   • InitiateOAuth：GETANDREFRESH に設定
   • OAuthClientId：アプリケーション設定のクライアントId に設定
   • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定

   接続すると、CData 製品がサービスアカウントでのOAuth フローを以下の手順で完了します。

   1. クライアントクレデンシャルOAuth フローで指定されたOAuthClientId およびOAuthClientSecret を使用して、アクセストークンを取得します
   2. OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします
   3. トークンが期限切れになった際に、新しいアクセストークンを要求します

   
   <configuration>
      ... <connectionStrings>
       <add name="AdobeAnalyticsContext" connectionString="Offline=False;GlobalCompanyId=myGlobalCompanyId; RSID=myRSID; OAuthClientId=myOauthClientId; OauthClientSecret=myOAuthClientSecret; CallbackURL=myCallbackURL;" providerName="System.Data.CData.AdobeAnalytics" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.AdobeAnalytics" type="System.Data.CData.AdobeAnalytics.AdobeAnalyticsProviderServices, System.Data.CData.AdobeAnalytics.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.AdobeAnalytics.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAdobeAnalyticsContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class AdobeAnalyticsContext :DbContext {
   	public AdobeAnalyticsContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<AdobeAnalyticsContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAdobe Analytics のエンティティ、例えばAdsReport にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class AdsReport {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String Page { get; set; }
   }
   public class AdsReportMap :EntityTypeConfiguration<AdsReport> {
   	public AdsReportMap() {
   		this.ToTable("AdsReport");
   		this.HasKey(AdsReport => AdsReport.Id);
   		this.Property(AdsReport => AdsReport.Page);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<AdsReport> AdsReport { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   AdobeAnalyticsContext context = new AdobeAnalyticsContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.AdsReport select line;