Method: reports.batchGet

Zwraca dane Analytics.

Żądanie HTTP

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
Pola
reportRequests[]

object(ReportRequest)

każde żądanie będzie miało oddzielną odpowiedź; Maksymalnie można przesłać 5 próśb. Wszystkie żądania powinny mieć te same wartości dateRanges, viewId, segments, samplingLevel i cohortGroup.

useResourceQuotas

boolean

Włącza limity oparte na zasobach (wartość domyślna to False). Jeśli to pole ma wartość True, limity na widok (profil) są regulowane przez koszt obliczeniowy żądania. Pamiętaj, że użycie limitów na podstawie kosztów włączy wyższe współczynniki próbkowania. (10 milionów w przypadku SMALL, 100 mln w przypadku LARGE. Aby dowiedzieć się więcej, zapoznaj się z dokumentacją limitów.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Główna klasa odpowiedzi, która zawiera raporty z wywołania batchGet interfejsu Reporting API.

Zapis JSON 
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
Pola
reports[]

object(Report)

Odpowiedzi odpowiadające każdemu z żądań.

queryCost

number

Liczba tokenów limitu zasobów odjętych w celu wykonania zapytania. Obejmuje wszystkie odpowiedzi.

resourceQuotasRemaining

object(ResourceQuotasRemaining)

Pozostały limit zasobów usługi.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ReportRequest

Główna klasa żądania, która określa żądanie interfejsu Reporting API.

Zapis JSON 
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
Pola
viewId

string

Identyfikator widoku danych w Analytics, z którego mają być pobierane dane. Każde żądanie ReportRequest w metodzie batchGet musi zawierać tę samą wartość viewId.

dateRanges[]

object(DateRange)

Zakresy dat w żądaniu. Prośba może zawierać maksymalnie 2 zakresy dat. Odpowiedź będzie zawierać zestaw wartości danych dla każdej kombinacji wymiarów dla każdego zakresu dat w żądaniu. Jeśli więc mamy 2 zakresy dat, to zostaną tam również dwa zestawy wartości danych – jedna dla pierwotnego zakresu dat, a druga dla drugiego. Pola reportRequest.dateRanges nie należy określać w przypadku kohort ani żądań wartości od początku śledzenia. Jeśli zakres dat nie zostanie podany, domyślny zakres dat to (startDate: bieżąca data – 7 dni, data zakończenia: data bieżąca – 1 dzień). Każde żądanie ReportRequest w metodzie batchGet musi zawierać tę samą definicję dateRanges.

samplingLevel

enum(Sampling)

Żądany rozmiar próbki raportu. Jeśli pole samplingLevel jest nieokreślone, używany jest poziom próbkowania DEFAULT. Każde żądanie ReportRequest w metodzie batchGet musi zawierać tę samą definicję samplingLevel. Więcej informacji znajdziesz w przewodniku dla programistów.

dimensions[]

object(Dimension)

Żądane wymiary. Żądania mogą zawierać łącznie 9 wymiarów.

dimensionFilterClauses[]

object(DimensionFilterClause)

Klauzule filtra wymiarów przeznaczone do filtrowania wartości wymiarów. Są one logicznie połączone z operatorem AND. Pamiętaj, że filtrowanie ma miejsce przed agregacją wymiarów, więc zwracane dane przedstawiają sumę tylko dla odpowiednich wymiarów.

metrics[]

object(Metric)

Żądane wskaźniki. Żądania muszą określać co najmniej 1 rodzaj danych. Żądania mogą obejmować łącznie 10 rodzajów danych.

metricFilterClauses[]

object(MetricFilterClause)

Klauzule filtra wskaźników. Są one logicznie połączone z operatorem AND. Filtry danych uwzględniają tylko pierwszy zakres dat, a nie porównywany zakres. Pamiętaj, że filtrowanie według wskaźników następuje po ich agregacji.

filtersExpression

string

Filtry wymiarów lub danych, które ograniczają ilość danych zwracanych w odpowiedzi na żądanie. Aby użyć parametru filtersExpression, podaj wymiar lub dane do filtrowania, a po nim wyrażenie filtra. Na przykład poniższe wyrażenie wybiera wymiar ga:browser, którego nazwa zaczyna się od Firefox: ga:browser=~^Firefox. Więcej informacji o filtrach wymiarów i danych znajdziesz w artykule Informacje o filtrach.

orderBys[]

object(OrderBy)

Kolejność sortowania wierszy wyjściowych. Aby porównać 2 wiersze, poniższe elementy są stosowane w odpowiedniej kolejności aż do znalezienia różnicy. Wszystkie zakresy dat w danych wyjściowych mają tę samą kolejność wierszy.

segments[]

object(Segment)

Podziel dane zwrócone w odpowiedzi na żądanie. Definicja segmentu pomaga przyjrzeć się podzbiorze żądania dotyczącego segmentu. Żądanie może zawierać maksymalnie 4 segmenty. Każde żądanie ReportRequest w metodzie batchGet musi zawierać tę samą definicję segments. Żądania z segmentami muszą mieć wymiar ga:segment.

pivots[]

object(Pivot)

Definicje tabel przestawnych. Żądania mogą zawierać maksymalnie 2 przestawienia.

cohortGroup

object(CohortGroup)

Grupa kohorty powiązana z tym żądaniem. Jeśli żądanie zawiera grupę kohorty, musi być obecny wymiar ga:cohort. Każde żądanie ReportRequest w metodzie batchGet musi zawierać tę samą definicję cohortGroup.

pageToken

string

Token kontynuacji, który pozwala wyświetlić następną stronę wyników. Dodanie tego kodu do żądania spowoduje zwrócenie wierszy po parametrze pageToken. Parametr pageToken powinien być wartością zwracaną w parametrze nextPageToken w odpowiedzi na żądanie reports.batchGet.

pageSize

number

Rozmiar strony służy do podziału na strony i określa maksymalną liczbę zwracanych wierszy. Rozmiar strony powinien wynosić >= 0. Zapytanie zwraca domyślnie 1000 wierszy. Interfejs Analytics Core Reporting API zwraca maksymalnie 100 tys. wierszy na żądanie,niezależnie od tego, ile z nich poprosisz. Może też zwrócić mniej wierszy niż wynosi żądanie, jeśli nie ma oczekiwanej liczby segmentów wymiarów. Na przykład możliwych wartości parametru ga:country jest mniej niż 300, więc przy segmentowaniu tylko według kraju nie uda Ci się uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz wyższą wartość pageSize.

includeEmptyRows

boolean

Jeśli zasada ma wartość Fałsz, odpowiedź nie uwzględnia wierszy, jeśli wszystkie pobrane dane mają wartość 0. Wartość domyślna to fałsz (false), co spowoduje wykluczenie tych wierszy.

hideTotals

boolean

Jeśli ma wartość Prawda, ukrywa sumę wszystkich danych we wszystkich pasujących wierszach i w każdym zakresie dat. Domyślnie ma wartość Fałsz i zwraca sumy.

hideValueRanges

boolean

Jeśli ma wartość Prawda, ukrywa wartość minimalną i maksymalną we wszystkich pasujących wierszach. Wartość domyślna to fałsz, a zakresy wartości są zwracane.

Próbkowanie

Wartości poziomu próbkowania.

Wartości w polu enum
SAMPLING_UNSPECIFIED Jeśli pole samplingLevel nie jest określone, używany jest poziom próbkowania DEFAULT.
DEFAULT Zwraca odpowiedź z rozmiarem próbki, który równoważy szybkość i dokładność.
SMALL Zwraca szybką odpowiedź z mniejszą próbką.
LARGE Zwraca dokładniejszą odpowiedź z użyciem dużej wielkości próbki. Może to jednak spowodować spowolnienie czasu reakcji.

Wymiar

Wymiary to atrybuty danych. Na przykład wymiar ga:city wskazuje miasto, np. „Paryż” lub „Nowy Jork”, z którego pochodzi każda sesja.

Zapis JSON 
{
  "name": string,
  "histogramBuckets": [
    string
  ]
}
Pola
name

string

Nazwa wymiaru do pobrania, np. ga:browser.

histogramBuckets[]

string (int64 format)

Jeśli pole nie jest puste, wartości wymiarów umieszczamy w zasobnikach po ciągu znaków do int64. Wartości wymiarów, które nie są reprezentowanymi ciągami znaków, zostaną przekonwertowane na 0. Wartości zasobników muszą rosnąć. Każdy zasobnik jest zamknięty w dolnej części, a otwarty w górnej. „Pierwszy” zasobnik zawiera wszystkie wartości mniejsze niż pierwsza granica, a „ostatni” – wszystkie wartości do nieskończoności. Wartości wymiarów, które mieszczą się w zasobniku, są przekształcane w nową wartość wymiaru. Jeśli np. dana lista zawiera listę „0, 1, 3, 4, 7”, zwracamy następujące segmenty:

  • zasobnik nr 1: wartości < 0, wartość wymiaru „<0”
  • zasobnik nr 2: wartości w [0,1), wartość wymiaru „0”
  • zasobnik nr 3: wartości w [1,3), wartość wymiaru „1–2”
  • zasobnik nr 4: wartości w [3,4), wartość wymiaru „3”
  • segment 5: wartości w [4,7), wartość wymiaru „4–6”
  • zasobnik nr 6: wartości >= 7, wartość wymiaru „7+”

UWAGA: jeśli stosujesz mutację histogramu do dowolnego wymiaru i używasz tego wymiaru do sortowania, należy użyć w tym celu typu sortowania HISTOGRAM_BUCKET. Jeśli tego nie zrobisz, wartości wymiarów będą sortowane według kolejności słownikowej (leksykograficznej). Na przykład kolejność rosnąca w słowniku to:

„<50”, „1001+”, „121–1000”, „50–120”

A kolejność rosnąca HISTOGRAM_BUCKET to:

„< 50”, „50–120”, „121–1000”, „1001+”

Klient musi wyraźnie poprosić o "orderType": "HISTOGRAM_BUCKET" w przypadku wymiaru zmutowanego histogramem.

DimensionFilterClause

Grupa filtrów wymiarów. Ustaw wartość operatora, aby określić sposób logicznego łączenia filtrów.

Zapis JSON 
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
Pola
operator

enum(FilterLogicalOperator)

Operator do łączenia wielu filtrów wymiarów. Jeśli nie określono inaczej, jest traktowany jako OR.

filters[]

object(DimensionFilter)

Powtórzony zestaw filtrów. Są one logicznie łączone w zależności od podanego operatora.

FilterLogicalOperator

Logiczny sposób łączenia filtrów.

Wartości w polu enum
OPERATOR_UNSPECIFIED Nieokreślony operator. Jest traktowana jak OR.
OR Operator logiczny OR.
AND Operator logiczny AND.

DimensionFilter

Filtr wymiaru określa opcje filtrowania wymiaru.

Zapis JSON 
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
Pola
dimensionName

string

Wymiar, według którego chcesz filtrować. Filtr wymiarów musi zawierać wymiar.

not

boolean

Operator logiczny NOT. Jeśli ta wartość logiczna ma wartość „true”, pasujące wartości wymiarów zostaną wykluczone z raportu. Wartość domyślna to false (fałsz).

operator

enum(Operator)

Jak dopasować wymiar do wyrażenia. Wartością domyślną jest REGEXP.

expressions[]

string

Ciągi znaków lub wyrażenie regularne służące do dopasowywania. Do porównania używana jest tylko pierwsza wartość listy, chyba że operator to IN_LIST. W przypadku operatora IN_LIST do filtrowania wymiarów zgodnie z opisem operatora IN_LIST używana jest cała lista.

caseSensitive

boolean

Czy w dopasowaniu ma być rozróżniana wielkość liter? Wartość domyślna to false (fałsz).

Operator

Obsługiwane są różne typy dopasowania.

Wartości w polu enum
OPERATOR_UNSPECIFIED Jeśli typ dopasowania jest nieokreślony, jest traktowany jak REGEXP.
REGEXP Wyrażenie dopasowania jest traktowane jako wyrażenie regularne. Żadne typy dopasowania nie są traktowane jako wyrażenia regularne.
BEGINS_WITH Dopasowuje wartość, która rozpoczyna się od podanego wyrażenia dopasowania.
ENDS_WITH Dopasowuje wartości, które kończą się podanym wyrażeniem dopasowania.
PARTIAL Dopasowanie podłańcucha.
EXACT Wartość powinna w całości odpowiadać wyrażeniu dopasowania.
NUMERIC_EQUAL

Filtry porównania liczb całkowitych. W przypadku tych wyrażeń wielkość liter nie jest rozróżniana, a wyrażenie jest uznawane za ciąg znaków reprezentujący liczbę całkowitą. Warunki niepowodzenia:

  • Jeśli wyrażenie nie jest prawidłowym wyrażeniem int64, klient powinien spodziewać się błędu.
  • Wymiary wejściowe, które nie są prawidłowymi wartościami int64, nigdy nie będą pasować do filtra.
NUMERIC_GREATER_THAN Sprawdza, czy wymiar jest liczbowy większy niż wyrażenie dopasowania. Informacje o ograniczeniach znajdziesz w opisie zasady NUMERIC_EQUALS.
NUMERIC_LESS_THAN Sprawdza, czy wymiar ma wartość liczbową mniejszą niż wyrażenie dopasowania. Informacje o ograniczeniach znajdziesz w opisie zasady NUMERIC_EQUALS.
IN_LIST

Ta opcja służy do określania filtra wymiaru, którego wyrażenie może przyjmować dowolną wartość z wybranej listy wartości. Dzięki temu unikniesz oceny wielu filtrów wymiarów dopasowania ścisłego z wykorzystaniem operatora LUB dla każdego wiersza odpowiedzi. Na przykład:

expressions: ["A", "B", "C"]

Każdy wiersz odpowiedzi, którego wymiar ma wartość A, B lub C, pasuje do tego filtra wymiarów.

Dane

Dane służą do pomiaru ilości. Na przykład dane ga:users wskazują łączną liczbę użytkowników w wybranym okresie.

Zapis JSON 
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
Pola
expression

string

Wyrażenie wskaźnika w żądaniu. Wyrażenie jest tworzone na podstawie co najmniej jednego wskaźnika i jednej liczby. Dopuszczalne operatory: Plus (+), Minus (-), Negation (Jednoargumentowy -), Dzielenie przez (/), Mnożenie przez (*), Nawias, dodatnie liczby kardynalne (0–9), mogą obejmować ułamki dziesiętne, a ich długość jest ograniczona do 1024 znaków. Przykład ga:totalRefunds/ga:users. W większości przypadków wyrażenie danych to po prostu jedna nazwa danych, np. ga:users. Dodawanie mieszanej zawartości MetricType (np. CURRENCY + PERCENTAGE) może spowodować nieoczekiwane wyniki.

alias

string

Alias wyrażenia wskaźnika to alternatywna nazwa wyrażenia. Alias może służyć do filtrowania i sortowania. To pole jest opcjonalne i przydatne, gdy wyrażenie nie jest pojedynczym wskaźnikiem, ale złożonym wyrażeniem, którego nie można używać do filtrowania i sortowania. Alias jest też używany w nagłówku kolumny odpowiedzi.

formattingType

enum(MetricType)

Określa sposób formatowania wyrażenia danych, np. INTEGER.

MetricType

Typy danych.

Wartości w polu enum
METRIC_TYPE_UNSPECIFIED Typ wskaźnika jest nieokreślony.
INTEGER Liczba całkowita.
FLOAT Liczba zmiennoprzecinkowa.
CURRENCY Waluta.
PERCENT Dane procentowe.
TIME Dane dotyczące czasu w formacie HH:MM:SS.

MetricFilterClause

Reprezentuje grupę filtrów wskaźników. Ustaw wartość operatora, aby określić sposób logicznego łączenia filtrów.

Zapis JSON 
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
Pola
operator

enum(FilterLogicalOperator)

Operator do łączenia wielu filtrów danych. Jeśli nie określono inaczej, jest traktowany jako OR.

filters[]

object(MetricFilter)

Powtórzony zestaw filtrów. Są one logicznie łączone w zależności od podanego operatora.

MetricFilter

MetricFilter określa filtr danych.

Zapis JSON 
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
Pola
metricName

string

Dane, według których będą filtrowane dane. MetricFilter musi zawierać nazwę wskaźnika. Nazwa wskaźnika może być aliasem wcześniej zdefiniowanym jako dane lub może być też wyrażeniem danych.

not

boolean

Operator logiczny NOT. Jeśli ta wartość logiczna ma wartość „true”, pasujące wartości danych zostaną wykluczone z raportu. Wartość domyślna to false (fałsz).

operator

enum(Operator)

To dane EQUAL, LESS_THAN lub GREATER_THAN z wartością porównań, a wartością domyślną jest EQUAL. Jeśli operator to IS_MISSING, sprawdza, czy brakuje danych, i zignoruje parametr porównanie.

comparisonValue

string

Wartość do porównania.

Operator

Różne opcje typu porównania.

Wartości w polu enum
OPERATOR_UNSPECIFIED Jeśli operator nie zostanie określony, będzie traktowany jako EQUAL.
EQUAL Wartość danych powinna być dokładnie taka sama jak wartość porównania.
LESS_THAN Może mieć wartość mniejszą od wartości porównania.
GREATER_THAN Wartość danych powinna być większa od wartości porównania.
IS_MISSING Sprawdza, czy brakuje danych. Nie uwzględnia wartości porównań.

OrderBy

Określa opcje sortowania.

Zapis JSON 
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder)
}
Pola
fieldName

