Documentation

Google_Service_AnalyticsReporting_ReportRequest extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$filtersExpression  : mixed
$hideTotals  : mixed
$hideValueRanges  : mixed
$includeEmptyRows  : mixed
$pageSize  : mixed
$pageToken  : mixed
$samplingLevel  : mixed
$viewId  : mixed
$cohortGroupDataType  : mixed
$cohortGroupType  : mixed
$collection_key  : mixed
$dateRangesDataType  : mixed
$dateRangesType  : mixed
$dimensionFilterClausesDataType  : mixed
$dimensionFilterClausesType  : mixed
$dimensionsDataType  : mixed
$dimensionsType  : mixed
$internal_gapi_mappings  : mixed
$metricFilterClausesDataType  : mixed
$metricFilterClausesType  : mixed
$metricsDataType  : mixed
$metricsType  : mixed
$modelData  : mixed
$orderBysDataType  : mixed
$orderBysType  : mixed
$pivotsDataType  : mixed
$pivotsType  : mixed
$processed  : mixed
$segmentsDataType  : mixed
$segmentsType  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getCohortGroup()  : Google_Service_AnalyticsReporting_CohortGroup
getDateRanges()  : Google_Service_AnalyticsReporting_DateRange
getDimensionFilterClauses()  : Google_Service_AnalyticsReporting_DimensionFilterClause
getDimensions()  : Google_Service_AnalyticsReporting_Dimension
getFiltersExpression()  : mixed
getHideTotals()  : mixed
getHideValueRanges()  : mixed
getIncludeEmptyRows()  : mixed
getMetricFilterClauses()  : Google_Service_AnalyticsReporting_MetricFilterClause
getMetrics()  : Google_Service_AnalyticsReporting_Metric
getOrderBys()  : Google_Service_AnalyticsReporting_OrderBy
getPageSize()  : mixed
getPageToken()  : mixed
getPivots()  : Google_Service_AnalyticsReporting_Pivot
getSamplingLevel()  : mixed
getSegments()  : Google_Service_AnalyticsReporting_Segment
getViewId()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCohortGroup()  : mixed
setDateRanges()  : mixed
setDimensionFilterClauses()  : mixed
setDimensions()  : mixed
setFiltersExpression()  : mixed
setHideTotals()  : mixed
setHideValueRanges()  : mixed
setIncludeEmptyRows()  : mixed
setMetricFilterClauses()  : mixed
setMetrics()  : mixed
setOrderBys()  : mixed
setPageSize()  : mixed
setPageToken()  : mixed
setPivots()  : mixed
setSamplingLevel()  : mixed
setSegments()  : mixed
setViewId()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$cohortGroupDataType

protected mixed $cohortGroupDataType = ''

$cohortGroupType

protected mixed $cohortGroupType = 'Google_Service_AnalyticsReporting_CohortGroup'

$collection_key

protected mixed $collection_key = 'segments'

$dateRangesDataType

protected mixed $dateRangesDataType = 'array'

$dateRangesType

protected mixed $dateRangesType = 'Google_Service_AnalyticsReporting_DateRange'

$dimensionFilterClausesDataType

protected mixed $dimensionFilterClausesDataType = 'array'

$dimensionFilterClausesType

protected mixed $dimensionFilterClausesType = 'Google_Service_AnalyticsReporting_DimensionFilterClause'

$dimensionsDataType

protected mixed $dimensionsDataType = 'array'

$dimensionsType

protected mixed $dimensionsType = 'Google_Service_AnalyticsReporting_Dimension'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$metricFilterClausesDataType

protected mixed $metricFilterClausesDataType = 'array'

$metricFilterClausesType

protected mixed $metricFilterClausesType = 'Google_Service_AnalyticsReporting_MetricFilterClause'

$metricsType

protected mixed $metricsType = 'Google_Service_AnalyticsReporting_Metric'

$modelData

protected mixed $modelData = array()

$orderBysDataType

protected mixed $orderBysDataType = 'array'

$orderBysType

protected mixed $orderBysType = 'Google_Service_AnalyticsReporting_OrderBy'

$pivotsType

protected mixed $pivotsType = 'Google_Service_AnalyticsReporting_Pivot'

$processed

protected mixed $processed = array()

$segmentsDataType

protected mixed $segmentsDataType = 'array'

$segmentsType

protected mixed $segmentsType = 'Google_Service_AnalyticsReporting_Segment'

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed —

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getFiltersExpression()

public getFiltersExpression() : mixed
Return values
mixed —

getHideTotals()

public getHideTotals() : mixed
Return values
mixed —

getHideValueRanges()

public getHideValueRanges() : mixed
Return values
mixed —

getIncludeEmptyRows()

public getIncludeEmptyRows() : mixed
Return values
mixed —

getPageSize()

public getPageSize() : mixed
Return values
mixed —

getPageToken()

public getPageToken() : mixed
Return values
mixed —

getSamplingLevel()

public getSamplingLevel() : mixed
Return values
mixed —

getViewId()

public getViewId() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

rewind()

public rewind() : mixed
Return values
mixed —

setDateRanges()

public setDateRanges(mixed $dateRanges) : mixed
Parameters
$dateRanges : mixed
Return values
mixed —

setDimensionFilterClauses()

public setDimensionFilterClauses(mixed $dimensionFilterClauses) : mixed
Parameters
$dimensionFilterClauses : mixed
Return values
mixed —

setDimensions()

public setDimensions(mixed $dimensions) : mixed
Parameters
$dimensions : mixed
Return values
mixed —

setFiltersExpression()

public setFiltersExpression(mixed $filtersExpression) : mixed
Parameters
$filtersExpression : mixed
Return values
mixed —

setHideTotals()

public setHideTotals(mixed $hideTotals) : mixed
Parameters
$hideTotals : mixed
Return values
mixed —

setHideValueRanges()

public setHideValueRanges(mixed $hideValueRanges) : mixed
Parameters
$hideValueRanges : mixed
Return values
mixed —

setIncludeEmptyRows()

public setIncludeEmptyRows(mixed $includeEmptyRows) : mixed
Parameters
$includeEmptyRows : mixed
Return values
mixed —

setMetricFilterClauses()

public setMetricFilterClauses(mixed $metricFilterClauses) : mixed
Parameters
$metricFilterClauses : mixed
Return values
mixed —

setMetrics()

public setMetrics(mixed $metrics) : mixed
Parameters
$metrics : mixed
Return values
mixed —

setOrderBys()

public setOrderBys(mixed $orderBys) : mixed
Parameters
$orderBys : mixed
Return values
mixed —

setPageSize()

public setPageSize(mixed $pageSize) : mixed
Parameters
$pageSize : mixed
Return values
mixed —

setPageToken()

public setPageToken(mixed $pageToken) : mixed
Parameters
$pageToken : mixed
Return values
mixed —

setPivots()

public setPivots(mixed $pivots) : mixed
Parameters
$pivots : mixed
Return values
mixed —

setSamplingLevel()

public setSamplingLevel(mixed $samplingLevel) : mixed
Parameters
$samplingLevel : mixed
Return values
mixed —

setSegments()

public setSegments(mixed $segments) : mixed
Parameters
$segments : mixed
Return values
mixed —

setViewId()

public setViewId(mixed $viewId) : mixed
Parameters
$viewId : mixed
Return values
mixed —

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed —

valid()

public valid() : mixed
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed —

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void —

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results