- Zasób: ReportTask
- ReportDefinition
- Wymiar
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Wskaźnik
- DateRange (Zakres dat)
- FilterExpression
- FilterExpressionList
- Filtrowanie
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operacja
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Kohorta
- CohortsRange
- Szczegółowość
- CohortReportSettings (Ustawienia raportów kohortowych).
- ReportMetadata
- Stan
- Metody
Zasób: ReportTask
Konkretna 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żącego do pobierania danych z raportu, która opisuje jego strukturę. Zwykle zawiera pola, które zostaną 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 raportowania, które zawierają informacje o raporcie. Zwykle zawierają one te informacje: nazwę zasobu raportu, stan raportu, sygnaturę czasową utworzenia raportu itp. |
ReportDefinition
Definicja sposobu generowania raportu.
Zapis JSON |
---|
{ "dimensions": [ { object ( |
Pola | |
---|---|
dimensions[] |
Opcjonalnie. Żądane i wyświetlone wymiary. |
metrics[] |
Opcjonalnie. Żądane i wyświetlone wskaźniki. |
dateRanges[] |
Opcjonalnie. 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 |
dimensionFilter |
Opcjonalnie. Dzięki filtrom wymiarów możesz poprosić o uwzględnienie w raporcie tylko określonych wartości wymiarów. Więcej informacji znajdziesz w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych. |
metricFilter |
Opcjonalnie. Klauzula filtra danych. 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 wiersza początkowego 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 000 wierszy na żądanie,niezależnie od tego, ile zażądasz. Interfejs API może też zwrócić mniej wierszy niż w żądaniu |
metricAggregations[] |
Opcjonalnie. Agregacja danych. Zbiorcze wartości danych będą widoczne w wierszach, w których wymiar wymiarValues ma wartość „RESERVED_(MetricAggregation)”. |
orderBys[] |
Opcjonalnie. Określa kolejność wierszy w odpowiedzi. |
currencyCode |
Opcjonalnie. Kod waluty w formacie ISO4217, np. „AED”, „USD”, „JPY”. Jeśli to pole jest puste, raport używa domyślnej waluty usługi. |
cohortSpec |
Opcjonalnie. Grupa kohorty powiązana z tym żądaniem. Jeśli żądanie zawiera grupę kohorty, musi być obecny wymiar „kohorta”. |
keepEmptyRows |
Opcjonalnie. 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. Niezależnie od tego ustawienia Jeśli np. usługa nigdy nie rejestruje zdarzenia |
Wymiar
Wymiary to atrybuty danych. Na przykład wymiar Miasto wskazuje miasto, z którego pochodzi zdarzenie. Wartości wymiarów w odpowiedziach w raporcie są ciągami tekstowymi, np. miastem może być „Paryż” lub „Nowy Jork”.
Zapis JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Pola | |
---|---|
name |
Nazwa wymiaru. Listę nazw wymiarów obsługiwanych przez podstawowe metody raportowania, np. Jeśli określono Wymiary powiązane z wymiarami: |
dimensionExpression |
Jeden wymiar może być wynikiem wyrażenia wielu wymiarów. Na przykład wymiar „kraj, miasto”: concatenate(kraj, ", ", miasto). |
DimensionExpression
Służy do wyrażenia wymiaru, który jest wynikiem formuły złożonej z wielu wymiarów. Przykładowe zastosowania: 1) LowCase(wymiar) 2) konkatenacja(wymiar1, symbol, wymiar2).
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy one_expression . Określ jeden typ wyrażenia wymiaru dla funkcji DimensionExpression . one_expression może być 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 konwertowania wartości wymiaru na jeden przypadek.
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ą się odwoływać do nazw podanych w polu wymiarów żądania. |
delimiter |
Separator umieszczony między nazwami wymiarów. Separatorami są często pojedyncze znaki, np. „|” czy „”, ale mogą być też dłuższe. Jeśli wartość wymiaru zawiera separator, obie te wartości występują w odpowiedzi bez żadnego rozróżnienia. Jeśli np. wartość wymiaru 1 = „PL,FR”, wartość wymiaru 2 = „JP”, a separator = „,”, odpowiedź będzie zawierać ciąg „US,FR,JP”. |
Wskaźnik
Pomiary ilościowe z raportu. Na przykład dane eventCount
to łączna liczba zdarzeń. Żądania mogą obejmować maksymalnie 10 rodzajów danych.
Zapis JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Pola | |
---|---|
name |
Nazwa danych. Listę nazw danych obsługiwanych przez podstawowe metody raportowania, np. Jeśli określono Do danych odwołują się zasady |
expression |
Wyrażenie matematyczne dla wskaźników pochodnych. np. dane Liczba zdarzeń na użytkownika wynoszą |
invisible |
Wskazuje, czy dane są niewidoczne w odpowiedzi raportu. Jeśli dane są niewidoczne, nie generują kolumny w odpowiedzi, ale można ich użyć w tabeli |
DateRange
sąsiadujący zestaw dni: startDate
, startDate + 1
, ..., endDate
; Żądania mogą obejmować maksymalnie 4 zakresy dat.
Zapis JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Pola | |
---|---|
startDate |
Data początkowa zapytania w formacie |
endDate |
Uwzględniająca data zakończenia zapytania w formacie |
name |
Powoduje przypisanie nazwy do tego zakresu dat. Wymiar |
FilterExpression
Do wyrażania filtrów wymiarów lub danych. Pola w tym samym obiekcie FilterExpression muszą zawierać wszystkie wymiary lub dane.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy expr . Określ jeden typ wyrażenia filtra dla właściwości FilterExpression . expr może być tylko jedną z tych wartości: |
|
andGroup |
Wyrażenie filtrujące w grupie andGroup jest połączone relacją ORAZ. |
orGroup |
Parametr FiltrExpressions w orGroup jest powiązany z operatorem LUB. |
notExpression |
Parametr FilterExpression NIE ma wartości typu notExpression. |
filter |
Filtr podstawowy. W ramach tego samego filtra wszystkie nazwy pól filtra muszą być wszystkimi wymiarami lub danymi. |
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 danych. Musi być nazwą zdefiniowaną w wymiarach lub danych. |
Pole sumy one_filter . Określ jeden typ filtra dla elementu Filter . one_filter może być tylko jedną z tych wartości: |
|
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 między 2 wartościami. |
StringFilter
Filtr ciągu znaków
Zapis JSON |
---|
{
"matchType": enum ( |
Pola | |
---|---|
matchType |
Typ dopasowania dla tego filtra. |
value |
Wartość ciągu znaków używana w dopasowaniu. |
caseSensitive |
Jeśli ma wartość prawda, w wartości ciągu znaków wielkość liter ma znaczenie. |
MatchType
typ dopasowania filtra ciągu tekstowego.
Wartości w polu enum | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Brak informacji |
EXACT |
Dokładne dopasowanie wartości ciągu. |
BEGINS_WITH |
Zaczyna się od wartości ciągu znaków. |
ENDS_WITH |
Kończy się wartością ciągu. |
CONTAINS |
Zawiera wartość ciągu znaków. |
FULL_REGEXP |
Pełne dopasowanie wyrażenia regularnego do wartości ciągu znaków. |
PARTIAL_REGEXP |
Dopasowanie częściowe do wyrażenia regularnego z wartością ciągu znaków. |
InListFilter
Wynik musi się znajdować na liście wartości ciągu znaków.
Zapis JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Pola | |
---|---|
values[] |
Lista wartości ciągów znaków. Pole nie może być puste. |
caseSensitive |
Jeśli ma wartość prawda, w wartości ciągu znaków wielkość liter ma znaczenie. |
NumericFilter
Filtry dla wartości liczbowych lub daty.
Zapis JSON |
---|
{ "operation": enum ( |
Pola | |
---|---|
operation |
Typ operacji dla tego filtra. |
value |
Wartość liczbowa lub data. |
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 sumy one_value . Jedna z wartości liczbowych one_value może być tylko jedną z tych wartości: |
|
int64Value |
Wartość w formie liczby całkowitej |
doubleValue |
Podwójna wartość |
BetweenFilter
Aby wyrazić, że wynik musi się mieścić w przedziale między dwiema liczbami (włącznie).
Zapis JSON |
---|
{ "fromValue": { object ( |
Pola | |
---|---|
fromValue |
Zaczyna się od tej liczby. |
toValue |
Kończy się na tej wartości. |
MetricAggregation
Reprezentuje agregację danych.
Wartości w polu enum | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Nieokreślony operator. |
TOTAL |
SUMA. |
MINIMUM |
Operator minimalnej. |
MAXIMUM |
Operator maksymalny. |
COUNT |
Operator liczenia. |
OrderBy
Kolejność według kolejności określa sposób sortowania wierszy w odpowiedzi. Na przykład kolejność wierszy malejąco według liczby zdarzeń to 1 kolejność, a wiersze według ciągu nazwy zdarzenia – mają inną kolejność.
Zapis JSON |
---|
{ "desc": boolean, // Union field |
Pola | |
---|---|
desc |
Jeśli ma wartość true (prawda), sortowanie powoduje sortowanie malejąco. |
Pole sumy one_order_by . Określ jeden typ zamówienia dla OrderBy . one_order_by może być 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 danych.
Zapis JSON |
---|
{ "metricName": string } |
Pola | |
---|---|
metricName |
Nazwa danych w żądaniu sortowania. |
DimensionOrderBy
Sortuje według wartości wymiarów.
Zapis JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Pola | |
---|---|
dimensionName |
Nazwa wymiaru w żądaniu sortowania. |
orderType |
Kontroluje regułę kolejności wartości wymiarów. |
OrderType
Reguła porządkowania według 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. np. „2” < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Sortowanie alfanumeryczne według małych liter nie ma znaczenia. np. „2” < "A" < "b" < "X" < "z". |
NUMERIC |
Przed sortowaniem wartości wymiarów są konwertowane na liczby. Na przykład w sortowaniu NUMERYCZNYM, „25” < „100” i w sortowaniu ALPHANUMERIC , „100” < „25”. Wszystkie wartości wymiarów nieliczbowych mają taką samą kolejność poniżej wszystkich wartości liczbowych. |
CohortSpec
Specyfikacja kohort w raporcie dotyczącym kohorty.
Raporty dotyczące kohorty tworzą serię czasową utrzymania użytkowników w kohorcie. Możesz np. wybrać kohortę użytkowników pozyskanych w pierwszym tygodniu września i śledzić tę kohortę przez kolejne 6 tygodni. Wybór użytkowników pozyskanych w pierwszym tygodniu września jest określony w obiekcie cohort
. Kohorta na kolejne 6 tygodni jest określona w obiekcie cohortsRange
.
Przykłady znajdziesz w artykule Przykłady raportów dotyczących kohorty.
Odpowiedź w raporcie może zawierać cotygodniowy ciąg czasowy, w którym aplikacja utrzymała 60% tej kohorty po 3 tygodniach i 25% tej kohorty po 6 tygodniach. Te 2 wartości procentowe mogą być obliczane według danych cohortActiveUsers/cohortTotalUsers
i znajdują się w oddzielnych wierszach raportu.
Zapis JSON |
---|
{ "cohorts": [ { object ( |
Pola | |
---|---|
cohorts[] |
Określa kryteria wyboru służące do grupowania użytkowników w kohorty. Większość raportów dotyczących kohorty definiuje tylko jedną kohortę. Jeśli określisz wiele kohort, każda z nich zostanie rozpoznana w raporcie po jej nazwie. |
cohortsRange |
Raporty dotyczące kohorty uwzględniają kohorty w rozszerzonym zakresie dat. Ten zakres określa czas przesunięcia, aby śledzić 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 takim samym atrybutem firstSessionDate
należą do tej samej kohorty.
Zapis JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
Pola | |
---|---|
name |
Przypisuje nazwę do tej kohorty. Wymiar |
dimension |
Wymiar używany przez kohortę. Wymagana i obsługiwana tylko w przypadku języka |
dateRange |
Kohorta wybiera użytkowników, których data pierwszego kontaktu przypada między datą rozpoczęcia a datą zakończenia określoną w W żądaniu dotyczącym kohorty pole Ten parametr |
CohortsRange
Konfiguruje rozszerzony zakres dat w raporcie dotyczącym kohorty. Określa czas przesunięcia, aby śledzić kohorty.
Zapis JSON |
---|
{
"granularity": enum ( |
Pola | |
---|---|
granularity |
Wymagane. Szczegółowość używana do interpretacji |
startOffset |
Jeśli Jeśli Jeśli |
endOffset |
Wymagane. Jeśli Jeśli Jeśli |
Szczegółowość
Szczegółowość używana do interpretacji startOffset
i endOffset
w rozszerzonym zakresie dat raportowania w raporcie dotyczącym kohorty.
Wartości w polu enum | |
---|---|
GRANULARITY_UNSPECIFIED |
Nigdy nie należy określać. |
DAILY |
Szczegółowość dzienna. Zwykle używana, jeśli dateRange kohorty to 1 dzień, a żądanie zawiera cohortNthDay . |
WEEKLY |
Szczegółowość tygodniowa. Zwykle używany, jeśli dateRange kohorty obejmuje tydzień (rozpoczynający się w niedzielę, a kończący w sobotę) i żądanie zawiera wartość cohortNthWeek . |
MONTHLY |
Szczegółowość miesięczna. Zwykle używana, jeśli dateRange kohorty trwa miesiąc, a żądanie zawiera cohortNthMonth . |
CohortReportSettings
Opcjonalne ustawienia raportu dotyczącego kohorty.
Zapis JSON |
---|
{ "accumulate": boolean } |
Pola | |
---|---|
accumulate |
Jeśli ma wartość prawda, kumuluje wynik od pierwszego dnia kontaktu do dnia końcowego. Nieobsługiwane w |
ReportMetadata
Metadane raportu związane z konkretnym zadaniem w raporcie.
Zapis JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Pola | |
---|---|
creationQuotaTokensCharged |
Tylko dane wyjściowe. Łączna liczba tokenów limitu opłaconych podczas tworzenia raportu. Ta liczba tokenów jest uzależniona od aktywności ze stanu |
state |
Tylko dane wyjściowe. Bieżący stan tego zadania raportowania. |
beginCreatingTime |
Tylko dane wyjściowe. Godzina wywołania funkcji Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: |
taskRowCount |
Tylko dane wyjściowe. Łączna liczba wierszy w wyniku raportu. To pole zostanie wypełnione, gdy stan będzie aktywny. Tagu |
errorMessage |
Tylko dane wyjściowe. Jeśli podczas tworzenia zadania raportu nie uda się wykonać zadania raportu, pojawi się komunikat o błędzie. |
totalRowCount |
Tylko dane wyjściowe. Łączna liczba wierszy zapisanych na koncie Google Analytics. Jeśli chcesz wysłać zapytanie do dodatkowych wierszy danych poza bieżącym raportem, mogą one zainicjować nowe zadanie raportu na podstawie parametru
Załóżmy np., że w bieżącym raporcie wartość |
Stan
Stan przetwarzania.
Wartości w polu enum | |
---|---|
STATE_UNSPECIFIED |
Nieokreślony stan nigdy nie będzie używany. |
CREATING |
Obecnie trwa tworzenie raportu i będzie on dostępny w przyszłości. Tworzenie następuje bezpośrednio po wywołaniu CreateReport. |
ACTIVE |
Raport jest w pełni utworzony i można do niego wysyłać zapytania. |
FAILED |
Nie udało się utworzyć raportu. |
Metody |
|
---|---|
|
Inicjuje tworzenie zadania związanego z raportem. |
|
Pobiera metadane raportu dotyczące określonego zadania związanego z raportem. |
|
Wyświetla listę wszystkich zadań związanych z raportowaniem w danej usłudze. |
|
Pobiera treść zadania raportu. |