string

Pole, według którego należy sortować. Domyślna kolejność sortowania rosnąco. Przykład: ga:browser. Pamiętaj, że w tym miejscu możesz określić tylko jedno pole do sortowania. np. ga:browser, ga:city.

orderType

enum(OrderType)

Typ zamówienia. Domyślna wartość orderType to VALUE.

sortOrder

enum(SortOrder)

Kolejność sortowania pola.

OrderType

OrderType określa sposób określania kolejności sortowania.

Wartości w polu enum
ORDER_TYPE_UNSPECIFIED Nieokreślony typ zamówienia będzie traktowany jako sortowanie na podstawie wartości.
VALUE Porządek sortowania zależy od wartości z wybranej kolumny. Uwzględniany jest tylko pierwszy zakres dat.
DELTA Kolejność sortowania jest określana na podstawie różnicy wartości w wybranej kolumnie między dwoma pierwszymi zakresami dat. Tej opcji należy używać tylko w przypadku dokładnie 2 zakresów dat.
SMART Porządek sortowania zależy od ważonej wartości wybranej kolumny. Jeśli kolumna ma format n/d, wartość ważona tego współczynnika będzie (n + totals.n)/(d + totals.d). Może być używana tylko w przypadku danych reprezentujących współczynniki.
HISTOGRAM_BUCKET Typ kolejności histogramu ma zastosowanie tylko do kolumn wymiarów z niepustymi zasobnikami histogramu.
DIMENSION_AS_INTEGER Jeśli wymiary mają postać liczbową o stałej długości, wystarczy zwykłe sortowanie. Funkcji DIMENSION_AS_INTEGER można użyć, jeśli wymiary mają postać liczbową o zmiennej długości.

