Zwraca niestandardowy raport zawierający dane o zdarzeniach z Google Analytics. Raporty zawierają statystyki pozyskane na podstawie danych zebranych przez kod śledzenia Google Analytics. Dane zwracane przez interfejs API mają postać tabeli z kolumnami dotyczącymi żą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 zdarzeń. Wymiary dzielą dane według typowych kryteriów, np. kraju czy nazwy zdarzenia.
Przewodnik po tworzeniu żądań zapoznaj się z sekcją 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. Jest określony w ścieżce adresu URL, a nie w treści. Więcej informacji znajdziesz w artykule, gdzie znaleźć identyfikator usługi. W żądaniu zbiorczym ta właściwość powinna być albo nieokreślona, lub zgodna 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świetlane wymiary. |
metrics[] |
Dane żądane i wyświetlone. |
dateRanges[] |
Zakresy dat danych do odczytu. Jeśli zażądasz wielu zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat się nakładają, dane o zdarzeniach z pokrywających się dni są uwzględniane w wierszach odpowiedzi dotyczących obu zakresów dat. W żądaniu dotyczącym kohorty wartość |
dimensionFilter |
Filtry wymiarów umożliwiają wyświetlenie w raporcie tylko określonych wartości wymiarów. Więcej przykładów znajdziesz w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych. |
metricFilter |
Klauzula filtra wskaźników. Jest 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 sekcji Podział na strony. |
limit |
Liczba wierszy do zwrócenia. Jeśli wartość nie jest określona, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 000 wierszy na żądanie bez względu na to, o ile prosisz. Wartość Interfejs API może też zwrócić mniej wierszy niż żądane Więcej informacji o tym parametrze podziału na strony znajdziesz w sekcji Podział na strony. |
metricAggregations[] |
Agregacja wskaźników. Zagregowane 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” lub „JPY”. Jeśli to pole jest puste, w raporcie używana jest domyślna waluta usługi. |
cohortSpec |
Grupa kohort powiązana z tym żądaniem. Jeśli w żądaniu znajduje się grupa kohortowa, „kohorta” wymiar musi być podany. |
keepEmptyRows |
Jeśli wartość to fałsz lub nieokreślona wartość, nie zostaną zwrócone żadne wiersze z żadnymi danymi równymi 0. Jeśli tak, wiersze te zostaną zwrócone, jeśli nie zostały usunięte osobno przez filtr. Niezależnie od tego ustawienia Jeśli np. usługa nigdy nie rejestruje zdarzenia |
returnPropertyQuota |
Określa, czy ma być zwracany bieżący stan limitu tej usługi w Analytics. Limit jest zwracany w polu PropertyQuota. |
comparisons[] |
Opcjonalnie: Konfiguracja porównań żądanych i wyświetlanych. Aby otrzymać w odpowiedzi kolumnę porównania, żądanie wymaga tylko pola porównań. |
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu RunReportResponse
.
Zakresy autoryzacji
Wymaga jednego z tych zakresów protokołu OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics