Zaawansowane przypadki użycia

Ten dokument opisuje kilka zaawansowanych funkcji interfejsu Google Analytics Data API w wersji 1. Szczegółowe informacje o interfejsie API znajdziesz w dokumentacji interfejsu API.

Wyświetlanie listy definicji niestandardowych i tworzenie raportów

Interfejs Data API może tworzyć raporty na podstawie zarejestrowanych niestandardowych wymiarów i niestandardowych danych. Metoda Metadata API może służyć do wyświetlania nazw interfejsu API zarejestrowanych definicji niestandardowych usługi. Te nazwy interfejsu API można używać w żądaniach raportów, np. w metodzie runReport.

W kolejnych sekcjach znajdziesz przykłady każdego typu definicji niestandardowej. W tych przykładach zastąp GA_PROPERTY_ID identyfikatorem usługi.

Wymiary niestandardowe ograniczone do zdarzenia

Krok 1. Wyślij zapytanie do metody Metadata API z identyfikatorem usługi.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Krok 2. W odpowiedzi znajdź wymiar niestandardowy ograniczony do zdarzenia, na podstawie którego chcesz tworzyć raporty. Jeśli wymiar nie jest obecny, musisz go zarejestrować.

"dimensions": [
...
    {
      "apiName": "customEvent:achievement_id",
      "uiName": "Achievement ID",
      "description": "An event scoped custom dimension for your Analytics property."
    },
...
],

Krok 3. Uwzględnij wymiar niestandardowy w żądaniu raportu. Poniżej znajdziesz przykładowe żądanie do metody runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "customEvent:achievement_id" }],
  "metrics": [{ "name": "eventCount" }]
}

Wymiary niestandardowe ograniczone do użytkownika

Krok 1. Wyślij zapytanie do metody Metadata API z identyfikatorem usługi.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Krok 2. W odpowiedzi znajdź wymiar niestandardowy ograniczony do użytkownika, na podstawie którego chcesz tworzyć raporty. Jeśli wymiar nie jest obecny, musisz go zarejestrować.

"dimensions": [
...
    {
      "apiName": "customUser:last_level",
      "uiName": "Last level",
      "description": "A user property for your Analytics property."
    },
...
],

Krok 3. Uwzględnij wymiar niestandardowy w żądaniu raportu. Poniżej znajdziesz przykładowe żądanie do metody runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "entity": { "propertyId": "GA_PROPERTY_ID" },
  "dateRanges": [{ "startDate": "7daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "customUser:last_level" }],
  "metrics": [{ "name": "activeUsers" }]
}

Dane niestandardowe ograniczone do zdarzenia

Krok 1. Wyślij zapytanie do metody Metadata API z identyfikatorem usługi.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Krok 2. W odpowiedzi znajdź dane niestandardowe ograniczone do zdarzenia, na podstawie których chcesz tworzyć raporty. Jeśli dane nie są obecne, musisz je zarejestrować.

"metrics": [
...
    {
      "apiName": "customEvent:credits_spent",
      "uiName": "Credits Spent",
      "description": "An event scoped custom metric for your Analytics property.",
      "type": "TYPE_STANDARD"
    },
...
],

Krok 3. Uwzględnij dane niestandardowe w żądaniu raportu. Poniżej znajdziesz przykładowe żądanie do metody runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "customEvent:credits_spent" }]
}

Dane o współczynniku kluczowych zdarzeń dla jednego kluczowego zdarzenia

Krok 1. Wyślij zapytanie do metody Metadata API z identyfikatorem usługi.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Krok 2. W odpowiedzi znajdź dane o współczynniku kluczowych zdarzeń dla jednego kluczowego zdarzenia, na podstawie których chcesz tworzyć raporty. Jeśli kluczowe zdarzenie nie jest obecne, musisz je skonfigurować.

