Monitorowanie gadżetów

W tym dokumencie opisano sposób używania nowego interfejsu API gadżetów do śledzenia gadżetów w usłudze Analytics. Ten interfejs API oferuje ulepszony model danych i funkcje śledzenia wydajności, dzięki czemu możesz zbierać raporty Analytics statystyki dotyczące gadżetów.

  1. Zanim zaczniesz
  2. Śledzenie gadżetów
  3. Metody śledzenia
  4. Uwagi na temat użytkowania
  5. Wskazówki
 

Zanim zaczniesz

W Google Analytics każda unikalna domena witryny lub subdomena, którą dodasz do konta, jest śledzona w osobnym widoku (profilu) i przypisywana oddzielny identyfikator domeny. Ponieważ każdy gadżet działa we własnej subdomenie w witrynie hosta gmodules.com, każdy utworzony gadżet możesz śledzić w osobnym widoku (profilu) i przy użyciu unikalnego identyfikatora domeny.

Najprostszym sposobem, aby to zrobić, jest zezwolenie Google Analytics na wygenerowanie unikalnego identyfikatora.

  1. Aby rozpocząć, zaloguj się w Google Analytics lub zarejestruj konto Google Analytics.
    • Nowi użytkownicy powinni zobaczyć stronę Rejestracja nowego konta.
    • Jeśli jesteś już użytkownikiem, otwórz stronę Ustawienia Analytics i kliknij Dodaj widok witryny (profil). Pamiętaj, aby wybrać nową domenę.
  2. Wpisz dowolny prawidłowy adres URL witryny z każdej z tych stron.
    3. Adres URL witryny jest tylko ciągiem znaków, który oprogramowanie Google Analytics paruje z identyfikatorem Twojej domeny, dlatego ten adres URL może być dowolnym prawidłowym ciągiem adresu URL witryny – zarówno wymyślonym, jak i prawdziwym. Nie masz zamiaru instalować kodu śledzenia na żadnych stronach internetowych i nie potrzebujesz dostępu do żadnych stron w witrynie.
  3. Kliknij przycisk, aby przejść do następnego ekranu.
    4. Po wyświetleniu fragmentu kodu śledzenia skopiuj unikalny identyfikator domeny do notatnika. Wygenerowany automatycznie fragment kodu zawiera ten identyfikator domeny w formacie UA-123456-1.
  4. Kliknij przycisk Zakończ.
    5. Na liście widoków (profili) powinna być widoczna nazwa adresu URL Twojej witryny. Możesz też zmienić nazwę widoku (profilu) na bardziej rozpoznawalną, klikając link Edytuj w odpowiednim widoku (profil) i ponownie klikając Edytuj.
  5. Użyj wygenerowanego identyfikatora domeny w kodzie śledzenia gadżet.
    6. Identyfikator domeny Analytics ma postać:
    UA-123456-1
 

Śledzenie gadżetów

Aby śledzić gadżet, musisz dodać do niego trzy elementy:

  1. Włączam funkcję.
  2. Tworzę obiekt skryptu śledzenia.
  3. Śledzić gadżet za pomocą jednej z dwóch metod.

Poniższe przykłady kodu gadżetów pokazują wszystkie te dodatki, które zostały wyjaśnione poniżej. Możesz użyć tego przykładowego pliku, by utworzyć własny gadżet.

<?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. Włączanie funkcji

Najpierw włącz tę funkcję, importując bibliotekę Analytics przy użyciu przestrzeni nazw cech:

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

2. Tworzenie obiektu śledzenia

Interfejs API śledzenia Analytics jest zgodny z tym samym obiektowym modelem kodu śledzenia ga.js. Zanim zaczniesz śledzić gadżet, utwórz instancję obiektu śledzącego:

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

Tutaj wstaw identyfikator domeny wygenerowany zgodnie z instrukcjami powyżej.

Musisz podać pełny identyfikator domeny i jedną cyfrę na końcu. W przeciwnym razie wywołanie obiektu śledzenia zakończy się niepowodzeniem.

3. Śledzenie gadżetów

