Отслеживание гаджетов

В этом документе описывается, как использовать новый API гаджетов для отслеживания гаджетов Analytics. Этот API предлагает улучшенную модель данных и отслеживание производительности для сбора статистики отчетов Analytics для ваших гаджетов.

  1. Прежде чем вы начнете
  2. Отслеживание вашего гаджета
  3. Методы отслеживания
  4. Рекомендации по использованию
  5. Советы
 

Прежде чем вы начнете

В Google Analytics каждый уникальный домен веб-сайта или субдомен, который вы добавляете в свою учетную запись, отслеживается в отдельном представлении (профиле) и получает отдельный идентификатор домена . Поскольку каждый гаджет работает в своем собственном поддомене на хост-сайте gmodules.com , вам потребуется отслеживать каждый создаваемый вами гаджет в его собственном представлении (профиле) и с помощью уникального идентификатора домена.

Самый простой способ сделать это — позволить Google Analytics сгенерировать для вас уникальный идентификатор.

  1. Для начала войдите в Google Analytics или зарегистрируйте учетную запись Google Analytics.
    • Новые пользователи должны увидеть страницу регистрации новой учетной записи .
    • Существующим пользователям следует перейти на страницу настроек аналитики и нажать «Добавить представление веб-сайта (профиль)» . (Обязательно выберите новый домен .)
  2. На любой из этих страниц введите любой действительный URL-адрес веб-сайта.
    3. Поскольку URL-адрес веб-сайта представляет собой всего лишь строку, которую программное обеспечение Google Analytics связывает с идентификатором вашего домена, этот URL-адрес может быть любой действительной строкой URL-адреса веб-сайта, как сфабрикованной, так и реальной. Вы вообще не собираетесь устанавливать код отслеживания ни на какие веб-страницы, и вам не потребуется доступ ни к каким страницам веб-сайта.
  3. Нажмите кнопку, чтобы перейти к следующему экрану.
    4. Когда появится фрагмент кода отслеживания, скопируйте уникальный идентификатор домена в блокнот. Автоматически сгенерированный фрагмент кода содержит этот идентификатор домена в виде UA-123456-1 .
  4. Нажмите кнопку Готово .
    5. Вы должны увидеть имя URL-адреса вашего веб-сайта в списке представлений (профилей). Вы также можете изменить имя представления (профиля) на более значимое, щелкнув ссылку «Изменить» для этого представления (профиля), а затем еще раз нажав «Изменить» .
  5. Используйте сгенерированный идентификатор домена в коде отслеживания вашего гаджета.
    6. Идентификаторы доменов Google Аналитики имеют следующую форму:
    UA-123456-1
 

Отслеживание вашего гаджета

Процесс отслеживания вашего гаджета включает в себя три дополнения к коду вашего гаджета:

  1. Включение функции.
  2. Создание объекта трекера.
  3. Отслеживание вашего гаджета осуществляется одним из двух методов.

В следующем примере кода гаджета показано каждое из этих дополнений кода, которые затем объясняются ниже. Этот пример файла можно использовать для запуска собственного гаджета.

<?xml version="1.0" encoding="UTF-8" ?>
<Module>
  <ModulePrefs title="Analytics Test">
     <!-- Sets the feature -->
     <Require feature="com.google.gadgets.analytics" /> 
     <Require feature="setprefs" /> 
  </ModulePrefs>
  <UserPref 
      name="counter"
      datatype="hidden"
      default_value="0" />
  <Content type="html"> 
  <![CDATA[ 
      <script>
      // Track this gadget using Google Analytics.

      // Creates a tracking object and uses reportPageview method to call gadget view
      var ga = new _IG_GA("UA-00000-1");
      ga.reportPageview('/view/counterGadget');

      // Suppose, for example, you have a gadget with two counter buttons.
      // You can track interactions with those counters via Analytics.

      // Increment value of "counter" user preference
      function incrementCounter() {
         var count = prefs.getInt("counter");

         prefs.set("counter", count + 1);

         // Tracks button click as an event
         ga.reportEvent("Counter Gadget", "Increment", "Button", 0);
      }

      // Reset value of "counter" userpref to 0
      function resetCounter(){
         prefs.set("counter", 0);

         // Tracks button click as an event
         ga.reportEvent("Counter Gadget", "Reset", "Button", 0);
      }
      </script>
      <form name="counter">
      <input type=button value="Reset" name="reset" onClick="resetCounter()">
      <input type=button value="Count" name="count" onClick="incrementCounter()">
      </form>
  ]]>
  </Content>
</Module>

1. Включение функции

Сначала включите эту функцию, импортировав библиотеку Analytics, используя пространство имен функции:

 <Require feature="com.google.gadgets.analytics" />

2. Создание объекта трекера

API отслеживания Analytics придерживается той же объектно-ориентированной модели, что и код отслеживания ga.js Итак, прежде чем отслеживать свой гаджет, создайте экземпляр объекта трекера:

var ga = new _IG_GA("UA-123456-1");

Здесь вы вставите идентификатор домена, сгенерированный в результате выполнения описанных выше шагов.

Вы должны использовать полный идентификатор домена с одной конечной цифрой; в противном случае вызов объекта отслеживания завершится неудачно.

3. Отслеживание вашего гаджета

API гаджетов предоставляет два метода, которые вы можете использовать для отслеживания взаимодействия с вашими гаджетами:

  • Метод виртуального URL
    • ga.reportPageview(path);

    Этот метод отслеживает статистику гаджетов в виде просмотров особых страниц. Он тот же метод, который использовался в более ранней версии API гаджетов Google Analytics. Используя этот метод, вы можете обновить любой уже существующий код отслеживания гаджетов, не затрагивая существующий макет отчетов Google Analytics. Вы просматриваете данные отчетов на своих гаджетах так же, как вы просматриваете данные отчетов для веб-страниц.

    Когда вы используете метод виртуального URL-адреса для отслеживания взаимодействия с гаджетом, каждый вызов записывается как запрос страницы для строки, которую вы предоставляете в качестве параметра метода. Вы можете воспользоваться этим поведением, чтобы передать искусственный путь URL-адреса, чтобы вы могли просматривать отчеты для гаджетов в интерфейсе Google Analytics так же, как вы бы это делали с отчетами по страницам веб-сайтов. Например, вы можете использовать отдельные пути для отслеживания просмотров гаджетов и взаимодействий с ними:

    ga.reportPageview('/view/counterGadget');
ga.reportPageview('/click/increment');
ga.reportPageview('/click/reset');

  • Метод отслеживания событий
    • ga.reportEvent(name, action, [[]label], [[]value]);

    Этот метод доступен только в новом API гаджета Analytics. Используя этот метод, вы можете отслеживать просмотры страниц (например, отображение гаджета) отдельно от действий пользователя на вашем гаджете.

    Примечание . В настоящее время отслеживание событий находится на стадии закрытого бета-тестирования. Используйте метод виртуального URL-адреса, если у вас нет доступа к отслеживанию событий.

    Метод event предоставляет другую модель, которую можно использовать для отслеживания гаджетов. Во-первых, вызовы событий рассчитываются отдельно от вызовов просмотра страниц, а полученные данные отображаются в отдельной части отчетов по контенту Google Analytics. Таким образом, вы можете отслеживать просмотр гаджета отдельно от действий пользователя на гаджете, не допуская увеличения общего числа просмотров гаджета при взаимодействии с пользователем. Во-вторых, в этом методе используется модель отслеживания событий, структура которой специально разработана для анализа взаимодействия пользователей с гаджетами. В этой модели и метка, и значение являются необязательными параметрами.

    Используя пример счетчиков, мы можем использовать метод события, чтобы отслеживать, какие функции гаджета запускаются, и мы можем передать тип элемента управления, которым в обоих случаях является кнопка.

    ga.reportEvent("Counter Gadget", "Increment", "Button");
ga.reportEvent("Counter Gadget", "Reset", "Button");

    Это очень простой пример, но модель отслеживания событий представляет собой очень гибкую структуру, которую вы можете усовершенствовать, чтобы воспользоваться уникальными требованиями отслеживания вашего гаджета. Дополнительную информацию см. в документации по отслеживанию событий .

 

Методы отслеживания

В настоящее время функция аналитики предлагает следующие методы. Их использование рассмотрено выше.

  • отчетПросмотр страницы()
    • Требуется строка для правильного заполнения отчетов о содержимом. Обычно эта строка имеет форму пути, который вы определяете для целей отчетности. Значение, передаваемое в этот метод, отправляется в запросе GIF через переменную utmp . Используйте этот метод для отслеживания загрузки гаджетов и взаимодействия с ними. параметры 
    ga.reportPageview("/view/gadgetName");

    String path Путь для виртуального URL-адреса этого элемента.

  • отчетСобытие()
    • Требуется имя гаджета и параметр действия, чтобы правильно вставлять отслеживаемые данные в отчеты по отслеживанию событий. Остальные параметры являются необязательными. Значения, передаваемые с помощью этого метода, отправляются в запросе GIF с просмотром переменной utme .

    параметры
    name String Обязательно . Строка, используемая на верхнем уровне отчетов об отслеживании событий. Например, если вы отслеживаете взаимодействие с несколькими элементами гаджета, вы, скорее всего, будете использовать в качестве этого параметра имя самого гаджета, чтобы все отслеживание взаимодействий для гаджета было агрегировано в одном разделе отчетов Google Analytics.

    String action Требуется . Строка для дальнейшего сегментирования взаимодействия гаджета в отчетах по отслеживанию событий. Дополнительную информацию см. в документации по отслеживанию событий .

    String label Необязательно . Строка, которую вы можете использовать в качестве дополнительного сегмента для своего гаджета.

    Int value Необязательно . Число, которое вы можете указать в качестве значения для взаимодействия с гаджетом. Это число суммируется при каждом вызове метода.

 

