Method: properties.runReport

Zwraca dostosowany raport zawierający dane zdarzeń z Google Analytics. Raporty zawierają statystyki pochodzące z danych zebranych przez kod śledzenia Google Analytics. Dane zwracane przez interfejs API mają postać tabeli z kolumnami zawierającymi żądane wymiary i dane. Dane to poszczególne pomiary aktywności użytkowników w Twojej usłudze, np. liczba aktywnych użytkowników lub liczba zdarzeń. Wymiary dzielą dane według niektórych typowych kryteriów, takich jak kraj lub nazwa zdarzenia.

Żądanie HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runReport

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
property

string

Wymagane. Identyfikator usługi w Google Analytics, której zdarzenia są śledzone. Określony w ścieżce adresu URL, a nie w treści. Więcej informacji znajdziesz w artykule gdzie znaleźć identyfikator usługi. W ramach żądania zbiorczego ta właściwość powinna być nieokreślona lub zgodna z właściwością na poziomie zbiorczym.

Przykład: properties/1234

Treść żądania

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

Zapis JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Pola
dimensions[]

object (Dimension)

Opcjonalnie. Wymiary, o które poproszono i które zostały wyświetlone.
metrics[]

object (Metric)

Opcjonalnie. Żądane i wyświetlane dane.
dateRanges[]

object (DateRange)

Opcjonalnie. Zakresy dat danych do odczytania. Jeśli zostanie wysłane żądanie dotyczące wielu zakresów dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat nakładają się na siebie, dane o zdarzeniach z nakładających się dni są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W przypadku żądania dotyczącego kohorty ten parametr dateRanges musi być nieokreślony.
dimensionFilter

object (FilterExpression)

Opcjonalnie. Filtry wymiarów umożliwiają wyświetlanie w raporcie tylko określonych wartości wymiarów. Więcej informacji znajdziesz w artykule Podstawy filtrów wymiarów, w którym znajdziesz przykłady. W tym filtrze nie można używać wskaźników.
metricFilter

object (FilterExpression)

Opcjonalnie. Klauzula filtra danych. Stosowany po agregacji wierszy raportu, podobnie jak klauzula HAVING w SQL-u. W tym filtrze nie można używać wymiarów.
offset

string (int64 format)

Opcjonalnie. Liczba wierszy w wierszu początkowym. Pierwszy wiersz jest liczony jako wiersz 0.

Podczas stronicowania pierwsze żądanie nie określa przesunięcia lub ustawia przesunięcie na 0. Pierwsze żądanie zwraca pierwsze limit wierszy. Drugie żądanie ustawia przesunięcie na limit pierwszego żądania, a drugie żądanie zwraca drugi limit wierszy.

Więcej informacji o tym parametrze paginacji znajdziesz w sekcji Paginacja.
limit

string (int64 format)

Opcjonalnie. Maksymalna liczba wierszy do zwrócenia. Jeśli nie określono inaczej, zwracanych jest 10 tys. wierszy. Interfejs API zwraca maksymalnie 250 tys. wierszy na żądanie,niezależnie od tego, ile wierszy zażądasz. Wartość limit musi być dodatnia.

Interfejs API może też zwrócić mniej wierszy niż żądana wartość limit, jeśli liczba wartości wymiarów jest mniejsza niż limit. Na przykład wymiar country ma mniej niż 300 możliwych wartości, więc podczas generowania raportu tylko na podstawie tego wymiaru nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz wartość limit na wyższą.country

Więcej informacji o tym parametrze paginacji znajdziesz w sekcji Paginacja.
metricAggregations[]

enum (MetricAggregation)

Opcjonalnie. Agregacja danych. Zagregowane wartości danych będą wyświetlane w wierszach, w których parametr dimensionValues ma wartość „RESERVED_(MetricAggregation)”. Agregacje obejmujące zarówno porównania, jak i wiele zakresów dat będą agregowane na podstawie zakresów dat.
orderBys[]

object (OrderBy)

Opcjonalnie. Określa sposób uporządkowania wierszy w odpowiedzi. W przypadku żądań obejmujących zarówno porównania, jak i wiele zakresów dat klauzule ORDER BY będą stosowane do porównań.
currencyCode

string

Opcjonalnie. Kod waluty w formacie ISO 4217, np. „AED”, „USD”, „JPY”. Jeśli pole jest puste, raport używa domyślnej waluty usługi.
cohortSpec

object (CohortSpec)

Opcjonalnie. Grupa kohortowa powiązana z tym żądaniem. Jeśli w żądaniu znajduje się grupa kohort, musi być w nim obecny wymiar „kohorta”.
keepEmptyRows

boolean

Opcjonalnie. Jeśli wartość jest fałszywa lub nieokreślona, każdy wiersz, w którym wszystkie dane mają wartość 0, nie zostanie zwrócony. Jeśli ma wartość Prawda, te wiersze zostaną zwrócone, o ile nie zostaną osobno usunięte przez filtr.

