Google Analytics Data V1alpha Client - Class SamplingMetadata (0.16.4)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class SamplingMetadata.

If funnel report results are sampled, this metadata describes what percentage of events were used in this funnel report for a date range. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.

Generated from protobuf message google.analytics.data.v1alpha.SamplingMetadata

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ samples_read_count int|string

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 funnel report.

↳ sampling_space_size int|string

The total number of events present in this property's data that could have been analyzed in this funnel 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 funnel report, compute samplesReadCount/samplingSpaceSize.

getSamplesReadCount

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 funnel report.

Returns
Type Description
int|string

setSamplesReadCount

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 funnel report.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getSamplingSpaceSize

The total number of events present in this property's data that could have been analyzed in this funnel 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 funnel report, compute samplesReadCount/samplingSpaceSize.

Returns
Type Description
int|string

setSamplingSpaceSize

The total number of events present in this property's data that could have been analyzed in this funnel 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 funnel report, compute samplesReadCount/samplingSpaceSize.

Parameter
Name Description
var int|string
Returns
Type Description
$this