Documentation

Google_Service_AnalyticsData_RunReportRequest 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.
$currencyCode  : mixed
$keepEmptyRows  : mixed
$limit  : mixed
$metricAggregations  : mixed
$offset  : mixed
$returnPropertyQuota  : mixed
$cohortSpecDataType  : mixed
$cohortSpecType  : mixed
$collection_key  : mixed
$dateRangesDataType  : mixed
$dateRangesType  : mixed
$dimensionFilterDataType  : mixed
$dimensionFilterType  : mixed
$dimensionsDataType  : mixed
$dimensionsType  : mixed
$entityDataType  : mixed
$entityType  : mixed
$internal_gapi_mappings  : mixed
$metricFilterDataType  : mixed
$metricFilterType  : mixed
$metricsDataType  : mixed
$metricsType  : mixed
$modelData  : mixed
$orderBysDataType  : mixed
$orderBysType  : mixed
$processed  : 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
getCohortSpec()  : Google_Service_AnalyticsData_CohortSpec
getCurrencyCode()  : mixed
getDateRanges()  : Google_Service_AnalyticsData_DateRange
getDimensionFilter()  : Google_Service_AnalyticsData_FilterExpression
getDimensions()  : Google_Service_AnalyticsData_Dimension
getEntity()  : Google_Service_AnalyticsData_Entity
getKeepEmptyRows()  : mixed
getLimit()  : mixed
getMetricAggregations()  : mixed
getMetricFilter()  : Google_Service_AnalyticsData_FilterExpression
getMetrics()  : Google_Service_AnalyticsData_Metric
getOffset()  : mixed
getOrderBys()  : Google_Service_AnalyticsData_OrderBy
getReturnPropertyQuota()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCohortSpec()  : mixed
setCurrencyCode()  : mixed
setDateRanges()  : mixed
setDimensionFilter()  : mixed
setDimensions()  : mixed
setEntity()  : mixed
setKeepEmptyRows()  : mixed
setLimit()  : mixed
setMetricAggregations()  : mixed
setMetricFilter()  : mixed
setMetrics()  : mixed
setOffset()  : mixed
setOrderBys()  : mixed
setReturnPropertyQuota()  : 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

$cohortSpecType

protected mixed $cohortSpecType = 'Google_Service_AnalyticsData_CohortSpec'

$dateRangesType

protected mixed $dateRangesType = 'Google_Service_AnalyticsData_DateRange'

$dimensionFilterType

protected mixed $dimensionFilterType = 'Google_Service_AnalyticsData_FilterExpression'

$dimensionsType

protected mixed $dimensionsType = 'Google_Service_AnalyticsData_Dimension'

$entityType

protected mixed $entityType = 'Google_Service_AnalyticsData_Entity'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$metricFilterType

protected mixed $metricFilterType = 'Google_Service_AnalyticsData_FilterExpression'

$metricsType

protected mixed $metricsType = 'Google_Service_AnalyticsData_Metric'

$modelData

protected mixed $modelData = array()

$orderBysType

protected mixed $orderBysType = 'Google_Service_AnalyticsData_OrderBy'

$processed

protected mixed $processed = array()

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 —

getCurrencyCode()

public getCurrencyCode() : mixed
Return values
mixed —

getKeepEmptyRows()

public getKeepEmptyRows() : mixed
Return values
mixed —

getMetricAggregations()

public getMetricAggregations() : mixed
Return values
mixed —

getReturnPropertyQuota()

public getReturnPropertyQuota() : 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 —

setCurrencyCode()

public setCurrencyCode(mixed $currencyCode) : mixed
Parameters
$currencyCode : mixed
Return values
mixed —

setDateRanges()

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

setDimensions()

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

setKeepEmptyRows()

public setKeepEmptyRows(mixed $keepEmptyRows) : mixed
Parameters
$keepEmptyRows : mixed
Return values
mixed —

setLimit()

public setLimit(mixed $limit) : mixed
Parameters
$limit : mixed
Return values
mixed —

setMetricAggregations()

public setMetricAggregations(mixed $metricAggregations) : mixed
Parameters
$metricAggregations : mixed
Return values
mixed —

setMetrics()

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

setOffset()

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

setOrderBys()

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

setReturnPropertyQuota()

public setReturnPropertyQuota(mixed $returnPropertyQuota) : mixed
Parameters
$returnPropertyQuota : 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