gtm_on_rails 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a8eac117ffac718f394160b8e35932a4f0ce2c
-  data.tar.gz: 517d2fa7b9b26cb0d863f7888358525a3f38e8eb
+  metadata.gz: 1c9e870f052ec71da90cdec566206bf0a0abbdb3
+  data.tar.gz: d9f6a5094d2f6ab658b0f6b4b65c792d2c6ecee1
 SHA512:
-  metadata.gz: 5c52b280fe734410874001cc4d026053cb886830e5c9c2332950a8dcae7f6d019a9bc463307c9dc45746b37531268e43232d7c27221d1163a9093060b7014263
-  data.tar.gz: b875836ba165cab590f5154b14f58a7de0a6dc05032c6190daa4d58fb25db044ae94911e2aa97db5f7c4ad4a482f8aece9333a4bf6e1df183a571eb4bf24c2ea
+  metadata.gz: 4bada8d3c2ab77c132d1aa4e4441b633c07e94ea6fbde9ee3c302c089b061da502f9630d5c368c154fa5a17898062a43faef76c4e95a3972826e7e6cc3ecf087
+  data.tar.gz: 3ee546cdb7d1ae43bb00a3d0f0c8e2c7143f372fc931cde46fe0ac7d647cde5e72db2994584735a94d56bceaa26cab99dd8dd3f5a841c8e42b018c205c855b22

data/README.ja.md

@@ -52,6 +52,21 @@ data_layer.push({
 
 送信したdataLayerの内容は、GoogleTagManager側で変数に設定する等して使用して下さい。
 
+```ruby
+data_layer.push(
+  {
+    name: 'name'
+  },
+  before_page_view: true
+)
+```
+
+上記のように`before_page_view`属性を設定することで、GoogleTagManagerの「Page View」イベントより前にdataLayerをpushできます。
+
+「Page View」イベント自体にdataLayerの変数を使用したい場合等に使用します。
+
+※GoogleAnalyticsのページビュー送信より前に「ヒット」系の送信が行われてしまうと、正常にGoogleAnalyticsのページビューが計測できない可能性があるので、使用する際は注意して下さい。
+
 #### `GtmOnRails::DataLayer::Object`
 ```ruby
 object = GtmOnRails::DataLayer::Object.new({name: 'name'})

data/README.md

@@ -52,6 +52,21 @@ data_layer.push({
 ```
 Configure the variable and so on Google Tag Manager when use sended values.
 
+```ruby
+data_layer.push(
+  {
+    name: 'name'
+  },
+  before_page_view: true
+)
+```
+
+You also can set dataLayer values before the "Page View" event of Google Tag Manager, when you use `before_page_view` option as the above.
+
+For examle, you use this option when want to use dataLayer's variables in the "Page View" event.
+
+† Be careful of using this option, because you may not be measure PageView normalcy, when you send Hit type event to GoogleAnalytics before send PageView.
+
 #### `GtmOnRails::DataLayer::Object`
 ```ruby
 object = GtmOnRails::DataLayer::Object.new({name: 'name'})

data/app/views/gtm_on_rails/layouts/_data_layer_before_page_view_tag.html.erb

@@ -0,0 +1,14 @@
+<% begin %>
+  <!-- GTM on Rails before Page View -->
+  <%= data_layer.print_on_html(before_page_view: true) %>
+  <!-- End GTM on Rails before Page View -->
+<%-
+  rescue => e
+    if GtmOnRails.config.rescue_when_error_occurred
+      logger.warn(e.message)
+      logger.warn(e.backtrace.join("\n"))
+    else
+      raise e
+    end
+  end
+-%>

data/lib/gtm_on_rails/models/data_layer.rb

@@ -3,30 +3,40 @@ module GtmOnRails
   class DataLayer
     include ActionView::Helpers::TagHelper
 
-    attr_accessor :objects
+    attr_accessor :objects, :objects_before_page_view
 
     def initialize(*args)
       options  = args.extract_options!
       @objects = [args].flatten # @objects are instances of GTM::DataLayerObject
+
+      @objects_before_page_view = []
     end
 
-    def push(args)
+    def push(args, **options)
       args = [args].flatten
       args.each do |object|
         case object
         when Hash
-          @objects << GtmOnRails::DataLayer::Object.new(object)
+          obj = GtmOnRails::DataLayer::Object.new(object)
         when GtmOnRails::DataLayer::Object
-          @objects << object
+          obj = object
+        end
+
+        if options[:before_page_view]
+          @objects_before_page_view << obj
+        else
+          @objects << obj
         end
       end
     end
 
-    def to_js
+    def to_js(before_page_view: false)
       js_codes = []
 
       js_codes << "var dataLayer = dataLayer || [];"
-      @objects.each do |data_layer_object|
+
+      objs = before_page_view ? @objects_before_page_view : @objects
+      objs.each do |data_layer_object|
         # dataLayer size limit exception
         size = data_layer_object.to_json.bytesize
         if size > GtmOnRails.config.data_layer_limit_byte_size
@@ -40,8 +50,8 @@ module GtmOnRails
       return js_codes.join.html_safe
     end
 
-    def print_on_html
-      content_tag(:script, self.to_js)
+    def print_on_html(before_page_view: false)
+      content_tag(:script, self.to_js(before_page_view: before_page_view))
     end
 
     def method_missing(method, *args, &block)

data/lib/gtm_on_rails/tag_helper.rb

@@ -2,6 +2,7 @@ module GtmOnRails
   module TagHelper
     def render_gtm_on_rails_tag_in_head
       tags = []
+      tags << render(partial: 'gtm_on_rails/layouts/data_layer_before_page_view_tag')
       tags << render(partial: 'gtm_on_rails/layouts/google_tag_manager_tag_in_head')
       tags.join.html_safe
     end

data/lib/gtm_on_rails/version.rb

@@ -1,3 +1,3 @@
 module GtmOnRails
-  VERSION = '0.1.10'
+  VERSION = '0.1.11'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gtm_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - ykogure
@@ -49,6 +49,7 @@ files:
 - README.ja.md
 - README.md
 - Rakefile
+- app/views/gtm_on_rails/layouts/_data_layer_before_page_view_tag.html.erb
 - app/views/gtm_on_rails/layouts/_data_layer_tag.html.erb
 - app/views/gtm_on_rails/layouts/_google_tag_manager_tag_in_body.html.erb
 - app/views/gtm_on_rails/layouts/_google_tag_manager_tag_in_head.html.erb