Support and Documentation

To integrate Google Analytics with Brightspot, you must have a Google Analytics account and a Google API Service account, both of which generate values that you need to configure Brightspot.

Administrators perform these tasks.

Brightspot uses the class GoogleAnalyticsProcessTask to retrieve data from the Google Analytics service using the configuration you make as described in Configuring a Brightspot site. When the GoogleAnalyticsProcessTask is complete, it sends a GoogleAnalyticsProcessTask.TASK_COMPLETE message to Brightspot. The message can be used to trigger further processing, such as recalculating indexed methods and retrieving report data.

The following snippet shows how a modification to a Page can listen for TASK_COMPLETE messages from GoogleAnalyticsProcessTask and then perform a task.

package brightspot.core.page;
import com.psddev.dari.db.Modification;
import com.psddev.dari.db.Recordable;
import com.psddev.dari.util.StringUtils;
import com.psddev.google.analytics.GoogleAnalytics;
import com.psddev.dari.util.ObjectUtils;
import java.util.Date;

@Recordable.FieldInternalNamePrefix("googleAnalytics.")
public class GoogleAnalyticsPageModification extends Modification<Page> {

   @Indexed
   Date lastUpdate;

   @Override
   protected void receiveMessage(String key, Object... args) {
      if (!StringUtils.isBlank(key) && key.startsWith(GoogleAnalytics.MESSAGE_REPORT_PAGE)) {
         if (!ObjectUtils.isBlank(args)) {
             Object endDate = args[0];

             if (args[0] != null && args[0] instanceof Date) {
                 Date newLastUpdate = (Date) args[0];

                 if (!ObjectUtils.equals(lastUpdate, newLastUpdate)) {
                     lastUpdate = newLastUpdate;
                     this.save();
                 }
             }
         }
     }
   }
}

In the previous snippet—

You can also use modifications to access Google report data for objects that you want to report on. Use the TimeSeries and TimeSeriesValues classes to specify the time scope of data to be retrieved and reported on.

The following example calculates total page views for the last 24 hours for Page.

package brightspot.core.page;

import com.psddev.cms.db.Site;
import com.psddev.dari.db.Modification;
import com.psddev.dari.db.Recordable;
import com.psddev.dari.util.StringUtils;
import com.psddev.google.analytics.GoogleAnalytics;
import com.psddev.timeseries.TimeSeries;
import com.psddev.timeseries.TimeSeriesValues;
import com.psddev.dari.util.ObjectUtils;
import java.util.Date;

@Recordable.FieldInternalNamePrefix("googleAnalytics.")
public class GoogleAnalyticsPageModification extends Modification<Page> {

   @Indexed
   Date lastUpdate;

   @Indexed
   public float getPageViewsLast24Hours() {
      long pageViews = 0;

      Site.ObjectModification siteModification = this.as(Site.ObjectModification.class);

      if (siteModification != null) {
         if (siteModification.isGlobal()) {

             TimeSeries pageViewTimeSeries = new TimeSeries(GoogleAnalytics.PAGE_VIEWS_TIME_SERIES_NAME);

             if (pageViewTimeSeries != null) {
                 pageViews += TimeSeriesValues.ofHours(24, getId(), pageViewTimeSeries).sum();
             }
         }

         Site owner = siteModification.getOwner();
         if (owner != null) {
             TimeSeries pageViewTimeSeries = new TimeSeries(GoogleAnalytics.PAGE_VIEWS_TIME_SERIES_NAME + "." + owner.getId());
             if (pageViewTimeSeries != null) {
                 pageViews += TimeSeriesValues.ofHours(24, getId(), pageViewTimeSeries).sum();
             }
         }

         for (Site site : siteModification.getConsumers()) {

             TimeSeries pageViewTimeSeries = new TimeSeries(GoogleAnalytics.PAGE_VIEWS_TIME_SERIES_NAME + "." + site.getId());
             if (pageViewTimeSeries != null) {
                 pageViews += TimeSeriesValues.ofHours(24, getId(), pageViewTimeSeries).sum();
             }
         }
      }
      return pageViews;
   }
}

In the previous snippet—