フィルタを指定して特定のページのPVを Google Analytics から取得する - C#

Google Analytics Data Export APIを用いてGoogle Analyticsのページビュー数を取得します。今回はフィルタを指定して特定のページのPVを取得します。
サービス終了に関する注意
Google Universal Analytics はサービスを終了したため、現在はこの記事で紹介しているコードは動作しません。 新しい Google Analytics 4 (GA4) プロパティを利用する必要があります。 GA4プロパティからのデータ取得はこちらの記事を参照してください。

UI

以下のUIを用意します。使用するボタンは"プロファイル取得"と"ページごとのPV取得 フィルタ"の2つのみになります。

コード

下記のコードを記述します。
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using Google.GData.Client;
using Google.GData.Analytics;
using Google.GData.Extensions;


namespace GoogleAnalyticsDataGet
{
  public partial class FormMain : Form
  {

    public FormMain()
    {
      InitializeComponent();
    }

    private void button_GetProfile_Click(object sender, EventArgs e)
    {
      string userName = textBox_User.Text;
      string passWord = textBox_Pass.Text;

      AccountQuery query = new AccountQuery();
      AnalyticsService service = new AnalyticsService("AnalyticsSampleApp(iPentec)");
      if (!string.IsNullOrEmpty(userName)) {
        service.setUserCredentials(userName, passWord);
      }

      AccountFeed accountFeed = service.Query(query);
      foreach (AccountEntry entry in accountFeed.Entries) {
        ListViewItem item = new ListViewItem(entry.Title.Text);
        //item.SubItems.Add(entry.Title.Text);
        item.SubItems.Add(entry.ProfileId.Value);
        listView_Profile.Items.Add(item);
      }
    }

    private void button1_Click(object sender, EventArgs e)
    {
      listView_PageView.Items.Clear();

      string userName = textBox_User.Text;
      string passWord = textBox_Pass.Text;
      string profileId = listView_Profile.SelectedItems[0].SubItems[1].Text;
      const string dataFeedUrl = "https://www.google.com/analytics/feeds/data";

      AnalyticsService service = new AnalyticsService("AnalyticsSampleApp(iPentec)");
      if (!string.IsNullOrEmpty(userName)) {
        service.setUserCredentials(userName, passWord);
      }

      DataQuery query = new DataQuery(dataFeedUrl);
      query.Ids = profileId;
      query.Metrics = "ga:pageviews";
      query.Dimensions = "ga:pagePath";
      query.Sort = "-ga:pageviews";
      //query.Filters = "-ga:pageviews";
      //query.Filters = "ga:pagePath==/";
      query.Filters = @"ga:pagePath=~/Document/Document.aspx\?page=csharp.*";

      query.GAStartDate = dateTimePicker_Start.Value.ToString("yyyy-MM-dd");
      query.GAEndDate = dateTimePicker_End.Value.ToString("yyyy-MM-dd");
      query.NumberToRetrieve = 500;

      DataFeed dataFeed = service.Query(query);
      foreach (DataEntry entry in dataFeed.Entries) {
        ListViewItem item = new ListViewItem(entry.Title.Text);
        item.SubItems.Add(entry.Metrics[0].Value);
        listView_PageView.Items.Add(item);
      }
    }
  }
}

解説

下記のボタンのClickイベントでフィルタを指定してPageViewの値を取得しています。
private void button1_Click(object sender, EventArgs e)
{
  listView_PageView.Items.Clear();

  string userName = textBox_User.Text;
  string passWord = textBox_Pass.Text;
  string profileId = listView_Profile.SelectedItems[0].SubItems[1].Text;
  const string dataFeedUrl = "https://www.google.com/analytics/feeds/data";

  AnalyticsService service = new AnalyticsService("AnalyticsSampleApp(iPentec)");
  if (!string.IsNullOrEmpty(userName)) {
    service.setUserCredentials(userName, passWord);
  }

  DataQuery query = new DataQuery(dataFeedUrl);
  query.Ids = profileId;
  query.Metrics = "ga:pageviews";
  query.Dimensions = "ga:pagePath";
  query.Sort = "-ga:pageviews";
  query.Filters = "ga:pagePath==/";

  query.GAStartDate = dateTimePicker_Start.Value.ToString("yyyy-MM-dd");
  query.GAEndDate = dateTimePicker_End.Value.ToString("yyyy-MM-dd");
  query.NumberToRetrieve = 500;

  DataFeed dataFeed = service.Query(query);
  foreach (DataEntry entry in dataFeed.Entries) {
    ListViewItem item = new ListViewItem(entry.Title.Text);
    item.SubItems.Add(entry.Metrics[0].Value);
    listView_PageView.Items.Add(item);
  }
}

下記のコードでフィルタを指定しています。"pagePath"が"/"のものを抽出する式になっています。
  query.Filters = "ga:pagePath==/";

条件式の一覧は https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters のページに記載されています。
Metricフィルタで利用できる等号・不等号
表記説明
==一致
!=不一致
>より小さい
<より大きい
>=以下
<=以上


Dimension フィルタで利用できる等号・不等号
表記説明
==一致
!=不一致
=@右辺を含んでいる(部分一致)
!@右辺を含んでいない
=~正規表現を満たす
!~正規表現を満たさない

実行結果

pagePathが"/"の値が取り出せます。

フィルタに正規表現を使う場合

フィルタに正規表現を指定することもできます。正規表現の場合は フィルタの"=="を "=~"に変えます。

先のコードの
query.Filters = "ga:pagePath==/";
部分を
query.Filters = @"ga:pagePath=~/Document/Document.aspx\?page=csharp.*";
に変更します。PagePathが"/Document/Document.aspx\?page=csharp(任意の文字列)"のものを抽出する条件式です。

実行結果

PagePathが"/Document/Document.aspx\?page=csharp(任意の文字列)"のみを抽出できています。


著者
iPentecのメインプログラマー
C#, ASP.NET の開発がメイン、少し前まではDelphiを愛用
掲載日: 2011-12-28
iPentec all rights reserverd.