Zwraca dostosowany raport z danymi zdarzeń Google Analytics. Raporty zawierają statystyki generowane na podstawie danych zebranych przez kod śledzenia Google Analytics. Dane zwrócone przez interfejs API mają postać tabeli z kolumnami dla żądanych wymiarów i danych. Dane to indywidualne pomiary aktywności użytkowników w Twojej usłudze, np. liczba aktywnych użytkowników lub liczby zdarzeń. Wymiary służą do podziału danych według często spotykanych kryteriów, takich jak kraj czy nazwa wydarzenia.
Wskazówki dotyczące tworzenia żądań i interpretowania odpowiedzi znajdziesz w artykule Tworzenie raportu.
Żądanie HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
property |
Identyfikator usługi w GA4 w Google Analytics, którego zdarzenia są śledzone. Określana w ścieżce adresu URL, a nie w treści. Dowiedz się, gdzie znajdziesz identyfikator usługi. W żądaniu zbiorczym ta właściwość powinna być nieokreślona lub spójna z właściwością na poziomie wsadu. Przykład: properties/1234 |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "dimensions": [ { object ( |
Pola | |
---|---|
dimensions[] |
Żądane i wyświetlone wymiary. |
metrics[] |
Żądane i wyświetlone wskaźniki. |
dateRanges[] |
Zakresy dat danych do odczytania. Jeśli zażądano wielu zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat się pokrywają, dane dotyczące zdarzeń z pokrywających się dni znajdą się w wierszach odpowiedzi w przypadku obu zakresów dat. W żądaniu dotyczącym kohorty pole |
dimensionFilter |
Filtry wymiarów umożliwiają przesłanie prośby o uwzględnienie w raporcie tylko określonych wartości wymiarów. Więcej informacji znajdziesz w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych. |
metricFilter |
Klauzula filtra wskaźników. Stosowana po zagregowaniu wierszy raportu, podobnie jak w przypadku klauzuli SQL. W tym filtrze nie można używać wymiarów. |
offset |
Liczba wierszy w wierszu początkowym. Pierwszy wiersz jest liczony jako wiersz 0. Podczas stronicowania pierwsze żądanie nie określa przesunięcia lub równoważnie ustawia przesunięcie na 0. Pierwsze żądanie zwraca pierwsze Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule Podział na strony. |
limit |
Liczba wierszy do zwrócenia. Jeśli wartość ta nie zostanie określona, zostanie zwróconych 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie,niezależnie od tego, ile z nich poprosisz. Interfejs API może też zwrócić mniej wierszy niż żądany element Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule Podział na strony. |
metricAggregations[] |
Agregacja danych. Połączone wartości danych będą wyświetlane w wierszach, w których parametr parametrValues ma wartość „RESERVED_(MetricAggregation)”. |
orderBys[] |
Określa kolejność wierszy w odpowiedzi. |
currencyCode |
Kod waluty w formacie ISO4217, np. „AED”, „USD”, „JPY”. Jeśli to pole jest puste, w raporcie używana jest domyślna waluta usługi. |
cohortSpec |
Grupa kohortowa powiązana z tym żądaniem. Jeśli żądanie zawiera grupę kohorty, musi być obecny wymiar „kohorta”. |
keepEmptyRows |
Jeśli zasada ma wartość Fałsz lub jest nieokreślona, każdy wiersz ze wszystkimi danymi o wartości 0 nie będzie zwracany. Jeśli ma wartość true (prawda), te wiersze zostaną zwrócone, jeśli nie zostaną osobno usunięte przez filtr. Niezależnie od tego ustawienia Jeśli np. usługa nigdy nie rejestruje zdarzenia |
returnPropertyQuota |
Określa, czy zwrócić bieżący stan limitu tej usługi Analytics. Limit jest zwracany w metodzie PropertyQuota. |
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu RunReportResponse
.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics