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żda prośba będzie mieć oddzielną odpowiedź. Można wysłać maksymalnie 5 próśb. Wszystkie żądania powinny mieć te same wartości w polach dateRanges, viewId, segments, samplingLevel i cohortGroup.

useResourceQuotas

boolean

Włącza limity oparte na zasobach (domyślnie jest to False). Jeśli to pole ma wartość True, limity na wyświetlenie (profil) są zależne od kosztu obliczeniowego żądania. Pamiętaj, że użycie limitów opartych na kosztach zwiększy częstotliwość próbkowania. (10 milionów SMALL, 100 mln dla LARGE. Więcej informacji znajdziesz w dokumentacji limitów i limitów.

Treść odpowiedzi

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

Główna klasa odpowiedzi zawierająca raporty z wywołania interfejsu API raportowania batchGet.

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

object(Report)

Odpowiedzi związane z każdym żądaniem.

queryCost

number

Liczba tokenów odejmowanych w celu wykonania zapytania. Obejmuje wszystkie odpowiedzi.

resourceQuotasRemaining

object(ResourceQuotasRemaining)

Pozostały limit zasobów dla usługi.

Zakresy autoryzacji

Wymaga jednego z następujących zakresów OAuth:

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

Prośba o raport

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

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 Analytics, z którego można pobrać dane. Każde żądanie ReportRequest w metodzie batchGet musi zawierać te same wartości viewId.

dateRanges[]

object(DateRange)

Zakresy dat w żądaniu. Żądanie 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 masz 2 zakresy dat, powstaną 2 zestawy danych: jedna dotycząca oryginalnego zakresu dat i druga dla drugiego zakresu dat. Pole reportRequest.dateRanges nie powinno być określone w przypadku kohort ani żądań wartości od początku śledzenia. Jeśli nie podasz zakresu dat, zostanie ustawiony domyślny zakres dat (data rozpoczęcia: bieżąca data – 7 dni, data zakończenia: bieżąca data – 1 dzień). Każde żądanie ReportRequest zawierające metodę batchGet musi zawierać tę samą definicję dateRanges.

samplingLevel

enum(Sampling)

Żądany rozmiar próbki raportu. Jeśli pole samplingLevel nie jest określone, używany jest poziom próbkowania DEFAULT. Każde żądanie ReportRequest zawierające metodę batchGet musi zawierać tę samą definicję samplingLevel. Szczegóły znajdziesz w przewodniku dla programistów.

dimensions[]

object(Dimension)

Żądane wymiary Żądania mogą mieć maksymalnie 9 wymiarów.

dimensionFilterClauses[]

object(DimensionFilterClause)

Klauzule filtrowania wymiarów, które pozwalają filtrować wartości wymiarów. Są one logicznie połączone z operatorem AND. Pamiętaj, że filtrowanie odbywa się przed zagregowaniem jakichkolwiek wymiarów, więc zwrócone dane reprezentują łączną wartość tylko w odpowiednich wymiarach.

metrics[]

object(Metric)

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

metricFilterClauses[]

object(MetricFilterClause)

Klauzule filtrowania danych. Są one logicznie połączone z operatorem AND. Filtry danych obejmują tylko pierwszy zakres dat, a nie porównanie zakresu dat. Pamiętaj, że filtrowanie według danych odbywa się po połączeniu danych.

filtersExpression

string

Filtry wymiarów lub danych, które ograniczają dane wyświetlane w odpowiedzi na żądanie. Aby użyć elementu filtersExpression, podaj wymiar lub dane, według których chcesz filtrować, a potem wyrażenie filtra. Na przykład następujące wyrażenie wybiera wymiar ga:browser, który rozpoczyna się od Firefoksa: ga:browser=~^Firefox. Więcej informacji o wymiarach i filtrach danych znajdziesz w artykule Filtry.

orderBys[]

object(OrderBy)

Kolejność sortowania w wierszach wyjściowych. Aby porównać 2 wiersze, elementy wymienione poniżej są stosowane w ustalonej kolejności, aż zostaną znalezione różnice. Wszystkie zakresy dat w danych wyjściowych mają tę samą kolejność wierszy.

segments[]

object(Segment)

Podział danych na segmenty w odpowiedzi na żądanie. Definicja segmentu ułatwia analizę podzbioru żądania segmentu. Żądanie może zawierać do 4 segmentów. Każde żądanie ReportRequest zawierające metodę batchGet musi zawierać tę samą definicję segments. Żądania z segmentami muszą mieć wymiar ga:segment.

pivots[]

object(Pivot)

Definicje przestawne. Żądania mogą mieć maksymalnie 2 pozycje.

cohortGroup

object(CohortGroup)

Grupa kohortowa powiązana z tym żądaniem. Jeśli w żądaniu występuje grupa kohorty, wymiar ga:cohort musi być obecny. Każde żądanie ReportRequest zawierające metodę batchGet musi zawierać tę samą definicję cohortGroup.

pageToken

string

Token kontynuacji, by uzyskać następną stronę wyników. Dodanie tej opcji do żądania spowoduje zwrócenie wierszy po tokenie pageToken. Element pageToken powinien być wartością zwracaną w parametrze nextPageToken w odpowiedzi na żądanie report.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ślną wartość 1000 wierszy. Interfejs Analytics Core Reporting API zwraca maksymalnie 100 tys. wierszy na żądanie,niezależnie od tego, o co prosisz. Jeśli nie ma oczekiwanej liczby segmentów wymiarów, liczba wierszy może być mniejsza niż oczekiwana. Na przykład dostępnych jest mniej niż 300 wartości w polu ga:country, więc przy segmentacji tylko według kraju nie możesz przekroczyć 300 wierszy, nawet jeśli pageSize ma wartość większą.

includeEmptyRows

boolean

Jeśli ma wartość Fałsz, odpowiedź nie zawiera wierszy, jeśli wszystkie pobrane dane mają wartość zero. Wartość domyślna to false (fałsz), co wyklucza te wiersze.

hideTotals

boolean

Jeśli ma wartość Prawda, ukrywa łączną liczbę wszystkich danych we wszystkich pasujących wierszach w każdym zakresie dat. Wartość domyślna to false (fałsz) i zwraca łączne wartości.

hideValueRanges

boolean

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

Próbkowanie

Wartości do 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 odpowiada za szybkość i dokładność.
SMALL Zwraca szybką odpowiedź z mniejszym rozmiarem próbki.
LARGE Zwraca dokładniejszą odpowiedź z dużym rozmiarem próbki. Może to jednak spowolnić odpowiedź.

Wymiar

Wymiary to atrybuty danych. Na przykład wymiar ga:city wskazuje miasto, na przykład "Paryż" Nowy Jork" z którego pochodzi 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, umieszczamy wartości wymiarów w zasobnikach po ciągu int64. Wartości wymiarów, które nie są ciągami reprezentującymi wartości całkowania, zostaną przekonwertowane na zero. Wartości zasobnika muszą być w rosnącej kolejności. Każdy zasobnik jest zamknięty na dole i otwarty w górnym. Zasobnik &"first" zawiera wszystkie wartości mniejsze od pierwszej granicy, a zasobnik "ostatni" zawiera wszystkie wartości aż do nieskończoności. Wartości wymiarów w zasobniku są przekształcane w nową wartość wymiaru. Jeśli na przykład lista zawiera ciąg &0, 1, 3, 4, 7", zwracamy takie zasobniki:

  • zasobnik #1: wartości < 0, wartość wymiaru &&t;0"
  • zasobnik 2: wartości w [0,1), wartość wymiaru &"
  • zasobnik nr 3: wartości w ciągu [1,3], wartość wymiaru "1–2"
  • zasobnik #4: wartości w [3,4), wartość wymiaru "3"
  • zasobnik 5: wartości w [4,7), wartość wymiaru "4–6"
  • zasobnik #6: wartości >= 7, wartość wymiaru "7+"

UWAGA: jeśli stosujesz mutację histogramu do dowolnego wymiaru i używasz tego wymiaru w sortowaniu, użyj właśnie tego typu sortowania: HISTOGRAM_BUCKET. Bez niego wartości wymiarów są sortowane według słownika (leksykograficznego). Na przykład rosnąca kolejność słowników to:

"<50", "1001+", "121-1000", "50-120"

Rosnąca kolejność HISTOGRAM_BUCKET to:

"<50", "50-120", "121-1000", "1001+"

Klient musi wyraźnie zażądać "orderType": "HISTOGRAM_BUCKET" w wymiarze histogramu.

Warstwa filtra wymiarów

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

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

enum(FilterLogicalOperator)

Operator, który łączy kilka wymiarów. Jeśli nie jest określony, jest traktowany jako OR.

filters[]

object(DimensionFilter)

Powtórzony zestaw filtrów. Są one logicznie połączone na podstawie podanego operatora.

Operator filtra

Jak łączone są logicznie

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

Filtr wymiarów

Filtr wymiarów 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ść Prawda, dopasowane wartości wymiarów są wykluczone z raportu. Wartość domyślna to false (fałsz).

operator

enum(Operator)

Jak dopasować wymiar do wyrażenia. Wartość domyślna to REGEXP.

expressions[]

string

Ciągi znaków lub wyrażenia regularne do dopasowania. Dla porównania używana jest tylko pierwsza wartość z listy, chyba że operator to IN_LIST. Jeśli używasz operatora IN_LIST, do filtrowania wymiarów zgodnie z opisem operatora IN_LIST używana jest cała lista.

caseSensitive

boolean

Czy podczas dopasowywania 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 nie jest określony, jest on traktowany jako REGEXP.
REGEXP Wyrażenie dopasowania jest traktowane jako wyrażenie regularne. Wszystkie typy dopasowania nie są traktowane jako wyrażenia regularne.
BEGINS_WITH Odpowiada wartości, która zaczyna się od podanego wyrażenia dopasowania.
ENDS_WITH Dopasowuje wartości kończące się wyrażeniem dopasowania.
PARTIAL Dopasowanie podłańcucha.
EXACT Wartość powinna całkowicie pasować do wyrażenia zgodnego.
NUMERIC_EQUAL

Filtry porównania w liczbach całkowitych. W ich przypadku wielkość liter jest ignorowana, 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 int64, klient powinien oczekiwać błędu.
  • Wymiary wejściowe, które nie są prawidłowymi wartościami int64, nigdy nie będą pasowały do filtra.
NUMERIC_GREATER_THAN Sprawdza, czy wymiar jest większy niż wyrażenie zgodne. Opis ograniczeń znajdziesz w opisie aplikacji NUMERIC_EQUALS.
NUMERIC_LESS_THAN Sprawdza, czy wymiar jest mniejszy niż wyrażenie dopasowania. Opis ograniczeń znajdziesz w opisie aplikacji NUMERIC_EQUALS.
IN_LIST

Ta opcja służy do określania filtra wymiarów, którego wyrażenie może przyjmować dowolną wartość z wybranej listy wartości. Pozwala to uniknąć oceny wielu filtrów wymiarów w dopasowaniu ścisłym, które są połączone operatorem w każdym wierszu odpowiedzi. Przykład:

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

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

Dane

Dane to ilościowe wyniki pomiarów. 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 danych w żądaniu. Wyrażenie składa się z co najmniej 1 rodzaju danych i liczb. Dopuszczalne operatory to: plus (+), minus (-), negacja (dwukropek -), podzielone przez (/), mnożone przez (*), dodatnie liczby kardynalne (0–9) i mogą mieć maksymalnie 1024 znaki. W większości przypadków wyrażenie danych ga:totalRefunds/ga:users to pojedyncza nazwa danych, np. ga:users. Dodanie elementu MetricType mieszanego (np. CURRENCY + PERCENTAGE) oznacza, że wyniki będą nieoczekiwane.

alias

string

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

formattingType

enum(MetricType)

Określa sposób formatowania wyrażenia danych, na przykład INTEGER.

Typ metryki

Rodzaje danych.

Wartości w polu enum
METRIC_TYPE_UNSPECIFIED Nieokreślony typ wskaźnika.
INTEGER Wartość w formie liczby całkowitej.
FLOAT Wartość zmiennoprzecinkowa.
CURRENCY Dane waluty.
PERCENT Dane procentowe.
TIME Dane dotyczące czasu w formacie HH:MM:SS.

Warstwa filtra danych

Reprezentuje grupę filtrów danych. Ustaw wartość operatora, by określić sposób logicznego łączenia filtrów.

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

enum(FilterLogicalOperator)

Operator, który łączy kilka filtrów danych. Jeśli nie jest określony, jest traktowany jako OR.

filters[]

object(MetricFilter)

Powtórzony zestaw filtrów. Są one logicznie połączone na podstawie podanego operatora.

Filtr wskaźników

MetricFiltr określa filtr danych.

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

string

Dane, które będą filtrowane. Filtr danych musi zawierać nazwę wskaźnika. Nazwa danych może być aliasem wcześniej zdefiniowanym jako dane lub może być także wyrażeniem danych.

not

boolean

Operator logiczny NOT. Jeśli ta wartość logiczna ma wartość Prawda, dopasowane wartości danych są wykluczone z raportu. Wartość domyślna to false (fałsz).

operator

enum(Operator)

Czy dane to EQUAL, LESS_THAN lub GREATER_THAN, to wartość domyślna, np. EQUAL. Jeśli operator to IS_MISSING, sprawdzi, czy nie brakuje danych, i zignoruje wartość ValueTrack.

comparisonValue

string

Wartość do porównania.

Operator

Różne opcje porównania.

Wartości w polu enum
OPERATOR_UNSPECIFIED Jeśli nie określisz operatora, zostanie on potraktowany jako EQUAL.
EQUAL Czy wartość danych powinna być dokładnie taka sama jak wartość porównania.
LESS_THAN Czy wartość danych powinna być mniejsza od wartości porównawczej.
GREATER_THAN Czy wartość danych powinna być większa niż wartość porównania.
IS_MISSING Sprawdza, czy brakuje danych. Nie uwzględnia parametru ValueTrack.

Sortuj według

Określa opcje sortowania.

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

string

Pole, według którego chcesz sortować arkusz. Domyślna kolejność sortowania jest rosnąca. Przykład: ga:browser. Uwaga: w tym miejscu możesz określić tylko jedno pole do sortowania. Na przykład reguła ga:browser, ga:city jest nieprawidłowa.

orderType

enum(OrderType)

Typ zamówienia. Domyślny typ zamówienia to VALUE.

sortOrder

enum(SortOrder)

Kolejność sortowania pola.

Typ zamówienia

Element 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 Kolejność sortowania jest oparta na wartości wybranej kolumny. Widoczne są tylko pierwsze zakresy dat.
DELTA Kolejność sortowania jest uzależniona od różnic w wartościach wybranej kolumny między pierwszymi zakresami dat. Użyta tylko wtedy, gdy istnieją dokładnie 2 zakresy dat.
SMART Kolejność sortowania jest obliczana na podstawie ważonej wartości wybranej kolumny. Jeśli kolumna ma format nd., wartość ważona tego współczynnika będzie wynosiła (n + totals.n)/(d + totals.d). Tylko w przypadku danych, które odpowiadają współczynnikom.
HISTOGRAM_BUCKET Histogram typu kolejności dotyczy tylko kolumn wymiarów z niepustymi zasobnikami histogramu.
DIMENSION_AS_INTEGER Jeśli wymiary mają stałą długość, wystarczy zwykłe sortowanie. Jeśli wymiary są różnej długości, można użyć właściwości DIMENSION_AS_INTEGER.

SortOrder

Kolejność sortowania.

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

Segmenty

Definicja segmentu, jeśli raport ma zostać podzielony na segmenty. Segment jest podzbiorem danych Analytics. Na przykład cała grupa użytkowników może np. należeć do użytkowników z określonego kraju lub miasta.

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 związkowe dynamicOrById. Segment możesz definiować dynamicznie za pomocą segmentu dynamicznego lub za pomocą identyfikatora wbudowanego lub niestandardowego segmentu. dynamicOrById może mieć tylko jedną z tych wartości:
dynamicSegment

object(DynamicSegment)

Definicja segmentu dynamicznego w żądaniu.

segmentId

string

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

Segment dynamiczny

Definicja segmentu dynamicznego w celu zdefiniowania segmentu w żądaniu. Segment może obejmować 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, by wybrać użytkowników do uwzględnienia w segmencie.

sessionSegment

object(SegmentDefinition)

Segment sesji, by wybrać sesje do uwzględnienia w segmencie.

Definicja segmentu

SegmentDefinition definiuje segment jako zestaw filtrów Segments, które są połączone z operacją logiczną AND.

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

object(SegmentFilter)

Segment jest określany za pomocą zestawu filtrów segmentów, które są łączone w operację logiczną AND.

Filtr segmentów

SegmentSegment definiuje segment jako prosty lub sekwencyjny. Prosty warunek segmentu zawiera warunki wymiarów i danych, które pozwalają wybrać sesje 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 prawda, dopasuj do siebie segment prosty lub sekwencyjny. Aby np. dopasować wszystkie wizyty, które nie pochodzą z Poznania, możemy zdefiniować segment w ten sposób:

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

Pole związkowe simpleOrSequence. Czy to prosty segment czy definicja segmentu sekwencji. simpleOrSequence może mieć tylko jedną z tych wartości:
simpleSegment

object(SimpleSegment)

Proste warunki segmentu składają się z jednego lub kilku warunków dotyczących wymiarów lub danych, które można łączyć

sequenceSegment

object(SequenceSegment)

Warunki sekwencji składają się z co najmniej 1 kroku, w którym każdy krok jest zdefiniowany w 1 lub kilku warunkach wymiarów lub danych. Kilka kroków można łączyć ze specjalnymi operatorami sekwencji.

Prosty segment

Proste warunki segmentu składają się z co najmniej jednego warunku wymiaru lub rodzaju danych, który można połączyć.

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

object(OrFiltersForSegment)

Lista grup filtrów segmentów, które są połączone z operatorem logicznym AND.

OrFiltryForSegment

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 mają zostać połączone z operatorem OR.

Klaster filtra segmentów

Klauzula filtrowania używana w definicji segmentu może korzystać z filtra danych lub filtra wymiarów.

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łniającego (!) filtra.

Pole związkowe dimensionOrMetricFilter. Wymiar lub filtr danych. dimensionOrMetricFilter może mieć tylko jedną z tych wartości:
dimensionFilter

object(SegmentDimensionFilter)

Filtr wymiarów na potrzeby definicji segmentu.

metricFilter

object(SegmentMetricFilter)

Filtr danych na potrzeby definicji segmentu.

Filtr wymiarów segmentu

Filtr wymiarów 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 chcesz zastosować filtr.

operator

enum(Operator)

Operator, który służy do dopasowania wymiaru do wyrażeń.

caseSensitive

boolean

Wielkość liter w dopasowaniu powinna być rozróżniana dla 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ównania dla typu dopasowania BETWEEN.

maxComparisonValue

string

Maksymalne wartości porównania dla typu dopasowania BETWEEN.

Operator

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

Wartości w polu enum
OPERATOR_UNSPECIFIED Jeśli typ dopasowania nie jest określony, jest on 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 Odpowiada wartościom, które zaczynają się od podanego wyrażenia dopasowania.
ENDS_WITH Dopasowuje wartości kończące się wyrażeniem dopasowania.
PARTIAL Dopasowanie podłańcucha.
EXACT Wartość powinna całkowicie pasować do wyrażenia zgodnego.
IN_LIST

Ta opcja służy do określania filtra wymiarów, którego wyrażenie może przyjmować dowolną wartość z wybranej listy wartości. Pozwala to uniknąć oceny wielu filtrów wymiarów w dopasowaniu ścisłym, które są połączone operatorem w każdym wierszu odpowiedzi. Przykład:

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

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

NUMERIC_LESS_THAN

Filtry porównania w liczbach całkowitych. W ich przypadku wielkość liter jest ignorowana, 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 int64, klient powinien oczekiwać błędu.
  • wymiary wejściowe, które nie są prawidłowymi wartościami int64, nigdy nie będą pasowały do filtra.

Sprawdza, czy wymiar jest mniejszy niż wyrażenie dopasowania.

NUMERIC_GREATER_THAN Sprawdza, czy wymiar jest większy niż wyrażenie zgodne.
NUMERIC_BETWEEN Sprawdza, czy wymiar jest liczbowy między minimalnym a maksymalnym wyrażeniem dopasowania, z wyłączeniem granic.

SegmentMetricFiltr

Filtr danych do użycia w klauzuli filtra segmentów.

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

enum(Scope)

Zakres wskaźników określa poziom, na którym dane są zdefiniowane. Podany zakres danych musi być większy niż jego zakres główny określony w modelu danych. Podstawowy zakres jest określany na podstawie tego, czy segment wybiera użytkowników lub sesje.

metricName

string

Dane, które będą filtrowane. Pole metricFilter musi zawierać nazwę danych.

operator

enum(Operator)

Określa operację, która ma zostać wykonana w celu porównania danych. Wartość domyślna to EQUAL.

comparisonValue

string

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

maxComparisonValue

string

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

Zakres

Zakres danych określa poziom, na którym zdefiniowane są te dane: PRODUCT, HIT, SESSION lub USER. Wartości danych mogą być raportowane w zakresach większych niż ich zakres podstawowy. Np. Wartości ga:pageviews i ga:transactions można raportować na poziomie SESSION i USER, dodając je do każdego działania, które wystąpiło 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 USER lub SESSION w zależności od tego, czy segment próbuje wybrać użytkowników czy sesje.
PRODUCT Zakres produktu.
HIT Zakres ograniczony do działania.
SESSION Zakres sesji.
USER Zakres użytkownika.

Operator

Różne opcje 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 niż wartość porównania.
GREATER_THAN Sprawdza, czy wartość danych jest większa niż wartość porównania.
EQUAL Równa się operatorowi.
BETWEEN zarówno w przypadku operatora, jak i minimalnego i maksymalnego. Dla porównania użyjemy LT i GT.

SegmentSekwencji

Warunki sekwencji składają się z co najmniej 1 kroku, w którym każdy krok jest zdefiniowany w 1 lub kilku warunkach wymiarów lub danych. Kilka kroków można łączyć ze specjalnymi operatorami sekwencji.

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

object(SegmentSequenceStep)

Lista kroków sekwencji.

firstStepShouldMatchFirstHit

boolean

Jeśli jest skonfigurowana, warunek pierwszego kroku musi być zgodny z pierwszym działaniem użytkownika (w zakresie dat).

KrokSekcji

Definicja sekwencji segmentu.

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

object(OrFiltersForSegment)

Sekwencja określa listę filtrów „LUB”, które są połączone z operatorem AND.

matchType

enum(MatchType)

Określa, czy krok zaczyna się od razu, czy może być poprzedzający następny.

Typ dopasowania

Typ dopasowania sekwencji.

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

Samo sedno

Tabela przestawna opisuje sekcję przestawną w żądaniu. Tabela przestawna ułatwia zmianę informacji w tabeli w przypadku niektórych raportów, zmieniając dane w drugi wymiar.

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

object(Dimension)

Lista wymiarów, które mają być wyświetlane jako kolumny przestawne. Tabela przestawna może mieć maksymalnie 4 wymiary. Wymiary przestawne stanowią część ograniczenia łącznej liczby wymiarów dozwolonych w żądaniu.

dimensionFilterClauses[]

object(DimensionFilterClause)

Wskazówki dotyczące wymiarów są połączone logicznie z operatorem AND – wartości uwzględnione w tych wszystkich obszarach są uwzględniane tylko w tych wartościach. Filtry wymiarów pozwalają ograniczać kolumny widoczne w regionie tabeli przestawnej. Jeśli na przykład w obszarze tabeli przestawnej masz ustawiony wymiar ga:browser i określisz kluczowe filtry, tak by ograniczyć ga:browser tylko do „"IE"” i „quot;Firefox"”, to te 2 przeglądarki będą widoczne jako kolumny.

metrics[]

object(Metric)

Dane tabeli przestawnej. Tabela przestawna to część ograniczenia całkowitej liczby danych dozwolonych w żądaniu.

startGroup

number

Jeśli zażądano danych k, odpowiedź zawiera niektóre z kolumn kolumny k zależnej od danych w raporcie. Jeśli na przykład przejdziesz do wymiaru ga:browser, otrzymasz kolumny k dla „"Firefox" k kolumn” dla „"IE" k kolumn” dla „"Chrome"” itd. Kolejność grup kolumn jest określana przez malejącą kolejność wartości w kolumnie "sum" Łuski są dzielone na podstawie pierwszego wymiaru wymiaru obrotu, leksykografii itd. Jeśli np. sumy w pierwszej wartości w przeglądarkach Firefox, IE i Chrome to odpowiednio 8, 2 i 8, kolejność kolumn to odpowiednio Chrome, Firefox i IE.

Poniżej możesz wybrać, które grupy kolumn (k) są uwzględniane w odpowiedzi.

maxGroupCount

number

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

Grupa kohortowa

Określa grupę kohortową. 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łącza wartość od początku śledzenia. Wartość od początku śledzenia mierzy wartość od początku śledzenia użytkowników pozyskanych za pomocą różnych kanałów. Więcej informacji znajdziesz w artykułach Analiza kohortowa i Wartość od początku śledzenia.

  • 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. Na przykład żądania ga:cohortNthWeek startDate powinny być zdefiniowane jako niedziele, a endDate – w sobotę. endDate to startDate dzień miesiąca, a endDate to ostatni dzień miesiąca.

Gdy wartość parametru wartość długookresowa ma wartość prawda:

  • Wartości danych będą odpowiadać wartościom w raporcie Czas życia danych z interfejsu internetowego.
  • Raport Wartość od początku śledzenia pokazuje, jak wartość użytkownika (przychody) i zaangażowanie (wyświetlenia aplikacji, realizacje celu, sesje i czas trwania sesji) rośnie w ciągu 90 dni od pozyskania użytkownika.
  • Dane są obliczane jako średnia skumulowana na użytkownika w zależności od czasu.
  • Zakresy dat definicji kohorty nie muszą być zgodne z granicami tygodnia kalendarzowego i miesiąca.
  • viewId musi być identyfikatorem wyświetlenia aplikacji

Kohorta

Określa 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 FIRST_VISIT_DATE typ. Jeśli to pole nie jest określone, kohorta jest traktowana jako kohorta typu FIRST_VISIT_DATE.

dateRange

object(DateRange)

Jest ona używana w kohorcie FIRST_VISIT_DATE i wybiera użytkowników, których data pierwszej wizyty mieści się w przedziale między datą rozpoczęcia a datą zakończenia określoną w zakresie dat. Zakresy dat powinny być dostosowane w przypadku żądań kohorty. Jeśli żądanie zawiera zmienną ga:cohortNthDay, powinna to być dokładnie 1 dzień, jeśli ga:cohortNthWeek powinna być dopasowana do granicy tygodnia (licząc od niedzieli i końca soboty), a w przypadku ga:cohortNthMonth zakres dat powinien być dopasowany do miesiąca (począwszy od pierwszego i ostatniego dnia miesiąca). W przypadku żądań od początku śledzenia nie ma takich ograniczeń. W polu reportsRequest.dateRanges nie musisz określać zakresu dat.

Typ

Typ kohorty.

Wartości w polu enum
UNSPECIFIED_COHORT_TYPE Jeśli nie został określony, jest traktowany jako FIRST_VISIT_DATE.
FIRST_VISIT_DATE Kohorty wybrane na podstawie daty pierwszej wizyty.

Zgłoś

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 z listy.

Nagłówek kolumny

Nagłówki kolumn.

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

string

Nazwy wymiarów w odpowiedzi.

metricHeader

object(MetricHeader)

Nagłówki danych w odpowiedzi.

Nagłówek wskaźnika

Nagłówki danych.

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

object(MetricHeaderEntry)

Nagłówki danych w odpowiedzi.

pivotHeaders[]

object(PivotHeader)

Nagłówki elementów przestawnych w odpowiedzi.

HeaderHeaderEntry (Wskaźnik nagłówka)

Nagłówek danych.

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

string

Nazwa nagłówka.

type

enum(MetricType)

Typ danych, np. INTEGER.

Tabela przestawna

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

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

object(PivotHeaderEntry)

Jeden nagłówek sekcji przestawnej.

totalPivotGroupsCount

number

Łączna liczba grup w tej tabeli przestawnej.

Nagłówek PivotHeaderEntry

Nagłówki wszystkich kolumn danych odpowiadających danym żądanym w sekcji przestawnej odpowiedzi.

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

string

Nazwa wymiarów w odpowiedzi tabeli przestawnej.

dimensionValues[]

string

Wartości wymiarów w tabeli przestawnej.

metric

object(MetricHeaderEntry)

Nagłówek danych do danych w tabeli przestawnej.

Dane raportów

Część danych w raporcie.

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)

Dla każdego unikalnego połączenia wymiarów znajduje się jeden wiersz raportowania.

totals[]

object(DateRangeValues)

Dla każdego żądanego zakresu dat zestaw danych obejmuje wszystkie wiersze pasujące do zapytania. Wartość dla formatu wartości jest obliczana przez zsumowanie danych wymienionych w formacie wartości, a następnie określenie formatu wartości jako wyrażenia skalarnego. Np. &"totals" dla 3 / (ga:sessions + 2) obliczamy 3 / ((sum of all relevant ga:sessions) + 2). Sumy są obliczane przed podziałem na strony.

rowCount

number

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

minimums[]

object(DateRangeValues)

Minimalna i maksymalna wartość we wszystkich pasujących wierszach. Oba są puste, gdy hideValueRanges w żądaniu jest fałszywy lub gdy liczba wierszy wynosi 0.

maximums[]

object(DateRangeValues)

Minimalna i maksymalna wartość we wszystkich pasujących wierszach. Oba są puste, gdy hideValueRanges w żądaniu jest fałszywy lub gdy liczba wierszy wynosi 0.

samplesReadCounts[]

string (int64 format)

Jeśli wyniki są próbkowane, zwraca łączną liczbę przeczytanych próbek – po 1 wpisie na zakres dat. Jeśli wyniki nie są próbkowane, to pole nie zostanie zdefiniowane. Szczegóły znajdziesz w przewodniku dla programistów.