SortOrder

Porządek sortowania.

Wartości w polu enum
SORT_ORDER_UNSPECIFIED Jeśli kolejność sortowania nie jest określona, domyślnie jest to rosnąco.
ASCENDING Sortowanie rosnąco. Pole zostanie posortowane rosnąco.
DESCENDING Sortowanie malejąco. Pole zostanie posortowane malejąco.

Segmenty

Definicja segmentu, jeśli raport musi zostać posegmentowany. Segment jest podzbiorem danych Analytics. Mogą to być np. użytkownicy z danego kraju lub miasta wydzieleni z całego zbioru użytkowników.

Zapis JSON 
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
Pola
Pole sumy dynamicOrById. Segment można definiować dynamicznie za pomocą funkcji DynamicSegment lub identyfikatora wbudowanego bądź niestandardowego segmentu. dynamicOrById może być tylko jedną z tych wartości:
dynamicSegment

object(DynamicSegment)

Definicja segmentu dynamicznego w żądaniu.

segmentId

string

Identyfikator segmentu wbudowanego lub niestandardowego, np. gaid::-3.

DynamicSegment

Definicja segmentu dynamicznego służąca do definiowania segmentu w żądaniu. Segment może wybrać użytkowników, sesje lub oba te elementy.

Zapis JSON 
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  }
}
Pola
name

