google_analytics_v4_api 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00e78b59df928bfa8edea30095716394a73902e8b49e67dbf80d43a50bd0abae
-  data.tar.gz: ebb7c0c7726fcfd28692959614d11d5e47c5b35f468f353df1b157e6c6516023
+  metadata.gz: 516d5859258748f1f4749df54b064cc3caf1b9707028041fd0db0084a75d719d
+  data.tar.gz: 0030de2106fff16d2ad13e7feb9c98af718fa0c55b04c30a9eecd462ff8df08a
 SHA512:
-  metadata.gz: 9cf3584d6552e6c46849ad878dc3a987d5b835d198f138a4f8125722e5c50b47466adc337999235adf8c1ec8ba4a5fa3ae70b454209b838e860da2c9e156938f
-  data.tar.gz: f12a6255bda5ce39749cd152f515d8fbc6e3fa99c3b5ae087dd356f582fdcff45b73ac49c278ec184dc7933df208e84353166bd2dec019d8cd812bb614af5f53
+  metadata.gz: 3bee4ad056696d0829191e46f6187c0d5a29cfeaebc5ad7fba3ea3b0766aa7d004b1b99ec26f854f4f7cf6d636c94f1f3b097e2ad5991413e7507be3e545443c
+  data.tar.gz: 060b03b7c94203270e627dcc35ae8e1262ccbb467040b5221c86518c4815b16a5239d3c77699ea43a8b5b511160d948143a4069aaa3b67b8af8d398e14ef4be6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    google_analytics_v4_api (0.0.1)
+    google_analytics_v4_api (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,7 @@
 # Google Analytics v4 API Ruby Gem
 This is a simple wrapper to interact with the Google Analytics v4 API (currently in beta) with Ruby.
-It's based on the [API guide](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta)
+It's based on the [Admin API guide](https://developers.google.com/analytics/devguides/config/admin/v1/rest) and the
+[Reports API guide](https://developers.google.com/analytics/devguides/reporting/data/v1/basics?authuser=1#report_response)
 
 ## Usage
 Add this gem to your Gemfile:
@@ -10,21 +11,79 @@ gem 'google_analytics_v4_api'
 
 You will need a way to get a user's valid (and fresh) token (I personally use the `gem omnioauth`), and then:
 
+### Management API
 ```rb
 client = GoogleAnalyticsV4Api::Client.new(token)
 # List all the accounts
-client.accounts
+accounts = client.accounts
 # Or get one particular account
-client.account("account/24696xxx")
+account = client.account("accounts/24696xxx")
 
 # List all the properties for a particular account
-client.properties("accounts/24596xxx")
+properties = client.properties("accounts/24596xxx")
 # Or get one particular property
-client.property("properties/33783xxx")
+property = client.property("properties/33783xxx")
+
+# Or simply call the properties for an Account object
+properties = account.properties
+# Or one particular property
+property = account.property("properties/33783xxx")
 ```
 
-The rest is still being defined.
+### Data API
+```rb
+filter = {
+  "andGroup": {
+    "expressions": [
+      {
+        "filter": {
+          "fieldName": "countryId",
+          "stringFilter": {
+            "value": "CL"
+          }
+        }
+      },
+      {
+        "filter": {
+          "fieldName": "pagePath",
+          "stringFilter": {
+            "matchType": "CONTAINS",
+            "value": "events",
+            "caseSensitive": false
+          }
+        }
+      }
+    ]
+  }
+}
+report = GoogleAnalyticsV4Api::Report.new(
+          dimensions: ['pagePath', 'countryId'],
+          metrics: ['sessions', 'screenPageViews'],
+          dimension_filter: filter,
+          start_date: Date.today - 30, #optional, 30 days ago by default
+          end_date: Date.today - 1) #optional, today by default
+
+response = property.run_report(report)
+
+# Get raw data from the response
+response.raw_dimension_headers
+=> [{"name"=>"pagePath"}, {"name"=>"countryId"}]
+response.raw_metric_headers
+=> [{"name"=>"sessions", "type"=>"TYPE_INTEGER"}, {"name"=>"screenPageViews", "type"=>"TYPE_INTEGER"}]
+response.rows.first
+=> {"dimensionValues"=>[{"value"=>"/events"}, {"value"=>"CL"}], "metricValues"=>[{"value"=>"58"}, {"value"=>"78"}]}
+
+# Or get a simplified version of the response
+response.dimension_headers
+=> ["pagePath", "countryId"]
+response.metric_headers
+=> ["sessions", "screenPageViews"]
+response.parsed_rows.first.data
+=> {"pagePath"=>"/events", "countryId"=>"CL", "sessions"=>58, "screenPageViews"=>78}
 
+```
+Dimensions and Metrics are available [here](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema)
+Information about Filters is available [here](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
 
 ## Development
 

data/lib/google_analytics_v4_api/account.rb

@@ -6,19 +6,24 @@ module GoogleAnalyticsV4Api
   class Account
     attr_accessor :name, :createTime, :updateTime, :displayName, :regionCode
 
-    def initialize(attributes = {})
+    def initialize(client, attributes = {})
+      @client = client
       attributes.each do |k, v|
         self.send("#{k}=", v)
       end
     end
 
     def properties
+      @client.properties(name)
+    end
 
+    def property(property_name)
+      @client.property(property_name)
     end
 
-    def self.parse_list(body)
+    def self.parse_list(client, body)
       JSON.parse(body)["accounts"].map do |attrs|
-        GoogleAnalyticsV4Api::Account.new(attrs)
+        GoogleAnalyticsV4Api::Account.new(client, attrs)
       end
     end
   end

data/lib/google_analytics_v4_api/client.rb

@@ -1,20 +1,16 @@
 # frozen_string_literal: true
 
-require 'json'
-require "net/http"
-require "uri"
-
 module GoogleAnalyticsV4Api
   class Client
 
-    BASE_URL = "https://analyticsadmin.googleapis.com/v1beta"
+    attr_accessor :access_token
 
     def initialize(access_token)
       @access_token = access_token
     end
 
     def accounts
-      @accounts ||= GoogleAnalyticsV4Api::Account.parse_list get("/accounts").body
+      @accounts ||= GoogleAnalyticsV4Api::Account.parse_list(self, get("/accounts"))
     end
 
     def account(account_name)
@@ -22,7 +18,10 @@ module GoogleAnalyticsV4Api
     end
 
     def properties(account_name)
-      @properties ||= GoogleAnalyticsV4Api::Property.parse_list get("/properties", { filter: "parent:#{account_name}"}).body
+      @properties ||= Hash.new do |h, key|
+        h[key] = GoogleAnalyticsV4Api::Property.parse_list(self, get("/properties", { filter: "parent:#{key}"}))
+      end
+      @properties[account_name]
     end
 
     def property(property_name)
@@ -31,25 +30,13 @@ module GoogleAnalyticsV4Api
         return property unless property.nil?
       end
 
-      GoogleAnalyticsV4Api::Property.parse get("/#{property_name}").body
+      GoogleAnalyticsV4Api::Property.parse(self, get("/#{property_name}"))
     end
 
     private
     def get(path, params = {})
-      url = "#{BASE_URL}#{path}"
-      url += "?#{URI.encode_www_form params}" unless params.empty?
-      uri = URI(url)
-
-      response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
-        request = Net::HTTP::Get.new uri
-        request["Authorization"] = "Bearer #{@access_token}"
-        request["Content-Type"] = "application/json"
-
-        http.request request
-      end
-      raise GoogleAnalyticsV4Api::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
-
-      response
+      Request.get(access_token: @access_token, path: path, params: params).body
     end
+
   end
 end

data/lib/google_analytics_v4_api/property.rb

@@ -6,21 +6,30 @@ module GoogleAnalyticsV4Api
   class Property
     attr_accessor :name, :propertyType, :createTime, :updateTime, :parent, :displayName, :industryCategory, :timeZone, :currencyCode, :serviceLevel, :deleteTime, :expireTime, :account
 
-    def initialize(attributes = {})
+    def initialize(client, attributes = {})
+      @client = client
       attributes.each do |k, v|
         self.send("#{k}=", v)
       end
     end
 
-    def self.parse_list(body)
+    def account
+      @client.account(parent)
+    end
+
+    def run_report(report)
+      response = Request.post(access_token: @client.access_token, path: "/#{name}:runReport", payload: report.to_json)
+      ReportResponse.new(response)
+    end
+
+    def self.parse_list(client, body)
       JSON.parse(body)["properties"].map do |attrs|
-        GoogleAnalyticsV4Api::Property.new(attrs)
+        GoogleAnalyticsV4Api::Property.new(client, attrs)
       end
     end
 
-    def self.parse(body)
-      GoogleAnalyticsV4Api::Property.new(JSON.parse(body))
+    def self.parse(client, body)
+      GoogleAnalyticsV4Api::Property.new(client, JSON.parse(body))
     end
-
   end
 end

data/lib/google_analytics_v4_api/report.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'date'
+
+module GoogleAnalyticsV4Api
+  class Report
+    attr_accessor :date_ranges, :dimensions, :metrics, :dimension_filter
+
+    def initialize(start_date: nil, end_date: nil, dimensions: [], metrics: [], dimension_filter: {})
+      @date_ranges = [{ "startDate": start_date || (Date.today - 30), "endDate": end_date || Date.today }]
+      @dimensions = dimensions.map { |dimension| { "name": dimension } }
+      @metrics = metrics.map { |metric| { "name": metric } }
+      @dimension_filter = dimension_filter
+    end
+
+    def to_json
+      {
+        "dateRanges": @date_ranges,
+        "dimensions": @dimensions,
+        "metrics": @metrics,
+        "dimensionFilter": @dimension_filter
+      }.to_json
+    end
+  end
+end

data/lib/google_analytics_v4_api/report_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'date'
+
+module GoogleAnalyticsV4Api
+  class ReportResponse
+
+    attr_accessor :body, :raw_dimension_headers, :raw_metric_headers, :rows, :row_count, :metadata, :kind
+
+    def initialize(body)
+      @body = JSON.parse body
+      @raw_dimension_headers = @body["dimensionHeaders"]
+      @raw_metric_headers = @body["metricHeaders"]
+      @rows = @body["rows"]
+      @row_cont = @body["rowCount"]
+      @metadata = @body["metadata"]
+      @kind = @body["kind"]
+    end
+
+    def dimension_headers
+      @dimension_headers ||= @raw_dimension_headers.map { |header| header["name"] }
+    end
+
+    def metric_headers
+      @metric_headers ||= @raw_metric_headers.map { |header| header["name"] }
+    end
+
+    def parsed_rows
+      @rows.map do |row|
+        ReportResponseRow.new(row, @raw_dimension_headers, @raw_metric_headers)
+      end
+    end
+
+  end
+end

data/lib/google_analytics_v4_api/report_response_row.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'date'
+
+module GoogleAnalyticsV4Api
+  class ReportResponseRow
+
+    attr_accessor :data
+
+    def initialize(row, raw_dimension_headers, raw_metric_headers)
+      # "dimensionHeaders"=>[{"name"=>"pagePath"}, {"name"=>"countryId"}],
+      # "metricHeaders"=>[{"name"=>"sessions", "type"=>"TYPE_INTEGER"}, {"name"=>"screenPageViews", "type"=>"TYPE_INTEGER"}],
+      # a row: {"dimensionValues"=>[{"value"=>"/events"}, {"value"=>"CL"}], "metricValues"=>[{"value"=>"62"}, {"value"=>"82"}]}
+      @raw_row = row
+      @data = {}
+      raw_dimension_headers.each_with_index do |dimension_header, index|
+        @data[dimension_header["name"]] = row["dimensionValues"][index]["value"]
+      end
+      raw_metric_headers.each_with_index do |metric_header, index|
+        @data[metric_header["name"]] = cast(row["metricValues"][index]["value"], metric_header["type"])
+      end
+    end
+
+    def cast(value, type)
+      words = type.split("_")
+      return value unless words[0] == 'TYPE'
+      return value.to_i if words[1] == "INTEGER"
+      return value.to_f if words[1].in? %w(FLOAT SECONDS MILLISECONDS MINUTES HOURS STANDARD CURRENCY FEET MILES METERS KILOMETERS)
+
+      value
+    end
+
+  end
+end

data/lib/google_analytics_v4_api/request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module GoogleAnalyticsV4Api
+  class Request
+
+    ADMIN_URL = "https://analyticsadmin.googleapis.com/v1beta"
+    DATA_URL = "https://analyticsdata.googleapis.com/v1beta"
+
+    def self.get(access_token:, url: ADMIN_URL, path:, params: {})
+      url = "#{url}#{path}"
+      url += "?#{URI.encode_www_form params}" unless params.empty?
+      uri = URI(url)
+
+      response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+        request = Net::HTTP::Get.new uri
+        request["Authorization"] = "Bearer #{access_token}"
+        request["Content-Type"] = "application/json"
+
+        http.request request
+      end
+      raise GoogleAnalyticsV4Api::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
+
+      response
+    end
+
+    def self.post(access_token:, url: DATA_URL, path:, payload: nil)
+      url = URI("#{url}#{path}")
+
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Post.new(url)
+      request["Authorization"] = "Bearer #{access_token}"
+      request["Content-Type"] = "application/javascript"
+      request.body = payload
+
+      response = https.request(request)
+      response.read_body
+    end
+
+  end
+end

data/lib/google_analytics_v4_api/version.rb

@@ -1,3 +1,3 @@
 module GoogleAnalyticsV4Api
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/google_analytics_v4_api.rb

@@ -4,5 +4,9 @@ module GoogleAnalyticsV4Api
   autoload :Client, "google_analytics_v4_api/client"
   autoload :Account, "google_analytics_v4_api/account"
   autoload :Property, "google_analytics_v4_api/property"
+  autoload :Request, "google_analytics_v4_api/request"
+  autoload :Report, "google_analytics_v4_api/report"
+  autoload :ReportResponse, "google_analytics_v4_api/report_response"
+  autoload :ReportResponseRow, "google_analytics_v4_api/report_response_row"
   autoload :Error, "google_analytics_v4_api/error"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_analytics_v4_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-20 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the Google Analytics V4 API to be used in conjuntion
   with OAuth2
@@ -33,6 +33,10 @@ files:
 - lib/google_analytics_v4_api/client.rb
 - lib/google_analytics_v4_api/error.rb
 - lib/google_analytics_v4_api/property.rb
+- lib/google_analytics_v4_api/report.rb
+- lib/google_analytics_v4_api/report_response.rb
+- lib/google_analytics_v4_api/report_response_row.rb
+- lib/google_analytics_v4_api/request.rb
 - lib/google_analytics_v4_api/version.rb
 homepage: https://github.com/dailytics/google_analytics_v4_api
 licenses: