Documentation

Google_Service_Analytics_Experiment 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.
$accountId  : mixed
$created  : mixed
$description  : mixed
$editableInGaUi  : mixed
$endTime  : mixed
$equalWeighting  : mixed
$id  : mixed
$internalWebPropertyId  : mixed
$kind  : mixed
$minimumExperimentLengthInDays  : mixed
$name  : mixed
$objectiveMetric  : mixed
$optimizationType  : mixed
$profileId  : mixed
$reasonExperimentEnded  : mixed
$rewriteVariationUrlsAsOriginal  : mixed
$selfLink  : mixed
$servingFramework  : mixed
$snippet  : mixed
$startTime  : mixed
$status  : mixed
$trafficCoverage  : mixed
$updated  : mixed
$webPropertyId  : mixed
$winnerConfidenceLevel  : mixed
$winnerFound  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$parentLinkDataType  : mixed
$parentLinkType  : mixed
$processed  : mixed
$variationsDataType  : mixed
$variationsType  : 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
getAccountId()  : mixed
getCreated()  : mixed
getDescription()  : mixed
getEditableInGaUi()  : mixed
getEndTime()  : mixed
getEqualWeighting()  : mixed
getId()  : mixed
getInternalWebPropertyId()  : mixed
getKind()  : mixed
getMinimumExperimentLengthInDays()  : mixed
getName()  : mixed
getObjectiveMetric()  : mixed
getOptimizationType()  : mixed
getParentLink()  : Google_Service_Analytics_ExperimentParentLink
getProfileId()  : mixed
getReasonExperimentEnded()  : mixed
getRewriteVariationUrlsAsOriginal()  : mixed
getSelfLink()  : mixed
getServingFramework()  : mixed
getSnippet()  : mixed
getStartTime()  : mixed
getStatus()  : mixed
getTrafficCoverage()  : mixed
getUpdated()  : mixed
getVariations()  : Google_Service_Analytics_ExperimentVariations
getWebPropertyId()  : mixed
getWinnerConfidenceLevel()  : mixed
getWinnerFound()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAccountId()  : mixed
setCreated()  : mixed
setDescription()  : mixed
setEditableInGaUi()  : mixed
setEndTime()  : mixed
setEqualWeighting()  : mixed
setId()  : mixed
setInternalWebPropertyId()  : mixed
setKind()  : mixed
setMinimumExperimentLengthInDays()  : mixed
setName()  : mixed
setObjectiveMetric()  : mixed
setOptimizationType()  : mixed
setParentLink()  : mixed
setProfileId()  : mixed
setReasonExperimentEnded()  : mixed
setRewriteVariationUrlsAsOriginal()  : mixed
setSelfLink()  : mixed
setServingFramework()  : mixed
setSnippet()  : mixed
setStartTime()  : mixed
setStatus()  : mixed
setTrafficCoverage()  : mixed
setUpdated()  : mixed
setVariations()  : mixed
setWebPropertyId()  : mixed
setWinnerConfidenceLevel()  : mixed
setWinnerFound()  : 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

$internalWebPropertyId

public mixed $internalWebPropertyId

$minimumExperimentLengthInDays

public mixed $minimumExperimentLengthInDays

$optimizationType

public mixed $optimizationType

$reasonExperimentEnded

public mixed $reasonExperimentEnded

$rewriteVariationUrlsAsOriginal

public mixed $rewriteVariationUrlsAsOriginal

$servingFramework

public mixed $servingFramework

$winnerConfidenceLevel

public mixed $winnerConfidenceLevel

$collection_key

protected mixed $collection_key = 'variations'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$parentLinkDataType

protected mixed $parentLinkDataType = ''

$parentLinkType

protected mixed $parentLinkType = 'Google_Service_Analytics_ExperimentParentLink'

$processed

protected mixed $processed = array()

$variationsDataType

protected mixed $variationsDataType = 'array'

$variationsType

protected mixed $variationsType = 'Google_Service_Analytics_ExperimentVariations'

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 —

getAccountId()

public getAccountId() : mixed
Return values
mixed —

getCreated()

public getCreated() : mixed
Return values
mixed —

getDescription()

public getDescription() : mixed
Return values
mixed —

getEditableInGaUi()

public getEditableInGaUi() : mixed
Return values
mixed —

getEndTime()

public getEndTime() : mixed
Return values
mixed —

getEqualWeighting()

public getEqualWeighting() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getInternalWebPropertyId()

public getInternalWebPropertyId() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getMinimumExperimentLengthInDays()

public getMinimumExperimentLengthInDays() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getObjectiveMetric()

public getObjectiveMetric() : mixed
Return values
mixed —

getOptimizationType()

public getOptimizationType() : mixed
Return values
mixed —