Рекомендации по использованию

API гаджета Google Analytics имеет ряд особенностей использования:

  • Поддерживаемые контейнеры
    • API гаджетов Google Analytics поддерживает многие типы контейнеров, включая, помимо прочего:
    • iGoogle
    • Открытое распространение
    • Открытая социальная сеть
    • Гаджеты
  • Неподдерживаемые типы гаджетов
    • API гаджетов Google Analytics не поддерживает следующие типы гаджетов:
    • Встроенные гаджеты (type=html-inline)
    • Маплеты
    • Гаджеты типа URL (type-url)
    • Гаджет-реклама в Google AdSense
  • Рекомендации по домену
    • Если вам потребуется функция аналитики для вашего гаджета, ваш гаджет будет перенаправлен на <subdomain>.gmodules.com , где <subdomain> — это уникальный случайный субдомен. Следовательно, весь контент гаджета отображается в этом поддомене. Пример: 3nvma227-a.gmodules.com . Кроме того, все файлы cookie отслеживания Google Analytics настроены на этот уникальный субдомен. По этой причине маплеты не поддерживаются функцией отслеживания Analytics, и вам необходимо специально разрешить Flash-содержимому специальный доступ к функции отслеживания (см. ниже).
  • Гаджеты, использующие Flash-контент
    • Гаджеты, использующие Flash-контент, должны специально разрешить связь между URL-адресом Flash и URL-адресом гаджета, установив для allowScriptAccess значение Always. 
    _IG_EmbedFlash("example.swf", "wrapper", {allowScriptAccess: "always"});
 

Советы

Как лучше всего использовать метод виртуального URL-адреса

Если у вас нет доступа к методу отслеживания событий для ваших гаджетов, следуйте этим рекомендациям по отслеживанию ваших гаджетов с помощью метода виртуального URL-адреса:

  • Четко сегментируйте нагрузку на гаджеты.
    • Вы можете вызвать ga.reportPageview() при загрузке гаджета, указав путь, который сегментирует статистику загрузки/просмотра гаджета отдельно от показателей взаимодействия гаджета. При этом данные отчетов о содержимом гаджета будут храниться в отдельном «каталоге» от взаимодействий с гаджетом, так что вы сможете видеть общее количество просмотров отдельно от количества взаимодействий с самим гаджетом. Например, следующий фрагмент кода можно использовать в вашем гаджете для отображения всей статистики загрузки вашего гаджета: 
      ga.reportPageview('/view/gadgetName');
  • Сегментируйте разные типы взаимодействия друг от друга.
    • Вызовите ga.reportPageview() с путем, который сегментирует различные взаимодействия с пользователем. Таким образом, вы можете получить отдельные отчеты о содержимом для ссылок гаджетов, кнопок гаджетов или других виджетов, которые вы, возможно, захотите отслеживать на предмет данных о взаимодействии. Например:
    • ga.reportPageview('/link/click');
    • ga.reportPageview('/link/submit');

Использование метода отслеживания событий

Если у вас есть доступ к функции отслеживания событий в отчетах Google Analytics, вы можете воспользоваться очень гибкой моделью данных, чтобы получить максимальную отдачу от отслеживания ваших объектов. Вот несколько советов:

  • Отслеживайте просмотр или показ гаджета с помощью ga.reportPageview() и отслеживайте взаимодействие гаджета с помощью ga.reportEvent() .
    • Представления гаджета будут отображаться в разделе «Содержимое» для данных страницы, а взаимодействия с гаджетом будут отображаться в разделе «События» в отчетах «Содержимое».
  • Используйте document.referrer в качестве параметра, чтобы узнать, где был размещен ваш гаджет.
    • В гаджете document.referrer обычно является URL-адресом страницы контейнера, поэтому его можно передать в качестве параметра метки в методе ga.reportEvent() :
    var containerPage = document.referrer;
ga.reportEvent("Counter Gadget", "Increment", containerPage, 0);

Поиск неисправностей

Вы можете использовать сторонние инструменты для анализа строки запроса GIF для вашего гаджета, чтобы убедиться, что данные будут отправляться в отчеты Google Analytics так, как вы ожидаете. После того как гаджет будет правильно размещен и начнет работать на тестовой странице, проанализируйте строку запроса GIF следующим образом:

  • Способ просмотра страницы
    • Найдите переменную utmp в параметрах запроса GIF. Информация, связанная с этой переменной, будет отправлена ​​в отчеты Google Analytics как «путь» к гаджету.
  • Метод отслеживания событий
    • Найдите переменную utme в параметрах запроса GIF. Эта информация должна иметь вид 5(object*action*label)(value) .

Дополнительную информацию об устранении неполадок с кодом отслеживания см. в Руководстве по устранению неполадок GATC .