string

Nazwa segmentu dynamicznego.

userSegment

object(SegmentDefinition)

Segment użytkowników, aby wybrać użytkowników do uwzględnienia w segmencie.

sessionSegment

object(SegmentDefinition)

Segment sesji, aby wybrać sesje, które mają być uwzględnione w segmencie.

SegmentDefinition

SegmentDefinition definiuje segment jako zbiór filtrów segmentów, które są połączone ze sobą operacji logicznej AND.

Zapis JSON 
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ]
}
Pola
segmentFilters[]

object(SegmentFilter)

Segment jest definiowany przez zestaw filtrów segmentów, które są połączone ze sobą za pomocą operacji logicznej AND.

SegmentFilter

SegmentFilter definiuje segment prosty lub sekwencyjny. Prosty warunek segmentu zawiera warunki wymiarów i danych służące do wyboru sesji lub użytkowników. Warunek segmentu sekwencji może służyć do wybierania użytkowników lub sesji na podstawie warunków sekwencyjnych.

Zapis JSON 
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
Pola
not

boolean

Jeśli ma wartość true (prawda), dopasuj dopełnienie do prostego lub sekwencyjnego segmentu. Aby np. dopasować wszystkie odwiedziny z „Kraków”, można zdefiniować segment w następujący sposób:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

