- Zasób: ReportTask
- ReportDefinition
- Wymiar
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Wskaźnik
- DateRange
- FilterExpression
- FilterExpressionList
- Filtruj
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operacja
- NumericValue
- BetweenFilter
- EmptyFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Kohorta
- CohortsRange
- Szczegółowość
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- Stan
- Metody
Zasób: ReportTask
Określona konfiguracja zadania 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}” |
reportDefinition |
Opcjonalnie. Definicja raportu służąca do pobierania danych raportu, która opisuje strukturę raportu. Zwykle zawiera ona pola, które będą uwzględnione w raporcie, oraz kryteria, które będą używane do filtrowania danych. |
reportMetadata |
Tylko dane wyjściowe. Metadane raportu dotyczące konkretnego zadania związanego z raportem, które zawierają informacje o raporcie. Zwykle zawiera te informacje: nazwę zasobu raportu, jego stan, sygnaturę czasową utworzenia itp. |
ReportDefinition
Definicja sposobu generowania raportu.
| Zapis JSON |
|---|
{ "dimensions": [ { object ( |
| Pola | |
|---|---|
dimensions[] |
Opcjonalnie. Wymiary, o które poproszono i które zostały wyświetlone. |
metrics[] |
Opcjonalnie. Żądane i wyświetlane dane. |
dateRanges[] |
Opcjonalnie. Zakresy dat danych do odczytania. Jeśli zostanie wysłana prośba o wiele zakresów dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat pokrywają się, dane o zdarzeniach z dni, w których się pokrywają, są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W przypadku prośby dotyczącej kohorty ten parametr |
dimensionFilter |
Opcjonalnie. Filtry wymiarów umożliwiają wyświetlanie w raporcie tylko określonych wartości wymiarów. Więcej informacji znajdziesz w artykule Podstawy filtrów wymiarów, w którym znajdziesz przykłady. W tym filtrze nie można używać wskaźników. |
metricFilter |
Opcjonalnie. Klauzula filtra danych. Stosowany po agregacji wierszy raportu, podobnie jak klauzula HAVING w SQL-u. W tym filtrze nie można używać wymiarów. |
offset |
Opcjonalnie. Liczba wierszy w wierszu początkowym z pamięci 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 nie określono inaczej, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, ile wierszy zażądasz. Interfejs API może też zwracać mniej wierszy niż żądana wartość |
metricAggregations[] |
Opcjonalnie. Agregacja danych. Zagregowane wartości danych będą wyświetlane w wierszach, w których parametr dimensionValues ma wartość „RESERVED_(MetricAggregation)”. |
orderBys[] |
Opcjonalnie. Określa kolejność wierszy w odpowiedzi. |
currencyCode |
Opcjonalnie. Kod waluty w formacie ISO 4217, np. „AED”, „USD”, „JPY”. Jeśli pole jest puste, raport używa domyślnej waluty usługi. |
cohortSpec |
Opcjonalnie. Grupa kohortowa powiązana z tym żądaniem. Jeśli w żądaniu znajduje się grupa kohort, musi być w nim obecny wymiar „kohorta”. |
keepEmptyRows |
Opcjonalnie. Jeśli wartość jest fałszywa lub nieokreślona, każdy wiersz, w którym wszystkie dane mają wartość 0, nie zostanie zwrócony. Jeśli ma wartość „true”, te wiersze zostaną zwrócone, o ile nie zostaną osobno usunięte przez filtr. Niezależnie od tego ustawienia Jeśli np. usługa nigdy nie rejestruje zdarzenia |
samplingLevel |
Opcjonalnie. poziom próbkowania raportu, |
Wymiar
Wymiary to atrybuty danych. Na przykład wymiar Miasto określa miasto, z którego pochodzi zdarzenie. Wartości wymiarów w odpowiedziach raportu są ciągami znaków, np. miasto może mieć wartość „Paryż” lub „Nowy Jork”.
| Zapis JSON |
|---|
{
"name": string,
"dimensionExpression": {
object ( |
| Pola | |
|---|---|
name |
Nazwa wymiaru. Listę nazw wymiarów obsługiwanych przez podstawowe metody raportowania, takie jak Jeśli podano Wymiary są określane przez |
dimensionExpression |
Jeden wymiar może być wynikiem wyrażenia obejmującego wiele wymiarów. Na przykład wymiar „kraj, miasto”: concatenate(kraj, „, ”, miasto). |
DimensionExpression
Używany do wyrażania wymiaru, który jest wynikiem formuły obejmującej wiele wymiarów. Przykłady użycia: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2).
| Zapis JSON |
|---|
{ // Union field |
| Pola | |
|---|---|
Pole zbiorcze one_expression. Określ jeden typ wyrażenia wymiaru dla DimensionExpression. one_expression może mieć tylko jedną z tych wartości: |
|
lowerCase |
Służy do przekształcania wartości wymiaru na małe litery. |
upperCase |
Służy do przekształcania wartości wymiaru na wielkie litery. |
concatenate |
Służy do łączenia wartości wymiarów w jeden wymiar. Na przykład wymiar „kraj, miasto”: concatenate(kraj, „, ”, miasto). |
CaseExpression
Służy do przekształcania wartości wymiaru na jeden rodzaj wielkości liter.
| Zapis JSON |
|---|
{ "dimensionName": string } |
| Pola | |
|---|---|
dimensionName |
Nazwa wymiaru. Nazwa musi odnosić się 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 | |
|---|---|
dimensionNames[] |
Nazwy wymiarów. Nazwy muszą odnosić się do nazw w polu wymiarów żądania. |
delimiter |
Ogranicznik umieszczony między nazwami wymiarów. Separatorami są często pojedyncze znaki, np. „|” lub „,”, ale mogą to być też dłuższe ciągi znaków. Jeśli wartość wymiaru zawiera separator, w odpowiedzi będą widoczne oba znaki bez rozróżnienia. Jeśli np. wartość wymiaru 1 to „US,FR”, wartość wymiaru 2 to „JP”, a ogranicznik to „,”, odpowiedź będzie zawierać ciąg „US,FR,JP”. |
Dane
Dane w raporcie wyrażone w formie liczbowej. Na przykład dane eventCount to łączna liczba zdarzeń. W żądaniach można podać maksymalnie 10 rodzajów danych.
| Zapis JSON |
|---|
{ "name": string, "expression": string, "invisible": boolean } |
| Pola | |
|---|---|
name |
Nazwa rodzaju danych. Listę nazw danych obsługiwanych przez podstawowe metody raportowania, takie jak Jeśli podano Dane są oznaczone symbolem |
expression |
Wyrażenie matematyczne dla danych pochodnych. Na przykład dane Liczba zdarzeń na użytkownika to |
invisible |
Wskazuje, czy dane są niewidoczne w odpowiedzi raportu. Jeśli dane są niewidoczne, nie utworzą kolumny w odpowiedzi, ale można ich używać w |
Zakres dat
Ciągły zestaw dni: startDate, startDate + 1, ..., endDate. Możesz przesłać maksymalnie 4 zakresy dat.
| Zapis JSON |
|---|
{ "startDate": string, "endDate": string, "name": string } |
| Pola | |
|---|---|
startDate |
Data rozpoczęcia zapytania (włącznie z tym dniem) w formacie |
endDate |
Data zakończenia zapytania (włącznie z tym dniem) w formacie |
name |
Przypisuje nazwę do tego zakresu dat. W odpowiedzi raportu wymiar |
FilterExpression
do wyrażania filtrów wymiarów lub danych. Pola w tym samym wyrażeniu FilterExpression muszą być albo wymiarami, albo danymi.
| Zapis JSON |
|---|
{ // Union field |
| Pola | |
|---|---|
Pole zbiorcze expr. Określ jeden typ wyrażenia filtra dla FilterExpression. expr może mieć tylko jedną z tych wartości: |
|
andGroup |
Elementy FilterExpressions w andGroup są ze sobą powiązane operatorem AND. |
orGroup |
Elementy FilterExpressions w orGroup są ze sobą powiązane operatorem OR. |
notExpression |
Wartość FilterExpression nie jest typu notExpression. |
filter |
Filtr podstawowy. W tym samym wyrażeniu FilterExpression wszystkie nazwy pól filtra muszą być albo wymiarami, albo rodzajami danych. |
FilterExpressionList
Lista wyrażeń filtra.
| Zapis JSON |
|---|
{
"expressions": [
{
object ( |
| Pola | |
|---|---|
expressions[] |
Lista wyrażeń filtra. |
Filtruj
Wyrażenie służące do filtrowania wartości wymiarów lub danych.
| Zapis JSON |
|---|
{ "fieldName": string, // Union field |
| Pola | |
|---|---|
fieldName |
Nazwa wymiaru lub nazwa danych. Musi to być nazwa zdefiniowana w wymiarach lub danych. |
Pole zbiorcze one_filter. Określ jeden typ filtra dla Filter. one_filter może mieć tylko jedną z tych wartości: |
|
stringFilter |
Filtr powiązany z ciągami znaków. |
inListFilter |
Filtr wartości na liście. |
numericFilter |
Filtr wartości liczbowych lub dat. |
betweenFilter |
Filtr dla wartości z określonego zakresu. |
emptyFilter |
Filtr pustych wartości, takich jak „(not set)” i „”. |
StringFilter
Filtr ciągu tekstowego
| Zapis JSON |
|---|
{
"matchType": enum ( |
| Pola | |
|---|---|
matchType |
Typ dopasowania tego filtra. |
value |
Wartość ciągu używana do dopasowywania. |
caseSensitive |
Jeśli ma wartość true, wielkość liter w wartości ciągu znaków ma znaczenie. |
MatchType
Typ dopasowania filtra ciągu znaków
| Wartości w polu enum | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
Nie określono |
EXACT |
Dopasowanie ścisłe do wartości ciągu. |
BEGINS_WITH |
Zaczyna się od wartości ciągu tekstowego. |
ENDS_WITH |
Kończy się wartością ciągu znaków. |
CONTAINS |
Zawiera wartość w postaci ciągu znaków. |
FULL_REGEXP |
Pełne dopasowanie wyrażenia regularnego do wartości ciągu tekstowego. |
PARTIAL_REGEXP |
Dopasowanie częściowe wyrażenia regularnego do wartości ciągu tekstowego. |
InListFilter
Wynik musi być listą wartości w formie ciągów znaków.
| Zapis JSON |
|---|
{ "values": [ string ], "caseSensitive": boolean } |
| Pola | |
|---|---|
values[] |
Lista wartości ciągu tekstowego. Nie może być puste. |
caseSensitive |
Jeśli ma wartość true, wielkość liter w wartości ciągu znaków ma znaczenie. |
NumericFilter
Filtry wartości liczbowych lub dat.
| Zapis JSON |
|---|
{ "operation": enum ( |
| Pola | |
|---|---|
operation |
Typ operacji przy tym filtrze. |
value |
wartość liczbowa lub data. |
Operacja
Operacja zastosowana do filtra numerycznego
| Wartości w polu enum | |
|---|---|
OPERATION_UNSPECIFIED |
Nie określono. |
EQUAL |
Równa się |
LESS_THAN |
Mniejsze niż |
LESS_THAN_OR_EQUAL |
Mniejsze lub równe |
GREATER_THAN |
Większe niż |
GREATER_THAN_OR_EQUAL |
Większe lub równe |
NumericValue
reprezentować liczbę.
| Zapis JSON |
|---|
{ // Union field |
| Pola | |
|---|---|
Pole zbiorcze one_value. Wartość liczbowa one_value może mieć tylko jedną z tych wartości: |
|
int64Value |
Wartość w formie liczby całkowitej |
doubleValue |
Podwójna wartość |
BetweenFilter
Aby wyrazić, że wynik musi mieścić się w przedziale między dwiema liczbami (włącznie).
| Zapis JSON |
|---|
{ "fromValue": { object ( |
| Pola | |
|---|---|
fromValue |
zaczyna się od tej liczby; |
toValue |
kończy się tą liczbą; |
EmptyFilter
Ten typ nie ma pól.
Filtruj według pustych wartości.
MetricAggregation
Reprezentuje agregację danych.
| Wartości w polu enum | |
|---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Nieokreślony operator. |
TOTAL |
Operator SUMA. |
MINIMUM |
Operator minimum. |
MAXIMUM |
Maksymalny operator. |
COUNT |
Operator Count. |
OrderBy
Kryteria sortowania określają sposób sortowania wierszy w odpowiedzi. Na przykład porządkowanie wierszy według malejącej liczby zdarzeń to jedno porządkowanie, a porządkowanie wierszy według ciągu nazwy zdarzenia to inne porządkowanie.
| Zapis JSON |
|---|
{ "desc": boolean, // Union field |
| Pola | |
|---|---|
desc |
Jeśli ma wartość „prawda”, sortuje w kolejności malejącej. |
Pole zbiorcze one_order_by. Określ jeden typ kolejności sortowania dla OrderBy. one_order_by może mieć tylko jedną z tych wartości: |
|
metric |
Sortuje wyniki według wartości danych. |
dimension |
Sortuje wyniki według wartości wymiaru. |
MetricOrderBy
Sortuje według wartości wskaźnika.
| Zapis JSON |
|---|
{ "metricName": string } |
| Pola | |
|---|---|
metricName |
Nazwa danych w żądaniu, według których ma być wykonane sortowanie. |
DimensionOrderBy
Sortuje według wartości wymiaru.
| Zapis JSON |
|---|
{
"dimensionName": string,
"orderType": enum ( |
| Pola | |
|---|---|
dimensionName |
Nazwa wymiaru w zapytaniu, według którego ma być przeprowadzane sortowanie. |
orderType |
Określa regułę kolejności wartości wymiaru. |
OrderType
Reguła, według której mają być porządkowane wartości wymiaru tekstowego.
| 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 rozróżniania wielkości liter według punktu kodowego Unicode małych liter. Na przykład „2” < „A” < „b” < „X” < „z”. |
NUMERIC |
Wartości wymiarów są przed sortowaniem przekształcane w liczby. Na przykład w przypadku sortowania NUMERIC „25” < „100”, a w przypadku sortowania ALPHANUMERIC „100” < „25”. Wartości wymiarów nienumerycznych mają taką samą wartość porządkowania, która jest mniejsza niż wszystkie wartości numeryczne. |
CohortSpec
Specyfikacja kohort w raporcie dotyczącym kohorty.
Raporty dotyczące kohort tworzą szereg czasowy utrzymania użytkowników w kohorcie. Możesz na przykład wybrać kohortę użytkowników pozyskanych w pierwszym tygodniu września i śledzić ją przez kolejne 6 tygodni. Wybór użytkowników pozyskanych w kohorcie z pierwszego tygodnia września jest określony w obiekcie cohort. Śledzenie tej kohorty przez kolejne 6 tygodni jest określone w obiekcie cohortsRange.
Przykłady znajdziesz w artykule Przykłady raportów dotyczących kohorty.
Odpowiedź raportu może zawierać tygodniowe dane szeregowe, np. po 3 tygodniach aplikacja utrzymała 60% użytkowników z tej kohorty, a po 6 tygodniach – 25%. Te 2 wartości procentowe można obliczyć za pomocą rodzaju danych cohortActiveUsers/cohortTotalUsers. Będą one wyświetlane w raporcie w osobnych wierszach.
| Zapis JSON |
|---|
{ "cohorts": [ { object ( |
| Pola | |
|---|---|
cohorts[] |
Określa kryteria wyboru, według których użytkownicy są grupowani w kohorty. Większość raportów dotyczących kohort definiuje tylko jedną kohortę. Jeśli określono wiele kohort, każdą z nich można rozpoznać w raporcie po nazwie. |
cohortsRange |
Raporty kohortowe śledzą kohorty w dłuższym okresie raportowania. Ten zakres określa czas przesunięcia, w którym mają być śledzone kohorty. |
cohortReportSettings |
Opcjonalne ustawienia raportu dotyczącego kohorty. |
Kohorta
Określa kryteria wyboru kohorty. Kohorta to grupa użytkowników, którzy mają wspólną cechę. Na przykład użytkownicy z tą samą firstSessionDate należą do tej samej kohorty.
| Zapis JSON |
|---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
| Pola | |
|---|---|
name |
Przypisuje nazwę do tej kohorty. W odpowiedzi raportu wymiar |
dimension |
Wymiar używany przez kohortę. Wymagane i obsługuje tylko wartość |
dateRange |
Kohorta wybiera użytkowników, których data pierwszego kontaktu mieści się w zakresie dat określonym w W przypadku żądania dotyczącego kohorty ten parametr Ten |
CohortsRange
Konfiguruje rozszerzony zakres dat raportowania w przypadku raportu dotyczącego kohorty. Określa czas przesunięcia, w którym mają być śledzone kohorty.
| Zapis JSON |
|---|
{
"granularity": enum ( |
| Pola | |
|---|---|
granularity |
Wymagane. Granularność używana do interpretowania wartości |
startOffset |
Jeśli Jeśli Jeśli |
endOffset |
Wymagane. Jeśli Jeśli Jeśli |
Szczegółowość
Granularność używana do interpretowania 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 określać. |
DAILY |
Szczegółowość dzienna. Używane zwykle, gdy dateRange kohorty to jeden dzień, a żądanie zawiera cohortNthDay. |
WEEKLY |
Szczegółowość tygodniowa. Używane zwykle, gdy dateRange kohorty trwa tydzień (od niedzieli do soboty), a żądanie zawiera cohortNthWeek. |
MONTHLY |
Miesięczny stopień szczegółowości. Używane zwykle, gdy dateRange kohorty trwa miesiąc, a żądanie zawiera cohortNthMonth. |
CohortReportSettings
Ustawienia opcjonalne raportu dotyczącego kohorty.
| Zapis JSON |
|---|
{ "accumulate": boolean } |
| Pola | |
|---|---|
accumulate |
Jeśli wartość to „true”, wynik jest kumulowany od dnia pierwszego kontaktu do dnia zakończenia. Nieobsługiwane na ścieżce |
SamplingLevel
Kategorie poziomów próbkowania żądań.
| Wartości w polu enum | |
|---|---|
SAMPLING_LEVEL_UNSPECIFIED |
Nieokreślony typ. |
LOW |
Stosuje poziom próbkowania 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 wynoszącym 1 mld. |
UNSAMPLED |
Dostępne tylko w usługach w Google Analytics 360. Eksploracje niespróbkowane są dokładniejsze i mogą ujawniać statystyki, które są niewidoczne w standardowych eksploracjach. Więcej informacji znajdziesz na stronie https://support.google.com/analytics/answer/10896953. |
ReportMetadata
Metadane raportu dotyczące konkretnego zadania związanego z raportem.
| Zapis JSON |
|---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
| Pola | |
|---|---|
creationQuotaTokensCharged |
Tylko dane wyjściowe. Łączna liczba tokenów limitu wykorzystanych podczas tworzenia raportu. Liczba tokenów jest obliczana na podstawie aktywności w stanie |
state |
Tylko dane wyjściowe. Bieżący stan tego zadania związanego z raportem. |
beginCreatingTime |
Tylko dane wyjściowe. Godzina, o której wywołano Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: |
taskRowCount |
Tylko dane wyjściowe. Łączna liczba wierszy w wynikach raportu. To pole zostanie wypełnione, gdy stan będzie aktywny. W ramach istniejącego raportu możesz używać |
errorMessage |
Tylko dane wyjściowe. Jeśli podczas tworzenia zadania raportu wystąpi błąd, wyświetli się komunikat o błędzie. |
totalRowCount |
Tylko dane wyjściowe. Łączna liczba wierszy w pamięci Google Analytics. Jeśli chcesz wysłać zapytanie o dodatkowe wiersze danych poza bieżącym raportem, możesz rozpocząć nowe zadanie raportu na podstawie Symbol Załóżmy na przykład, że bieżąca wartość |
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 funkcji CreateReport. |
ACTIVE |
Raport jest w pełni utworzony i gotowy do wysyłania zapytań. |
FAILED |
Nie udało się utworzyć raportu. |
Metody |
|
|---|---|
|
Inicjuje tworzenie zadania raportu. |
|
Pobiera metadane raportu dotyczące konkretnego zadania raportu. |
|
Zawiera listę wszystkich zadań związanych z raportami dotyczącymi usługi. |
|
Pobiera zawartość zadania raportu. |