Interfejs API do obsługi gadżetów udostępnia dwie metody śledzenia interakcji z gadżetami:

  • Metoda wirtualnego adresu URL
    • ga.reportPageview(path);

    Ta metoda śledzi statystyki gadżetów jako specjalne odsłony strony i jest taka sama jak we wcześniejszej wersji interfejsu API gadżetów Analytics. Korzystając z tej metody, można aktualizować dowolny kod śledzenia gadżetów bez wpływu na obecny układ raportów Analytics. Dane raportów można przeglądać w gadżecie tak samo jak dane raportów dotyczących stron internetowych.

    Jeśli do śledzenia interakcji z gadżetem używasz metody wirtualnego adresu URL, każde wywołanie jest rejestrowane jako żądanie strony dla ciągu podanego przez Ciebie jako parametr metody. Dzięki temu możesz przekazywać informacje w formie gotowej ścieżki adresu URL, co pozwala wyświetlać raporty dotyczące gadżetów w interfejsie Google Analytics tak samo jak w przypadku raportów dotyczących stron w witrynie. Możesz np. użyć osobnych ścieżek do śledzenia zarówno wyświetleń gadżetów, jak i interakcji z gadżetami: 

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

  • Metoda śledzenia zdarzeń
    • ga.reportEvent(name, action, [[]label], [[]value]);

    Ta metoda jest dostępna tylko w nowym interfejsie Analytics Gadżet API. Korzystając z tej metody, możesz śledzić wyświetlenia strony (np. renderowanie gadżetów) niezależnie od interakcji użytkowników z Twoim gadżetem.

    Uwaga: śledzenie zdarzeń znajduje się obecnie w zamkniętej wersji beta. Jeśli nie masz dostępu do śledzenia zdarzeń, użyj wirtualnego adresu URL.

    Metoda zdarzenia zapewnia inny model do śledzenia gadżetów. Po pierwsze wywołania zdarzeń są obliczane niezależnie od wywołań odsłon strony, a uzyskane dane są wyświetlane w osobnej części raportów o treści w Google Analytics. Można zatem śledzić wyświetlanie gadżetów oddzielnie od interakcji użytkowników z tym gadżetem bez konieczności zawyżania łącznej liczby wyświetleń gadżetów. Po drugie, ta metoda wykorzystuje model śledzenia zdarzeń, którego struktura została zaprojektowana w celu analizowania interakcji użytkowników z gadżetami. W tym modelu zarówno etykieta, jak i wartość są parametrami opcjonalnymi.

    W przykładzie z licznikami zdarzeń możemy użyć metody zdarzeń do śledzenia wywoływanych funkcji gadżetów. Możemy też przekazać typ elementu sterującego, który w obu przypadkach jest przyciskiem. 

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

    To bardzo prosty przykład. Model śledzenia zdarzeń to jednak bardzo elastyczna struktura, którą możesz dostosować tak, aby wykorzystać unikalne wymagania dotyczące śledzenia, jakie obowiązują w Twoim gadżecie. Więcej informacji znajdziesz w dokumentacji śledzenia zdarzeń.

 

Metody śledzenia

Obecnie funkcja Analytics udostępnia następujące metody. Ich zastosowanie zostało omówione powyżej.

  • reportPageview()
    • Do prawidłowego wypełnienia raportów dotyczących treści wymagane jest podanie ciągu znaków. Zwykle ma on postać ścieżki zdefiniowanej przez Ciebie na potrzeby raportowania. Wartość przekazywana do tej metody jest wysyłana w żądaniu GIF za pomocą zmiennej utmp. Ta metoda służy do śledzenia ładowania gadżetów i interakcji z gadżetami. 
    ga.reportPageview("/view/gadgetName");
    parameters
    String  path Ścieżka do wirtualnego adresu URL tego elementu.

  • reportEvent()
    • Wymaga podania nazwy gadżetów i parametru działania w celu prawidłowego wstawiania śledzonych danych do raportów śledzenia zdarzeń. Pozostałe parametry są opcjonalne. Wartości przekazywane tą metodą są wysyłane w widoku żądania GIF w zmiennej U utme.

    parameters
    String  name  Wymagany.Ciąg znaków używany na najwyższym poziomie raportów śledzenia zdarzeń. Na przykład w przypadku śledzenia interakcji z kilkoma elementami gadżetów warto prawdopodobnie użyć nazwy samego gadżetów w przypadku tego parametru, tak aby dane dotyczące wszystkich interakcji z gadżetem były zbierane w tej samej sekcji raportów Google Analytics.

    String  action  Wymagany. Ciąg pozwalający na dalszą segmentację interakcji z gadżetami w raportach śledzenia zdarzeń. Więcej informacji znajdziesz w dokumentacji śledzenia zdarzeń.

    String  label  Opcjonalny. Ciąg znaków, który można wykorzystać jako dodatkowy segment dla gadżetów.

    Int  value  Opcjonalny. Liczba, którą można podać jako wartość interakcji z gadżetem. Ta liczba jest agregowana przy każdym wywołaniu metody.

 

Uwagi na temat wykorzystania

W przypadku interfejsu API gadżetów Google Analytics należy wziąć pod uwagę kilka kwestii związanych z zastosowaniem:

  • Obsługiwane kontenery
    • Interfejs Google Analytics Gadget API obsługuje wiele typów kontenerów, między innymi:
    • iGoogle
    • Otwórz dystrybucję
    • Open Social
    • Gadżety
  • Nieobsługiwane typy gadżetów
    • Interfejs API gadżetów Google Analytics nie obsługuje tych typów gadżetów:
    • Wbudowane gadżety (type=html-inline)
    • Maplety
    • Typ adresu URL gadżety (type-url)
    • Reklamy gadżetowe w Google AdSense
  • Uwagi na temat domeny
    • Gdy włączysz w gadżecie funkcję Analytics, Twój gadżet będzie przekierowywał się na adres <subdomain>.gmodules.com, gdzie <subdomain> to unikalna, losowa subdomena. W związku z tym cała zawartość gadżetów jest wyświetlana w tej subdomenie. Przykład: 3nvma227-a.gmodules.com. Dodatkowo wszystkie pliki cookie śledzenia Google Analytics są przypisane do tej unikalnej subdomeny. Z tego powodu funkcja śledzenia Analytics nie obsługuje mapletów i musisz wyraźnie zezwolić treściom Flash na dostęp do funkcji śledzenia (patrz poniżej).
  • Gadżety z treściami Flash
    • Gadżety wykorzystujące treści Flash muszą umożliwiać komunikację między adresem URL pliku Flash a adresem URL gadżetów. W tym celu należy ustawić parametr allowScriptAccess na wartość „zawsze”. 
    _IG_EmbedFlash("example.swf", "wrapper", {allowScriptAccess: "always"});
 

Wskazówki

Jak najlepiej użyć metody wirtualnego adresu URL

Jeśli nie masz dostępu do metody śledzenia zdarzeń w przypadku swoich gadżetów, postępuj zgodnie z tymi zaleceniami dotyczącymi śledzenia gadżetów za pomocą metody wirtualnego adresu URL:

  • Wyraźnie podziel ładowanie gadżetów.
    • Przy wczytywaniu gadżetów można wywoływać funkcję ga.reportPageview(), zapewniając ścieżkę dzielącą statystyki wczytywania/wyświetlania gadżetów niezależnie od danych dotyczących interakcji z gadżetem. Dane te będą przechowywane w innym „katalogu” niż dane o interakcjach w gadżecie. Dzięki temu łączna liczba wyświetleń i liczba interakcji z gadżetem będą widoczne niezależnie od liczby interakcji. Aby wyświetlić wszystkie statystyki ładowania gadżetów, można użyć w gadżecie tego fragmentu kodu, na przykład: 
      ga.reportPageview('/view/gadgetName');
  • Dzielenie na siebie różnych typów interakcji.
    • Wywołuj metodę ga.reportPageview() ścieżką dzielącą różne interakcje użytkowników na segmenty. W ten sposób można uzyskiwać osobne raporty o zawartości linków do gadżetów, przycisków gadżetów i innych widżetów, które mogą być interesujące dla danych dotyczących interakcji. Na przykład:
    • ga.reportPageview('/link/click');
    • ga.reportPageview('/link/submit');

Korzystanie z metody śledzenia zdarzeń

Jeśli masz dostęp do funkcji śledzenia zdarzeń w raportach Google Analytics, możesz wykorzystać bardzo elastyczny model danych, by jak najpełniej korzystać ze śledzenia obiektów. Oto kilka porad:

  • Monitoruj wyświetlanie i wyświetlanie gadżetów za pomocą ga.reportPageview() oraz śledź interakcje z gadżetem za pomocą ga.reportEvent().
    • Widoki gadżetów będą wyświetlane w sekcji Treść dla danych strony, a interakcje z gadżetami będą widoczne w sekcji Zdarzenia w raporcie Treść.
  • Użyj document.referrer jako parametru, aby dowiedzieć się, gdzie został umieszczony Twój gadżet.
    • W gadżecie document.referrer to zwykle adres URL strony kontenera, więc możesz go przekazać jako parametr etykiety w metodzie ga.reportEvent():
    var containerPage = document.referrer;
ga.reportEvent("Counter Gadget", "Increment", containerPage, 0);

Rozwiązywanie problemów

Możesz użyć narzędzi innych firm do analizy ciągu żądania GIF dla swojego gadżetu, aby sprawdzić, czy dane są wysyłane do raportów Google Analytics w oczekiwany sposób. Gdy gadżet będzie prawidłowo hostowany i działa na stronie testowej, przeanalizuj ciąg żądania GIF w ten sposób:

  • Metoda wyświetlenia strony
    • Odszukaj zmienną utmp w parametrach żądania GIF. Informacje powiązane z tą zmienną będą wysyłane do raportów Google Analytics jako „ścieżka” do widżetu.
  • Metoda śledzenia zdarzeń
    • Poszukaj zmiennej utme w parametrach żądania GIF. Te informacje powinny mieć postać 5(object*action*label)(value).

Więcej informacji na temat rozwiązywania problemów z kodem śledzenia znajdziesz w Przewodniku rozwiązywania problemów z GATC.