- 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 poproszonych kilka zakresów dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat nakładają się na siebie, dane zdarzenia z nakładających się dni są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W przypadku prośby o kohortę 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. 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 podasz tu żadnej wartości, zostanie zwróconych 10 tys. wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, ile wierszy zażądasz. Wartość Interfejs API może też zwrócić mniej wierszy niż żądana wartość |
metricAggregations[] |
Opcjonalnie: Agregacja danych. Zagregowane wartości wskaźników będą wyświetlane w wierszach, w których parametr dimensionValues ma wartość „RESERVED_(MetricAggregation)”. |
orderBys[] |
Opcjonalnie: Określa sposób uporządkowania wierszy w odpowiedzi. |
currencyCode |
Opcjonalnie: Kod waluty w formacie ISO 4217, np. „PLN”, „USD”, „JPY”. Jeśli to 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 są równe 0, nie zostanie zwrócony. Jeśli wartość to „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 raportów są ciągami znaków. Na przykład 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 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "lowerCase": { object ( |
| Pola | |
|---|---|
Określ 1 typ wyrażenia wymiaru dla DimensionExpression. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: |
|
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). |
| Koniec pól wykluczających się nawzajem. | |
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 elementy bez rozróżnienia. Jeśli np. wartość wymiaru 1 to „US,FR”, wartość wymiaru 2 to „JP”, a ogranicznik to „,”, odpowiedź będzie zawierać „US,FR,JP”. |
Wskaźnik
Ilościowe wyniki pomiarów w raporcie. 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ą przywoływane przez |
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 funkcjach |
Zakres dat
Ciągły zbiór dni: startDate, startDate + 1, ..., endDate. Żądania mogą obejmować 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 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "andGroup": { object ( |
| Pola | |
|---|---|
Określ 1 typ wyrażenia filtra dla FilterExpression. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: |
|
andGroup |
Elementy FilterExpression w andGroup są ze sobą powiązane operatorem AND. |
orGroup |
Wyrażenia filtra w orGroup są ze sobą powiązane operatorem LUB. |
notExpression |
Wartość FilterExpression nie jest typu notExpression. |
filter |
Filtr podstawowy. W tym samym wyrażeniu filtra wszystkie nazwy pól filtra muszą być wymiarami lub danymi. |
| Koniec pól wykluczających się nawzajem. | |
FilterExpressionList
Lista wyrażeń filtra.
| Zapis JSON |
|---|
{
"expressions": [
{
object ( |
| Pola | |
|---|---|
expressions[] |
Lista wyrażeń filtra. |
Filtruj
Wyrażenie do filtrowania wartości wymiarów lub danych.
| Zapis JSON |
|---|
{ "fieldName": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringFilter": { object ( |
| Pola | |
|---|---|
fieldName |
Nazwa wymiaru lub danych. Musi to być nazwa zdefiniowana w wymiarach lub danych. |
Określ jeden typ filtra dla Filter. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: |
|
stringFilter |
Filtr zwią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 zakresu. |
emptyFilter |
filtr pustych wartości, np. wartości |
| Koniec pól wykluczających się nawzajem. | |
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 wartość to „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 znaków. |
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 |
Częściowe dopasowanie wyrażenia regularnego do wartości ciągu tekstowego. |
InListFilter
Wynik musi być listą wartości tekstowych.
| Zapis JSON |
|---|
{ "values": [ string ], "caseSensitive": boolean } |
| Pola | |
|---|---|
values[] |
Lista wartości ciągów tekstowych. Nie może być puste. |
caseSensitive |
Jeśli wartość to „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 dla tego filtra. |
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 niż lub równe |
GREATER_THAN |
Większe niż |
GREATER_THAN_OR_EQUAL |
Większe lub równe |
NumericValue
reprezentować liczbę.
| Zapis JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "int64Value": string, "doubleValue": number // End of mutually exclusive fields. } |
| Pola | |
|---|---|
| Wartość liczbowa. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: | |
int64Value |
Wartość w formie liczby całkowitej |
doubleValue |
Podwójna wartość |
| Koniec pól wykluczających się nawzajem. | |
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ę tym numerem; |
EmptyFilter
Ten typ nie ma pól.
Filtruj według pustych wartości. Pasuje do wartości wymiarów, które są wartościami "" lub (not set). Użyj tego filtra, aby dopasować wiersze z brakującymi lub nieuzupełnionymi wartościami wymiarów, albo połącz go z filtrem notExpression, aby wykluczyć je z raportu bez filtrowania osobno wartości "" i (not set).
MetricAggregation
Reprezentuje agregację danych.
| Wartości w polu enum | |
|---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Nieokreślony operator. |
TOTAL |
Operator SUMA. |
MINIMUM |
Operator minimum. |
MAXIMUM |
Operator maksimum. |
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, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "metric": { object ( |
| Pola | |
|---|---|
desc |
Jeśli ma wartość Prawda, sortuje w kolejności malejącej. |
Określ jeden typ zamówienia dla OrderBy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól: |
|
metric |
Sortuje wyniki według wartości danych. |
dimension |
Sortuje wyniki według wartości wymiaru. |
| Koniec pól wykluczających się nawzajem. | |
MetricOrderBy
Sortuje według wartości wskaźnika.
| Zapis JSON |
|---|
{ "metricName": string } |
| Pola | |
|---|---|
metricName |
Nazwa wskaźnika w żądaniu, według którego ma być przeprowadzane sortowanie. |
DimensionOrderBy
Sortuje według wartości wymiarów.
| Zapis JSON |
|---|
{
"dimensionName": string,
"orderType": enum ( |
| Pola | |
|---|---|
dimensionName |
Nazwa wymiaru w żądaniu, według którego ma zostać wykonane 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 nienumeryczne wymiaru mają taką samą wartość porządkowania poniżej wszystkich wartości numerycznych. |
CohortSpec
Specyfikacja kohort w raporcie dotyczącym kohorty.
Raporty dotyczące kohorty 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 pierwszym tygodniu 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, z których wynika np., że po 3 tygodniach w przypadku Twojej aplikacji 60% użytkowników z tej kohorty nadal z niej korzysta, a po 6 tygodniach – 25%. Te 2 wartości procentowe można obliczyć za pomocą danych cohortActiveUsers/cohortTotalUsers. Będą one wyświetlane w raporcie w oddzielnych wierszach.
| Zapis JSON |
|---|
{ "cohorts": [ { object ( |
| Pola | |
|---|---|
cohorts[] |
Określa kryteria wyboru do grupowania użytkowników w kohorty. Większość raportów dotyczących kohorty definiuje tylko jedną kohortę. Jeśli podasz kilka kohort, każda z nich będzie rozpoznawana w raporcie po nazwie. |
cohortsRange |
Raporty dotyczące kohort śledzą kohorty w dłuższym okresie raportowania. Ten zakres określa czas przesunięcia, w którym śledzone są kohorty. |
cohortReportSettings |
Opcjonalne ustawienia raportu dotyczącego kohorty. |
Kohorta
Określa kryteria wyboru kohorty. Kohorta to grupa 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ę do tej kohorty. W odpowiedzi raportu wymiar |
dimension |
Wymiar używany przez kohortę. Wymagany i obsługuje tylko wartość |
dateRange |
Kohorta wybiera użytkowników, których data pierwszego kontaktu mieści się w zakresie daty rozpoczęcia i daty zakończenia 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 parametr 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
Opcjonalne ustawienia raportu dotyczącego kohorty.
| Zapis JSON |
|---|
{ "accumulate": boolean } |
| Pola | |
|---|---|
accumulate |
Jeśli wartość to „true”, wynik jest sumowany 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 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 miliard. |
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 dla konkretnego zadania polegającego na wygenerowaniu raportu.
| 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. Czas, w którym 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 wyniku raportu. To pole zostanie wypełnione, gdy stan będzie aktywny. 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żący raport ma 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. |
|
Wyświetla listę wszystkich zadań związanych z raportami w usłudze. |
|
Pobiera zawartość zadania raportu. |