Pole sumy simpleOrSequence. Czy jest to prosty segment czy definicja segmentu sekwencji? simpleOrSequence może być tylko jedną z tych wartości:
simpleSegment

object(SimpleSegment)

Proste warunki segmentu składają się z co najmniej 1 warunku wymiaru/danych, które można łączyć.

sequenceSegment

object(SequenceSegment)

Warunki sekwencji składają się z jednego lub większej liczby kroków, przy czym każdy krok jest definiowany przez co najmniej jeden warunek wymiaru/rodzaju danych. Kilka kroków można łączyć za pomocą specjalnych operatorów sekwencji.

SimpleSegment

Prosty segment składa się z co najmniej 1 warunku wymiaru/danych, które można łączyć.

Zapis JSON 
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ]
}
Pola
orFiltersForSegment[]

object(OrFiltersForSegment)

Lista filtrów segmentów połączonych z operatorem logicznym AND.

OrFiltersForSegment

Lista filtrów segmentów w grupie OR jest połączona z operatorem logicznym LUB.

Zapis JSON 
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ]
}
Pola
segmentFilterClauses[]

object(SegmentFilterClause)

Lista filtrów segmentów, które można połączyć z operatorem OR.

SegmentFilterClause

Klauzula filtra do użycia w definicji segmentu. Można ją usunąć z danych lub filtra wymiaru.

Zapis JSON 
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
Pola
not

boolean

Pasuje do uzupełniania (!) filtra.

Pole sumy dimensionOrMetricFilter. Filtr wymiaru lub danych. dimensionOrMetricFilter może być tylko jedną z tych wartości:
dimensionFilter

object(SegmentDimensionFilter)

Filtr wymiaru na potrzeby definicji segmentu.

metricFilter

object(SegmentMetricFilter)

Filtr danych na potrzeby definicji segmentu.

SegmentDimensionFilter

Filtr wymiaru określa opcje filtrowania wymiaru.

Zapis JSON 
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
Pola
dimensionName

string

Nazwa wymiaru, do którego stosujesz filtr.

operator

enum(Operator)

Operator służący do dopasowywania wymiaru do wyrażeń.

caseSensitive

boolean

Czy dopasowanie ma uwzględniać wielkość liter i ignorować w przypadku operatora IN_LIST.

expressions[]

string

Lista wyrażeń (w przypadku wszystkich operatorów używany jest tylko pierwszy element)

minComparisonValue

string

Minimalne wartości porównywane dla BETWEEN typu dopasowania.

maxComparisonValue

string

Maksymalne wartości porównań dla BETWEEN typu dopasowania.

Operator

Obsługiwane są różne typy dopasowania.

Wartości w polu enum
OPERATOR_UNSPECIFIED Jeśli typ dopasowania jest nieokreślony, jest traktowany jako REGEXP.
REGEXP Wyrażenie dopasowania jest traktowane jako wyrażenie regularne. Pozostałe typy dopasowania nie są traktowane jako wyrażenia regularne.
BEGINS_WITH Dopasowuje wartości, które zaczynają się podanym wyrażeniem dopasowania.
ENDS_WITH Dopasowuje wartości, które kończą się podanym wyrażeniem dopasowania.
PARTIAL Dopasowanie podłańcucha.
EXACT Wartość powinna w całości odpowiadać wyrażeniu dopasowania.
IN_LIST

Ta opcja służy do określania filtra wymiaru, którego wyrażenie może przyjmować dowolną wartość z wybranej listy wartości. Dzięki temu unikniesz oceny wielu filtrów wymiarów dopasowania ścisłego z wykorzystaniem operatora LUB dla każdego wiersza odpowiedzi. Na przykład:

expressions: ["A", "B", "C"]

Każdy wiersz odpowiedzi, którego wymiar ma wartość A, B lub C, pasuje do tego filtra wymiarów.
NUMERIC_LESS_THAN

Filtry porównania liczb całkowitych. W przypadku tych wyrażeń wielkość liter nie jest rozróżniana, a wyrażenie jest uznawane za ciąg znaków reprezentujący liczbę całkowitą. Warunki niepowodzenia:

  • Jeśli wyrażenie nie jest prawidłowym wyrażeniem int64, klient powinien spodziewać się błędu.
  • wymiary wejściowe, które nie są prawidłowymi wartościami int64, nigdy nie będą pasować do filtra.

Sprawdza, czy wymiar ma wartość liczbową mniejszą niż wyrażenie dopasowania.
NUMERIC_GREATER_THAN Sprawdza, czy wymiar jest liczbowy większy niż wyrażenie dopasowania.
NUMERIC_BETWEEN Sprawdza, czy wymiar znajduje się między wartością minimalną a maksymalną w wyrażeniu dopasowania, z wyłączeniem granic.

SegmentMetricFilter

Filtr danych do użycia w klauzuli filtra segmentu.

Zapis JSON 
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
Pola
scope

enum(Scope)

Zakres wskaźnika określa poziom, na którym jest on zdefiniowany. Podany zakres wskaźników musi być równy lub większy od zakresu podstawowego zdefiniowanego w modelu danych. Zakres główny jest definiowany przez to, czy segment wybiera użytkowników czy sesje.

metricName

string

Dane, według których będą filtrowane dane. Pole metricFilter musi zawierać nazwę danych.

operator

enum(Operator)

Określa operację, która ma zostać przeprowadzona w celu porównania wskaźnika. Wartość domyślna to EQUAL.

comparisonValue

string

Wartość do porównania. Jeśli operator to BETWEEN, ta wartość jest traktowana jako minimalna wartość porównawcza.

maxComparisonValue

string

Maksymalna wartość porównania jest używana tylko w przypadku operatora BETWEEN.

Zakres

Zakres danych określa poziom, na którym są one zdefiniowane – PRODUCT, HIT, SESSION lub USER. Wartości danych mogą też być raportowane w zakresach większych niż ich zakres podstawowy. Np. Działania ga:pageviews i ga:transactions można generować na poziomie SESSION i USER, sumując je dla każdego działania w tych sesjach lub dla tych użytkowników.

Wartości w polu enum
UNSPECIFIED_SCOPE Jeśli zakres nie jest określony, domyślnie przyjmuje się zakres warunku USER lub SESSION w zależności od tego, czy segment próbuje wybrać użytkowników czy sesje.
PRODUCT Zakres produktu.
HIT Zakres działania.
SESSION Zakres sesji.
USER Zakres użytkownika.

Operator

Różne opcje typu porównania.

Wartości w polu enum
UNSPECIFIED_OPERATOR Nieokreślony operator jest traktowany jako operator LESS_THAN.
LESS_THAN Sprawdza, czy wartość danych jest mniejsza od wartości porównania.
GREATER_THAN Sprawdza, czy wartość danych jest większa od wartości porównania.
EQUAL Operator równości.
BETWEEN W przypadku operatorów między operatorami wartości minimalna i maksymalna nie są stosowane. Do porównania użyjemy LT i GT.

SequenceSegment

Warunki sekwencji składają się z jednego lub większej liczby kroków, przy czym każdy krok jest definiowany przez co najmniej jeden warunek wymiaru/rodzaju danych. Kilka kroków można łączyć za pomocą specjalnych operatorów sekwencji.

Zapis JSON 
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
Pola
segmentSequenceSteps[]

object(SegmentSequenceStep)

Lista kroków w sekwencji.

firstStepShouldMatchFirstHit

boolean

Jeśli jest ustawiony, warunek pierwszego kroku musi pasować do pierwszego działania użytkownika (w zakresie dat).

SegmentSequenceStep

Definicja sekwencji segmentu.

Zapis JSON 
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
Pola
orFiltersForSegment[]

object(OrFiltersForSegment)

Sekwencja jest określana za pomocą listy filtrów zgrupowanych lub połączonych z operatorem AND.

matchType

enum(MatchType)

Określa, czy krok bezpośrednio poprzedza następny czy może mieć miejsce przed nim.

MatchType

Typ dopasowania sekwencji.

Wartości w polu enum
UNSPECIFIED_MATCH_TYPE Nieokreślony typ dopasowania jest traktowany jak prefiksy.
PRECEDES Operator wskazuje, że poprzedni krok poprzedza następny.
IMMEDIATELY_PRECEDES Operator wskazuje, że poprzedni krok bezpośrednio poprzedza następny.

Przestaw

Tabela przestawna opisuje sekcję przestawną w żądaniu. Narzędzie Tabela przestawne umożliwia zmianę kolejności informacji w tabeli w niektórych raportach przez przestawianie danych na drugi wymiar.

Zapis JSON 
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
Pola
dimensions[]

object(Dimension)

Lista wymiarów do wyświetlenia jako kolumny przestawne. Tabela przestawna może mieć maksymalnie 4 wymiary. Wymiary przestawne są częścią ograniczenia dotyczącego łącznej liczby wymiarów dozwolonych w żądaniu.

dimensionFilterClauses[]

object(DimensionFilterClause)

Klauzule DimensionsFilter są logicznie połączone za pomocą operatora AND: w wartościach w tym regionie przestawnym uwzględniane są tylko dane uwzględnione przez wszystkie te klauzule obiektu DimensionsFilterClause. Za pomocą filtrów wymiarów możesz ograniczyć zakres kolumn wyświetlanych w regionie obrotu. Jeśli na przykład żądanym wymiarem w obszarze przestawnym jest ga:browser i określisz filtry kluczy, które ograniczają wymiar ga:browser tylko do „IE” lub „Firefox”, tylko te 2 przeglądarki będą widoczne jako kolumny.