getProfileId()

public getProfileId() : mixed
Return values
mixed —

getReasonExperimentEnded()

public getReasonExperimentEnded() : mixed
Return values
mixed —

getRewriteVariationUrlsAsOriginal()

public getRewriteVariationUrlsAsOriginal() : mixed
Return values
mixed —

getSelfLink()

public getSelfLink() : mixed
Return values
mixed —

getServingFramework()

public getServingFramework() : mixed
Return values
mixed —

getSnippet()

public getSnippet() : mixed
Return values
mixed —

getStartTime()

public getStartTime() : mixed
Return values
mixed —

getStatus()

public getStatus() : mixed
Return values
mixed —

getTrafficCoverage()

public getTrafficCoverage() : mixed
Return values
mixed —

getUpdated()

public getUpdated() : mixed
Return values
mixed —

getWebPropertyId()

public getWebPropertyId() : mixed
Return values
mixed —

getWinnerConfidenceLevel()

public getWinnerConfidenceLevel() : mixed
Return values
mixed —

getWinnerFound()

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

setAccountId()

public setAccountId(mixed $accountId) : mixed
Parameters
$accountId : mixed
Return values
mixed —

setCreated()

public setCreated(mixed $created) : mixed
Parameters
$created : mixed
Return values
mixed —

setDescription()

public setDescription(mixed $description) : mixed
Parameters
$description : mixed
Return values
mixed —

setEditableInGaUi()

public setEditableInGaUi(mixed $editableInGaUi) : mixed
Parameters
$editableInGaUi : mixed
Return values
mixed —

setEndTime()

public setEndTime(mixed $endTime) : mixed
Parameters
$endTime : mixed
Return values
mixed —

setEqualWeighting()

public setEqualWeighting(mixed $equalWeighting) : mixed
Parameters
$equalWeighting : mixed
Return values
mixed —

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed —

setInternalWebPropertyId()

public setInternalWebPropertyId(mixed $internalWebPropertyId) : mixed
Parameters
$internalWebPropertyId : mixed
Return values
mixed —

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed
Return values
mixed —

setMinimumExperimentLengthInDays()

public setMinimumExperimentLengthInDays(mixed $minimumExperimentLengthInDays) : mixed
Parameters
$minimumExperimentLengthInDays : mixed
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

setObjectiveMetric()

public setObjectiveMetric(mixed $objectiveMetric) : mixed
Parameters
$objectiveMetric : mixed
Return values
mixed —

setOptimizationType()

public setOptimizationType(mixed $optimizationType) : mixed
Parameters
$optimizationType : mixed
Return values
mixed —

setProfileId()

public setProfileId(mixed $profileId) : mixed
Parameters
$profileId : mixed
Return values
mixed —

setReasonExperimentEnded()

public setReasonExperimentEnded(mixed $reasonExperimentEnded) : mixed
Parameters
$reasonExperimentEnded : mixed
Return values
mixed —

setRewriteVariationUrlsAsOriginal()

public setRewriteVariationUrlsAsOriginal(mixed $rewriteVariationUrlsAsOriginal) : mixed
Parameters
$rewriteVariationUrlsAsOriginal : mixed
Return values
mixed —

setSelfLink()

public setSelfLink(mixed $selfLink) : mixed
Parameters
$selfLink : mixed
Return values
mixed —

setServingFramework()

public setServingFramework(mixed $servingFramework) : mixed
Parameters
$servingFramework : mixed
Return values
mixed —

setSnippet()

public setSnippet(mixed $snippet) : mixed
Parameters
$snippet : mixed
Return values
mixed —

setStartTime()

public setStartTime(mixed $startTime) : mixed
Parameters
$startTime : mixed
Return values
mixed —

setStatus()

public setStatus(mixed $status) : mixed
Parameters
$status : mixed
Return values
mixed —

setTrafficCoverage()

public setTrafficCoverage(mixed $trafficCoverage) : mixed
Parameters
$trafficCoverage : mixed
Return values
mixed —

setUpdated()

public setUpdated(mixed $updated) : mixed
Parameters
$updated : mixed
Return values
mixed —

setVariations()

public setVariations(mixed $variations) : mixed
Parameters
$variations : mixed
Return values
mixed —

setWebPropertyId()

public setWebPropertyId(mixed $webPropertyId) : mixed
Parameters
$webPropertyId : mixed
Return values
mixed —

setWinnerConfidenceLevel()

public setWinnerConfidenceLevel(mixed $winnerConfidenceLevel) : mixed
Parameters
$winnerConfidenceLevel : mixed
Return values
mixed —

setWinnerFound()

public setWinnerFound(mixed $winnerFound) : mixed
Parameters
$winnerFound : 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