Movatterモバイル変換


[0]ホーム

URL:


analyticsdata

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:21

Details

Repository

github.com/googleapis/google-api-go-client

Links

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/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

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

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://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, usegoogle.golang.org/api/option.WithScopes:

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

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

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

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// View and manage your Google Analytics dataAnalyticsScope = "https://www.googleapis.com/auth/analytics"// See and download your Google Analytics dataAnalyticsReadonlyScope = "https://www.googleapis.com/auth/analytics.readonly")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeActiveMetricRestrictionadded inv0.60.0

type ActiveMetricRestriction struct {// MetricName: The name of the restricted metric.MetricNamestring `json:"metricName,omitempty"`// RestrictedMetricTypes: The reason for this metric's restriction.//// Possible values://   "RESTRICTED_METRIC_TYPE_UNSPECIFIED" - Unspecified type.//   "COST_DATA" - Cost metrics such as `adCost`.//   "REVENUE_DATA" - Revenue metrics such as `purchaseRevenue`.RestrictedMetricTypes []string `json:"restrictedMetricTypes,omitempty"`// ForceSendFields is a list of field names (e.g. "MetricName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ActiveMetricRestriction: A metric actively restricted in creating thereport.

func (ActiveMetricRestriction)MarshalJSONadded inv0.60.0

func (sActiveMetricRestriction) MarshalJSON() ([]byte,error)

typeAudienceExportadded inv0.153.0

type AudienceExport struct {// Audience: Required. The audience resource name. This resource name// identifies the audience being listed and is shared between the Analytics// Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`Audiencestring `json:"audience,omitempty"`// AudienceDisplayName: Output only. The descriptive display name for this// audience. For example, "Purchasers".AudienceDisplayNamestring `json:"audienceDisplayName,omitempty"`// BeginCreatingTime: Output only. The time when CreateAudienceExport was// called and the AudienceExport began the `CREATING` state.BeginCreatingTimestring `json:"beginCreatingTime,omitempty"`// CreationQuotaTokensCharged: Output only. The total quota tokens charged// during creation of the AudienceExport. Because this token count is based on// activity from the `CREATING` state, this tokens charged will be fixed once// an AudienceExport enters the `ACTIVE` or `FAILED` states.CreationQuotaTokensChargedint64 `json:"creationQuotaTokensCharged,omitempty"`// Dimensions: Required. The dimensions requested and displayed in the query// response.Dimensions []*V1betaAudienceDimension `json:"dimensions,omitempty"`// ErrorMessage: Output only. Error message is populated when an audience// export fails during creation. A common reason for such a failure is quota// exhaustion.ErrorMessagestring `json:"errorMessage,omitempty"`// Name: Output only. Identifier. The audience export resource name assigned// during creation. This resource name identifies this `AudienceExport`.// Format: `properties/{property}/audienceExports/{audience_export}`Namestring `json:"name,omitempty"`// PercentageCompleted: Output only. The percentage completed for this audience// export ranging between 0 to 100.PercentageCompletedfloat64 `json:"percentageCompleted,omitempty"`// RowCount: Output only. The total number of rows in the AudienceExport// result.RowCountint64 `json:"rowCount,omitempty"`// State: Output only. The current state for this AudienceExport.//// Possible values://   "STATE_UNSPECIFIED" - Unspecified state will never be used.//   "CREATING" - The AudienceExport is currently creating and will be// available in the future. Creating occurs immediately after the// CreateAudienceExport call.//   "ACTIVE" - The AudienceExport is fully created and ready for querying. An// AudienceExport is updated to active asynchronously from a request; this// occurs some time (for example 15 minutes) after the initial create call.//   "FAILED" - The AudienceExport failed to be created. It is possible that// re-requesting this audience export will succeed.Statestring `json:"state,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Audience") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Audience") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AudienceExport: An audience export is a list of users in an audience at thetime of the list's creation. One audience may have multiple audience exportscreated for different days.

func (AudienceExport)MarshalJSONadded inv0.153.0

func (sAudienceExport) MarshalJSON() ([]byte,error)

func (*AudienceExport)UnmarshalJSONadded inv0.153.0

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

typeAudienceListMetadataadded inv0.132.0

type AudienceListMetadata struct {}

AudienceListMetadata: This metadata is currently blank.

typeBatchRunPivotReportsRequest

type BatchRunPivotReportsRequest struct {// 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. "Requests") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Requests") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchRunPivotReportsRequest: The batch request containing multiple pivotreport requests.

func (BatchRunPivotReportsRequest)MarshalJSON

func (sBatchRunPivotReportsRequest) MarshalJSON() ([]byte,error)

typeBatchRunPivotReportsResponse

type BatchRunPivotReportsResponse struct {// Kind: Identifies what kind of resource this message is. This `kind` is// always the fixed string "analyticsData#batchRunPivotReports". Useful to// distinguish between response types in JSON.Kindstring `json:"kind,omitempty"`// 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. "Kind") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Kind") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchRunPivotReportsResponse: The batch response containing multiple pivotreports.

func (BatchRunPivotReportsResponse)MarshalJSON

func (sBatchRunPivotReportsResponse) MarshalJSON() ([]byte,error)

typeBatchRunReportsRequest

type BatchRunReportsRequest struct {// 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. "Requests") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Requests") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchRunReportsRequest: The batch request containing multiple reportrequests.

func (BatchRunReportsRequest)MarshalJSON

func (sBatchRunReportsRequest) MarshalJSON() ([]byte,error)

typeBatchRunReportsResponse

type BatchRunReportsResponse struct {// Kind: Identifies what kind of resource this message is. This `kind` is// always the fixed string "analyticsData#batchRunReports". Useful to// distinguish between response types in JSON.Kindstring `json:"kind,omitempty"`// 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. "Kind") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Kind") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BatchRunReportsResponse: The batch response containing multiple reports.

func (BatchRunReportsResponse)MarshalJSON

func (sBatchRunReportsResponse) MarshalJSON() ([]byte,error)

typeBetweenFilter

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (BetweenFilter)MarshalJSON

func (sBetweenFilter) MarshalJSON() ([]byte,error)

typeCaseExpression

type CaseExpression struct {// DimensionName: Name of a dimension. The name must refer back to a name in// dimensions field of the request.DimensionNamestring `json:"dimensionName,omitempty"`// ForceSendFields is a list of field names (e.g. "DimensionName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (CaseExpression)MarshalJSON

func (sCaseExpression) MarshalJSON() ([]byte,error)

typeCheckCompatibilityRequestadded inv0.55.0

type CheckCompatibilityRequest struct {// CompatibilityFilter: Filters the dimensions and metrics in the response to// just this compatibility. Commonly used as `”compatibilityFilter”:// “COMPATIBLE”` to only return compatible dimensions & metrics.//// Possible values://   "COMPATIBILITY_UNSPECIFIED" - Unspecified compatibility.//   "COMPATIBLE" - The dimension or metric is compatible. This dimension or// metric can be successfully added to a report.//   "INCOMPATIBLE" - The dimension or metric is incompatible. This dimension// or metric cannot be successfully added to a report.CompatibilityFilterstring `json:"compatibilityFilter,omitempty"`// DimensionFilter: The filter clause of dimensions. `dimensionFilter` should// be the same value as in your `runReport` request.DimensionFilter *FilterExpression `json:"dimensionFilter,omitempty"`// Dimensions: The dimensions in this report. `dimensions` should be the same// value as in your `runReport` request.Dimensions []*Dimension `json:"dimensions,omitempty"`// MetricFilter: The filter clause of metrics. `metricFilter` should be the// same value as in your `runReport` requestMetricFilter *FilterExpression `json:"metricFilter,omitempty"`// Metrics: The metrics in this report. `metrics` should be the same value as// in your `runReport` request.Metrics []*Metric `json:"metrics,omitempty"`// ForceSendFields is a list of field names (e.g. "CompatibilityFilter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CompatibilityFilter") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CheckCompatibilityRequest: The request for compatibility information for areport's dimensions and metrics. Check compatibility provides a preview ofthe compatibility of a report; fields shared with the `runReport` requestshould be the same values as in your `runReport` request.

func (CheckCompatibilityRequest)MarshalJSONadded inv0.55.0

func (sCheckCompatibilityRequest) MarshalJSON() ([]byte,error)

typeCheckCompatibilityResponseadded inv0.55.0

type CheckCompatibilityResponse struct {// DimensionCompatibilities: The compatibility of each dimension.DimensionCompatibilities []*DimensionCompatibility `json:"dimensionCompatibilities,omitempty"`// MetricCompatibilities: The compatibility of each metric.MetricCompatibilities []*MetricCompatibility `json:"metricCompatibilities,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DimensionCompatibilities")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DimensionCompatibilities") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CheckCompatibilityResponse: The compatibility response with thecompatibility of each dimension & metric.

func (CheckCompatibilityResponse)MarshalJSONadded inv0.55.0

func (sCheckCompatibilityResponse) MarshalJSON() ([]byte,error)

typeCohort

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// `firstSessionDate`.Dimensionstring `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.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "DateRange") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Cohort)MarshalJSON

func (sCohort) MarshalJSON() ([]byte,error)

typeCohortReportSettings

type CohortReportSettings struct {// Accumulate: If true, accumulates the result from first touch day to the end// day. Not supported in `RunReportRequest`.Accumulatebool `json:"accumulate,omitempty"`// ForceSendFields is a list of field names (e.g. "Accumulate") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CohortReportSettings: Optional settings of a cohort report.

func (CohortReportSettings)MarshalJSON

func (sCohortReportSettings) MarshalJSON() ([]byte,error)

typeCohortSpec

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CohortSpec: The specification of cohorts for a cohort report. Cohort reportscreate a time series of user retention for the cohort. For example, youcould select the cohort of users that were acquired in the first week ofSeptember and follow that cohort for the next six weeks. Selecting the usersacquired 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. For examples, see Cohort Report Examples(https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples).The report response could show a weekly time series where say your app hasretained 60% of this cohort after three weeks and 25% of this cohort aftersix weeks. These two percentages can be calculated by the metric`cohortActiveUsers/cohortTotalUsers` and will be separate rows in thereport.

func (CohortSpec)MarshalJSON

func (sCohortSpec) MarshalJSON() ([]byte,error)

typeCohortsRange

type CohortsRange struct {// EndOffset: Required. `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.EndOffsetint64 `json:"endOffset,omitempty"`// Granularity: Required. 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`.Granularitystring `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.StartOffsetint64 `json:"startOffset,omitempty"`// ForceSendFields is a list of field names (e.g. "EndOffset") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (CohortsRange)MarshalJSON

func (sCohortsRange) MarshalJSON() ([]byte,error)

typeComparisonadded inv0.181.0

type Comparison struct {// Comparison: A saved comparison identified by the comparison's resource name.// For example, 'comparisons/1234'.Comparisonstring `json:"comparison,omitempty"`// DimensionFilter: A basic comparison.DimensionFilter *FilterExpression `json:"dimensionFilter,omitempty"`// Name: Each comparison produces separate rows in the response. In the// response, this comparison is identified by this name. If name is// unspecified, we will use the saved comparisons display name.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Comparison") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Comparison") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Comparison: Defines an individual comparison. Most requests will includemultiple comparisons so that the report compares between the comparisons.

func (Comparison)MarshalJSONadded inv0.181.0

func (sComparison) MarshalJSON() ([]byte,error)

typeComparisonMetadataadded inv0.181.0

type ComparisonMetadata struct {// ApiName: This comparison's resource name. Useable in Comparison// (#Comparison)'s `comparison` field. For example, 'comparisons/1234'.ApiNamestring `json:"apiName,omitempty"`// Description: This comparison's description.Descriptionstring `json:"description,omitempty"`// UiName: This comparison's name within the Google Analytics user interface.UiNamestring `json:"uiName,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiName") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ComparisonMetadata: The metadata for a single comparison.

func (ComparisonMetadata)MarshalJSONadded inv0.181.0

func (sComparisonMetadata) MarshalJSON() ([]byte,error)

typeConcatenateExpression

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".Delimiterstring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ConcatenateExpression: Used to combine dimension values to a singledimension.

func (ConcatenateExpression)MarshalJSON

func (sConcatenateExpression) MarshalJSON() ([]byte,error)

typeDateRange

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.EndDatestring `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.Namestring `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.StartDatestring `json:"startDate,omitempty"`// ForceSendFields is a list of field names (e.g. "EndDate") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.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 (sDateRange) MarshalJSON() ([]byte,error)

typeDimension

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/reporting/data/v1/api-schema#dimensions)// for the list of dimension names supported by core reporting methods such as// `runReport` and `batchRunReports`. See Realtime Dimensions// (https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions)// for the list of dimension names supported by the `runRealtimeReport` method.// See Funnel Dimensions// (https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions)// for the list of dimension names supported by the `runFunnelReport` method.// If `dimensionExpression` is specified, `name` can be any string that you// would like within the allowed character set. For example if a// `dimensionExpression` concatenates `country` and `city`, you could call that// dimension `countryAndCity`. Dimension names that you choose must match the// regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in// `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "DimensionExpression") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Dimension)MarshalJSON

func (sDimension) MarshalJSON() ([]byte,error)

typeDimensionCompatibilityadded inv0.55.0

type DimensionCompatibility struct {// Compatibility: The compatibility of this dimension. If the compatibility is// COMPATIBLE, this dimension can be successfully added to the report.//// Possible values://   "COMPATIBILITY_UNSPECIFIED" - Unspecified compatibility.//   "COMPATIBLE" - The dimension or metric is compatible. This dimension or// metric can be successfully added to a report.//   "INCOMPATIBLE" - The dimension or metric is incompatible. This dimension// or metric cannot be successfully added to a report.Compatibilitystring `json:"compatibility,omitempty"`// DimensionMetadata: The dimension metadata contains the API name for this// compatibility information. The dimension metadata also contains other// helpful information like the UI name and description.DimensionMetadata *DimensionMetadata `json:"dimensionMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "Compatibility") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Compatibility") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DimensionCompatibility: The compatibility for a single dimension.

func (DimensionCompatibility)MarshalJSONadded inv0.55.0

func (sDimensionCompatibility) MarshalJSON() ([]byte,error)

typeDimensionExpression

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (DimensionExpression)MarshalJSON

func (sDimensionExpression) MarshalJSON() ([]byte,error)

typeDimensionHeader

type DimensionHeader struct {// Name: The dimension's name.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DimensionHeader: Describes a dimension column in the report. Dimensionsrequested in a report produce column entries within rows andDimensionHeaders. However, dimensions used exclusively within filters orexpressions do not produce columns in a report; correspondingly, thosedimensions do not produce headers.

func (DimensionHeader)MarshalJSON

func (sDimensionHeader) MarshalJSON() ([]byte,error)

typeDimensionMetadata

type DimensionMetadata struct {// ApiName: This dimension's name. Useable in Dimension (#Dimension)'s `name`.// For example, `eventName`.ApiNamestring `json:"apiName,omitempty"`// Category: The display name of the category that this dimension belongs to.// Similar dimensions and metrics are categorized together.Categorystring `json:"category,omitempty"`// CustomDefinition: True if the dimension is custom to this property. This// includes user, event, & item scoped custom dimensions; to learn more about// custom dimensions, seehttps://support.google.com/analytics/answer/14240153.// This also include custom channel groups; to learn more about custom channel// groups, seehttps://support.google.com/analytics/answer/13051316.CustomDefinitionbool `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.Descriptionstring `json:"description,omitempty"`// UiName: This dimension's name within the Google Analytics user interface.// For example, `Event name`.UiNamestring `json:"uiName,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiName") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DimensionMetadata: Explains a dimension.

func (DimensionMetadata)MarshalJSON

func (sDimensionMetadata) MarshalJSON() ([]byte,error)

typeDimensionOrderBy

type DimensionOrderBy struct {// DimensionName: A dimension name in the request to order by.DimensionNamestring `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.OrderTypestring `json:"orderType,omitempty"`// ForceSendFields is a list of field names (e.g. "DimensionName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DimensionOrderBy: Sorts by dimension values.

func (DimensionOrderBy)MarshalJSON

func (sDimensionOrderBy) MarshalJSON() ([]byte,error)

typeDimensionValue

type DimensionValue struct {// Value: Value as a string if the dimension type is a string.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Value") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DimensionValue: The value of a dimension.

func (DimensionValue)MarshalJSON

func (sDimensionValue) MarshalJSON() ([]byte,error)

typeEmptyFilteradded inv0.208.0

type EmptyFilter struct {}

EmptyFilter: Filter for empty values.

typeFilter

type Filter struct {// BetweenFilter: A filter for two values.BetweenFilter *BetweenFilter `json:"betweenFilter,omitempty"`// EmptyFilter: A filter for empty values such as "(not set)" and "" values.EmptyFilter *EmptyFilter `json:"emptyFilter,omitempty"`// FieldName: The dimension name or metric name. In most methods, dimensions &// metrics can be used for the first time in this field. However in a// RunPivotReportRequest, this field must be additionally specified by name in// the RunPivotReportRequest's dimensions or metrics.FieldNamestring `json:"fieldName,omitempty"`// InListFilter: A filter for in list values.InListFilter *InListFilter `json:"inListFilter,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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Filter: An expression to filter dimension or metric values.

func (Filter)MarshalJSON

func (sFilter) MarshalJSON() ([]byte,error)

typeFilterExpression

type FilterExpression struct {// AndGroup: The FilterExpressions in and_group have an AND relationship.AndGroup *FilterExpressionList `json:"andGroup,omitempty"`// Filter: A primitive filter. In the same FilterExpression, all of the// filter's field names need to be either all dimensions or all 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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (FilterExpression)MarshalJSON

func (sFilterExpression) MarshalJSON() ([]byte,error)

typeFilterExpressionList

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

FilterExpressionList: A list of filter expressions.

func (FilterExpressionList)MarshalJSON

func (sFilterExpressionList) MarshalJSON() ([]byte,error)

typeInListFilter

type InListFilter struct {// CaseSensitive: If true, the string value is case sensitive.CaseSensitivebool `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (InListFilter)MarshalJSON

func (sInListFilter) MarshalJSON() ([]byte,error)

typeListAudienceExportsResponseadded inv0.153.0

type ListAudienceExportsResponse struct {// AudienceExports: Each audience export for a property.AudienceExports []*AudienceExport `json:"audienceExports,omitempty"`// NextPageToken: A token, which can be sent as `page_token` to retrieve the// next page. If this field is omitted, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AudienceExports") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AudienceExports") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListAudienceExportsResponse: A list of all audience exports for a property.

func (ListAudienceExportsResponse)MarshalJSONadded inv0.153.0

func (sListAudienceExportsResponse) MarshalJSON() ([]byte,error)

typeMetadata

type Metadata struct {// Comparisons: The comparison descriptions.Comparisons []*ComparisonMetadata `json:"comparisons,omitempty"`// Dimensions: The dimension descriptions.Dimensions []*DimensionMetadata `json:"dimensions,omitempty"`// Metrics: The metric descriptions.Metrics []*MetricMetadata `json:"metrics,omitempty"`// Name: Resource name of this metadata.Namestring `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. "Comparisons") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Comparisons") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Metadata: The dimensions, metrics and comparisons currently accepted inreporting methods.

func (Metadata)MarshalJSON

func (sMetadata) MarshalJSON() ([]byte,error)

typeMetric

type Metric struct {// Expression: A mathematical expression for derived metrics. For example, the// metric Event count per user is `eventCount/totalUsers`.Expressionstring `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`.Invisiblebool `json:"invisible,omitempty"`// Name: The name of the metric. See the API Metrics// (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)// for the list of metric names supported by core reporting methods such as// `runReport` and `batchRunReports`. See Realtime Metrics// (https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics)// for the list of metric names supported by the `runRealtimeReport` method.// See Funnel Metrics// (https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics)// for the list of metric names supported by the `runFunnelReport` method. If// `expression` is specified, `name` can be any string that you would like// within the allowed character set. For example if `expression` is// `screenPageViews/sessions`, you could call that metric's name =// `viewsPerSession`. Metric names that you choose must match the regular// expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in// `metricFilter`, `orderBys`, and metric `expression`.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Expression") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.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 10metrics.

func (Metric)MarshalJSON

func (sMetric) MarshalJSON() ([]byte,error)

typeMetricCompatibilityadded inv0.55.0

type MetricCompatibility struct {// Compatibility: The compatibility of this metric. If the compatibility is// COMPATIBLE, this metric can be successfully added to the report.//// Possible values://   "COMPATIBILITY_UNSPECIFIED" - Unspecified compatibility.//   "COMPATIBLE" - The dimension or metric is compatible. This dimension or// metric can be successfully added to a report.//   "INCOMPATIBLE" - The dimension or metric is incompatible. This dimension// or metric cannot be successfully added to a report.Compatibilitystring `json:"compatibility,omitempty"`// MetricMetadata: The metric metadata contains the API name for this// compatibility information. The metric metadata also contains other helpful// information like the UI name and description.MetricMetadata *MetricMetadata `json:"metricMetadata,omitempty"`// ForceSendFields is a list of field names (e.g. "Compatibility") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Compatibility") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricCompatibility: The compatibility for a single metric.

func (MetricCompatibility)MarshalJSONadded inv0.55.0

func (sMetricCompatibility) MarshalJSON() ([]byte,error)

typeMetricHeader

type MetricHeader struct {// Name: The metric's name.Namestring `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.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (MetricHeader)MarshalJSON

func (sMetricHeader) MarshalJSON() ([]byte,error)

typeMetricMetadata

type MetricMetadata struct {// ApiName: A metric name. Useable in Metric (#Metric)'s `name`. For example,// `eventCount`.ApiNamestring `json:"apiName,omitempty"`// BlockedReasons: If reasons are specified, your access is blocked to this// metric for this property. API requests from you to this property for this// metric will succeed; however, the report will contain only zeros for this// metric. API requests with metric filters on blocked metrics will fail. If// reasons are empty, you have access to this metric. To learn more, see Access// and data-restriction management// (https://support.google.com/analytics/answer/10851388).//// Possible values://   "BLOCKED_REASON_UNSPECIFIED" - Will never be specified in API response.//   "NO_REVENUE_METRICS" - If present, your access is blocked to revenue// related metrics for this property, and this metric is revenue related.//   "NO_COST_METRICS" - If present, your access is blocked to cost related// metrics for this property, and this metric is cost related.BlockedReasons []string `json:"blockedReasons,omitempty"`// Category: The display name of the category that this metrics belongs to.// Similar dimensions and metrics are categorized together.Categorystring `json:"category,omitempty"`// CustomDefinition: True if the metric is a custom metric for this property.CustomDefinitionbool `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.Descriptionstring `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.Expressionstring `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.Typestring `json:"type,omitempty"`// UiName: This metric's name within the Google Analytics user interface. For// example, `Event count`.UiNamestring `json:"uiName,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiName") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricMetadata: Explains a metric.

func (MetricMetadata)MarshalJSON

func (sMetricMetadata) MarshalJSON() ([]byte,error)

typeMetricOrderBy

type MetricOrderBy struct {// MetricName: A metric name in the request to order by.MetricNamestring `json:"metricName,omitempty"`// ForceSendFields is a list of field names (e.g. "MetricName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricOrderBy: Sorts by metric values.

func (MetricOrderBy)MarshalJSON

func (sMetricOrderBy) MarshalJSON() ([]byte,error)

typeMetricValue

type MetricValue struct {// Value: Measurement value. See MetricHeader for type.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Value") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricValue: The value of a metric.

func (MetricValue)MarshalJSON

func (sMetricValue) MarshalJSON() ([]byte,error)

typeMinuteRangeadded inv0.50.0

type MinuteRange struct {// EndMinutesAgo: The inclusive end minute for the query as a number of minutes// before now. Cannot be before `startMinutesAgo`. For example,// "endMinutesAgo": 15` specifies the report should include event data from// prior to 15 minutes ago. If unspecified, `endMinutesAgo` is defaulted to 0.// Standard Analytics properties can request any minute in the last 30 minutes// of event data (`endMinutesAgo <= 29`), and 360 Analytics properties can// request any minute in the last 60 minutes of event data (`endMinutesAgo <=// 59`).EndMinutesAgoint64 `json:"endMinutesAgo,omitempty"`// Name: Assigns a name to this minute 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, minute ranges are named by their// zero based index in the request: `date_range_0`, `date_range_1`, etc.Namestring `json:"name,omitempty"`// StartMinutesAgo: The inclusive start minute for the query as a number of// minutes before now. For example, "startMinutesAgo": 29` specifies the// report should include event data from 29 minutes ago and after. Cannot be// after `endMinutesAgo`. If unspecified, `startMinutesAgo` is defaulted to 29.// Standard Analytics properties can request up to the last 30 minutes of event// data (`startMinutesAgo <= 29`), and 360 Analytics properties can request up// to the last 60 minutes of event data (`startMinutesAgo <= 59`).StartMinutesAgoint64 `json:"startMinutesAgo,omitempty"`// ForceSendFields is a list of field names (e.g. "EndMinutesAgo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndMinutesAgo") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MinuteRange: A contiguous set of minutes: `startMinutesAgo`,`startMinutesAgo + 1`, ..., `endMinutesAgo`. Requests are allowed up to 2minute ranges.

func (MinuteRange)MarshalJSONadded inv0.50.0

func (sMinuteRange) MarshalJSON() ([]byte,error)

typeNumericFilter

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 equalOperationstring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NumericFilter: Filters for numeric or date values.

func (NumericFilter)MarshalJSON

func (sNumericFilter) MarshalJSON() ([]byte,error)

typeNumericValue

type NumericValue struct {// DoubleValue: Double valueDoubleValuefloat64 `json:"doubleValue,omitempty"`// Int64Value: Integer valueInt64Valueint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NumericValue: To represent a number.

func (NumericValue)MarshalJSON

func (sNumericValue) MarshalJSON() ([]byte,error)

func (*NumericValue)UnmarshalJSON

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

typeOperationadded inv0.153.0

type Operation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *Status `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Operation: This resource represents a long-running operation that is theresult of a network API call.

func (Operation)MarshalJSONadded inv0.153.0

func (sOperation) MarshalJSON() ([]byte,error)

typeOrderBy

type OrderBy struct {// Desc: If true, sorts by descending order.Descbool `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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OrderBy: Order bys define how rows will be sorted in the response. Forexample, ordering rows by descending event count is one ordering, andordering rows by the event name string is a different ordering.

func (OrderBy)MarshalJSON

func (sOrderBy) MarshalJSON() ([]byte,error)

typePivot

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 unique combinations of dimension values to return in// this pivot. The `limit` parameter is required. A `limit` of 10,000 is common// for single pivot requests. The product of the `limit` for each `pivot` in a// `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot// request with `limit: 1000` in each pivot will fail because the product is// `1,000,000`.Limitint64 `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.Offsetint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Pivot: Describes the visible dimension columns and rows in the reportresponse.

func (Pivot)MarshalJSON

func (sPivot) MarshalJSON() ([]byte,error)

typePivotDimensionHeader

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (PivotDimensionHeader)MarshalJSON

func (sPivotDimensionHeader) MarshalJSON() ([]byte,error)

typePivotHeader

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. The total number of rows for this// pivot's fields regardless of how the parameters `offset` and `limit` are// specified in the request.RowCountint64 `json:"rowCount,omitempty"`// ForceSendFields is a list of field names (e.g. "PivotDimensionHeaders") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PivotHeader: Dimensions' values in a single pivot.

func (PivotHeader)MarshalJSON

func (sPivotHeader) MarshalJSON() ([]byte,error)

typePivotOrderBy

type PivotOrderBy struct {// MetricName: In the response to order by, order rows by this column. Must be// a metric name from the request.MetricNamestring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PivotOrderBy: Sorts by a pivot column group.

func (PivotOrderBy)MarshalJSON

func (sPivotOrderBy) MarshalJSON() ([]byte,error)

typePivotSelection

type PivotSelection struct {// DimensionName: Must be a dimension name from the request.DimensionNamestring `json:"dimensionName,omitempty"`// DimensionValue: Order by only when the named dimension is this value.DimensionValuestring `json:"dimensionValue,omitempty"`// ForceSendFields is a list of field names (e.g. "DimensionName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PivotSelection: A pair of dimension names and values. Rows with thisdimension pivot pair are ordered by the metric's value. For example ifpivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rowswill 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 (sPivotSelection) MarshalJSON() ([]byte,error)

typePropertiesAudienceExportsCreateCalladded inv0.153.0

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

func (*PropertiesAudienceExportsCreateCall)Contextadded inv0.153.0

Context sets the context to be used in this call's Do method.

func (*PropertiesAudienceExportsCreateCall)Doadded inv0.153.0

Do executes the "analyticsdata.properties.audienceExports.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*PropertiesAudienceExportsCreateCall)Fieldsadded inv0.153.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesAudienceExportsCreateCall)Headeradded inv0.153.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesAudienceExportsGetCalladded inv0.153.0

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

func (*PropertiesAudienceExportsGetCall)Contextadded inv0.153.0

Context sets the context to be used in this call's Do method.

func (*PropertiesAudienceExportsGetCall)Doadded inv0.153.0

Do executes the "analyticsdata.properties.audienceExports.get" call.Any non-2xx status code is an error. Response headers are in either*AudienceExport.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*PropertiesAudienceExportsGetCall)Fieldsadded inv0.153.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesAudienceExportsGetCall)Headeradded inv0.153.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*PropertiesAudienceExportsGetCall)IfNoneMatchadded inv0.153.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typePropertiesAudienceExportsListCalladded inv0.153.0

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

func (*PropertiesAudienceExportsListCall)Contextadded inv0.153.0

Context sets the context to be used in this call's Do method.

func (*PropertiesAudienceExportsListCall)Doadded inv0.153.0

Do executes the "analyticsdata.properties.audienceExports.list" call.Any non-2xx status code is an error. Response headers are in either*ListAudienceExportsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*PropertiesAudienceExportsListCall)Fieldsadded inv0.153.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesAudienceExportsListCall)Headeradded inv0.153.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*PropertiesAudienceExportsListCall)IfNoneMatchadded inv0.153.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*PropertiesAudienceExportsListCall)PageSizeadded inv0.153.0

PageSize sets the optional parameter "pageSize": The maximum number ofaudience exports to return. The service may return fewer than this value. Ifunspecified, at most 200 audience exports will be returned. The maximumvalue is 1000 (higher values will be coerced to the maximum).

func (*PropertiesAudienceExportsListCall)PageTokenadded inv0.153.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListAudienceExports` call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to`ListAudienceExports` must match the call that provided the page token.

func (*PropertiesAudienceExportsListCall)Pagesadded inv0.153.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typePropertiesAudienceExportsQueryCalladded inv0.153.0

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

func (*PropertiesAudienceExportsQueryCall)Contextadded inv0.153.0

Context sets the context to be used in this call's Do method.

func (*PropertiesAudienceExportsQueryCall)Doadded inv0.153.0

Do executes the "analyticsdata.properties.audienceExports.query" call.Any non-2xx status code is an error. Response headers are in either*QueryAudienceExportResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*PropertiesAudienceExportsQueryCall)Fieldsadded inv0.153.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesAudienceExportsQueryCall)Headeradded inv0.153.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesAudienceExportsServiceadded inv0.153.0

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

funcNewPropertiesAudienceExportsServiceadded inv0.153.0

func NewPropertiesAudienceExportsService(s *Service) *PropertiesAudienceExportsService

func (*PropertiesAudienceExportsService)Createadded inv0.153.0

Create: Creates an audience export for later retrieval. This method quicklyreturns the audience export's resource name and initiates a long runningasynchronous request to form an audience export. To export the users in anaudience export, first create the audience export through this method andthen send the audience resource name to the `QueryAudienceExport` method.See Creating an Audience Export(https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)for an introduction to Audience Exports with examples. An audience export isa snapshot of the users currently in the audience at the time of audienceexport creation. Creating audience exports for one audience on differentdays will return different results as users enter and exit the audience.Audiences in Google Analytics 4 allow you to segment your users in the waysthat are important to your business. To learn more, seehttps://support.google.com/analytics/answer/9267572. Audience exportscontain the users in each audience. Audience Export APIs have some methodsat alpha and other methods at beta stability. The intention is to advancemethods to beta stability after some feedback and adoption. To give yourfeedback on this API, complete the Google Analytics Audience Export APIFeedback (https://forms.gle/EeA5u5LW6PEggtCEA) form.

  • parent: The parent resource where this audience export will be created.Format: `properties/{property}`.

func (*PropertiesAudienceExportsService)Getadded inv0.153.0

Get: Gets configuration metadata about a specific audience export. Thismethod can be used to understand an audience export after it has beencreated. See Creating an Audience Export(https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)for an introduction to Audience Exports with examples. Audience Export APIshave some methods at alpha and other methods at beta stability. Theintention is to advance methods to beta stability after some feedback andadoption. To give your feedback on this API, complete the Google AnalyticsAudience Export API Feedback (https://forms.gle/EeA5u5LW6PEggtCEA) form.

  • name: The audience export resource name. Format:`properties/{property}/audienceExports/{audience_export}`.

func (*PropertiesAudienceExportsService)Listadded inv0.153.0

List: Lists all audience exports for a property. This method can be used foryou to find and reuse existing audience exports rather than creatingunnecessary new audience exports. The same audience can have multipleaudience exports that represent the export of users that were in an audienceon different days. See Creating an Audience Export(https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)for an introduction to Audience Exports with examples. Audience Export APIshave some methods at alpha and other methods at beta stability. Theintention is to advance methods to beta stability after some feedback andadoption. To give your feedback on this API, complete the Google AnalyticsAudience Export API Feedback (https://forms.gle/EeA5u5LW6PEggtCEA) form.

  • parent: All audience exports for this property will be listed in theresponse. Format: `properties/{property}`.

func (*PropertiesAudienceExportsService)Queryadded inv0.153.0

Query: Retrieves an audience export of users. After creating an audience,the users are not immediately available for exporting. First, a request to`CreateAudienceExport` is necessary to create an audience export of users,and then second, this method is used to retrieve the users in the audienceexport. See Creating an Audience Export(https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)for an introduction to Audience Exports with examples. Audiences in GoogleAnalytics 4 allow you to segment your users in the ways that are importantto your business. To learn more, seehttps://support.google.com/analytics/answer/9267572. Audience Export APIshave some methods at alpha and other methods at beta stability. Theintention is to advance methods to beta stability after some feedback andadoption. To give your feedback on this API, complete the Google AnalyticsAudience Export API Feedback (https://forms.gle/EeA5u5LW6PEggtCEA) form.

  • name: The name of the audience export to retrieve users from. Format:`properties/{property}/audienceExports/{audience_export}`.

typePropertiesBatchRunPivotReportsCall

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

func (*PropertiesBatchRunPivotReportsCall)Context

Context sets the context to be used in this call's Do method.

func (*PropertiesBatchRunPivotReportsCall)Do

Do executes the "analyticsdata.properties.batchRunPivotReports" call.Any non-2xx status code is an error. Response headers are in either*BatchRunPivotReportsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*PropertiesBatchRunPivotReportsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesBatchRunPivotReportsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesBatchRunReportsCall

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

func (*PropertiesBatchRunReportsCall)Context

Context sets the context to be used in this call's Do method.

func (*PropertiesBatchRunReportsCall)Do

Do executes the "analyticsdata.properties.batchRunReports" call.Any non-2xx status code is an error. Response headers are in either*BatchRunReportsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*PropertiesBatchRunReportsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesBatchRunReportsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesCheckCompatibilityCalladded inv0.55.0

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

func (*PropertiesCheckCompatibilityCall)Contextadded inv0.55.0

Context sets the context to be used in this call's Do method.

func (*PropertiesCheckCompatibilityCall)Doadded inv0.55.0

Do executes the "analyticsdata.properties.checkCompatibility" call.Any non-2xx status code is an error. Response headers are in either*CheckCompatibilityResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*PropertiesCheckCompatibilityCall)Fieldsadded inv0.55.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesCheckCompatibilityCall)Headeradded inv0.55.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesGetMetadataCall

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

func (*PropertiesGetMetadataCall)Context

Context sets the context to be used in this call's Do method.

func (*PropertiesGetMetadataCall)Do

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

func (*PropertiesGetMetadataCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesGetMetadataCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*PropertiesGetMetadataCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typePropertiesRunPivotReportCall

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

func (*PropertiesRunPivotReportCall)Context

Context sets the context to be used in this call's Do method.

func (*PropertiesRunPivotReportCall)Do

Do executes the "analyticsdata.properties.runPivotReport" call.Any non-2xx status code is an error. Response headers are in either*RunPivotReportResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*PropertiesRunPivotReportCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesRunPivotReportCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesRunRealtimeReportCall

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

func (*PropertiesRunRealtimeReportCall)Context

Context sets the context to be used in this call's Do method.

func (*PropertiesRunRealtimeReportCall)Do

Do executes the "analyticsdata.properties.runRealtimeReport" call.Any non-2xx status code is an error. Response headers are in either*RunRealtimeReportResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*PropertiesRunRealtimeReportCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesRunRealtimeReportCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesRunReportCall

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

func (*PropertiesRunReportCall)Context

Context sets the context to be used in this call's Do method.

func (*PropertiesRunReportCall)Do

Do executes the "analyticsdata.properties.runReport" call.Any non-2xx status code is an error. Response headers are in either*RunReportResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*PropertiesRunReportCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PropertiesRunReportCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typePropertiesService

type PropertiesService struct {AudienceExports *PropertiesAudienceExportsService// contains filtered or unexported fields}

funcNewPropertiesService

func NewPropertiesService(s *Service) *PropertiesService

func (*PropertiesService)BatchRunPivotReports

func (r *PropertiesService) BatchRunPivotReports(propertyidstring, batchrunpivotreportsrequest *BatchRunPivotReportsRequest) *PropertiesBatchRunPivotReportsCall

BatchRunPivotReports: Returns multiple pivot reports in a batch. All reportsmust be for the same Google Analytics property.

  • property: A Google Analytics property identifier whose events are tracked.Specified in the URL path and not the body. To learn more, see where tofind your Property ID(https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).This property must be specified for the batch. The property withinRunPivotReportRequest may either be unspecified or consistent with thisproperty. Example: properties/1234.

func (*PropertiesService)BatchRunReports

func (r *PropertiesService) BatchRunReports(propertyidstring, batchrunreportsrequest *BatchRunReportsRequest) *PropertiesBatchRunReportsCall

BatchRunReports: Returns multiple reports in a batch. All reports must befor the same Google Analytics property.

  • property: A Google Analytics property identifier whose events are tracked.Specified in the URL path and not the body. To learn more, see where tofind your Property ID(https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).This property must be specified for the batch. The property withinRunReportRequest may either be unspecified or consistent with thisproperty. Example: properties/1234.

func (*PropertiesService)CheckCompatibilityadded inv0.55.0

func (r *PropertiesService) CheckCompatibility(propertyidstring, checkcompatibilityrequest *CheckCompatibilityRequest) *PropertiesCheckCompatibilityCall

CheckCompatibility: This compatibility method lists dimensions and metricsthat can be added to a report request and maintain compatibility. Thismethod fails if the request's dimensions and metrics are incompatible. InGoogle Analytics, reports fail if they request incompatible dimensionsand/or metrics; in that case, you will need to remove dimensions and/ormetrics from the incompatible report until the report is compatible. TheRealtime and Core reports have different compatibility rules. This methodchecks compatibility for Core reports.

func (*PropertiesService)GetMetadata

func (r *PropertiesService) GetMetadata(nameidstring) *PropertiesGetMetadataCall

GetMetadata: Returns metadata for dimensions and metrics available inreporting methods. Used to explore the dimensions and metrics. In thismethod, a Google Analytics property identifier is specified in the request,and the metadata response includes Custom dimensions and metrics as well asUniversal metadata. For example if a custom metric with parameter name`levels_unlocked` is registered to a property, the Metadata response willcontain `customEvent:levels_unlocked`. Universal metadata are dimensions andmetrics applicable to any property such as `country` and `totalUsers`.

  • name: The resource name of the metadata to retrieve. This name field isspecified in the URL path and not URL parameters. Property is a numericGoogle Analytics property identifier. To learn more, see where to findyour Property ID(https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).Example: properties/1234/metadata Set the Property ID to 0 for dimensionsand metrics common to all properties. In this special mode, this methodwill not return custom dimensions and metrics.

func (*PropertiesService)RunPivotReport

func (r *PropertiesService) RunPivotReport(propertyidstring, runpivotreportrequest *RunPivotReportRequest) *PropertiesRunPivotReportCall

RunPivotReport: Returns a customized pivot report of your Google Analyticsevent data. Pivot reports are more advanced and expressive formats thanregular reports. In a pivot report, dimensions are only visible if they areincluded in a pivot. Multiple pivots can be specified to further dissectyour data.

func (*PropertiesService)RunRealtimeReport

func (r *PropertiesService) RunRealtimeReport(propertyidstring, runrealtimereportrequest *RunRealtimeReportRequest) *PropertiesRunRealtimeReportCall

RunRealtimeReport: Returns a customized report of realtime event data foryour property. Events appear in realtime reports seconds after they havebeen sent to the Google Analytics. Realtime reports show events and usagedata for the periods of time ranging from the present moment to 30 minutesago (up to 60 minutes for Google Analytics 360 properties). For a guide toconstructing realtime requests & understanding responses, see Creating aRealtime Report(https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).

func (*PropertiesService)RunReport

func (r *PropertiesService) RunReport(propertyidstring, runreportrequest *RunReportRequest) *PropertiesRunReportCall

RunReport: Returns a customized report of your Google Analytics event data.Reports contain statistics derived from data collected by the GoogleAnalytics tracking code. The data returned from the API is as a table withcolumns for the requested dimensions and metrics. Metrics are individualmeasurements of user activity on your property, such as active users orevent count. Dimensions break down metrics across some common criteria, suchas country or event name. For a guide to constructing requests &understanding responses, see Creating a Report(https://developers.google.com/analytics/devguides/reporting/data/v1/basics).

typePropertyQuota

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"`// PotentiallyThresholdedRequestsPerHour: Analytics Properties can send up to// 120 requests with potentially thresholded dimensions per hour. In a batch// request, each report request is individually counted for this quota if the// request contains potentially thresholded dimensions.PotentiallyThresholdedRequestsPerHour *QuotaStatus `json:"potentiallyThresholdedRequestsPerHour,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 200,000 tokens per// day; Analytics 360 Properties can use 2,000,000 tokens per day. Most// requests consume fewer than 10 tokens.TokensPerDay *QuotaStatus `json:"tokensPerDay,omitempty"`// TokensPerHour: Standard Analytics Properties can use up to 40,000 tokens per// hour; Analytics 360 Properties can use 400,000 tokens per hour. An API// request consumes a single number of tokens, and that number is deducted from// all of the hourly, daily, and per project hourly quotas.TokensPerHour *QuotaStatus `json:"tokensPerHour,omitempty"`// TokensPerProjectPerHour: Analytics Properties can use up to 35% of their// tokens per project per hour. This amounts to standard Analytics Properties// can use up to 14,000 tokens per project per hour, and Analytics 360// Properties can use 140,000 tokens per project per hour. An API request// consumes a single number of tokens, and that number is deducted from all of// the hourly, daily, and per project hourly quotas.TokensPerProjectPerHour *QuotaStatus `json:"tokensPerProjectPerHour,omitempty"`// ForceSendFields is a list of field names (e.g. "ConcurrentRequests") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (PropertyQuota)MarshalJSON

func (sPropertyQuota) MarshalJSON() ([]byte,error)

typeQueryAudienceExportRequestadded inv0.153.0

type QueryAudienceExportRequest struct {// Limit: Optional. The number of rows to return. If unspecified, 10,000 rows// are returned. The API returns a maximum of 250,000 rows per request, no// matter how many you ask for. `limit` must be positive. The API can also// return fewer rows than the requested `limit`, if there aren't as many// dimension values as the `limit`. To learn more about this pagination// parameter, see Pagination// (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).Limitint64 `json:"limit,omitempty,string"`// Offset: Optional. The row count of the start row. The first row is counted// as row 0. When paging, the first request does not specify offset; or// equivalently, sets offset to 0; the first request returns the first `limit`// of rows. The second request sets offset to the `limit` of the first request;// the second request returns the second `limit` of rows. To learn more about// this pagination parameter, see Pagination// (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).Offsetint64 `json:"offset,omitempty,string"`// ForceSendFields is a list of field names (e.g. "Limit") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Limit") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QueryAudienceExportRequest: A request to list users in an audience export.

func (QueryAudienceExportRequest)MarshalJSONadded inv0.153.0

func (sQueryAudienceExportRequest) MarshalJSON() ([]byte,error)

typeQueryAudienceExportResponseadded inv0.153.0

type QueryAudienceExportResponse struct {// AudienceExport: Configuration data about AudienceExport being queried.// Returned to help interpret the audience rows in this response. For example,// the dimensions in this AudienceExport correspond to the columns in the// AudienceRows.AudienceExport *AudienceExport `json:"audienceExport,omitempty"`// AudienceRows: Rows for each user in an audience export. The number of rows// in this response will be less than or equal to request's page size.AudienceRows []*V1betaAudienceRow `json:"audienceRows,omitempty"`// RowCount: The total number of rows in the AudienceExport result. `rowCount`// is independent of the number of rows returned in the response, the `limit`// request parameter, and the `offset` request parameter. For example if a// query returns 175 rows and includes `limit` of 50 in the API request, the// response will contain `rowCount` of 175 but only 50 rows. To learn more// about this pagination parameter, see Pagination// (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).RowCountint64 `json:"rowCount,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AudienceExport") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AudienceExport") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QueryAudienceExportResponse: A list of users in an audience export.

func (QueryAudienceExportResponse)MarshalJSONadded inv0.153.0

func (sQueryAudienceExportResponse) MarshalJSON() ([]byte,error)

typeQuotaStatus

type QuotaStatus struct {// Consumed: Quota consumed by this request.Consumedint64 `json:"consumed,omitempty"`// Remaining: Quota remaining after this request.Remainingint64 `json:"remaining,omitempty"`// ForceSendFields is a list of field names (e.g. "Consumed") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QuotaStatus: Current state for a particular quota group.

func (QuotaStatus)MarshalJSON

func (sQuotaStatus) MarshalJSON() ([]byte,error)

typeResponseMetaData

type ResponseMetaData struct {// CurrencyCode: The currency code used in this report. Intended to be used in// formatting currency metrics like `purchaseRevenue` for visualization. If// currency_code was specified in the request, this response parameter will// echo the request parameter; otherwise, this response parameter is the// property's current currency_code. Currency codes are string encodings of// currency types from the ISO 4217 standard// (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY".// To learn more, seehttps://support.google.com/analytics/answer/9796179.CurrencyCodestring `json:"currencyCode,omitempty"`// DataLossFromOtherRow: If true, indicates some buckets of dimension// combinations are rolled into "(other)" row. This can happen for high// cardinality reports. The metadata parameter dataLossFromOtherRow is// populated based on the aggregated data table used in the report. The// parameter will be accurately populated regardless of the filters and limits// in the report. For example, the (other) row could be dropped from the report// because the request contains a filter on sessionSource = google. This// parameter will still be populated if data loss from other row was present in// the input aggregate data used to generate this report. To learn more, see// About the (other) row and data sampling// (https://support.google.com/analytics/answer/13208658#reports).DataLossFromOtherRowbool `json:"dataLossFromOtherRow,omitempty"`// EmptyReason: If empty reason is specified, the report is empty for this// reason.EmptyReasonstring `json:"emptyReason,omitempty"`// SamplingMetadatas: If this report results is sampled// (https://support.google.com/analytics/answer/13331292), this describes the// percentage of events used in this report. One `samplingMetadatas` is// populated for each date range. Each `samplingMetadatas` corresponds to a// date range in order that date ranges were specified in the request. However// if the results are not sampled, this field will not be defined.SamplingMetadatas []*SamplingMetadata `json:"samplingMetadatas,omitempty"`// SchemaRestrictionResponse: Describes the schema restrictions actively// enforced in creating this report. To learn more, see Access and// data-restriction management// (https://support.google.com/analytics/answer/10851388).SchemaRestrictionResponse *SchemaRestrictionResponse `json:"schemaRestrictionResponse,omitempty"`// SubjectToThresholding: If `subjectToThresholding` is true, this report is// subject to thresholding and only returns data that meets the minimum// aggregation thresholds. It is possible for a request to be subject to// thresholding thresholding and no data is absent from the report, and this// happens when all data is above the thresholds. To learn more, see Data// thresholds (https://support.google.com/analytics/answer/9383630).SubjectToThresholdingbool `json:"subjectToThresholding,omitempty"`// TimeZone: The property's current timezone. Intended to be used to interpret// time-based dimensions like `hour` and `minute`. Formatted as strings from// the IANA Time Zone database (https://www.iana.org/time-zones); for example// "America/New_York" or "Asia/Tokyo".TimeZonestring `json:"timeZone,omitempty"`// ForceSendFields is a list of field names (e.g. "CurrencyCode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CurrencyCode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (ResponseMetaData)MarshalJSON

func (sResponseMetaData) MarshalJSON() ([]byte,error)

typeRow

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.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 (sRow) MarshalJSON() ([]byte,error)

typeRunPivotReportRequest

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"`// Comparisons: Optional. The configuration of comparisons requested and// displayed. The request requires both a comparisons field and a comparisons// dimension to receive a comparison column in the response.Comparisons []*Comparison `json:"comparisons,omitempty"`// CurrencyCode: A currency code in ISO4217 format, such as "AED", "USD",// "JPY". If the field is empty, the report uses the property's default// currency.CurrencyCodestring `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"`// 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. Regardless of this `keep_empty_rows`// setting, only data recorded by the Google Analytics property can be// displayed in a report. For example if a property never logs a `purchase`// event, then a query for the `eventName` dimension and `eventCount` metric// will not have a row eventName: "purchase" and eventCount: 0.KeepEmptyRowsbool `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"`// Property: A Google Analytics property identifier whose events are tracked.// Specified in the URL path and not the body. To learn more, see where to find// your Property ID// (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).// Within a batch request, this property should either be unspecified or// consistent with the batch-level property. Example: properties/1234Propertystring `json:"property,omitempty"`// ReturnPropertyQuota: Toggles whether to return the current state of this// Google Analytics property's quota. Quota is returned in PropertyQuota// (#PropertyQuota).ReturnPropertyQuotabool `json:"returnPropertyQuota,omitempty"`// ForceSendFields is a list of field names (e.g. "CohortSpec") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RunPivotReportRequest: The request to generate a pivot report.

func (RunPivotReportRequest)MarshalJSON

func (sRunPivotReportRequest) MarshalJSON() ([]byte,error)

typeRunPivotReportResponse

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"`// Kind: Identifies what kind of resource this message is. This `kind` is// always the fixed string "analyticsData#runPivotReport". Useful to// distinguish between response types in JSON.Kindstring `json:"kind,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 Google 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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (RunPivotReportResponse)MarshalJSON

func (sRunPivotReportResponse) MarshalJSON() ([]byte,error)

typeRunRealtimeReportRequest

type RunRealtimeReportRequest struct {// DimensionFilter: The filter clause of dimensions. 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,000 rows are// returned. The API returns a maximum of 250,000 rows per request, no matter// how many you ask for. `limit` must be positive. The API can also return// fewer rows than the requested `limit`, if there aren't as many dimension// values as the `limit`. For instance, there are fewer than 300 possible// values for the dimension `country`, so when reporting on only `country`, you// can't get more than 300 rows, even if you set `limit` to a higher value.Limitint64 `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. Dimensions cannot be used in this// filter.MetricFilter *FilterExpression `json:"metricFilter,omitempty"`// Metrics: The metrics requested and displayed.Metrics []*Metric `json:"metrics,omitempty"`// MinuteRanges: The minute ranges of event data to read. If unspecified, one// minute range for the last 30 minutes will be used. If multiple minute ranges// are requested, each response row will contain a zero based minute range// index. If two minute ranges overlap, the event data for the overlapping// minutes is included in the response rows for both minute ranges.MinuteRanges []*MinuteRange `json:"minuteRanges,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// Google Analytics property's Realtime quota. Quota is returned in// PropertyQuota (#PropertyQuota).ReturnPropertyQuotabool `json:"returnPropertyQuota,omitempty"`// ForceSendFields is a list of field names (e.g. "DimensionFilter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RunRealtimeReportRequest: The request to generate a realtime report.

func (RunRealtimeReportRequest)MarshalJSON

func (sRunRealtimeReportRequest) MarshalJSON() ([]byte,error)

typeRunRealtimeReportResponse

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"`// Kind: Identifies what kind of resource this message is. This `kind` is// always the fixed string "analyticsData#runRealtimeReport". Useful to// distinguish between response types in JSON.Kindstring `json:"kind,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 Google Analytics property's Realtime quota state// including this request.PropertyQuota *PropertyQuota `json:"propertyQuota,omitempty"`// RowCount: The total number of rows in the query result. `rowCount` is// independent of the number of rows returned in the response and the `limit`// request parameter. For example if a query returns 175 rows and includes// `limit` of 50 in the API request, the response will contain `rowCount` of// 175 but only 50 rows.RowCountint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RunRealtimeReportResponse: The response realtime report table correspondingto a request.

func (RunRealtimeReportResponse)MarshalJSON

func (sRunRealtimeReportResponse) MarshalJSON() ([]byte,error)

typeRunReportRequest

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"`// Comparisons: Optional. The configuration of comparisons requested and// displayed. The request only requires a comparisons field in order to receive// a comparison column in the response.Comparisons []*Comparison `json:"comparisons,omitempty"`// CurrencyCode: A currency code in ISO4217 format, such as "AED", "USD",// "JPY". If the field is empty, the report uses the property's default// currency.CurrencyCodestring `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: Dimension filters let you ask for only specific dimension// values in the report. To learn more, see Fundamentals of Dimension Filters// (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)// for examples. Metrics cannot be used in this filter.DimensionFilter *FilterExpression `json:"dimensionFilter,omitempty"`// Dimensions: The dimensions requested and displayed.Dimensions []*Dimension `json:"dimensions,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. Regardless of this `keep_empty_rows`// setting, only data recorded by the Google Analytics property can be// displayed in a report. For example if a property never logs a `purchase`// event, then a query for the `eventName` dimension and `eventCount` metric// will not have a row eventName: "purchase" and eventCount: 0.KeepEmptyRowsbool `json:"keepEmptyRows,omitempty"`// Limit: The number of rows to return. If unspecified, 10,000 rows are// returned. The API returns a maximum of 250,000 rows per request, no matter// how many you ask for. `limit` must be positive. The API can also return// fewer rows than the requested `limit`, if there aren't as many dimension// values as the `limit`. For instance, there are fewer than 300 possible// values for the dimension `country`, so when reporting on only `country`, you// can't get more than 300 rows, even if you set `limit` to a higher value. To// learn more about this pagination parameter, see Pagination// (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).Limitint64 `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)". Aggregates including both comparisons and// multiple date ranges will be aggregated based on the date ranges.//// 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 after aggregating the// report's rows, similar to SQL having-clause. 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.// When paging, the first request does not specify offset; or equivalently,// sets offset to 0; the first request returns the first `limit` of rows. The// second request sets offset to the `limit` of the first request; the second// request returns the second `limit` of rows. To learn more about this// pagination parameter, see Pagination// (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).Offsetint64 `json:"offset,omitempty,string"`// OrderBys: Specifies how rows are ordered in the response. Requests including// both comparisons and multiple date ranges will have order bys applied on the// comparisons.OrderBys []*OrderBy `json:"orderBys,omitempty"`// Property: A Google Analytics property identifier whose events are tracked.// Specified in the URL path and not the body. To learn more, see where to find// your Property ID// (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).// Within a batch request, this property should either be unspecified or// consistent with the batch-level property. Example: properties/1234Propertystring `json:"property,omitempty"`// ReturnPropertyQuota: Toggles whether to return the current state of this// Google Analytics property's quota. Quota is returned in PropertyQuota// (#PropertyQuota).ReturnPropertyQuotabool `json:"returnPropertyQuota,omitempty"`// ForceSendFields is a list of field names (e.g. "CohortSpec") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RunReportRequest: The request to generate a report.

func (RunReportRequest)MarshalJSON

func (sRunReportRequest) MarshalJSON() ([]byte,error)

typeRunReportResponse

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"`// Kind: Identifies what kind of resource this message is. This `kind` is// always the fixed string "analyticsData#runReport". Useful to distinguish// between response types in JSON.Kindstring `json:"kind,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 Google Analytics property's quota state including this// request.PropertyQuota *PropertyQuota `json:"propertyQuota,omitempty"`// RowCount: The total number of rows in the query result. `rowCount` is// independent of the number of rows returned in the response, the `limit`// request parameter, and the `offset` request parameter. For example if a// query returns 175 rows and includes `limit` of 50 in the API request, the// response will contain `rowCount` of 175 but only 50 rows. To learn more// about this pagination parameter, see Pagination// (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).RowCountint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RunReportResponse: The response report table corresponding to a request.

func (RunReportResponse)MarshalJSON

func (sRunReportResponse) MarshalJSON() ([]byte,error)

typeSamplingMetadataadded inv0.151.0

type SamplingMetadata struct {// SamplesReadCount: The total number of events read in this sampled report for// a date range. This is the size of the subset this property's data that was// analyzed in this report.SamplesReadCountint64 `json:"samplesReadCount,omitempty,string"`// SamplingSpaceSize: The total number of events present in this property's// data that could have been analyzed in this report for a date range. Sampling// uncovers the meaningful information about the larger data set, and this is// the size of the larger data set. To calculate the percentage of available// data that was used in this report, compute// `samplesReadCount/samplingSpaceSize`.SamplingSpaceSizeint64 `json:"samplingSpaceSize,omitempty,string"`// ForceSendFields is a list of field names (e.g. "SamplesReadCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SamplesReadCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SamplingMetadata: If this report results is sampled(https://support.google.com/analytics/answer/13331292), this describes thepercentage of events used in this report. Sampling is the practice ofanalyzing a subset of all data in order to uncover the meaningfulinformation in the larger data set.

func (SamplingMetadata)MarshalJSONadded inv0.151.0

func (sSamplingMetadata) MarshalJSON() ([]byte,error)

typeSchemaRestrictionResponseadded inv0.60.0

type SchemaRestrictionResponse struct {// ActiveMetricRestrictions: All restrictions actively enforced in creating the// report. For example, `purchaseRevenue` always has the restriction type// `REVENUE_DATA`. However, this active response restriction is only populated// if the user's custom role disallows access to `REVENUE_DATA`.ActiveMetricRestrictions []*ActiveMetricRestriction `json:"activeMetricRestrictions,omitempty"`// ForceSendFields is a list of field names (e.g. "ActiveMetricRestrictions")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActiveMetricRestrictions") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SchemaRestrictionResponse: The schema restrictions actively enforced increating this report. To learn more, see Access and data-restrictionmanagement (https://support.google.com/analytics/answer/10851388).

func (SchemaRestrictionResponse)MarshalJSONadded inv0.60.0

func (sSchemaRestrictionResponse) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProperties *PropertiesService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewService

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

NewService creates a new Service.

typeStatusadded inv0.153.0

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSONadded inv0.153.0

func (sStatus) MarshalJSON() ([]byte,error)

typeStringFilter

type StringFilter struct {// CaseSensitive: If true, the string value is case sensitive.CaseSensitivebool `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 match for the regular expression with the string// value.//   "PARTIAL_REGEXP" - Partial match for the regular expression with the// string value.MatchTypestring `json:"matchType,omitempty"`// Value: The string value used for the matching.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "CaseSensitive") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

StringFilter: The filter for string

func (StringFilter)MarshalJSON

func (sStringFilter) MarshalJSON() ([]byte,error)

typeV1betaAudienceDimensionadded inv0.153.0

type V1betaAudienceDimension struct {// DimensionName: Optional. The API name of the dimension. See the API// Dimensions// (https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions)// for the list of dimension names.DimensionNamestring `json:"dimensionName,omitempty"`// ForceSendFields is a list of field names (e.g. "DimensionName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

V1betaAudienceDimension: An audience dimension is a user attribute. Specificuser attributed are requested and then later returned in the`QueryAudienceExportResponse`.

func (V1betaAudienceDimension)MarshalJSONadded inv0.153.0

func (sV1betaAudienceDimension) MarshalJSON() ([]byte,error)

typeV1betaAudienceDimensionValueadded inv0.153.0

type V1betaAudienceDimensionValue struct {// Value: Value as a string if the dimension type is a string.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Value") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

V1betaAudienceDimensionValue: The value of a dimension.

func (V1betaAudienceDimensionValue)MarshalJSONadded inv0.153.0

func (sV1betaAudienceDimensionValue) MarshalJSON() ([]byte,error)

typeV1betaAudienceRowadded inv0.153.0

type V1betaAudienceRow struct {// DimensionValues: Each dimension value attribute for an audience user. One// dimension value will be added for each dimension column requested.DimensionValues []*V1betaAudienceDimensionValue `json:"dimensionValues,omitempty"`// ForceSendFields is a list of field names (e.g. "DimensionValues") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

V1betaAudienceRow: Dimension value attributes for the audience user row.

func (V1betaAudienceRow)MarshalJSONadded inv0.153.0

func (sV1betaAudienceRow) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp