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.
Żądanie HTTP
POST https://analyticsdata.googleapis.com/v1alpha:runReport
Adres URL używa składni transkodowania gRPC.
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON | |
---|---|
{ "entity": { object ( |
Pola | |
---|---|
entity |
Usługa, której zdarzenia są śledzone. W żądaniu zbiorczym ta encja powinna być nieokreślona lub zgodna z encją na poziomie wsadu. |
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 |
offset |
Liczba wierszy wiersza początkowego. Pierwszy wiersz jest liczony jako wiersz 0. |
limit |
Liczba wierszy do zwrócenia. Jeśli parametr |
metricAggregations[] |
Agregacja danych. Zbiorcze wartości danych będą widoczne w wierszach, w których wymiar wymiarValues ma wartość „RESERVED_(MetricAggregation)”. |
dimensionFilter |
Klauzula filtra wymiarów. Aby można było użyć wymiarów w tym filtrze, trzeba poprosić o ich zastosowanie. W tym filtrze nie można używać danych. |
metricFilter |
Klauzula filtra danych. Stosowane na etapie po agregacji, podobnie jak w przypadku klauzuli SQL. Aby można było użyć danych w tym filtrze, należy poprosić o dane. W tym filtrze nie można używać wymiarów. |
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 elementu. |
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. |
returnPropertyQuota |
Określa, czy zwracać bieżący stan limitu tej usługi Analytics. Limit jest zwracany w ramach 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