samplingSpaceSizes[]

string (int64 format)

Jeśli wyniki są próbkowane, zwraca łączną liczbę próbek w zakresie dat. Jeśli wyniki nie są próbkowane, to pole nie zostanie zdefiniowane. Szczegóły znajdziesz w przewodniku dla programistów.

isDataGolden

boolean

Wskazuje, czy odpowiedź na to żądanie jest złoty. Dane są przekazywane, gdy żądanie dokładnie nie zwróci żadnych wyników, jeśli później się pojawią.

dataLastRefreshed

string (Timestamp format)

Ostatnie odświeżenie danych w raporcie. Wszystkie działania otrzymane 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".

Wiersz raportu

Wiersz w raporcie.

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

string

Lista żądanych wymiarów.

metrics[]

object(DateRangeValues)

Lista wskaźników dla każdego żądanego zakresu dat.

Wartości zakresu dat

Służy do zwracania listy danych dla pojedynczej kombinacji dat / zakresów

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

string

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

pivotValueRegions[]

object(PivotValueRegion)

Wartości poszczególnych regionów tabeli przestawnej.

Region wartości przestawnych

Wartości danych w regionie tabeli przestawnej.

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

string

Wartości danych w każdym regionie tabeli przestawnej.

Pozostałe limity zasobów

Tokeny limitu zasobów pozostałe dla usługi po wypełnieniu żądania.

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

number

Pozostały dzienny limit zasobów.

hourlyQuotaTokensRemaining

number

Pozostało tokenów godzinowych zasobów.

Wypróbuj