Documentation

Overview

Package analyticsdata provides access to the Google Analytics Data API.

For product documentation, see: https://developers.google.com/analytics/devguides/reporting/data/v1/

Creating a client

Usage example:

import "google.golang.org/api/analyticsdata/v1alpha"
...
ctx := context.Background()
analyticsdataService, err := analyticsdata.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

analyticsdataService, err := analyticsdata.NewService(ctx, option.WithScopes(analyticsdata.AnalyticsReadonlyScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

analyticsdataService, err := analyticsdata.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
analyticsdataService, err := analyticsdata.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your Google Analytics data
	AnalyticsScope = "https://www.googleapis.com/auth/analytics"

	// View your Google Analytics data
	AnalyticsReadonlyScope = "https://www.googleapis.com/auth/analytics.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchRunPivotReportsRequest

type BatchRunPivotReportsRequest struct {
	// Entity: A property whose events are tracked. This entity must be
	// specified for the batch. The entity within RunPivotReportRequest may
	// either be unspecified or consistent with this entity.
	Entity *Entity `json:"entity,omitempty"`

	// Requests: Individual requests. Each request has a separate pivot
	// report response. Each batch request is allowed up to 5 requests.
	Requests []*RunPivotReportRequest `json:"requests,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Entity") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Entity") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchRunPivotReportsRequest: The batch request containing multiple pivot report requests.

func (*BatchRunPivotReportsRequest) MarshalJSON

func (s *BatchRunPivotReportsRequest) MarshalJSON() ([]byte, error)

type BatchRunPivotReportsResponse

type BatchRunPivotReportsResponse struct {
	// PivotReports: Individual responses. Each response has a separate
	// pivot report request.
	PivotReports []*RunPivotReportResponse `json:"pivotReports,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "PivotReports") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PivotReports") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchRunPivotReportsResponse: The batch response containing multiple pivot reports.

func (*BatchRunPivotReportsResponse) MarshalJSON

func (s *BatchRunPivotReportsResponse) MarshalJSON() ([]byte, error)

type BatchRunReportsRequest

type BatchRunReportsRequest struct {
	// Entity: A property whose events are tracked. This entity must be
	// specified for the batch. The entity within RunReportRequest may
	// either be unspecified or consistent with this entity.
	Entity *Entity `json:"entity,omitempty"`

	// Requests: Individual requests. Each request has a separate report
	// response. Each batch request is allowed up to 5 requests.
	Requests []*RunReportRequest `json:"requests,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Entity") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Entity") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchRunReportsRequest: The batch request containing multiple report requests.

func (*BatchRunReportsRequest) MarshalJSON

func (s *BatchRunReportsRequest) MarshalJSON() ([]byte, error)

type BatchRunReportsResponse

type BatchRunReportsResponse struct {
	// Reports: Individual responses. Each response has a separate report
	// request.
	Reports []*RunReportResponse `json:"reports,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Reports") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Reports") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchRunReportsResponse: The batch response containing multiple reports.

func (*BatchRunReportsResponse) MarshalJSON

func (s *BatchRunReportsResponse) MarshalJSON() ([]byte, error)

type BetweenFilter

type BetweenFilter struct {
	// FromValue: Begins with this number.
	FromValue *NumericValue `json:"fromValue,omitempty"`

	// ToValue: Ends with this number.
	ToValue *NumericValue `json:"toValue,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FromValue") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FromValue") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BetweenFilter: To express that the result needs to be between two numbers (inclusive).

func (*BetweenFilter) MarshalJSON

func (s *BetweenFilter) MarshalJSON() ([]byte, error)

type CaseExpression

type CaseExpression struct {
	// DimensionName: Name of a dimension. The name must refer back to a
	// name in dimensions field of the request.
	DimensionName string `json:"dimensionName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CaseExpression: Used to convert a dimension value to a single case.

func (*CaseExpression) MarshalJSON

func (s *CaseExpression) MarshalJSON() ([]byte, error)

type Cohort

type Cohort struct {
	// DateRange: The cohort selects users whose first touch date is between
	// start date and end date defined in the `dateRange`. This `dateRange`
	// does not specify the full date range of event data that is present in
	// a cohort report. In a cohort report, this `dateRange` is extended by
	// the granularity and offset present in the `cohortsRange`; event data
	// for the extended reporting date range is present in a cohort report.
	// In a cohort request, this `dateRange` is required and the
	// `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest`
	// must be unspecified. This `dateRange` should generally be aligned
	// with the cohort's granularity. If `CohortsRange` uses daily
	// granularity, this `dateRange` can be a single day. If `CohortsRange`
	// uses weekly granularity, this `dateRange` can be aligned to a week
	// boundary, starting at Sunday and ending Saturday. If `CohortsRange`
	// uses monthly granularity, this `dateRange` can be aligned to a month,
	// starting at the first and ending on the last day of the month.
	DateRange *DateRange `json:"dateRange,omitempty"`

	// Dimension: Dimension used by the cohort. Required and only supports
	// `firstTouchDate`.
	Dimension string `json:"dimension,omitempty"`

	// Name: Assigns a name to this cohort. The dimension `cohort` is valued
	// to this name in a report response. If set, cannot begin with
	// `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero
	// based index `cohort_0`, `cohort_1`, etc.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DateRange") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DateRange") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Cohort: Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstTouchDate` belong to the same cohort.

func (*Cohort) MarshalJSON

func (s *Cohort) MarshalJSON() ([]byte, error)

type CohortReportSettings

type CohortReportSettings struct {
	// Accumulate: If true, accumulates the result from first touch day to
	// the end day. Not supported in `RunReportRequest`.
	Accumulate bool `json:"accumulate,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Accumulate") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Accumulate") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CohortReportSettings: Optional settings of a cohort report.

func (*CohortReportSettings) MarshalJSON

func (s *CohortReportSettings) MarshalJSON() ([]byte, error)

type CohortSpec

type CohortSpec struct {
	// CohortReportSettings: Optional settings for a cohort report.
	CohortReportSettings *CohortReportSettings `json:"cohortReportSettings,omitempty"`

	// Cohorts: Defines the selection criteria to group users into cohorts.
	// Most cohort reports define only a single cohort. If multiple cohorts
	// are specified, each cohort can be recognized in the report by their
	// name.
	Cohorts []*Cohort `json:"cohorts,omitempty"`

	// CohortsRange: Cohort reports follow cohorts over an extended
	// reporting date range. This range specifies an offset duration to
	// follow the cohorts over.
	CohortsRange *CohortsRange `json:"cohortsRange,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "CohortReportSettings") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CohortReportSettings") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CohortSpec: Specification of cohorts for a cohort report. Cohort reports can be used for example to create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object. The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.

func (*CohortSpec) MarshalJSON

func (s *CohortSpec) MarshalJSON() ([]byte, error)

type CohortsRange

type CohortsRange struct {
	// EndOffset: `endOffset` specifies the end date of the extended
	// reporting date range for a cohort report. `endOffset` can be any
	// positive integer but is commonly set to 5 to 10 so that reports
	// contain data on the cohort for the next several granularity time
	// periods. If `granularity` is `DAILY`, the `endDate` of the extended
	// reporting date range is `endDate` of the cohort plus `endOffset`
	// days. If `granularity` is `WEEKLY`, the `endDate` of the extended
	// reporting date range is `endDate` of the cohort plus `endOffset * 7`
	// days. If `granularity` is `MONTHLY`, the `endDate` of the extended
	// reporting date range is `endDate` of the cohort plus `endOffset * 30`
	// days.
	EndOffset int64 `json:"endOffset,omitempty"`

	// Granularity: The granularity used to interpret the `startOffset` and
	// `endOffset` for the extended reporting date range for a cohort
	// report.
	//
	// Possible values:
	//   "GRANULARITY_UNSPECIFIED" - Should never be specified.
	//   "DAILY" - Daily granularity. Commonly used if the cohort's
	// `dateRange` is a single day and the request contains `cohortNthDay`.
	//   "WEEKLY" - Weekly granularity. Commonly used if the cohort's
	// `dateRange` is a week in duration (starting on Sunday and ending on
	// Saturday) and the request contains `cohortNthWeek`.
	//   "MONTHLY" - Monthly granularity. Commonly used if the cohort's
	// `dateRange` is a month in duration and the request contains
	// `cohortNthMonth`.
	Granularity string `json:"granularity,omitempty"`

	// StartOffset: `startOffset` specifies the start date of the extended
	// reporting date range for a cohort report. `startOffset` is commonly
	// set to 0 so that reports contain data from the acquisition of the
	// cohort forward. If `granularity` is `DAILY`, the `startDate` of the
	// extended reporting date range is `startDate` of the cohort plus
	// `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of
	// the extended reporting date range is `startDate` of the cohort plus
	// `startOffset * 7` days. If `granularity` is `MONTHLY`, the
	// `startDate` of the extended reporting date range is `startDate` of
	// the cohort plus `startOffset * 30` days.
	StartOffset int64 `json:"startOffset,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndOffset") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndOffset") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CohortsRange: Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.

func (*CohortsRange) MarshalJSON

func (s *CohortsRange) MarshalJSON() ([]byte, error)

type ConcatenateExpression

type ConcatenateExpression struct {
	// Delimiter: The delimiter placed between dimension names. Delimiters
	// are often single characters such as "|" or "," but can be longer
	// strings. If a dimension value contains the delimiter, both will be
	// present in response with no distinction. For example if dimension 1
	// value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then
	// the response will contain "US,FR,JP".
	Delimiter string `json:"delimiter,omitempty"`

	// DimensionNames: Names of dimensions. The names must refer back to
	// names in the dimensions field of the request.
	DimensionNames []string `json:"dimensionNames,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Delimiter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Delimiter") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ConcatenateExpression: Used to combine dimension values to a single dimension.

func (*ConcatenateExpression) MarshalJSON

func (s *ConcatenateExpression) MarshalJSON() ([]byte, error)

type DateRange

type DateRange struct {
	// EndDate: The inclusive end date for the query in the format
	// `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`,
	// `yesterday`, or `today` is also accepted, and in that case, the date
	// is inferred based on the property's reporting time zone.
	EndDate string `json:"endDate,omitempty"`

	// Name: Assigns a name to this date range. The dimension `dateRange` is
	// valued to this name in a report response. If set, cannot begin with
	// `date_range_` or `RESERVED_`. If not set, date ranges are named by
	// their zero based index in the request: `date_range_0`,
	// `date_range_1`, etc.
	Name string `json:"name,omitempty"`

	// StartDate: The inclusive start date for the query in the format
	// `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`,
	// `yesterday`, or `today` is also accepted, and in that case, the date
	// is inferred based on the property's reporting time zone.
	StartDate string `json:"startDate,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndDate") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndDate") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DateRange: A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

func (*DateRange) MarshalJSON

func (s *DateRange) MarshalJSON() ([]byte, error)

type Dimension

type Dimension struct {
	// DimensionExpression: One dimension can be the result of an expression
	// of multiple dimensions. For example, dimension "country, city":
	// concatenate(country, ", ", city).
	DimensionExpression *DimensionExpression `json:"dimensionExpression,omitempty"`

	// Name: The name of the dimension. See the [API
	// Dimensions](https://developers.google.com/analytics/devguides/reportin
	// g/data/v1/api-schema#dimensions) for the list of dimension names. If
	// `dimensionExpression` is specified, `name` can be any string that you
	// would like. For example if a `dimensionExpression` concatenates
	// `country` and `city`, you could call that dimension `countryAndCity`.
	// Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`,
	// `dimensionExpression`, and `pivots`.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionExpression")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionExpression") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Dimension: Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 8 dimensions.

func (*Dimension) MarshalJSON

func (s *Dimension) MarshalJSON() ([]byte, error)

type DimensionExpression

type DimensionExpression struct {
	// Concatenate: Used to combine dimension values to a single dimension.
	// For example, dimension "country, city": concatenate(country, ", ",
	// city).
	Concatenate *ConcatenateExpression `json:"concatenate,omitempty"`

	// LowerCase: Used to convert a dimension value to lower case.
	LowerCase *CaseExpression `json:"lowerCase,omitempty"`

	// UpperCase: Used to convert a dimension value to upper case.
	UpperCase *CaseExpression `json:"upperCase,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Concatenate") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Concatenate") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DimensionExpression: Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).

func (*DimensionExpression) MarshalJSON

func (s *DimensionExpression) MarshalJSON() ([]byte, error)

type DimensionHeader

type DimensionHeader struct {
	// Name: The dimension's name.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DimensionHeader: Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.

func (*DimensionHeader) MarshalJSON

func (s *DimensionHeader) MarshalJSON() ([]byte, error)

type DimensionMetadata

type DimensionMetadata struct {
	// ApiName: This dimension's name. Useable in [Dimension](#Dimension)'s
	// `name`. For example, `eventName`.
	ApiName string `json:"apiName,omitempty"`

	// CustomDefinition: True if the dimension is a custom dimension for
	// this property.
	CustomDefinition bool `json:"customDefinition,omitempty"`

	// DeprecatedApiNames: Still usable but deprecated names for this
	// dimension. If populated, this dimension is available by either
	// `apiName` or one of `deprecatedApiNames` for a period of time. After
	// the deprecation period, the dimension will be available only by
	// `apiName`.
	DeprecatedApiNames []string `json:"deprecatedApiNames,omitempty"`

	// Description: Description of how this dimension is used and
	// calculated.
	Description string `json:"description,omitempty"`

	// UiName: This dimension's name within the Google Analytics user
	// interface. For example, `Event name`.
	UiName string `json:"uiName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ApiName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApiName") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DimensionMetadata: Explains a dimension.

func (*DimensionMetadata) MarshalJSON

func (s *DimensionMetadata) MarshalJSON() ([]byte, error)

type DimensionOrderBy

type DimensionOrderBy struct {
	// DimensionName: A dimension name in the request to order by.
	DimensionName string `json:"dimensionName,omitempty"`

	// OrderType: Controls the rule for dimension value ordering.
	//
	// Possible values:
	//   "ORDER_TYPE_UNSPECIFIED" - Unspecified.
	//   "ALPHANUMERIC" - Alphanumeric sort by Unicode code point. For
	// example, "2" < "A" < "X" < "b" < "z".
	//   "CASE_INSENSITIVE_ALPHANUMERIC" - Case insensitive alphanumeric
	// sort by lower case Unicode code point. For example, "2" < "A" < "b" <
	// "X" < "z".
	//   "NUMERIC" - Dimension values are converted to numbers before
	// sorting. For example in NUMERIC sort, "25" < "100", and in
	// `ALPHANUMERIC` sort, "100" < "25". Non-numeric dimension values all
	// have equal ordering value below all numeric values.
	OrderType string `json:"orderType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DimensionOrderBy: Sorts by dimension values.

func (*DimensionOrderBy) MarshalJSON

func (s *DimensionOrderBy) MarshalJSON() ([]byte, error)

type DimensionValue

type DimensionValue struct {
	// Value: Value as a string if the dimension type is a string.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Value") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Value") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DimensionValue: The value of a dimension.

func (*DimensionValue) MarshalJSON

func (s *DimensionValue) MarshalJSON() ([]byte, error)

type Entity

type Entity struct {
	// PropertyId: A Google Analytics GA4 property id. To learn more, see
	// [where to find your Property
	// ID](https://developers.google.com/analytics/devguides/reporting/data/v
	// 1/property-id).
	PropertyId string `json:"propertyId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PropertyId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PropertyId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Entity: The unique identifier of the property whose events are tracked.

func (*Entity) MarshalJSON

func (s *Entity) MarshalJSON() ([]byte, error)

type Filter

type Filter struct {
	// BetweenFilter: A filter for two values.
	BetweenFilter *BetweenFilter `json:"betweenFilter,omitempty"`

	// FieldName: The dimension name or metric name. Must be a name defined
	// in dimensions or metrics.
	FieldName string `json:"fieldName,omitempty"`

	// InListFilter: A filter for in list values.
	InListFilter *InListFilter `json:"inListFilter,omitempty"`

	// NullFilter: A filter for null values. If True, a null dimension value
	// is matched by this filter. Null filter is commonly used inside a NOT
	// filter expression. For example, a NOT expression of a null filter
	// removes rows when a dimension is null.
	NullFilter bool `json:"nullFilter,omitempty"`

	// NumericFilter: A filter for numeric or date values.
	NumericFilter *NumericFilter `json:"numericFilter,omitempty"`

	// StringFilter: Strings related filter.
	StringFilter *StringFilter `json:"stringFilter,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BetweenFilter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BetweenFilter") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Filter: An expression to filter dimension or metric values.

func (*Filter) MarshalJSON

func (s *Filter) MarshalJSON() ([]byte, error)

type FilterExpression

type FilterExpression struct {
	// AndGroup: The FilterExpressions in and_group have an AND
	// relationship.
	AndGroup *FilterExpressionList `json:"andGroup,omitempty"`

	// Filter: A primitive filter. All fields in filter in same
	// FilterExpression needs to be either all dimensions or metrics.
	Filter *Filter `json:"filter,omitempty"`

	// NotExpression: The FilterExpression is NOT of not_expression.
	NotExpression *FilterExpression `json:"notExpression,omitempty"`

	// OrGroup: The FilterExpressions in or_group have an OR relationship.
	OrGroup *FilterExpressionList `json:"orGroup,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AndGroup") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AndGroup") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FilterExpression: To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.

func (*FilterExpression) MarshalJSON

func (s *FilterExpression) MarshalJSON() ([]byte, error)

type FilterExpressionList

type FilterExpressionList struct {
	// Expressions: A list of filter expressions.
	Expressions []*FilterExpression `json:"expressions,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Expressions") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Expressions") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FilterExpressionList: A list of filter expressions.

func (*FilterExpressionList) MarshalJSON

func (s *FilterExpressionList) MarshalJSON() ([]byte, error)

type InListFilter

type InListFilter struct {
	// CaseSensitive: If true, the string value is case sensitive.
	CaseSensitive bool `json:"caseSensitive,omitempty"`

	// Values: The list of string values. Must be non-empty.
	Values []string `json:"values,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CaseSensitive") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CaseSensitive") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

InListFilter: The result needs to be in a list of string values.

func (*InListFilter) MarshalJSON

func (s *InListFilter) MarshalJSON() ([]byte, error)

type Metadata

type Metadata struct {
	// Dimensions: The dimension descriptions.
	Dimensions []*DimensionMetadata `json:"dimensions,omitempty"`

	// Metrics: The metric descriptions.
	Metrics []*MetricMetadata `json:"metrics,omitempty"`

	// Name: Resource name of this metadata.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Dimensions") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Dimensions") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Metadata: The dimensions and metrics currently accepted in reporting methods.

func (*Metadata) MarshalJSON

func (s *Metadata) MarshalJSON() ([]byte, error)

type Metric

type Metric struct {
	// Expression: A mathematical expression for derived metrics. For
	// example, the metric Event count per user is `eventCount/totalUsers`.
	Expression string `json:"expression,omitempty"`

	// Invisible: Indicates if a metric is invisible in the report response.
	// If a metric is invisible, the metric will not produce a column in the
	// response, but can be used in `metricFilter`, `orderBys`, or a metric
	// `expression`.
	Invisible bool `json:"invisible,omitempty"`

	// Name: The name of the metric. See the [API
	// Metrics](https://developers.google.com/analytics/devguides/reporting/d
	// ata/v1/api-schema#metrics) for the list of metric names. If
	// `expression` is specified, `name` can be any string that you would
	// like. For example if `expression` is `screenPageViews/sessions`, you
	// could call that metric's name = `viewsPerSession`. Metrics are
	// referenced by `name` in `metricFilter`, `orderBys`, and metric
	// `expression`.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Expression") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Expression") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Metric: The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.

func (*Metric) MarshalJSON

func (s *Metric) MarshalJSON() ([]byte, error)

type MetricHeader

type MetricHeader struct {
	// Name: The metric's name.
	Name string `json:"name,omitempty"`

	// Type: The metric's data type.
	//
	// Possible values:
	//   "METRIC_TYPE_UNSPECIFIED" - Unspecified type.
	//   "TYPE_INTEGER" - Integer type.
	//   "TYPE_FLOAT" - Floating point type.
	//   "TYPE_SECONDS" - A duration of seconds; a special floating point
	// type.
	//   "TYPE_MILLISECONDS" - A duration in milliseconds; a special
	// floating point type.
	//   "TYPE_MINUTES" - A duration in minutes; a special floating point
	// type.
	//   "TYPE_HOURS" - A duration in hours; a special floating point type.
	//   "TYPE_STANDARD" - A custom metric of standard type; a special
	// floating point type.
	//   "TYPE_CURRENCY" - An amount of money; a special floating point
	// type.
	//   "TYPE_FEET" - A length in feet; a special floating point type.
	//   "TYPE_MILES" - A length in miles; a special floating point type.
	//   "TYPE_METERS" - A length in meters; a special floating point type.
	//   "TYPE_KILOMETERS" - A length in kilometers; a special floating
	// point type.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MetricHeader: Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.

func (*MetricHeader) MarshalJSON

func (s *MetricHeader) MarshalJSON() ([]byte, error)

type MetricMetadata

type MetricMetadata struct {
	// ApiName: A metric name. Useable in [Metric](#Metric)'s `name`. For
	// example, `eventCount`.
	ApiName string `json:"apiName,omitempty"`

	// CustomDefinition: True if the metric is a custom metric for this
	// property.
	CustomDefinition bool `json:"customDefinition,omitempty"`

	// DeprecatedApiNames: Still usable but deprecated names for this
	// metric. If populated, this metric is available by either `apiName` or
	// one of `deprecatedApiNames` for a period of time. After the
	// deprecation period, the metric will be available only by `apiName`.
	DeprecatedApiNames []string `json:"deprecatedApiNames,omitempty"`

	// Description: Description of how this metric is used and calculated.
	Description string `json:"description,omitempty"`

	// Expression: The mathematical expression for this derived metric. Can
	// be used in [Metric](#Metric)'s `expression` field for equivalent
	// reports. Most metrics are not expressions, and for non-expressions,
	// this field is empty.
	Expression string `json:"expression,omitempty"`

	// Type: The type of this metric.
	//
	// Possible values:
	//   "METRIC_TYPE_UNSPECIFIED" - Unspecified type.
	//   "TYPE_INTEGER" - Integer type.
	//   "TYPE_FLOAT" - Floating point type.
	//   "TYPE_SECONDS" - A duration of seconds; a special floating point
	// type.
	//   "TYPE_MILLISECONDS" - A duration in milliseconds; a special
	// floating point type.
	//   "TYPE_MINUTES" - A duration in minutes; a special floating point
	// type.
	//   "TYPE_HOURS" - A duration in hours; a special floating point type.
	//   "TYPE_STANDARD" - A custom metric of standard type; a special
	// floating point type.
	//   "TYPE_CURRENCY" - An amount of money; a special floating point
	// type.
	//   "TYPE_FEET" - A length in feet; a special floating point type.
	//   "TYPE_MILES" - A length in miles; a special floating point type.
	//   "TYPE_METERS" - A length in meters; a special floating point type.
	//   "TYPE_KILOMETERS" - A length in kilometers; a special floating
	// point type.
	Type string `json:"type,omitempty"`

	// UiName: This metric's name within the Google Analytics user
	// interface. For example, `Event count`.
	UiName string `json:"uiName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ApiName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApiName") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MetricMetadata: Explains a metric.

func (*MetricMetadata) MarshalJSON

func (s *MetricMetadata) MarshalJSON() ([]byte, error)

type MetricOrderBy

type MetricOrderBy struct {
	// MetricName: A metric name in the request to order by.
	MetricName string `json:"metricName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MetricName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MetricName") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MetricOrderBy: Sorts by metric values.

func (*MetricOrderBy) MarshalJSON

func (s *MetricOrderBy) MarshalJSON() ([]byte, error)

type MetricValue

type MetricValue struct {
	// Value: Measurement value. See MetricHeader for type.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Value") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Value") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MetricValue: The value of a metric.

func (*MetricValue) MarshalJSON

func (s *MetricValue) MarshalJSON() ([]byte, error)

type NumericFilter

type NumericFilter struct {
	// Operation: The operation type for this filter.
	//
	// Possible values:
	//   "OPERATION_UNSPECIFIED" - Unspecified.
	//   "EQUAL" - Equal
	//   "LESS_THAN" - Less than
	//   "LESS_THAN_OR_EQUAL" - Less than or equal
	//   "GREATER_THAN" - Greater than
	//   "GREATER_THAN_OR_EQUAL" - Greater than or equal
	Operation string `json:"operation,omitempty"`

	// Value: A numeric value or a date value.
	Value *NumericValue `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Operation") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Operation") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

NumericFilter: Filters for numeric or date values.

func (*NumericFilter) MarshalJSON

func (s *NumericFilter) MarshalJSON() ([]byte, error)

type NumericValue

type NumericValue struct {
	// DoubleValue: Double value
	DoubleValue float64 `json:"doubleValue,omitempty"`

	// Int64Value: Integer value
	Int64Value int64 `json:"int64Value,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "DoubleValue") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DoubleValue") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

NumericValue: To represent a number.

func (*NumericValue) MarshalJSON

func (s *NumericValue) MarshalJSON() ([]byte, error)

func (*NumericValue) UnmarshalJSON

func (s *NumericValue) UnmarshalJSON(data []byte) error

type OrderBy

type OrderBy struct {
	// Desc: If true, sorts by descending order.
	Desc bool `json:"desc,omitempty"`

	// Dimension: Sorts results by a dimension's values.
	Dimension *DimensionOrderBy `json:"dimension,omitempty"`

	// Metric: Sorts results by a metric's values.
	Metric *MetricOrderBy `json:"metric,omitempty"`

	// Pivot: Sorts results by a metric's values within a pivot column
	// group.
	Pivot *PivotOrderBy `json:"pivot,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Desc") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Desc") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

OrderBy: The sort options.

func (*OrderBy) MarshalJSON

func (s *OrderBy) MarshalJSON() ([]byte, error)

type Pivot

type Pivot struct {
	// FieldNames: Dimension names for visible columns in the report
	// response. Including "dateRange" produces a date range column; for
	// each row in the response, dimension values in the date range column
	// will indicate the corresponding date range from the request.
	FieldNames []string `json:"fieldNames,omitempty"`

	// Limit: The number of rows to return in this pivot. If unspecified, 10
	// rows are returned. If -1, all rows are returned.
	Limit int64 `json:"limit,omitempty,string"`

	// MetricAggregations: Aggregate the metrics by dimensions in this pivot
	// using the specified metric_aggregations.
	//
	// Possible values:
	//   "METRIC_AGGREGATION_UNSPECIFIED" - Unspecified operator.
	//   "TOTAL" - SUM operator.
	//   "MINIMUM" - Minimum operator.
	//   "MAXIMUM" - Maximum operator.
	//   "COUNT" - Count operator.
	MetricAggregations []string `json:"metricAggregations,omitempty"`

	// Offset: The row count of the start row. The first row is counted as
	// row 0.
	Offset int64 `json:"offset,omitempty,string"`

	// OrderBys: Specifies how dimensions are ordered in the pivot. In the
	// first Pivot, the OrderBys determine Row and PivotDimensionHeader
	// ordering; in subsequent Pivots, the OrderBys determine only
	// PivotDimensionHeader ordering. Dimensions specified in these OrderBys
	// must be a subset of Pivot.field_names.
	OrderBys []*OrderBy `json:"orderBys,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FieldNames") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FieldNames") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Pivot: Describes the visible dimension columns and rows in the report response.

func (*Pivot) MarshalJSON

func (s *Pivot) MarshalJSON() ([]byte, error)

type PivotDimensionHeader

type PivotDimensionHeader struct {
	// DimensionValues: Values of multiple dimensions in a pivot.
	DimensionValues []*DimensionValue `json:"dimensionValues,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionValues") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionValues") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

PivotDimensionHeader: Summarizes dimension values from a row for this pivot.

func (*PivotDimensionHeader) MarshalJSON

func (s *PivotDimensionHeader) MarshalJSON() ([]byte, error)

type PivotHeader

type PivotHeader struct {
	// PivotDimensionHeaders: The size is the same as the cardinality of the
	// corresponding dimension combinations.
	PivotDimensionHeaders []*PivotDimensionHeader `json:"pivotDimensionHeaders,omitempty"`

	// RowCount: The cardinality of the pivot as if offset = 0 and limit =
	// -1. The total number of rows for this pivot's fields regardless of
	// how the parameters offset and limit are specified in the request.
	RowCount int64 `json:"rowCount,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "PivotDimensionHeaders") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PivotDimensionHeaders") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

PivotHeader: Dimensions' values in a single pivot.

func (*PivotHeader) MarshalJSON

func (s *PivotHeader) MarshalJSON() ([]byte, error)

type PivotOrderBy

type PivotOrderBy struct {
	// MetricName: In the response to order by, order rows by this column.
	// Must be a metric name from the request.
	MetricName string `json:"metricName,omitempty"`

	// PivotSelections: Used to select a dimension name and value pivot. If
	// multiple pivot selections are given, the sort occurs on rows where
	// all pivot selection dimension name and value pairs match the row's
	// dimension name and value pair.
	PivotSelections []*PivotSelection `json:"pivotSelections,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MetricName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MetricName") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PivotOrderBy: Sorts by a pivot column group.

func (*PivotOrderBy) MarshalJSON

func (s *PivotOrderBy) MarshalJSON() ([]byte, error)

type PivotSelection

type PivotSelection struct {
	// DimensionName: Must be a dimension name from the request.
	DimensionName string `json:"dimensionName,omitempty"`

	// DimensionValue: Order by only when the named dimension is this value.
	DimensionValue string `json:"dimensionValue,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PivotSelection: A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------

func (*PivotSelection) MarshalJSON

func (s *PivotSelection) MarshalJSON() ([]byte, error)

type PropertiesGetMetadataCall

type PropertiesGetMetadataCall struct {
	// contains filtered or unexported fields
}

func (*PropertiesGetMetadataCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PropertiesGetMetadataCall) Do

Do executes the "analyticsdata.properties.getMetadata" call. Exactly one of *Metadata or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Metadata.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PropertiesGetMetadataCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*PropertiesGetMetadataCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*PropertiesGetMetadataCall) IfNoneMatch

func (c *PropertiesGetMetadataCall) IfNoneMatch(entityTag string) *PropertiesGetMetadataCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type PropertiesRunRealtimeReportCall

type PropertiesRunRealtimeReportCall struct {
	// contains filtered or unexported fields
}

func (*PropertiesRunRealtimeReportCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PropertiesRunRealtimeReportCall) Do

Do executes the "analyticsdata.properties.runRealtimeReport" call. Exactly one of *RunRealtimeReportResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RunRealtimeReportResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PropertiesRunRealtimeReportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*PropertiesRunRealtimeReportCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type PropertiesService

type PropertiesService struct {
	// contains filtered or unexported fields
}

func NewPropertiesService

func NewPropertiesService(s *Service) *PropertiesService

func (*PropertiesService) GetMetadata

func (r *PropertiesService) GetMetadata(nameid string) *PropertiesGetMetadataCall

GetMetadata: Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.

func (*PropertiesService) RunRealtimeReport

func (r *PropertiesService) RunRealtimeReport(propertyid string, runrealtimereportrequest *RunRealtimeReportRequest) *PropertiesRunRealtimeReportCall

RunRealtimeReport: The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.

type PropertyQuota

type PropertyQuota struct {
	// ConcurrentRequests: Standard Analytics Properties can send up to 10
	// concurrent requests; Analytics 360 Properties can use up to 50
	// concurrent requests.
	ConcurrentRequests *QuotaStatus `json:"concurrentRequests,omitempty"`

	// ServerErrorsPerProjectPerHour: Standard Analytics Properties and
	// cloud project pairs can have up to 10 server errors per hour;
	// Analytics 360 Properties and cloud project pairs can have up to 50
	// server errors per hour.
	ServerErrorsPerProjectPerHour *QuotaStatus `json:"serverErrorsPerProjectPerHour,omitempty"`

	// TokensPerDay: Standard Analytics Properties can use up to 25,000
	// tokens per day; Analytics 360 Properties can use 250,000 tokens per
	// day. Most requests consume fewer than 10 tokens.
	TokensPerDay *QuotaStatus `json:"tokensPerDay,omitempty"`

	// TokensPerHour: Standard Analytics Properties can use up to 5,000
	// tokens per day; Analytics 360 Properties can use 50,000 tokens per
	// day. An API request consumes a single number of tokens, and that
	// number is deducted from both the hourly and daily quotas.
	TokensPerHour *QuotaStatus `json:"tokensPerHour,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConcurrentRequests")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConcurrentRequests") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

PropertyQuota: Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.

func (*PropertyQuota) MarshalJSON

func (s *PropertyQuota) MarshalJSON() ([]byte, error)

type QuotaStatus

type QuotaStatus struct {
	// Consumed: Quota consumed by this request.
	Consumed int64 `json:"consumed,omitempty"`

	// Remaining: Quota remaining after this request.
	Remaining int64 `json:"remaining,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Consumed") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Consumed") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

QuotaStatus: Current state for a particular quota group.

func (*QuotaStatus) MarshalJSON

func (s *QuotaStatus) MarshalJSON() ([]byte, error)

type ResponseMetaData

type ResponseMetaData struct {
	// DataLossFromOtherRow: If true, indicates some buckets of dimension
	// combinations are rolled into "(other)" row. This can happen for high
	// cardinality reports.
	DataLossFromOtherRow bool `json:"dataLossFromOtherRow,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "DataLossFromOtherRow") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DataLossFromOtherRow") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ResponseMetaData: Response's metadata carrying additional information about the report content.

func (*ResponseMetaData) MarshalJSON

func (s *ResponseMetaData) MarshalJSON() ([]byte, error)

type Row

type Row struct {
	// DimensionValues: List of requested dimension values. In a
	// PivotReport, dimension_values are only listed for dimensions included
	// in a pivot.
	DimensionValues []*DimensionValue `json:"dimensionValues,omitempty"`

	// MetricValues: List of requested visible metric values.
	MetricValues []*MetricValue `json:"metricValues,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionValues") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionValues") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Row: Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```

func (*Row) MarshalJSON

func (s *Row) MarshalJSON() ([]byte, error)

type RunPivotReportRequest

type RunPivotReportRequest struct {
	// CohortSpec: Cohort group associated with this request. If there is a
	// cohort group in the request the 'cohort' dimension must be present.
	CohortSpec *CohortSpec `json:"cohortSpec,omitempty"`

	// CurrencyCode: A currency code in ISO4217 format, such as "AED",
	// "USD", "JPY". If the field is empty, the report uses the entity's
	// default currency.
	CurrencyCode string `json:"currencyCode,omitempty"`

	// DateRanges: The date range to retrieve event data for the report. If
	// multiple date ranges are specified, event data from each date range
	// is used in the report. A special dimension with field name
	// "dateRange" can be included in a Pivot's field names; if included,
	// the report compares between date ranges. In a cohort request, this
	// `dateRanges` must be unspecified.
	DateRanges []*DateRange `json:"dateRanges,omitempty"`

	// DimensionFilter: The filter clause of dimensions. Dimensions must be
	// requested to be used in this filter. Metrics cannot be used in this
	// filter.
	DimensionFilter *FilterExpression `json:"dimensionFilter,omitempty"`

	// Dimensions: The dimensions requested. All defined dimensions must be
	// used by one of the following: dimension_expression, dimension_filter,
	// pivots, order_bys.
	Dimensions []*Dimension `json:"dimensions,omitempty"`

	// Entity: A property whose events are tracked. Within a batch request,
	// this entity should either be unspecified or consistent with the
	// batch-level entity.
	Entity *Entity `json:"entity,omitempty"`

	// KeepEmptyRows: If false or unspecified, each row with all metrics
	// equal to 0 will not be returned. If true, these rows will be returned
	// if they are not separately removed by a filter.
	KeepEmptyRows bool `json:"keepEmptyRows,omitempty"`

	// MetricFilter: The filter clause of metrics. Applied at post
	// aggregation phase, similar to SQL having-clause. Metrics must be
	// requested to be used in this filter. Dimensions cannot be used in
	// this filter.
	MetricFilter *FilterExpression `json:"metricFilter,omitempty"`

	// Metrics: The metrics requested, at least one metric needs to be
	// specified. All defined metrics must be used by one of the following:
	// metric_expression, metric_filter, order_bys.
	Metrics []*Metric `json:"metrics,omitempty"`

	// Pivots: Describes the visual format of the report's dimensions in
	// columns or rows. The union of the fieldNames (dimension names) in all
	// pivots must be a subset of dimension names defined in Dimensions. No
	// two pivots can share a dimension. A dimension is only visible if it
	// appears in a pivot.
	Pivots []*Pivot `json:"pivots,omitempty"`

	// ReturnPropertyQuota: Toggles whether to return the current state of
	// this Analytics Property's quota. Quota is returned in
	// [PropertyQuota](#PropertyQuota).
	ReturnPropertyQuota bool `json:"returnPropertyQuota,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CohortSpec") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CohortSpec") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RunPivotReportRequest: The request to generate a pivot report.

func (*RunPivotReportRequest) MarshalJSON

func (s *RunPivotReportRequest) MarshalJSON() ([]byte, error)

type RunPivotReportResponse

type RunPivotReportResponse struct {
	// Aggregates: Aggregation of metric values. Can be totals, minimums, or
	// maximums. The returned aggregations are controlled by the
	// metric_aggregations in the pivot. The type of aggregation returned in
	// each row is shown by the dimension_values which are set to
	// "RESERVED_".
	Aggregates []*Row `json:"aggregates,omitempty"`

	// DimensionHeaders: Describes dimension columns. The number of
	// DimensionHeaders and ordering of DimensionHeaders matches the
	// dimensions present in rows.
	DimensionHeaders []*DimensionHeader `json:"dimensionHeaders,omitempty"`

	// Metadata: Metadata for the report.
	Metadata *ResponseMetaData `json:"metadata,omitempty"`

	// MetricHeaders: Describes metric columns. The number of MetricHeaders
	// and ordering of MetricHeaders matches the metrics present in rows.
	MetricHeaders []*MetricHeader `json:"metricHeaders,omitempty"`

	// PivotHeaders: Summarizes the columns and rows created by a pivot.
	// Each pivot in the request produces one header in the response. If we
	// have a request like this: "pivots": [{ "fieldNames": ["country",
	// "city"] }, { "fieldNames": "eventName" }] We will have the following
	// `pivotHeaders` in the response: "pivotHeaders" : [{
	// "dimensionHeaders": [{ "dimensionValues": [ { "value": "United
	// Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ {
	// "value": "Japan" }, { "value": "Osaka" } ] }] }, {
	// "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start"
	// }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]
	PivotHeaders []*PivotHeader `json:"pivotHeaders,omitempty"`

	// PropertyQuota: This Analytics Property's quota state including this
	// request.
	PropertyQuota *PropertyQuota `json:"propertyQuota,omitempty"`

	// Rows: Rows of dimension value combinations and metric values in the
	// report.
	Rows []*Row `json:"rows,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Aggregates") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Aggregates") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RunPivotReportResponse: The response pivot report table corresponding to a pivot request.

func (*RunPivotReportResponse) MarshalJSON

func (s *RunPivotReportResponse) MarshalJSON() ([]byte, error)

type RunRealtimeReportRequest

type RunRealtimeReportRequest struct {
	// DimensionFilter: The filter clause of dimensions. Dimensions must be
	// requested to be used in this filter. Metrics cannot be used in this
	// filter.
	DimensionFilter *FilterExpression `json:"dimensionFilter,omitempty"`

	// Dimensions: The dimensions requested and displayed.
	Dimensions []*Dimension `json:"dimensions,omitempty"`

	// Limit: The number of rows to return. If unspecified, 10 rows are
	// returned. If -1, all rows are returned.
	Limit int64 `json:"limit,omitempty,string"`

	// MetricAggregations: Aggregation of metrics. Aggregated metric values
	// will be shown in rows where the dimension_values are set to
	// "RESERVED_(MetricAggregation)".
	//
	// Possible values:
	//   "METRIC_AGGREGATION_UNSPECIFIED" - Unspecified operator.
	//   "TOTAL" - SUM operator.
	//   "MINIMUM" - Minimum operator.
	//   "MAXIMUM" - Maximum operator.
	//   "COUNT" - Count operator.
	MetricAggregations []string `json:"metricAggregations,omitempty"`

	// MetricFilter: The filter clause of metrics. Applied at post
	// aggregation phase, similar to SQL having-clause. Metrics must be
	// requested to be used in this filter. Dimensions cannot be used in
	// this filter.
	MetricFilter *FilterExpression `json:"metricFilter,omitempty"`

	// Metrics: The metrics requested and displayed.
	Metrics []*Metric `json:"metrics,omitempty"`

	// OrderBys: Specifies how rows are ordered in the response.
	OrderBys []*OrderBy `json:"orderBys,omitempty"`

	// ReturnPropertyQuota: Toggles whether to return the current state of
	// this Analytics Property's Realtime quota. Quota is returned in
	// [PropertyQuota](#PropertyQuota).
	ReturnPropertyQuota bool `json:"returnPropertyQuota,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DimensionFilter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionFilter") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RunRealtimeReportRequest: The request to generate a realtime report.

func (*RunRealtimeReportRequest) MarshalJSON

func (s *RunRealtimeReportRequest) MarshalJSON() ([]byte, error)

type RunRealtimeReportResponse

type RunRealtimeReportResponse struct {
	// DimensionHeaders: Describes dimension columns. The number of
	// DimensionHeaders and ordering of DimensionHeaders matches the
	// dimensions present in rows.
	DimensionHeaders []*DimensionHeader `json:"dimensionHeaders,omitempty"`

	// Maximums: If requested, the maximum values of metrics.
	Maximums []*Row `json:"maximums,omitempty"`

	// MetricHeaders: Describes metric columns. The number of MetricHeaders
	// and ordering of MetricHeaders matches the metrics present in rows.
	MetricHeaders []*MetricHeader `json:"metricHeaders,omitempty"`

	// Minimums: If requested, the minimum values of metrics.
	Minimums []*Row `json:"minimums,omitempty"`

	// PropertyQuota: This Analytics Property's Realtime quota state
	// including this request.
	PropertyQuota *PropertyQuota `json:"propertyQuota,omitempty"`

	// RowCount: The total number of rows in the query result, regardless of
	// the number of rows returned in the response. For example if a query
	// returns 175 rows and includes limit = 50 in the API request, the
	// response will contain row_count = 175 but only 50 rows.
	RowCount int64 `json:"rowCount,omitempty"`

	// Rows: Rows of dimension value combinations and metric values in the
	// report.
	Rows []*Row `json:"rows,omitempty"`

	// Totals: If requested, the totaled values of metrics.
	Totals []*Row `json:"totals,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DimensionHeaders") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionHeaders") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RunRealtimeReportResponse: The response realtime report table corresponding to a request.

func (*RunRealtimeReportResponse) MarshalJSON

func (s *RunRealtimeReportResponse) MarshalJSON() ([]byte, error)

type RunReportRequest

type RunReportRequest struct {
	// CohortSpec: Cohort group associated with this request. If there is a
	// cohort group in the request the 'cohort' dimension must be present.
	CohortSpec *CohortSpec `json:"cohortSpec,omitempty"`

	// CurrencyCode: A currency code in ISO4217 format, such as "AED",
	// "USD", "JPY". If the field is empty, the report uses the entity's
	// default currency.
	CurrencyCode string `json:"currencyCode,omitempty"`

	// DateRanges: Date ranges of data to read. If multiple date ranges are
	// requested, each response row will contain a zero based date range
	// index. If two date ranges overlap, the event data for the overlapping
	// days is included in the response rows for both date ranges. In a
	// cohort request, this `dateRanges` must be unspecified.
	DateRanges []*DateRange `json:"dateRanges,omitempty"`

	// DimensionFilter: The filter clause of dimensions. Dimensions must be
	// requested to be used in this filter. Metrics cannot be used in this
	// filter.
	DimensionFilter *FilterExpression `json:"dimensionFilter,omitempty"`

	// Dimensions: The dimensions requested and displayed.
	Dimensions []*Dimension `json:"dimensions,omitempty"`

	// Entity: A property whose events are tracked. Within a batch request,
	// this entity should either be unspecified or consistent with the
	// batch-level entity.
	Entity *Entity `json:"entity,omitempty"`

	// KeepEmptyRows: If false or unspecified, each row with all metrics
	// equal to 0 will not be returned. If true, these rows will be returned
	// if they are not separately removed by a filter.
	KeepEmptyRows bool `json:"keepEmptyRows,omitempty"`

	// Limit: The number of rows to return. If unspecified, 10 rows are
	// returned. If -1, all rows are returned. To learn more about this
	// pagination parameter, see
	// [Pagination](https://developers.google.com/analytics/devguides/reporti
	// ng/data/v1/basics#pagination).
	Limit int64 `json:"limit,omitempty,string"`

	// MetricAggregations: Aggregation of metrics. Aggregated metric values
	// will be shown in rows where the dimension_values are set to
	// "RESERVED_(MetricAggregation)".
	//
	// Possible values:
	//   "METRIC_AGGREGATION_UNSPECIFIED" - Unspecified operator.
	//   "TOTAL" - SUM operator.
	//   "MINIMUM" - Minimum operator.
	//   "MAXIMUM" - Maximum operator.
	//   "COUNT" - Count operator.
	MetricAggregations []string `json:"metricAggregations,omitempty"`

	// MetricFilter: The filter clause of metrics. Applied at post
	// aggregation phase, similar to SQL having-clause. Metrics must be
	// requested to be used in this filter. Dimensions cannot be used in
	// this filter.
	MetricFilter *FilterExpression `json:"metricFilter,omitempty"`

	// Metrics: The metrics requested and displayed.
	Metrics []*Metric `json:"metrics,omitempty"`

	// Offset: The row count of the start row. The first row is counted as
	// row 0. To learn more about this pagination parameter, see
	// [Pagination](https://developers.google.com/analytics/devguides/reporti
	// ng/data/v1/basics#pagination).
	Offset int64 `json:"offset,omitempty,string"`

	// OrderBys: Specifies how rows are ordered in the response.
	OrderBys []*OrderBy `json:"orderBys,omitempty"`

	// ReturnPropertyQuota: Toggles whether to return the current state of
	// this Analytics Property's quota. Quota is returned in
	// [PropertyQuota](#PropertyQuota).
	ReturnPropertyQuota bool `json:"returnPropertyQuota,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CohortSpec") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CohortSpec") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RunReportRequest: The request to generate a report.

func (*RunReportRequest) MarshalJSON

func (s *RunReportRequest) MarshalJSON() ([]byte, error)

type RunReportResponse

type RunReportResponse struct {
	// DimensionHeaders: Describes dimension columns. The number of
	// DimensionHeaders and ordering of DimensionHeaders matches the
	// dimensions present in rows.
	DimensionHeaders []*DimensionHeader `json:"dimensionHeaders,omitempty"`

	// Maximums: If requested, the maximum values of metrics.
	Maximums []*Row `json:"maximums,omitempty"`

	// Metadata: Metadata for the report.
	Metadata *ResponseMetaData `json:"metadata,omitempty"`

	// MetricHeaders: Describes metric columns. The number of MetricHeaders
	// and ordering of MetricHeaders matches the metrics present in rows.
	MetricHeaders []*MetricHeader `json:"metricHeaders,omitempty"`

	// Minimums: If requested, the minimum values of metrics.
	Minimums []*Row `json:"minimums,omitempty"`

	// PropertyQuota: This Analytics Property's quota state including this
	// request.
	PropertyQuota *PropertyQuota `json:"propertyQuota,omitempty"`

	// RowCount: The total number of rows in the query result, regardless of
	// the number of rows returned in the response. For example if a query
	// returns 175 rows and includes limit = 50 in the API request, the
	// response will contain row_count = 175 but only 50 rows. To learn more
	// about this pagination parameter, see
	// [Pagination](https://developers.google.com/analytics/devguides/reporti
	// ng/data/v1/basics#pagination).
	RowCount int64 `json:"rowCount,omitempty"`

	// Rows: Rows of dimension value combinations and metric values in the
	// report.
	Rows []*Row `json:"rows,omitempty"`

	// Totals: If requested, the totaled values of metrics.
	Totals []*Row `json:"totals,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DimensionHeaders") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DimensionHeaders") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RunReportResponse: The response report table corresponding to a request.

func (*RunReportResponse) MarshalJSON

func (s *RunReportResponse) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Properties *PropertiesService

	V1alpha *V1alphaService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type StringFilter

type StringFilter struct {
	// CaseSensitive: If true, the string value is case sensitive.
	CaseSensitive bool `json:"caseSensitive,omitempty"`

	// MatchType: The match type for this filter.
	//
	// Possible values:
	//   "MATCH_TYPE_UNSPECIFIED" - Unspecified
	//   "EXACT" - Exact match of the string value.
	//   "BEGINS_WITH" - Begins with the string value.
	//   "ENDS_WITH" - Ends with the string value.
	//   "CONTAINS" - Contains the string value.
	//   "FULL_REGEXP" - Full regular expression match with the string
	// value.
	//   "PARTIAL_REGEXP" - Partial regular expression match with the string
	// value.
	MatchType string `json:"matchType,omitempty"`

	// Value: The string value used for the matching.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CaseSensitive") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CaseSensitive") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

StringFilter: The filter for string

func (*StringFilter) MarshalJSON

func (s *StringFilter) MarshalJSON() ([]byte, error)

type V1alphaBatchRunPivotReportsCall

type V1alphaBatchRunPivotReportsCall struct {
	// contains filtered or unexported fields
}

func (*V1alphaBatchRunPivotReportsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1alphaBatchRunPivotReportsCall) Do

Do executes the "analyticsdata.batchRunPivotReports" call. Exactly one of *BatchRunPivotReportsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchRunPivotReportsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1alphaBatchRunPivotReportsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1alphaBatchRunPivotReportsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type V1alphaBatchRunReportsCall

type V1alphaBatchRunReportsCall struct {
	// contains filtered or unexported fields
}

func (*V1alphaBatchRunReportsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1alphaBatchRunReportsCall) Do

Do executes the "analyticsdata.batchRunReports" call. Exactly one of *BatchRunReportsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchRunReportsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1alphaBatchRunReportsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1alphaBatchRunReportsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type V1alphaRunPivotReportCall

type V1alphaRunPivotReportCall struct {
	// contains filtered or unexported fields
}

func (*V1alphaRunPivotReportCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1alphaRunPivotReportCall) Do

Do executes the "analyticsdata.runPivotReport" call. Exactly one of *RunPivotReportResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RunPivotReportResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1alphaRunPivotReportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1alphaRunPivotReportCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type V1alphaRunReportCall

type V1alphaRunReportCall struct {
	// contains filtered or unexported fields
}

func (*V1alphaRunReportCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1alphaRunReportCall) Do

Do executes the "analyticsdata.runReport" call. Exactly one of *RunReportResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RunReportResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1alphaRunReportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1alphaRunReportCall) Header

func (c *V1alphaRunReportCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type V1alphaService

type V1alphaService struct {
	// contains filtered or unexported fields
}

func NewV1alphaService

func NewV1alphaService(s *Service) *V1alphaService

func (*V1alphaService) BatchRunPivotReports

func (r *V1alphaService) BatchRunPivotReports(batchrunpivotreportsrequest *BatchRunPivotReportsRequest) *V1alphaBatchRunPivotReportsCall

BatchRunPivotReports: Returns multiple pivot reports in a batch. All reports must be for the same Entity.

func (*V1alphaService) BatchRunReports

func (r *V1alphaService) BatchRunReports(batchrunreportsrequest *BatchRunReportsRequest) *V1alphaBatchRunReportsCall

BatchRunReports: Returns multiple reports in a batch. All reports must be for the same Entity.

func (*V1alphaService) RunPivotReport

func (r *V1alphaService) RunPivotReport(runpivotreportrequest *RunPivotReportRequest) *V1alphaRunPivotReportCall

RunPivotReport: Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.

func (*V1alphaService) RunReport

func (r *V1alphaService) RunReport(runreportrequest *RunReportRequest) *V1alphaRunReportCall

RunReport: Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.