"metrics": [
...
    {
      "apiName": "sessionKeyEventRate:add_to_cart",
      "uiName": "Session key event rate for add_to_cart",
      "description": "The percentage of sessions in which a specific key event was triggered",
    },
...
],

Krok 3. Uwzględnij dane o współczynniku kluczowych zdarzeń w żądaniu raportu. Poniżej znajdziesz przykładowe żądanie do metody runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "30daysAgo", "endDate": "yesterday" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "sessionKeyEventRate:add_to_cart" }]
}

Średnie dane niestandardowe ograniczone do zdarzenia

Krok 1. Wyślij zapytanie do metody Metadata API z identyfikatorem usługi.

GET https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/metadata

Krok 2. W odpowiedzi znajdź średnie dane niestandardowe ograniczone do zdarzenia, na podstawie których chcesz tworzyć raporty. Jeśli dane nie są obecne, musisz je zarejestrować.

"metrics": [
...
    {
      "apiName": "averageCustomEvent:credits_spent",
      "uiName": "Average Credits Spent",
      "description": "The average of an event scoped custom metric for your Analytics property.",
      "type": "TYPE_STANDARD"
    },
...
],

Krok 3. Uwzględnij średnie dane niestandardowe w żądaniu raportu. Poniżej znajdziesz przykładowe żądanie do metody runReport.

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [{ "startDate": "2020-11-01", "endDate": "2020-11-10" }],
  "dimensions": [{ "name": "eventName" }],
  "metrics": [{ "name": "averageCustomEvent:credits_spent" }]
}

Przykłady raportów dotyczących kohorty

Raporty kohortowe tworzą szereg czasowy utrzymania użytkowników w kohorcie. Szczegółową dokumentację każdego pola interfejsu API znajdziesz w dokumentacji REST dla CohortSpec.

Tworzenie raportu dotyczącego kohorty

Oto przykładowy raport dotyczący kohorty, w którym:

  • Kohorta to użytkownicy z datą firstSessionDate równą 2020-12-01. Jest to skonfigurowane przez obiekt cohorts. Wymiary i dane w odpowiedzi raportu będą oparte tylko na użytkownikach kohorty.
  • Raport dotyczący kohorty będzie zawierać 3 kolumny. Jest to skonfigurowane przez obiekty dimensions i metrics.
    • Wymiar cohort to nazwa kohorty.
    • Wymiar cohortNthDay to liczba dni od 2020-12-01.
    • Dane cohortActiveUsers to liczba użytkowników, którzy są nadal aktywni.
  • Obiekt cohortsRange określa, że raport powinien zawierać dane o zdarzeniach z tej kohorty od 2020-12-01 do 2020-12-06.
    • Gdy używana jest szczegółowość DAILY, dla zachowania spójności zalecamy używanie wymiaru cohortNthDay.

Żądanie raportu dla kohorty:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [{ "name": "cohort" }, { "name": "cohortNthDay" }],
  "metrics": [{ "name": "cohortActiveUsers" }],
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-12-01", "endDate": "2020-12-01" }
      }
    ],
    "cohortsRange": {
      "endOffset": 5,
      "granularity": "DAILY"
    }
  },
}

Przykładowa odpowiedź na to żądanie:

{
  "dimensionHeaders": [
    { "name": "cohort" }, { "name": "cohortNthDay" }
  ],
  "metricHeaders": [
    { "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
      "metricValues": [{ "value": "293" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
      "metricValues": [{ "value": "143" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
      "metricValues": [{ "value": "123" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
      "metricValues": [{ "value": "92" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0005" }],
      "metricValues": [{ "value": "86" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
      "metricValues": [{ "value": "83" }]
    }
  ],
  "metadata": {},
  "rowCount": 6
}

Na podstawie tej odpowiedzi raportu poniżej znajduje się wykres tego raportu dotyczącego kohorty. Z tego raportu wynika, że największy spadek liczby aktywnych użytkowników w tej kohorcie następuje między pierwszym a drugim dniem.

Wizualizacja użytkowników z kohorty w danym okresie

Wiele kohort i ułamek utrzymania użytkowników

Pozyskiwanie i utrzymywanie użytkowników to sposoby na rozwój witryny lub aplikacji. Raporty kohortowe koncentrują się na utrzymaniu użytkowników. W tym przykładzie raport pokazuje, że w ciągu 2 tygodni usługa zwiększyła utrzymanie użytkowników przez 4 dni o 10%.

Aby utworzyć ten raport, określamy 3 kohorty: pierwszą z datą firstSessionDate równą 2020-11-02, drugą z datą firstSessionDate równą 2020-11-09 i trzecią z datą firstSessionDate równą 2020-11-16. Ponieważ liczba użytkowników w usłudze będzie się różnić w tych 3 dniach, porównujemy dane o ułamku utrzymania użytkowników w kohorcie cohortActiveUsers/cohortTotalUsers zamiast używać bezpośrednich danych cohortActiveUsers metric.

Żądanie raportu dla tych kohort:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
  "metrics": [
    {
      "name": "cohortRetentionFraction",
      "expression": "cohortActiveUsers/cohortTotalUsers"
    }
  ],
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-02", "endDate": "2020-11-02" }
      },
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-09", "endDate": "2020-11-09" }
      },
      {
        "dimension": "firstSessionDate",
        "dateRange": { "startDate": "2020-11-16", "endDate": "2020-11-16" }
      }
    ],
    "cohortsRange": {
      "endOffset": 4,
      "granularity": "DAILY"
    }
  },
}

Przykładowa odpowiedź na to żądanie:

{
  "dimensionHeaders": [{ "name": "cohort" },{ "name": "cohortNthDay" }],
  "metricHeaders": [{
      "name": "cohortRetentionFraction",
      "type": "TYPE_FLOAT"
    }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0000" }],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.308" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.272" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.257" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0001" }],
      "metricValues": [{ "value": "0.248" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.235" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_2" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.211" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.198" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0002" }],
      "metricValues": [{ "value": "0.172" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.167" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_1" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.155" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0003" }],
      "metricValues": [{ "value": "0.141" }]
    },
    {
      "dimensionValues": [{ "value": "cohort_0" },{ "value": "0004" }],
      "metricValues": [{ "value": "0.118" }]
    }
  ],
  "metadata": {},
  "rowCount": 15
}

Na podstawie tej odpowiedzi raportu poniżej znajduje się wykres tego raportu dotyczącego kohorty. Z tego raportu wynika, że w ciągu 2 tygodni utrzymanie użytkowników przez 4 dni wzrosło o 10%. Późniejsza kohorta z datą firstSessionDate równą 2020-11-16 przekracza utrzymanie wcześniejszej kohorty z datą firstSessionDate równą 2020-11-02.

Wykres przedstawiający utrzymanie uwagi w przypadku wielu kohort

Kohorty tygodniowe i używanie kohort z innymi funkcjami interfejsu API

Aby usunąć codzienne odchylenia w zachowaniu użytkowników, użyj kohort tygodniowych. W raportach kohortowych tygodniowych kohortę tworzą wszyscy użytkownicy z datą firstSessionDate w tym samym tygodniu. Tydzień zaczyna się w niedzielę, a kończy w sobotę. W tym raporcie dzielimy też kohortę, aby porównać użytkowników z aktywnością w Rosji z użytkownikami z aktywnością w Meksyku. Do tego podziału używamy wymiaru country i dimensionFilter, aby uwzględnić tylko te 2 kraje.

Żądanie raportu dla tych kohort:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dimensions": [
    { "name": "cohort" },
    { "name": "cohortNthWeek" },
    { "name": "country" }
  ],
  "metrics": [{ "name": "cohortActiveUsers" }],
  "dimensionFilter": {
    "filter": {
      "fieldName": "country",
      "inListFilter": {
        "values": [ "Russia", "Mexico" ]
      }
    }
  },
  "cohortSpec": {
    "cohorts": [
      {
        "dimension": "firstSessionDate",
        "dateRange": {
          "startDate": "2020-10-04",
          "endDate": "2020-10-10"
        }
      }
    ],
    "cohortsRange": {
      "endOffset": 5,
      "granularity": "WEEKLY"
    }
  },
}

Przykładowa odpowiedź na to żądanie:

{
  "dimensionHeaders": [
    { "name": "cohort" },
    { "name": "cohortNthWeek" },
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "cohortActiveUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0000" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "105" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0000" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "98" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0001" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "35" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0002" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "24" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0001" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "23" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0004" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "17" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0003" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "15" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0005" },{ "value": "Mexico" }
      ],
      "metricValues": [{ "value": "15" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0002" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "3" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0003" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "1" }]
    },
    {
      "dimensionValues": [
        { "value": "cohort_0" },{ "value": "0004" },{ "value": "Russia" }
      ],
      "metricValues": [{ "value": "1" }]
    }
  ],
  "metadata": {},
  "rowCount": 11
}

Na podstawie tej odpowiedzi raportu poniżej znajduje się wykres tego raportu dotyczącego kohorty. Z tego raportu wynika, że usługa lepiej utrzymuje użytkowników z aktywnością w Meksyku niż użytkowników z aktywnością w Rosji.

Wykres grup porównawczych krajów

Porównania

Dzięki porównaniom możesz analizować równolegle podzbiory danych. Porównania możesz zdefiniować, określając comparisons pole w definicji raportu. Funkcja porównań w interfejsie Data API jest podobna do porównań w interfejsie Google Analytics.

Szczegółową dokumentację każdego pola interfejsu API znajdziesz w dokumentacji REST dla Comparison.

Tworzenie porównania

Możesz utworzyć osobne porównanie w przypadku każdego zbioru danych, który chcesz porównać. Jeśli chcesz np. porównać dane z witryny i aplikacji, możesz utworzyć jedno porównanie dotyczące danych z Androida i iOS oraz drugie porównanie obejmujące dane z sieci.

Oto przykładowy raport, który definiuje 2 porównania i zwraca aktywnych użytkowników według kraju.

Pierwsze porównanie o nazwie „Ruch w aplikacji” używa inListFilter, aby dopasować wymiar platform do wartości „iOS” i „Android”. Drugie porównanie o nazwie „Ruch w sieci” używa stringFilter, aby dopasować wymiar platform do wartości „web”.

  POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
  {
    "comparisons": [
      {
        "name": "App traffic",
        "dimensionFilter": {
          "filter": {
            "fieldName": "platform",
            "inListFilter": {
              "values": [
                "iOS",
                "Android"
              ]
            }
          }
        }
      },
      {
        "name": "Web traffic",
        "dimensionFilter": {
          "filter": {
            "fieldName": "platform",
            "stringFilter": {
              "matchType": "EXACT",
              "value": "web"
            }
          }
        }
      }
    ],
    "dateRanges": [
      {
        "startDate": "2024-05-01",
        "endDate": "2024-05-15"
      }
    ],
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ]
  }

W przypadku wszystkich żądań korzystających z funkcji porównań pole comparison jest automatycznie dodawane do wygenerowanego raportu. To pole zawiera nazwę porównania podaną w żądaniu.

Oto przykładowy fragment odpowiedzi zawierający porównania:

{
  "dimensionHeaders": [
    {
      "name": "comparison"
    },
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "Web traffic"
        },
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "638572"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "Web traffic"
        },
        {
          "value": "Japan"
        }
      ],
      "metricValues": [
        {
          "value": "376578"
        }
      ]
    },
  {
      "dimensionValues": [
        {
          "value": "App traffic"
        },
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "79527"
        }
      ]
    },

    ...

  ],

...

}