Zwraca dostosowany raport z danymi o zdarzeniach w 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 usłudze, np. liczba aktywnych użytkowników lub liczba zdarzeń. Wymiary pozwalają podzielić dane według niektórych wspólnych kryteriów, takich jak kraj czy nazwa zdarzenia.
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órej zdarzenia są śledzone. Jest określony w ścieżce adresu URL, a nie w treści. Dowiedz się, gdzie znaleźć 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: właściwość/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żądasz kilku zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat się pokrywają, dane zdarzeń z pokrywających się dni znajdą się w wierszach odpowiedzi dla obu zakresów dat. W żądaniu dotyczącym kohorty pole |
dimensionFilter |
Dzięki filtrom wymiarów możesz poprosić 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 danych. Stosowana po zagregowaniu wierszy raportu, podobnie jak w przypadku klauzuli SQL. W tym filtrze nie można używać wymiarów. |
offset |
Liczba wierszy wiersza początkowego. 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 nie określono inaczej, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie,niezależnie od tego, ile zażądasz. Interfejs API może też zwrócić mniej wierszy niż w żądaniu Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule Podział na strony. |
metricAggregations[] |
Agregacja danych. Zbiorcze wartości danych będą widoczne w wierszach, w których wymiar wymiarValues 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, raport używa domyślnej waluty usługi. |
cohortSpec |
Grupa kohorty powiązana z tym żądaniem. Jeśli żądanie zawiera grupę kohorty, musi być obecny wymiar „kohorta”. |
keepEmptyRows |
Jeśli wartość fałsz lub nieokreślona, żaden wiersz ze wszystkimi danymi równymi 0 nie zostanie zwrócony. Jeśli ma wartość true (prawda), te wiersze zostaną zwrócone, jeśli nie zostaną usunięte oddzielnie przez filtr. Niezależnie od tego ustawienia Jeśli np. usługa nigdy nie rejestruje zdarzenia |
returnPropertyQuota |
Określa, czy zwracać bieżący stan limitu tej usługi Analytics. Limit jest zwracany w ramach PropertyQuota. |
comparisons[] |
Opcjonalnie. Konfiguracja porównań żądanych i wyświetlanych. Żądanie wymaga tylko pola porównań, aby otrzymać w odpowiedzi kolumnę porównawczą. |
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