chromeuxreport
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package chromeuxreport provides access to the Chrome UX Report API.
For product documentation, see:https://developers.google.com/web/tools/chrome-user-experience-report/api/reference
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/chromeuxreport/v1"...ctx := context.Background()chromeuxreportService, err := chromeuxreport.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¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
chromeuxreportService, err := chromeuxreport.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, ...)chromeuxreportService, err := chromeuxreport.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- type Bin
- type CollectionPeriod
- type Date
- type FractionTimeseries
- type HistoryKey
- type HistoryRecord
- type Key
- type Metric
- type MetricTimeseries
- type Percentiles
- type QueryHistoryRequest
- type QueryHistoryResponse
- type QueryRequest
- type QueryResponse
- type Record
- type RecordsQueryHistoryRecordCall
- func (c *RecordsQueryHistoryRecordCall) Context(ctx context.Context) *RecordsQueryHistoryRecordCall
- func (c *RecordsQueryHistoryRecordCall) Do(opts ...googleapi.CallOption) (*QueryHistoryResponse, error)
- func (c *RecordsQueryHistoryRecordCall) Fields(s ...googleapi.Field) *RecordsQueryHistoryRecordCall
- func (c *RecordsQueryHistoryRecordCall) Header() http.Header
- type RecordsQueryRecordCall
- func (c *RecordsQueryRecordCall) Context(ctx context.Context) *RecordsQueryRecordCall
- func (c *RecordsQueryRecordCall) Do(opts ...googleapi.CallOption) (*QueryResponse, error)
- func (c *RecordsQueryRecordCall) Fields(s ...googleapi.Field) *RecordsQueryRecordCall
- func (c *RecordsQueryRecordCall) Header() http.Header
- type RecordsService
- type Service
- type TimeseriesBin
- type TimeseriesPercentiles
- type UrlNormalization
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeBin¶
type Bin struct {// Density: The proportion of users that experienced this bin's value for the// given metric.Density interface{} `json:"density,omitempty"`// End: End is the end of the data bin. If end is not populated, then the bin// has no end and is valid from start to +inf.End interface{} `json:"end,omitempty"`// Start: Start is the beginning of the data bin.Start interface{} `json:"start,omitempty"`// ForceSendFields is a list of field names (e.g. "Density") 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. "Density") 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:"-"`}Bin: A bin is a discrete portion of data spanning from start to end, or ifno end is given, then from start to +inf. A bin's start and end values aregiven in the value type of the metric it represents. For example, "firstcontentful paint" is measured in milliseconds and exposed as ints, thereforeits metric bins will use int32s for its start and end types. However,"cumulative layout shift" is measured in unitless decimals and is exposed asa decimal encoded as a string, therefore its metric bins will use stringsfor its value type.
func (Bin)MarshalJSON¶
typeCollectionPeriod¶added inv0.98.0
type CollectionPeriod struct {// FirstDate: The first day in the collection period, inclusive.FirstDate *Date `json:"firstDate,omitempty"`// LastDate: The last day in the collection period, inclusive.LastDate *Date `json:"lastDate,omitempty"`// ForceSendFields is a list of field names (e.g. "FirstDate") 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. "FirstDate") 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:"-"`}CollectionPeriod: The collection period is a date range which includes the`first` and `last` day.
func (CollectionPeriod)MarshalJSON¶added inv0.98.0
func (sCollectionPeriod) MarshalJSON() ([]byte,error)
typeDate¶added inv0.98.0
type Date struct {// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,// or 0 to specify a year by itself or a year and month where the day isn't// significant.Dayint64 `json:"day,omitempty"`// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without// a month and day.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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:"-"`}Date: Represents a whole or partial calendar date, such as a birthday. Thetime of day and time zone are either specified elsewhere or areinsignificant. The date is relative to the Gregorian Calendar. This canrepresent one of the following: * A full date, with non-zero year, month,and day values. * A month and day, with a zero year (for example, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp
func (Date)MarshalJSON¶added inv0.98.0
typeFractionTimeseries¶added inv0.155.0
type FractionTimeseries struct {// Fractions: Values between 0.0 and 1.0 (inclusive) and NaN.Fractions []float64 `json:"fractions,omitempty"`// ForceSendFields is a list of field names (e.g. "Fractions") 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. "Fractions") 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:"-"`}FractionTimeseries: For enum metrics, provides fraction timeseries which addup to approximately 1.0 per entry (k-th element into the repeated fractionsfield for any k <= len) across fraction_timeseries.
func (FractionTimeseries)MarshalJSON¶added inv0.155.0
func (sFractionTimeseries) MarshalJSON() ([]byte,error)
func (*FractionTimeseries)UnmarshalJSON¶added inv0.155.0
func (s *FractionTimeseries) UnmarshalJSON(data []byte)error
typeHistoryKey¶added inv0.110.0
type HistoryKey struct {// FormFactor: The form factor is the device class that all users used to// access the site for this record. If the form factor is unspecified, then// aggregated data over all form factors will be returned.//// Possible values:// "ALL_FORM_FACTORS" - The default value, representing all device classes.// "PHONE" - The device class representing a "mobile"/"phone" sized client.// "DESKTOP" - The device class representing a "desktop"/"laptop" type full// size client.// "TABLET" - The device class representing a "tablet" type client.FormFactorstring `json:"formFactor,omitempty"`// Origin: Origin specifies the origin that this record is for. Note: When// specifying an origin, data for loads under this origin over all pages are// aggregated into origin level user experience data.Originstring `json:"origin,omitempty"`// Url: Url specifies a specific url that this record is for. This url should// be normalized, following the normalization actions taken in the request to// increase the chances of successful lookup. Note: When specifying a "url"// only data for that specific url will be aggregated.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "FormFactor") 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. "FormFactor") 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:"-"`}HistoryKey: Key defines all the dimensions that identify this record asunique.
func (HistoryKey)MarshalJSON¶added inv0.110.0
func (sHistoryKey) MarshalJSON() ([]byte,error)
typeHistoryRecord¶added inv0.110.0
type HistoryRecord struct {// CollectionPeriods: The collection periods indicate when each of the data// points reflected in the time series data in metrics was collected. Note that// all the time series share the same collection periods, and it is enforced in// the CrUX pipeline that every time series has the same number of data points.CollectionPeriods []*CollectionPeriod `json:"collectionPeriods,omitempty"`// Key: Key defines all of the unique querying parameters needed to look up a// user experience history record.Key *HistoryKey `json:"key,omitempty"`// Metrics: Metrics is the map of user experience time series data available// for the record defined in the key field. Metrics are keyed on the metric// name. Allowed key values: ["first_contentful_paint", "first_input_delay",// "largest_contentful_paint", "cumulative_layout_shift",// "experimental_time_to_first_byte", "experimental_interaction_to_next_paint"]Metrics map[string]MetricTimeseries `json:"metrics,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionPeriods") 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. "CollectionPeriods") 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:"-"`}HistoryRecord: HistoryRecord is a timeseries of Chrome UX Report data. Itcontains user experience statistics for a single url pattern and a set ofdimensions.
func (HistoryRecord)MarshalJSON¶added inv0.110.0
func (sHistoryRecord) MarshalJSON() ([]byte,error)
typeKey¶
type Key struct {// EffectiveConnectionType: The effective connection type is the general// connection class that all users experienced for this record. This field uses// the values ["offline", "slow-2G", "2G", "3G", "4G"] as specified in://https://wicg.github.io/netinfo/#effective-connection-types If the effective// connection type is unspecified, then aggregated data over all effective// connection types will be returned.EffectiveConnectionTypestring `json:"effectiveConnectionType,omitempty"`// FormFactor: The form factor is the device class that all users used to// access the site for this record. If the form factor is unspecified, then// aggregated data over all form factors will be returned.//// Possible values:// "ALL_FORM_FACTORS" - The default value, representing all device classes.// "PHONE" - The device class representing a "mobile"/"phone" sized client.// "DESKTOP" - The device class representing a "desktop"/"laptop" type full// size client.// "TABLET" - The device class representing a "tablet" type client.FormFactorstring `json:"formFactor,omitempty"`// Origin: Origin specifies the origin that this record is for. Note: When// specifying an origin, data for loads under this origin over all pages are// aggregated into origin level user experience data.Originstring `json:"origin,omitempty"`// Url: Url specifies a specific url that this record is for. Note: When// specifying a "url" only data for that specific url will be aggregated.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "EffectiveConnectionType") 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. "EffectiveConnectionType") 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:"-"`}Key: Key defines all the dimensions that identify this record as unique.
func (Key)MarshalJSON¶
typeMetric¶
type Metric struct {// Fractions: For enum metrics, provides fractions which add up to// approximately 1.0.Fractions map[string]float64 `json:"fractions,omitempty"`// Histogram: The histogram of user experiences for a metric. The histogram// will have at least one bin and the densities of all bins will add up to ~1.Histogram []*Bin `json:"histogram,omitempty"`// Percentiles: Commonly useful percentiles of the Metric. The value type for// the percentiles will be the same as the value types given for the Histogram// bins.Percentiles *Percentiles `json:"percentiles,omitempty"`// ForceSendFields is a list of field names (e.g. "Fractions") 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. "Fractions") 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: A `metric` is a set of user experience data for a single webperformance metric, like "first contentful paint". It contains a summaryhistogram of real world Chrome usage as a series of `bins`.
func (Metric)MarshalJSON¶
typeMetricTimeseries¶added inv0.110.0
type MetricTimeseries struct {// FractionTimeseries: Mapping from labels to timeseries of fractions// attributed to this label.FractionTimeseries map[string]FractionTimeseries `json:"fractionTimeseries,omitempty"`// HistogramTimeseries: The histogram of user experiences for a metric. The// histogram will have at least one bin and the densities of all bins will add// up to ~1, for each timeseries entry.HistogramTimeseries []*TimeseriesBin `json:"histogramTimeseries,omitempty"`// PercentilesTimeseries: Commonly useful percentiles of the Metric. The value// type for the percentiles will be the same as the value types given for the// Histogram bins.PercentilesTimeseries *TimeseriesPercentiles `json:"percentilesTimeseries,omitempty"`// ForceSendFields is a list of field names (e.g. "FractionTimeseries") 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. "FractionTimeseries") 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:"-"`}MetricTimeseries: A `metric timeseries` is a set of user experience data fora single web performance metric, like "first contentful paint". It containsa summary histogram of real world Chrome usage as a series of `bins`, whereeach bin has density values for a particular time period.
func (MetricTimeseries)MarshalJSON¶added inv0.110.0
func (sMetricTimeseries) MarshalJSON() ([]byte,error)
typePercentiles¶
type Percentiles struct {// P75: 75% of users experienced the given metric at or below this value.P75 interface{} `json:"p75,omitempty"`// ForceSendFields is a list of field names (e.g. "P75") 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. "P75") 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:"-"`}Percentiles: Percentiles contains synthetic values of a metric at a givenstatistical percentile. These are used for estimating a metric's value asexperienced by a percentage of users out of the total number of users.
func (Percentiles)MarshalJSON¶
func (sPercentiles) MarshalJSON() ([]byte,error)
typeQueryHistoryRequest¶added inv0.110.0
type QueryHistoryRequest struct {// CollectionPeriodCount: The number of collection periods to return. If not// specified, the default is 25. If present, must be in the range [1, 40].CollectionPeriodCountint64 `json:"collectionPeriodCount,omitempty"`// FormFactor: The form factor is a query dimension that specifies the device// class that the record's data should belong to. Note: If no form factor is// specified, then a special record with aggregated data over all form factors// will be returned.//// Possible values:// "ALL_FORM_FACTORS" - The default value, representing all device classes.// "PHONE" - The device class representing a "mobile"/"phone" sized client.// "DESKTOP" - The device class representing a "desktop"/"laptop" type full// size client.// "TABLET" - The device class representing a "tablet" type client.FormFactorstring `json:"formFactor,omitempty"`// Metrics: The metrics that should be included in the response. If none are// specified then any metrics found will be returned. Allowed values:// ["first_contentful_paint", "first_input_delay", "largest_contentful_paint",// "cumulative_layout_shift", "experimental_time_to_first_byte",// "experimental_interaction_to_next_paint"]Metrics []string `json:"metrics,omitempty"`// Origin: The url pattern "origin" refers to a url pattern that is the origin// of a website. Examples: "https://example.com", "https://cloud.google.com"Originstring `json:"origin,omitempty"`// Url: The url pattern "url" refers to a url pattern that is any arbitrary// url. Examples: "https://example.com/",// "https://cloud.google.com/why-google-cloud/"Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionPeriodCount") 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. "CollectionPeriodCount") 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:"-"`}QueryHistoryRequest: Request payload sent by a physical web client. Thisrequest includes all necessary context to load a particular user experiencehistory record.
func (QueryHistoryRequest)MarshalJSON¶added inv0.110.0
func (sQueryHistoryRequest) MarshalJSON() ([]byte,error)
typeQueryHistoryResponse¶added inv0.110.0
type QueryHistoryResponse struct {// Record: The record that was found.Record *HistoryRecord `json:"record,omitempty"`// UrlNormalizationDetails: These are details about automated normalization// actions that were taken in order to make the requested `url_pattern` valid.UrlNormalizationDetails *UrlNormalization `json:"urlNormalizationDetails,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Record") 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. "Record") 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:"-"`}QueryHistoryResponse: Response payload sent back to a physical web client.This response contains the record found based on the identiers present in a`QueryHistoryRequest`. The returned response will have a history record, andsometimes details on normalization actions taken on the request that werenecessary to make the request successful.
func (QueryHistoryResponse)MarshalJSON¶added inv0.110.0
func (sQueryHistoryResponse) MarshalJSON() ([]byte,error)
typeQueryRequest¶
type QueryRequest struct {// EffectiveConnectionType: The effective connection type is a query dimension// that specifies the effective network class that the record's data should// belong to. This field uses the values ["offline", "slow-2G", "2G", "3G",// "4G"] as specified in://https://wicg.github.io/netinfo/#effective-connection-types Note: If no// effective connection type is specified, then a special record with// aggregated data over all effective connection types will be returned.EffectiveConnectionTypestring `json:"effectiveConnectionType,omitempty"`// FormFactor: The form factor is a query dimension that specifies the device// class that the record's data should belong to. Note: If no form factor is// specified, then a special record with aggregated data over all form factors// will be returned.//// Possible values:// "ALL_FORM_FACTORS" - The default value, representing all device classes.// "PHONE" - The device class representing a "mobile"/"phone" sized client.// "DESKTOP" - The device class representing a "desktop"/"laptop" type full// size client.// "TABLET" - The device class representing a "tablet" type client.FormFactorstring `json:"formFactor,omitempty"`// Metrics: The metrics that should be included in the response. If none are// specified then any metrics found will be returned. Allowed values:// ["first_contentful_paint", "first_input_delay", "largest_contentful_paint",// "cumulative_layout_shift", "experimental_time_to_first_byte",// "experimental_interaction_to_next_paint"]Metrics []string `json:"metrics,omitempty"`// Origin: The url pattern "origin" refers to a url pattern that is the origin// of a website. Examples: "https://example.com", "https://cloud.google.com"Originstring `json:"origin,omitempty"`// Url: The url pattern "url" refers to a url pattern that is any arbitrary// url. Examples: "https://example.com/",// "https://cloud.google.com/why-google-cloud/"Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "EffectiveConnectionType") 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. "EffectiveConnectionType") 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:"-"`}QueryRequest: Request payload sent by a physical web client. This requestincludes all necessary context to load a particular user experience record.
func (QueryRequest)MarshalJSON¶
func (sQueryRequest) MarshalJSON() ([]byte,error)
typeQueryResponse¶
type QueryResponse struct {// Record: The record that was found.Record *Record `json:"record,omitempty"`// UrlNormalizationDetails: These are details about automated normalization// actions that were taken in order to make the requested `url_pattern` valid.UrlNormalizationDetails *UrlNormalization `json:"urlNormalizationDetails,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Record") 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. "Record") 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:"-"`}QueryResponse: Response payload sent back to a physical web client. Thisresponse contains the record found based on the identiers present in a`QueryRequest`. The returned response will have a record, and sometimesdetails on normalization actions taken on the request that were necessary tomake the request successful.
func (QueryResponse)MarshalJSON¶
func (sQueryResponse) MarshalJSON() ([]byte,error)
typeRecord¶
type Record struct {// CollectionPeriod: The collection period indicates when the data reflected in// this record was collected.CollectionPeriod *CollectionPeriod `json:"collectionPeriod,omitempty"`// Key: Key defines all of the unique querying parameters needed to look up a// user experience record.Key *Key `json:"key,omitempty"`// Metrics: Metrics is the map of user experience data available for the record// defined in the key field. Metrics are keyed on the metric name. Allowed key// values: ["first_contentful_paint", "first_input_delay",// "largest_contentful_paint", "cumulative_layout_shift",// "experimental_time_to_first_byte", "experimental_interaction_to_next_paint"]Metrics map[string]Metric `json:"metrics,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionPeriod") 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. "CollectionPeriod") 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:"-"`}Record: Record is a single Chrome UX report data record. It contains useexperience statistics for a single url pattern and set of dimensions.
func (Record)MarshalJSON¶
typeRecordsQueryHistoryRecordCall¶added inv0.110.0
type RecordsQueryHistoryRecordCall struct {// contains filtered or unexported fields}func (*RecordsQueryHistoryRecordCall)Context¶added inv0.110.0
func (c *RecordsQueryHistoryRecordCall) Context(ctxcontext.Context) *RecordsQueryHistoryRecordCall
Context sets the context to be used in this call's Do method.
func (*RecordsQueryHistoryRecordCall)Do¶added inv0.110.0
func (c *RecordsQueryHistoryRecordCall) Do(opts ...googleapi.CallOption) (*QueryHistoryResponse,error)
Do executes the "chromeuxreport.records.queryHistoryRecord" call.Any non-2xx status code is an error. Response headers are in either*QueryHistoryResponse.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 (*RecordsQueryHistoryRecordCall)Fields¶added inv0.110.0
func (c *RecordsQueryHistoryRecordCall) Fields(s ...googleapi.Field) *RecordsQueryHistoryRecordCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*RecordsQueryHistoryRecordCall)Header¶added inv0.110.0
func (c *RecordsQueryHistoryRecordCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeRecordsQueryRecordCall¶
type RecordsQueryRecordCall struct {// contains filtered or unexported fields}func (*RecordsQueryRecordCall)Context¶
func (c *RecordsQueryRecordCall) Context(ctxcontext.Context) *RecordsQueryRecordCall
Context sets the context to be used in this call's Do method.
func (*RecordsQueryRecordCall)Do¶
func (c *RecordsQueryRecordCall) Do(opts ...googleapi.CallOption) (*QueryResponse,error)
Do executes the "chromeuxreport.records.queryRecord" call.Any non-2xx status code is an error. Response headers are in either*QueryResponse.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 (*RecordsQueryRecordCall)Fields¶
func (c *RecordsQueryRecordCall) Fields(s ...googleapi.Field) *RecordsQueryRecordCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*RecordsQueryRecordCall)Header¶
func (c *RecordsQueryRecordCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeRecordsService¶
type RecordsService struct {// contains filtered or unexported fields}funcNewRecordsService¶
func NewRecordsService(s *Service) *RecordsService
func (*RecordsService)QueryHistoryRecord¶added inv0.110.0
func (r *RecordsService) QueryHistoryRecord(queryhistoryrequest *QueryHistoryRequest) *RecordsQueryHistoryRecordCall
QueryHistoryRecord: Queries the Chrome User Experience Report for atimeseries `history record` for a given site. Returns a `history record`that contains one or more `metric timeseries` corresponding to performancedata about the requested site.
func (*RecordsService)QueryRecord¶
func (r *RecordsService) QueryRecord(queryrequest *QueryRequest) *RecordsQueryRecordCall
QueryRecord: Queries the Chrome User Experience for a single `record` for agiven site. Returns a `record` that contains one or more `metrics`corresponding to performance data about the requested site.
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentRecords *RecordsService// contains filtered or unexported fields} funcNewdeprecated
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¶
NewService creates a new Service.
typeTimeseriesBin¶added inv0.110.0
type TimeseriesBin struct {// Densities: The proportion of users that experienced this bin's value for the// given metric in a given collection period; the index for each of these// entries corresponds to an entry in the CollectionPeriods field in the// HistoryRecord message, which describes when the density was observed in the// field. Thus, the length of this list of densities is equal to the length of// the CollectionPeriods field in the HistoryRecord message.Densities []float64 `json:"densities,omitempty"`// End: End is the end of the data bin. If end is not populated, then the bin// has no end and is valid from start to +inf.End interface{} `json:"end,omitempty"`// Start: Start is the beginning of the data bin.Start interface{} `json:"start,omitempty"`// ForceSendFields is a list of field names (e.g. "Densities") 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. "Densities") 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:"-"`}TimeseriesBin: A bin is a discrete portion of data spanning from start toend, or if no end is given, then from start to +inf. A bin's start and endvalues are given in the value type of the metric it represents. For example,"first contentful paint" is measured in milliseconds and exposed as ints,therefore its metric bins will use int32s for its start and end types.However, "cumulative layout shift" is measured in unitless decimals and isexposed as a decimal encoded as a string, therefore its metric bins will usestrings for its value type.
func (TimeseriesBin)MarshalJSON¶added inv0.110.0
func (sTimeseriesBin) MarshalJSON() ([]byte,error)
func (*TimeseriesBin)UnmarshalJSON¶added inv0.122.0
func (s *TimeseriesBin) UnmarshalJSON(data []byte)error
typeTimeseriesPercentiles¶added inv0.110.0
type TimeseriesPercentiles struct {// P75s: 75% of users experienced the given metric at or below this value. The// length of this list of densities is equal to the length of the// CollectionPeriods field in the HistoryRecord message, which describes when// the density was observed in the field.P75s []interface{} `json:"p75s,omitempty"`// ForceSendFields is a list of field names (e.g. "P75s") 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. "P75s") 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:"-"`}TimeseriesPercentiles: Percentiles contains synthetic values of a metric ata given statistical percentile. These are used for estimating a metric'svalue as experienced by a percentage of users out of the total number ofusers.
func (TimeseriesPercentiles)MarshalJSON¶added inv0.110.0
func (sTimeseriesPercentiles) MarshalJSON() ([]byte,error)
typeUrlNormalization¶
type UrlNormalization struct {// NormalizedUrl: The URL after any normalization actions. This is a valid user// experience URL that could reasonably be looked up.NormalizedUrlstring `json:"normalizedUrl,omitempty"`// OriginalUrl: The original requested URL prior to any normalization actions.OriginalUrlstring `json:"originalUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "NormalizedUrl") 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. "NormalizedUrl") 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:"-"`}UrlNormalization: Object representing the normalization actions taken tonormalize a url to achieve a higher chance of successful lookup. These aresimple automated changes that are taken when looking up the provided`url_patten` would be known to fail. Complex actions like followingredirects are not handled.
func (UrlNormalization)MarshalJSON¶
func (sUrlNormalization) MarshalJSON() ([]byte,error)
Source Files