metrics[]

object(Metric)

Dane w tabeli przestawnej. Dane przestawne są częścią ograniczenia dotyczącego łącznej liczby danych dozwolonych w żądaniu.

startGroup

number

Jeśli zażądano k wskaźników, odpowiedź będzie zawierała zależną od danych wielokrotność k kolumn w raporcie. Jeśli np. przełączysz wymiar ga:browser, otrzymasz k kolumn dla „Firefox”, k kolumn dla „IE”, k kolumn w przypadku „Chrome” itd. Kolejność grup kolumn jest określana w kolejności malejącej według pierwszej z k wartości. Powiązanie jest uzależnione od kolejności leksykograficznej pierwszego wymiaru, następnie kolejności leksykograficznej drugiego wymiaru itd. Jeśli np. suma pierwszej wartości dla przeglądarek Firefox, IE i Chrome wyniosła odpowiednio 8, 2, 8, kolumny miałyby następującą kolejność: Chrome, Firefox, IE.

Poniżej możesz wybrać, która z grup k kolumn ma być uwzględniona w odpowiedzi.
maxGroupCount

number

Określa maksymalną liczbę grup do zwrócenia. Wartość domyślna to 10, a maksymalna – 1000.

CohortGroup

Określa grupę kohorty. Na przykład:

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
Zapis JSON 
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
Pola
cohorts[]

object(Cohort)

Definicja kohorty.

lifetimeValue

boolean

Włącz wartość od początku śledzenia. Wartość od początku śledzenia mierzy wartość od początku śledzenia użytkowników pozyskanych poprzez różne kanały. Więcej informacji znajdziesz w sekcjach Analiza kohortowa i Wartość od początku śledzenia. Jeśli wartość parametru od początku śledzenia jest fałszowana:

  • Wartości danych są podobne do wartości w raporcie dotyczącym kohorty w interfejsie internetowym.
  • Zakresy dat definicji kohorty muszą być dopasowane do tygodnia i miesiąca kalendarzowego. Oznacza to, że żądanie ga:cohortNthWeek w polu startDate w definicji kohorty powinno dotyczyć niedzieli, a endDate – następnej soboty, a w przypadku ga:cohortNthMonth – pierwszego dnia miesiąca, a endDate – ostatniego dnia miesiąca.startDate

Gdy wartość od początku śledzenia ma wartość prawda:

  • Wartości wskaźników będą odpowiadać wartościom w interfejsie internetowym raportu o wartościach od początku śledzenia.
  • Raport Wartość od początku śledzenia pokazuje, jak rozwijała się wartość użytkownika (przychody) i zaangażowanie (wyświetlenia aplikacji, realizacje celu, sesje oraz czas trwania sesji) w ciągu 90 dni od pozyskania użytkownika.
  • Dane są obliczane jako skumulowana średnia na użytkownika w przypadku przyrostu czasu.
  • Zakresy dat definicji kohorty nie muszą być dopasowane do granic tygodniowych i miesięcy kalendarzowych.
  • Element viewId musi być identyfikatorem wyświetlenia aplikacji.

Kohorta

Definiuje kohortę. Kohorta to grupa użytkowników, którzy mają wspólną cechę. Na przykład wszyscy użytkownicy z tą samą datą pozyskania należą do tej samej kohorty.

Zapis JSON 
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  }
}
Pola
name

string

Unikalna nazwa kohorty. Jeśli nie zdefiniowano nazwy, zostanie ona wygenerowana automatycznie z wartościami kohorta_[1234...].

type

enum(Type)

Typ kohorty. Obecnie obsługiwany jest tylko typ FIRST_VISIT_DATE. Jeśli nie określisz wartości tego pola, kohorta będzie traktowana jako kohorta typu FIRST_VISIT_DATE.

dateRange

object(DateRange)

Ta opcja jest używana w kohorcie FIRST_VISIT_DATE. Kohorta wybiera użytkowników, których data pierwszej wizyty przypada w okresie między datą rozpoczęcia a datą zakończenia określoną w zakresie dat. Zakresy dat powinny być dopasowane pod kątem żądań dotyczących kohorty. Jeśli żądanie zawiera ga:cohortNthDay, powinno obejmować dokładnie 1 dzień. Jeśli ga:cohortNthWeek – z granicą tygodnia (od niedzieli do soboty), a w przypadku ga:cohortNthMonth – zakres dat powinien być dopasowany do miesiąca (rozpoczynający się od pierwszego dnia i kończący ostatniego dnia miesiąca). W przypadku żądań wartości od początku śledzenia nie ma takich ograniczeń. Nie musisz określać zakresu dat w polu reportsRequest.dateRanges.

Typ

Typ kohorty.

Wartości w polu enum
UNSPECIFIED_COHORT_TYPE Jeśli nie określono inaczej, jest traktowany jako FIRST_VISIT_DATE.
FIRST_VISIT_DATE Kohorty wybierane na podstawie daty pierwszej wizyty.

Zgłaszanie

Odpowiedź dotycząca danych odpowiadająca żądaniu.

Zapis JSON 
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
Pola
columnHeader

object(ColumnHeader)

Nagłówki kolumn.

data

object(ReportData)

Dane odpowiedzi.

nextPageToken

string

Token strony, aby pobrać następną stronę wyników na liście.

ColumnHeader

