https://github.com/koic/gtm_rails

Simply embed Google Tag Manager container snippet into Rails application
https://github.com/koic/gtm_rails

google-tag-manager rails

Last synced: 3 months ago
JSON representation

Simply embed Google Tag Manager container snippet into Rails application

• Host: GitHub
• URL: https://github.com/koic/gtm_rails
• Owner: koic
• License: mit
• Created: 2017-01-25T12:05:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-25T09:20:25.000Z (almost 6 years ago)
• Last Synced: 2024-10-06T04:35:00.024Z (3 months ago)
• Topics: google-tag-manager, rails
• Language: Ruby
• Homepage:
• Size: 40 KB
• Stars: 17
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gtm_rails [![Build Status](https://travis-ci.org/koic/gtm_rails.svg)](https://travis-ci.org/koic/gtm_rails) [![Gem Version](https://badge.fury.io/rb/gtm_rails.svg)](http://badge.fury.io/rb/gtm_rails) [![git.legal](https://git.legal/projects/3929/badge.svg "Number of libraries approved")](https://git.legal/projects/3929)

Simply embed Google Tag Manager container snippet into Rails application.

## Installation

Add these lines to your application's Gemfile:

```

gem 'gtm_rails'

```

And then execute:

```

$ bundle install

```

## Configuration

Create `config/google_tag_manager.yml` in your Rails application.

```yaml

staging:

  foo: GTM-YourGtmId1

  bar: GTM-YourGtmId2

  baz: GTM-YourGtmId3

production:

  foo: GTM-YourGtmId4

  bar: GTM-YourGtmId5

  baz: GTM-YourGtmId6

```

The above is a sample. `foo`, `bar`, `baz` are arbitrary label names, and replacing GTM-XXXX with your container ID.

In view, use two helper methods.

1. `google_tag_manager_script_tag(label_name)`

2. `google_tag_manager_noscript_tag(label_name)`

These method arguments are a label name specified in `config/google_tag_manager.yml`.

First, following method as close to the opening `` tag as possible on every page of your website.

```erb

<%= google_tag_manager_script_tag(:foo) %>

```

Google Tag Manager container snippet will be expanded based on `Rails.env` and label name. If there is no match, a blank string is returned.

```html

(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':

new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],

j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=

'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);

})(window,document,'script','dataLayer','GTM-YourGtmId1');

```

Second, following method immediately after the opening `` tag on every page of your website.

```erb

<%= google_tag_manager_noscript_tag(:foo) %>

```

Google Tag Manager container snippet will be expanded based on `Rails.env` and label name. If there is no match, a blank string is returned.

```html

```

For more detailed GTM please click here to [read more](https://developers.google.com/tag-manager/quickstart).

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## License

gtm_rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).