- Zasób: ReportTask
- ReportDefinition
- Wymiar
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Wskaźnik
- DateRange
- FilterExpression
- FilterExpressionList
- Filtruj
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operacja
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Kohorta
- CohortsRange
- Szczegółowość
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- Stan
- Metody
Zasób: ReportTask
Konfiguracja konkretnego zadania dotyczącego raportu.
Zapis JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Pola | |
---|---|
name |
Tylko dane wyjściowe. Identyfikator. Nazwa zasobu zadania raportu przypisana podczas tworzenia. Format: „properties/{property}/reportTasks/{reportTask}” |
report |
Opcjonalnie: Definicja raportu służąca do pobierania danych raportu, która opisuje strukturę raportu. Zwykle zawiera on pola uwzględnione w raporcie i kryteria filtrowania danych. |
report |
Tylko dane wyjściowe. Metadane raportu dotyczące konkretnego zadania związanego z raportami, które zawierają informacje o raporcie. Zwykle zawiera te informacje: nazwę zasobu raportu, stan raportu, sygnaturę czasową jego utworzenia itp. |
ReportDefinition
Definicja sposobu generowania raportu.
Zapis JSON |
---|
{ "dimensions": [ { object ( |
Pola | |
---|---|
dimensions[] |
Opcjonalnie: Wymiary żądane i wyświetlane. |
metrics[] |
Opcjonalnie: Dane, które mają być wyświetlane. |
date |
Opcjonalnie: Zakresy dat danych do odczytu. Jeśli zostanie podany zakres dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat oparty na 0. Jeśli 2 zakresy dat się pokrywają, dane o zdarzeniach z nachodzących na siebie dni są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W żądaniu dotyczącym kohorty wartość |
dimension |
Opcjonalnie: Filtry wymiarów umożliwiają wyświetlanie 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. |
metric |
Opcjonalnie: Klauzula filtra danych. Jest stosowana po zagregowaniu wierszy raportu, podobnie jak w przypadku klauzuli SQL. W tym filtrze nie można używać wymiarów. |
offset |
Opcjonalnie: Liczba wierszy w wierszu początkowym z magazynu danych Google Analytics. Pierwszy wiersz jest liczony jako wiersz 0. Podczas tworzenia zadania raportu parametry |
limit |
Opcjonalnie: Liczba wierszy do zwrócenia w raporcie. Jeśli wartość nie jest określona, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, ile ich potrzebujesz. Wartość Interfejs API może też zwrócić mniej wierszy niż żądana liczba |
metric |
Opcjonalnie: Agregacja danych. Uwzględnione wartości danych będą wyświetlane w wierszach, w których wartości wymiarów mają ustawienie „RESERVED_(MetricAggregation)”. |
order |
Opcjonalnie: Określa kolejność wierszy w odpowiedzi. |
currency |
Opcjonalnie: Kod waluty w formacie ISO 4217, np. „AED”, „USD”, „JPY”. Jeśli pole jest puste, raport używa domyślnej waluty usługi. |
cohort |
Opcjonalnie: Grupa kohorty powiązana z tym żądaniem. Jeśli w żądaniu występuje grupa kohorty, musi być podany wymiar „cohorta”. |
keep |
Opcjonalnie: Jeśli wartość to fałsz lub nieokreślona wartość, nie zostaną zwrócone żadne wiersze z żadnymi danymi równymi 0. Jeśli to pole ma wartość Prawda, zwrócone zostaną te wiersze, które nie zostały usunięte przez filtr. Niezależnie od tego ustawienia Jeśli np. usługa nigdy nie rejestruje zdarzenia |
sampling |
Opcjonalnie: Poziom próbkowania raportu. |
Wymiar
Wymiary to atrybuty danych. Na przykład wymiar Miasto określa miasto, z którego pochodzi zdarzenie. Wartościami wymiarów w odpowiedziach na raport są ciągi tekstowe, np. „Paryż” lub „Nowy Jork”.
Zapis JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Pola | |
---|---|
name |
Nazwa wymiaru. Lista nazw wymiarów obsługiwanych przez podstawowe metody raportowania, takie jak Jeśli parametr Wymiary są przywoływane przez atrybut |
dimension |
Jeden wymiar może być wynikiem wyrażenia wielu wymiarów. Na przykład wymiar „kraj, miasto”: concatenate(country, ", ", city). |
DimensionExpression
Służy do wyrażenia wymiaru, który jest wynikiem formuły zawierającej wiele wymiarów. Przykładowe zastosowania: 1) małe litery(wymiar) 2) konkatenacja(wymiar1, symbol, wymiar2).
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole unii one_expression . Określ 1 typ wyrażenia wymiaru na potrzeby elementu DimensionExpression . one_expression może być tylko jednym z tych elementów: |
|
lower |
Służy do konwertowania wartości wymiaru na małe litery. |
upper |
Służy do zamiany wartości wymiaru na wielką literę. |
concatenate |
Służy do łączenia wartości wymiarów w jeden wymiar. Na przykład wymiar „kraj, miasto”: concatenate(country, ", ", city). |
CaseExpression
Służy do konwertowania wartości wymiaru na wielkość pojedynczą.
Zapis JSON |
---|
{ "dimensionName": string } |
Pola | |
---|---|
dimension |
Nazwa wymiaru. Nazwa musi się odnosić do nazwy w polu wymiarów żądania. |
ConcatenateExpression
Służy do łączenia wartości wymiarów w jeden wymiar.
Zapis JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Pola | |
---|---|
dimension |
nazwy wymiarów; Nazwy muszą się odnosić do nazw w polu „Wymiary” żądania. |
delimiter |
Separator umieszczony między nazwami wymiarów. Separatory są często pojedynczymi znakami, takimi jak „|”, „|”, ale mogą być dłuższymi ciągami. Jeśli wartość wymiaru zawiera separator, w odpowiedzi będą obecne oba znaki bez żadnej różnicy. Jeśli np. wartość wymiaru 1 = „US,FR”, wartość wymiaru 2 = „JP”, a rozdzielacz = „,”, odpowiedź będzie zawierać ciąg „US,FR,JP”. |
Dane
Ilościowe pomiary w raporcie. Na przykład dane eventCount
to łączna liczba zdarzeń. W żądaniu można podać maksymalnie 10 danych.
Zapis JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Pola | |
---|---|
name |
Nazwa rodzaju danych. Listę nazw danych obsługiwanych przez podstawowe metody raportowania, np. Jeśli określono parametr Dane są odwoływane za pomocą parametru |
expression |
Wyrażenie matematyczne danych pochodnych. Na przykład dane Liczba zdarzeń na użytkownika to |
invisible |
Wskazuje, czy dane są niewidoczne w odpowiedzi na raport. Jeśli dane są niewidoczne, nie będą generować kolumny w odpowiedzi, ale można ich używać w elementach |
Zakres dat
ciągły zbiór dni: startDate
, startDate + 1
, …, endDate
. W prośbach można podać maksymalnie 4 zakresy dat.
Zapis JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Pola | |
---|---|
start |
Data rozpoczęcia zapytania w formacie |
end |
Data zakończenia zapytania w tym sensie, że jest uwzględniona w tym dniu (format |
name |
Przypisuje nazwę do tego zakresu dat. Wymiar |
FilterExpression
Aby wyrazić filtry wymiarów lub danych. Pola w ramach tego samego wyrażenia filtra muszą zawierać wszystkie wymiary lub dane.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole unii expr . W przypadku FilterExpression określ jeden typ wyrażenia filtra. expr może być tylko jednym z tych elementów: |
|
and |
Wyrażenia filtra w grupie AND są ze sobą powiązane operatorem ORAZ. |
or |
Wyrażenia filtra w grupie OR są powiązane relacją LUB. |
not |
Wyrażenie filtra NIE jest wyrażeniem nie. |
filter |
Filtr podstawowy. W tym samym wyrażeniu filtra wszystkie nazwy pól filtra muszą być albo wszystkimi wymiarami, albo wszystkimi rodzajami danych. |
FilterExpressionList
Lista wyrażeń filtra.
Zapis JSON |
---|
{
"expressions": [
{
object ( |
Pola | |
---|---|
expressions[] |
Lista wyrażeń filtra. |
Filtr
Wyrażenie do filtrowania wartości wymiarów lub danych.
Zapis JSON |
---|
{ "fieldName": string, // Union field |
Pola | |
---|---|
field |
Nazwa wymiaru lub danych. Musi to być nazwa zdefiniowana w wymiarach lub danych. |
Pole unii one_filter . Określ 1 typ filtra dla: Filter . one_filter może być tylko jednym z tych elementów: |
|
string |
Filtr powiązany z ciągiem znaków. |
in |
Filtr według wartości w liście. |
numeric |
Filtr wartości liczbowych lub dat. |
between |
Filtr między 2 wartościami. |
StringFilter
Filtr ciągu znaków
Zapis JSON |
---|
{
"matchType": enum ( |
Pola | |
---|---|
match |
Typ dopasowania tego filtra. |
value |
Wartość ciągu używana do dopasowywania. |
case |
Jeśli ma wartość true, wielkość liter w ciągu znaków jest rozróżniana. |
MatchType
Typ dopasowania filtra ciągu znaków
Wartości w polu enum | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Nie określono |
EXACT |
Dopasowanie ścisłe wartości ciągu znaków. |
BEGINS_WITH |
zaczyna się od ciągu znaków; |
ENDS_WITH |
Kończy się wartością ciągu znaków. |
CONTAINS |
Zawiera wartość ciągu znaków. |
FULL_REGEXP |
Dopasowanie dokładne wyrażenia regularnego do wartości ciągu znaków. |
PARTIAL_REGEXP |
Dopasowanie częściowe wyrażenia regularnego do wartości ciągu znaków. |
InListFilter
Wynik musi być listą wartości ciągu znaków.
Zapis JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Pola | |
---|---|
values[] |
Lista wartości ciągu tekstowego. Nie może być puste. |
case |
Jeśli ma wartość true, wielkość liter w ciągu znaków jest rozróżniana. |
NumericFilter
Filtry według wartości liczbowych lub dat.
Zapis JSON |
---|
{ "operation": enum ( |
Pola | |
---|---|
operation |
Typ operacji dla tego filtra. |
value |
Wartość liczbowa lub wartość daty. |
Operacja
Operacja zastosowana do filtra liczbowego
Wartości w polu enum | |
---|---|
OPERATION_UNSPECIFIED |
Nie określono. |
EQUAL |
Równa się |
LESS_THAN |
To mniej niż |
LESS_THAN_OR_EQUAL |
Mniejsze lub równe |
GREATER_THAN |
To więcej niż |
GREATER_THAN_OR_EQUAL |
Większe niż lub równe |
NumericValue
do reprezentowania liczby;
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole unii one_value . Wartość liczbowa one_value może mieć tylko jedną z tych wartości: |
|
int64 |
Wartość w formie liczby całkowitej |
double |
Podwójna wartość |
BetweenFilter
Aby wyrazić, że wynik musi mieścić się między dwoma liczbami (włącznie).
Zapis JSON |
---|
{ "fromValue": { object ( |
Pola | |
---|---|
from |
zaczyna się od tego numeru; |
to |
Kończy się na tym numerze. |
MetricAggregation
Reprezentują one agregację danych.
Wartości w polu enum | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Nieokreślony operator. |
TOTAL |
Operator SUMA. |
MINIMUM |
Operator minimum. |
MAXIMUM |
Operator maksymalny. |
COUNT |
Operator zliczania. |
OrderBy
Sortowanie określa sposób sortowania wierszy w odpowiedzi. Na przykład sortowanie wierszy według malejącej liczby zdarzeń to jedno uporządkowanie, a sortowanie według ciągu znaków nazwy zdarzenia to inne uporządkowanie.
Zapis JSON |
---|
{ "desc": boolean, // Union field |
Pola | |
---|---|
desc |
Jeśli ma wartość true (prawda), sortuje w kolejności malejącej. |
Pole unii one_order_by . Określ jeden typ sortowania w przypadku kolumny OrderBy . one_order_by może być tylko jednym z tych elementów: |
|
metric |
Sortuje wyniki według wartości danych. |
dimension |
Sortuje wyniki według wartości wymiaru. |
MetricOrderBy
Sortuje dane według wartości.
Zapis JSON |
---|
{ "metricName": string } |
Pola | |
---|---|
metric |
Nazwa danych w prośbie, według których mają być one posortowane. |
DimensionOrderBy
Sortuje dane według wartości wymiarów.
Zapis JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Pola | |
---|---|
dimension |
Nazwa wymiaru w pytaniu, według którego mają być sortowane dane. |
order |
Steruje regułą kolejności wartości wymiarów. |
OrderType
Reguła służąca do sortowania wartości wymiaru ciągu znaków.
Wartości w polu enum | |
---|---|
ORDER_TYPE_UNSPECIFIED |
Nie określono. |
ALPHANUMERIC |
Sortowanie alfanumeryczne według punktu kodowego Unicode. Na przykład „2” < „A” < „X” < „b” < „z”. |
CASE_INSENSITIVE_ALPHANUMERIC |
Sortowanie alfanumeryczne bez uwzględniania wielkości liter według punktu kodowego Unicode w małej literze. Na przykład „2” < „A” < „b” < „X” < „z”. |
NUMERIC |
Wartości wymiarów są konwertowane na liczby przed posortowaniem. Na przykład w sortowaniu NUMERYCZNYM „25” < „100”, a w sortowaniu ARYTMETYCZNYM „100” < „25”.ALPHANUMERIC Wartości wymiarów niebędących liczbami mają tę samą wartość sortowania niż wszystkie wartości liczbowe. |
CohortSpec
Specyfikacja kohort na potrzeby raportu dotyczącego kohorty.
Raporty kohortowe tworzą serię czasową danych o utrzymaniu użytkowników w kohortach. Możesz na przykład wybrać grupę użytkowników pozyskanych w pierwszym tygodniu września i śledzić ją przez kolejne 6 tygodni. Wybór użytkowników pozyskanych w pierwszym tygodniu września jest określony w obiekcie cohort
. Dane o tych grupach na kolejne 6 tygodni są podawane w obiekcie cohortsRange
.
Przykłady znajdziesz w artykule Przykłady raportu dotyczącego kohorty.
Odpowiedź w raporcie może wskazywać tygodniowy ciąg czasowy, w którym Twoja aplikacja utrzymała 60% z tej kohorty po 3 tygodniach, a 25% – po 6 tygodniach. Te 2 wartości procentowe można obliczyć na podstawie danych cohortActiveUsers/cohortTotalUsers
i będą one widoczne w raporcie w oddzielnych wierszach.
Zapis JSON |
---|
{ "cohorts": [ { object ( |
Pola | |
---|---|
cohorts[] |
Określa kryteria wyboru służące do grupowania użytkowników w kohortach. Większość raportów dotyczących kohort definiuje tylko jedną kohortą. Jeśli określisz wiele kohort, każda z nich będzie można rozpoznać w raporcie po nazwie. |
cohorts |
Raporty dotyczące kohort obejmują kohorty w rozszerzonym zakresie dat. Ten zakres określa czas przesunięcia, przez który należy śledzić kohorty. |
cohort |
Opcjonalne ustawienia raportu dotyczącego kohorty. |
Kohorta
Określa kryteria wyboru kohorty. Kohorta jest grupą użytkowników mających wspólną cechę. Na przykład użytkownicy z tym samym firstSessionDate
należą do tej samej kohorty.
Zapis JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
Pola | |
---|---|
name |
Przypisuje nazwę tej kohorcie. Wymiar |
dimension |
Wymiar używany przez kohortę. Wymagane i obsługuje tylko |
date |
Kohorta wybiera użytkowników, których data pierwszego kontaktu mieści się w zakresie daty rozpoczęcia i zakończenia zdefiniowanych w W żądaniu dotyczącej grupy Wartość |
CohortsRange
Konfiguruje rozszerzony zakres dat raportowania na potrzeby raportu dotyczących grup odbiorców. Określa czas przesunięcia, po którym następuje śledzenie kohort.
Zapis JSON |
---|
{
"granularity": enum ( |
Pola | |
---|---|
granularity |
Wymagane. Dokładność, która służy do interpretacji wartości |
start |
Jeśli Jeśli Jeśli |
end |
Wymagane. Jeśli Jeśli Jeśli |
Szczegółowość
Dokładność, która służy do interpretacji wartości startOffset
i endOffset
w przypadku rozszerzonego zakresu dat raportowania w raporcie dotyczącym kohorty.
Wartości w polu enum | |
---|---|
GRANULARITY_UNSPECIFIED |
Nigdy nie należy go podawać. |
DAILY |
Szczegółowość dzienna. Jest często używana, jeśli dateRange w przypadku kohorty to 1 dzień, a żądanie zawiera cohortNthDay . |
WEEKLY |
szczegółowość tygodniowa, Jest często używany, jeśli dateRange kohorty obejmuje tydzień (od niedzieli do soboty), a żądanie zawiera cohortNthWeek . |
MONTHLY |
Miesięczny stopień szczegółowości. Zwykle używany, jeśli wartość dateRange kohorty obejmuje miesiąc, a żądanie zawiera cohortNthMonth . |
CohortReportSettings
Opcjonalne ustawienia raportu dotyczącego kohorty.
Zapis JSON |
---|
{ "accumulate": boolean } |
Pola | |
---|---|
accumulate |
Jeśli ma wartość true, kumuluje wynik od dnia pierwszego kontaktu do dnia zakończenia. Nieobsługiwane w |
SamplingLevel
Kategorie poziomów próbkowania żądań.
Wartości w polu enum | |
---|---|
SAMPLING_LEVEL_UNSPECIFIED |
Nieokreślony typ. |
LOW |
Stosuje próbkowanie na poziomie 10 mln w przypadku usług standardowych i 100 mln w przypadku usług w Google Analytics 360. |
MEDIUM |
Dostępne tylko w usługach w Google Analytics 360 z poziomem próbkowania 1 mld. |
UNSAMPLED |
Funkcja dostępna tylko w usługach Google Analytics 360. Eksploracje niespróbkowane są dokładniejsze i mogą dostarczyć statystyk, które są niewidoczne w standardowych eksploracjach. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/10896953. |
ReportMetadata
Metadane raportu związane z konkretnym zadaniem związanym z raportem.
Zapis JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Pola | |
---|---|
creation |
Tylko dane wyjściowe. Łączna liczba tokenów wykorzystanych podczas tworzenia raportu. Ta liczba tokenów jest określana na podstawie aktywności w stanie |
state |
Tylko dane wyjściowe. Bieżący stan tego zadania polegającego na wygenerowaniu raportu. |
begin |
Tylko dane wyjściowe. Czas wywołania funkcji Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: |
task |
Tylko dane wyjściowe. Łączna liczba wierszy w wyniku raportu. To pole zostanie zapełnione, gdy stan będzie aktywny. Możesz używać |
error |
Tylko dane wyjściowe. Jeśli podczas tworzenia zadania związanego z raportowaniem wystąpi błąd, zostanie wyświetlony komunikat o błędzie. |
total |
Tylko dane wyjściowe. Łączna liczba wierszy w magazynie Google Analytics. Jeśli chcesz zapytać o dodatkowe wiersze danych poza bieżącym raportem, możesz utworzyć nowe zadanie dotyczące raportu na podstawie Wartość Załóżmy na przykład, że w bieżącym raporcie |
Stan
Stan przetwarzania.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Stan nieokreślony nigdy nie będzie używany. |
CREATING |
Raport jest obecnie tworzony i będzie dostępny w przyszłości. Tworzenie następuje natychmiast po wywołaniu CreateReport. |
ACTIVE |
Raport jest w pełni utworzony i gotowy do tworzenia zapytań. |
FAILED |
Nie udało się utworzyć raportu. |
Metody |
|
---|---|
|
Inicjowanie tworzenia zadania raportu. |
|
Pobiera metadane raportu dotyczące konkretnego zadania związanego z raportowaniem. |
|
Zawiera listę wszystkich zadań związanych z raportami w ramach danej usługi. |
|
Pobiera treść zadania raportu. |