Omówienie interfejsu Google Analytics Data API

Interfejs Data API umożliwia automatyczny dostęp do danych do raportu z poziomu Google Analytics.

Dowiedz się więcej o usługach w Google Analytics properties.

Dane zwracane przez interfejs API są zgodne z danymi wyświetlanymi w interfejsie Google Analytics i w pełni uwzględniają ustawienia tożsamości na potrzeby raportowania (np. mieszana, obserwowana lub oparta na urządzeniu) skonfigurowane w usłudze w Google Analytics .

Oto kilka przykładów, które możesz raportować za pomocą interfejsu Google Analytics Data API w wersji 1:

  • Ilu aktywnych użytkowników dziennie miała Twoja aplikacja na Androida w ostatnim tygodniu.
  • Ile odsłon odnotowało 10 najpopularniejszych stron w Twojej witrynie w ciągu ostatnich 28 dni.
  • Ilu aktywnych użytkowników korzystało z Twojej aplikacji na iOS w ciągu ostatnich 30 minut w poszczególnych krajach.

Za pomocą interfejsu Google Analytics Data API w wersji 1 możesz też:

  • tworzyć niestandardowe panele prezentujące dane Google Analytics;
  • automatyzować złożone zadania w zakresie raportowania i w ten sposób oszczędzać czas;
  • integrować dane Google Analytics z innymi aplikacjami biznesowymi.

Spójność danych i tożsamość na potrzeby raportowania

Interfejs Google Analytics Data API w wersji 1 uzyskuje dostęp do tych samych danych do raportu co interfejs Google Analytics. Dane zwracane przez interfejs API w pełni uwzględniają ustawienia tożsamości na potrzeby raportowania skonfigurowane w usłudze w Google Analytics, dzięki czemu liczba użytkowników, deduplikacja i modelowanie danych są zgodne z wybraną przestrzenią tożsamości (np. mieszana, obserwowana lub oparta na urządzeniu) w ustawieniach usługi.

Więcej informacji o tym, jak różne przestrzenie tożsamości mogą wpływać na raporty, znajdziesz w artykule Tożsamość na potrzeby raportowania.

Rozpocznij

Aby rozpocząć korzystanie z biblioteki klienta w języku Java, Python, Node.js, PHP, C#, Go lub Ruby, zapoznaj się z przewodnikiem Szybki start biblioteki klienta. Aby dowiedzieć się, jak tworzyć zapytania, filtrować wymiary i odczytywać odpowiedzi, przeczytaj artykuł Tworzenie raportu lub przetestuj zapytania interaktywnie w Eksploratorze zapytań.

Przykładowe żądanie i odpowiedź runReport

Aby wysłać zapytanie o dane zdarzeń przez REST, wyślij żądanie POST do runReport punktu końcowego z RunReportRequest treścią żądania w formacie JSON, w której określisz dateRanges, dimensions i metrics:

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

Możesz też uruchomić równoważne curl polecenie za pomocą domyślnego uwierzytelniania aplikacji:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

Interfejs API zwraca RunReportResponse zawierający nagłówki kolumn i wiersze danych:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

Dostępne metody

Oto lista metod interfejsu Data API. Więcej informacji znajdziesz w dokumentacji referencyjnej.

  • runReport Ta metoda zwraca raport niestandardowy zawierający dane zdarzeń z Google Analytics i jest preferowaną metodą w przypadku prostych zapytań o raporty.
  • batchRunReports To zbiorcza wersja metody runReport, która umożliwia generowanie wielu raportów za pomocą jednego wywołania interfejsu API.
  • runPivotReport Ta metoda zwraca niestandardowy raport przestawny zawierający dane zdarzeń z Google Analytics. Raporty przestawne są bardziej zaawansowane i mają bardziej rozbudowany format niż zwykłe raporty. Każda tabela przestawna opisuje widoczne kolumny i wiersze wymiarów w odpowiedzi raportu.
  • batchRunPivotReports To zbiorcza wersja metody runPivotReport, która umożliwia generowanie wielu raportów za pomocą jednego wywołania interfejsu API.
  • getMetadata Ta metoda zwraca metadane wymiarów i danych dostępnych w metodach raportowania. Służy do eksplorowania wymiarów i danych. Odpowiedź tej metody zawiera też wymiary i dane niestandardowe dostępne w określonej usłudze w Google Analytics.
  • checkCompatibility Ta metoda wyświetla listę wymiarów i danych, które można dodać do żądania raportu i zachować zgodność.
  • runRealtimeReport Ta metoda zwraca niestandardowy raport zawierający dane zdarzeń w czasie rzeczywistym dotyczące Twojej usługi. Zdarzenia pojawiają się w raportach Czas rzeczywisty kilka sekund po wysłaniu ich do Google Analytics. Raporty Czas rzeczywisty pokazują zdarzenia i dane o użytkowaniu z okresów od chwili obecnej do 30 minut temu (do 60 minut w przypadku usług w Google Analytics 360).
  • properties.audienceExports Grupa metod, które umożliwiają generowanie eksportów list odbiorców zawierających migawkę użytkowników na liście odbiorców.
  • properties.recurringAudienceLists (Wczesna wersja przedpremierowa) Grupa metod, które umożliwiają zarządzanie cyklicznymi eksportami list odbiorców. Cykliczny eksport list odbiorców tworzy nowe listy odbiorców każdego dnia.
  • runFunnelReport (Wczesna wersja przedpremierowa) Ta metoda zwraca niestandardowy raport ścieżki zawierający dane zdarzeń z Google Analytics. Eksploracja ścieżki umożliwia wizualizację kroków podejmowanych przez użytkowników i szybką ocenę skuteczności ich wykonywania.
  • properties.chat (Wczesna wersja przedpremierowa) Ta metoda zapewnia programowy dostęp do narzędzia Ask Advisor w Google Analytics. Możesz zadawać pytania w języku naturalnym dotyczące danych zdarzeń, diagnozować zmiany wydajności oraz otrzymywać uporządkowane informacje w formie opisowej i tabelarycznej.

Obsługiwane wymiary i dane

Listę wszystkich wymiarów i danych obsługiwanych przez interfejs Data API znajdziesz w dokumentacji schematu API.