Nagłówki kolumn.

Zapis JSON 
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
Pola
dimensions[]

string

Nazwy wymiarów w odpowiedzi.

metricHeader

object(MetricHeader)

Nagłówki wskaźników w odpowiedzi.

MetricHeader

Nagłówki danych.

Zapis JSON 
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
Pola
metricHeaderEntries[]

object(MetricHeaderEntry)

Nagłówki wskaźników w odpowiedzi.

pivotHeaders[]

object(PivotHeader)

Nagłówki przestawień w odpowiedzi.

MetricHeaderEntry

Nagłówek danych.

Zapis JSON 
{
  "name": string,
  "type": enum(MetricType)
}
Pola
name

string

Nazwa nagłówka.

type

enum(MetricType)

Typ danych, np. INTEGER.

PivotHeader

Nagłówki każdej sekcji przestawnej zdefiniowanej w żądaniu.

Zapis JSON 
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
Pola
pivotHeaderEntries[]

object(PivotHeaderEntry)

Pojedynczy nagłówek sekcji tabeli przestawnej.

totalPivotGroupsCount

number

Łączna liczba grup dla tej tabeli przestawnej.

PivotHeaderEntry

Nagłówki poszczególnych kolumn danych odpowiadające danym żądanym w sekcji tabeli przestawnej odpowiedzi.

Zapis JSON 
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
Pola
dimensionNames[]

string

Nazwa wymiarów w odpowiedzi przestawnej.

dimensionValues[]

string

Wartości wymiarów w tabeli przestawnej.

metric

object(MetricHeaderEntry)

Nagłówek danych na wykresie przestawnym.

ReportData

Część raportu dotycząca danych.

Zapis JSON 
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
Pola
rows[]

object(ReportRow)

Na każdą unikalną kombinację wymiarów przypada jeden wiersz raportu.

totals[]

object(DateRangeValues)

Dla każdego żądanego zakresu dat w przypadku zbioru wszystkich wierszy pasujących do zapytania każdy żądany format wartości otrzymuje sumę. Suma dla formatu wartości jest obliczana przez zsumowanie wskaźników wymienionych w formacie wartości, a następnie wystawienie formatu wartości jako wyrażenia skalarnego. Np. „Sumy” dla 3 / (ga:sessions + 2), które obliczamy 3 / ((sum of all relevant ga:sessions) + 2). Sumy są obliczane przed podziałem na strony.

rowCount

number

Łączna liczba wierszy pasujących do tego zapytania.

minimums[]

object(DateRangeValues)

Wartości minimalne i maksymalne we wszystkich pasujących wierszach. Oba te elementy są puste, gdy parametr hideValueRanges w żądaniu ma wartość fałsz lub gdy liczba wierszy wynosi zero.

maximums[]

object(DateRangeValues)

Wartości minimalne i maksymalne we wszystkich pasujących wierszach. Oba te elementy są puste, gdy parametr hideValueRanges w żądaniu ma wartość fałsz lub gdy liczba wierszy wynosi zero.

samplesReadCounts[]

string (int64 format)

Jeśli wyniki są spróbkowane, zwraca łączną liczbę odczytanych próbek – 1 wpis na zakres dat. Jeśli wyniki nie są próbkowane, to pole nie zostanie zdefiniowane. Więcej informacji znajdziesz w przewodniku dla programistów.

samplingSpaceSizes[]

string (int64 format)

Jeśli wyniki są spróbkowane, ta wartość zwraca łączną liczbę dostępnych próbek – 1 wpis na zakres dat. Jeśli wyniki nie są próbkowane, to pole nie zostanie zdefiniowane. Więcej informacji znajdziesz w przewodniku dla programistów.

isDataGolden

boolean

Wskazuje, czy odpowiedź na żądanie jest „złota”, czy nie. Dane są najcenniejsze, gdy to samo żądanie nie zwróci żadnych nowych wyników, jeśli później zostanie o to poproszone.

dataLastRefreshed

string (Timestamp format)

Moment ostatniego odświeżenia danych w raporcie. Wszystkie działania zebrane przed tą sygnaturą czasową są uwzględniane w obliczeniach raportu.

Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: "2014-10-02T15:01:23.045123456Z".

ReportRow

Wiersz w raporcie.

Zapis JSON 
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
Pola
dimensions[]

string

Lista żądanych wymiarów.

metrics[]

object(DateRangeValues)

Lista danych dla każdego żądanego zakresu dat.

DateRangeValues

Służy do zwrócenia listy danych dla pojedynczej kombinacji zakresu dat i wymiaru

Zapis JSON 
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
Pola
values[]

string

Każda wartość odpowiada poszczególnym danym w żądaniu.

pivotValueRegions[]

object(PivotValueRegion)

Wartości każdego regionu obrotu.

PivotValueRegion

Wartości danych w regionie obrotu.

Zapis JSON 
{
  "values": [
    string
  ]
}
Pola
values[]

string

Wartości danych w każdym z regionów przestawnych.

ResourceQuotasRemaining

Pozostałe tokeny limitu zasobów dla usługi po realizacji żądania.

Zapis JSON 
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
Pola
dailyQuotaTokensRemaining

number

Pozostały dzienny limit zasobów.

hourlyQuotaTokensRemaining

number

Pozostałe tokeny limitu godzinowego limitu zasobów.

Wypróbuj