Niezależnie od tego ustawienia keepEmptyRows w raporcie można wyświetlać tylko dane zarejestrowane przez usługę w Google Analytics.

Jeśli np. usługa nigdy nie rejestruje zdarzenia purchase, zapytanie dotyczące wymiaru eventName i danych eventCount nie będzie zawierać wiersza eventName: „purchase” i eventCount: 0.
returnPropertyQuota

boolean

Opcjonalnie. Określa, czy ma być zwracany bieżący stan limitu tej usługi w Google Analytics. Limit jest zwracany w obiekcie PropertyQuota.
comparisons[]

object (Comparison)

Opcjonalnie. Konfiguracja żądanych i wyświetlanych porównań. Aby otrzymać w odpowiedzi kolumnę porównania, żądanie musi zawierać tylko pole comparisons.
conversionSpec

object (ConversionSpec)

Opcjonalnie. Określa raportowanie konwersji. To pole jest opcjonalne. Jeśli to pole jest ustawione lub są wymagane jakiekolwiek dane o konwersjach, raport będzie raportem o konwersjach.

Treść odpowiedzi

Tabela raportu odpowiedzi odpowiadająca żądaniu.

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

Zapis JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Pola
dimensionHeaders[]

object (DimensionHeader)

Opisuje kolumny wymiarów. Liczba obiektów DimensionHeaders i ich kolejność odpowiadają wymiarom występującym w wierszach.
metricHeaders[]

object (MetricHeader)

Opisuje kolumny danych. Liczba elementów MetricHeaders i ich kolejność odpowiadają rodzajom danych w wierszach.
rows[]

object (Row)

Wiersze z kombinacjami wartości wymiarów i wartościami danych w raporcie.
totals[]

object (Row)

Na żądanie podaje łączne wartości danych.
maximums[]

object (Row)

W razie potrzeby maksymalne wartości rodzajów danych.
minimums[]

object (Row)

W razie potrzeby minimalne wartości danych.
rowCount

integer

Łączna liczba wierszy w wyniku zapytania, niezależnie od liczby wierszy zwróconych w odpowiedzi. Jeśli na przykład zapytanie zwraca 175 wierszy i zawiera w żądaniu do interfejsu API limit = 50, odpowiedź będzie zawierać rowCount = 175, ale tylko 50 wierszy.

Więcej informacji o tym parametrze paginacji znajdziesz w sekcji Paginacja.
metadata

object (ResponseMetaData)

Metadane raportu.
propertyQuota

object (PropertyQuota)

Stan limitu usługi w Analytics, w tym to żądanie.
kind

string

Określa rodzaj danego zasobu. Wartość kind to zawsze ustalony ciąg znaków „analyticsData#runReport”. Przydatne do rozróżniania typów odpowiedzi w formacie JSON.
nextPageToken

string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Porównanie

Definiuje pojedyncze porównanie. Większość żądań będzie zawierać kilka porównań, dzięki czemu raport będzie porównywać poszczególne porównania.

Zapis JSON 
{
  "name": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of mutually exclusive fields.
}
Pola
name

string

Każde porównanie generuje w odpowiedzi osobne wiersze. W odpowiedzi to porównanie jest identyfikowane za pomocą tej nazwy. Jeśli nazwa nie zostanie określona, użyjemy zapisanej nazwy wyświetlanej porównań.
Poniżej znajduje się lista pól, które wykluczają się nawzajem. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
dimensionFilter

object (FilterExpression)

Podstawowe porównanie.
comparison

string

Zapisane porównanie zidentyfikowane przez nazwę zasobu porównania. Na przykład „comparisons/1234”.
Koniec pól wykluczających się nawzajem.

ConversionSpec

Określa raportowanie konwersji.

Zapis JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Pola
conversionActions[]

string

Identyfikatory działań powodujących konwersję, które mają być uwzględnione w raporcie. Jeśli to pole jest puste, uwzględniane są wszystkie konwersje. Prawidłowe identyfikatory działań powodujących konwersję można pobrać z pola conversionAction na conversions liście w odpowiedzi metody properties.getMetadata. Na przykład „conversionActions/1234”.
attributionModel

enum (AttributionModel)

Model atrybucji, który ma być używany w raporcie o konwersjach. Jeśli nie zostanie określony, używany jest DATA_DRIVEN.

AttributionModel

Model atrybucji, który ma być używany w raporcie o konwersjach

Wartości w polu enum
ATTRIBUTION_MODEL_UNSPECIFIED Nieokreślony model atrybucji.
DATA_DRIVEN Atrybucja była oparta na modelu płatnym i bezpłatnym opartym na danych
LAST_CLICK Atrybucja była oparta na modelu „Kanały płatne i bezpłatne – ostatnie kliknięcie”.