Documentation

Google_Service_Doubleclicksearch_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.
$downloadFormat  : mixed
$includeDeletedEntities  : mixed
$includeRemovedEntities  : mixed
$maxRowsPerFile  : mixed
$reportType  : mixed
$rowCount  : mixed
$startRow  : mixed
$statisticsCurrency  : mixed
$verifySingleTimeZone  : mixed
$collection_key  : mixed
$columnsDataType  : mixed
$columnsType  : mixed
$filtersDataType  : mixed
$filtersType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$orderByDataType  : mixed
$orderByType  : mixed
$processed  : mixed
$reportScopeDataType  : mixed
$reportScopeType  : mixed
$timeRangeDataType  : mixed
$timeRangeType  : 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
getColumns()  : Google_Service_Doubleclicksearch_ReportApiColumnSpec
getDownloadFormat()  : mixed
getFilters()  : Google_Service_Doubleclicksearch_ReportRequestFilters
getIncludeDeletedEntities()  : mixed
getIncludeRemovedEntities()  : mixed
getMaxRowsPerFile()  : mixed
getOrderBy()  : Google_Service_Doubleclicksearch_ReportRequestOrderBy
getReportScope()  : Google_Service_Doubleclicksearch_ReportRequestReportScope
getReportType()  : mixed
getRowCount()  : mixed
getStartRow()  : mixed
getStatisticsCurrency()  : mixed
getTimeRange()  : Google_Service_Doubleclicksearch_ReportRequestTimeRange
getVerifySingleTimeZone()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setColumns()  : mixed
setDownloadFormat()  : mixed
setFilters()  : mixed
setIncludeDeletedEntities()  : mixed
setIncludeRemovedEntities()  : mixed
setMaxRowsPerFile()  : mixed
setOrderBy()  : mixed
setReportScope()  : mixed
setReportType()  : mixed
setRowCount()  : mixed
setStartRow()  : mixed
setStatisticsCurrency()  : mixed
setTimeRange()  : mixed
setVerifySingleTimeZone()  : 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

$includeDeletedEntities

public mixed $includeDeletedEntities

$includeRemovedEntities

public mixed $includeRemovedEntities

$columnsType

protected mixed $columnsType = 'Google_Service_Doubleclicksearch_ReportApiColumnSpec'

$filtersType

protected mixed $filtersType = 'Google_Service_Doubleclicksearch_ReportRequestFilters'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$orderByType

protected mixed $orderByType = 'Google_Service_Doubleclicksearch_ReportRequestOrderBy'

$processed

protected mixed $processed = array()

$reportScopeDataType

protected mixed $reportScopeDataType = ''

$reportScopeType

protected mixed $reportScopeType = 'Google_Service_Doubleclicksearch_ReportRequestReportScope'

$timeRangeType

protected mixed $timeRangeType = 'Google_Service_Doubleclicksearch_ReportRequestTimeRange'

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 —

getDownloadFormat()

public getDownloadFormat() : mixed
Return values
mixed —

getIncludeDeletedEntities()

public getIncludeDeletedEntities() : mixed
Return values
mixed —

getIncludeRemovedEntities()

public getIncludeRemovedEntities() : mixed
Return values
mixed —

getMaxRowsPerFile()

public getMaxRowsPerFile() : mixed
Return values
mixed —

getReportType()

public getReportType() : mixed
Return values
mixed —

getRowCount()

public getRowCount() : mixed
Return values
mixed —

getStartRow()

public getStartRow() : mixed
Return values
mixed —

getStatisticsCurrency()

public getStatisticsCurrency() : mixed
Return values
mixed —

getVerifySingleTimeZone()

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

setColumns()

public setColumns(mixed $columns) : mixed
Parameters
$columns : mixed
Return values
mixed —

setDownloadFormat()

public setDownloadFormat(mixed $downloadFormat) : mixed
Parameters
$downloadFormat : mixed
Return values
mixed —

setFilters()

public setFilters(mixed $filters) : mixed
Parameters
$filters : mixed
Return values
mixed —

setIncludeDeletedEntities()

public setIncludeDeletedEntities(mixed $includeDeletedEntities) : mixed
Parameters
$includeDeletedEntities : mixed
Return values
mixed —

setIncludeRemovedEntities()

public setIncludeRemovedEntities(mixed $includeRemovedEntities) : mixed
Parameters
$includeRemovedEntities : mixed
Return values
mixed —

setMaxRowsPerFile()

public setMaxRowsPerFile(mixed $maxRowsPerFile) : mixed
Parameters
$maxRowsPerFile : mixed
Return values
mixed —

setOrderBy()

public setOrderBy(mixed $orderBy) : mixed
Parameters
$orderBy : mixed
Return values
mixed —

setReportType()

public setReportType(mixed $reportType) : mixed
Parameters
$reportType : mixed
Return values
mixed —

setRowCount()

public setRowCount(mixed $rowCount) : mixed
Parameters
$rowCount : mixed
Return values
mixed —

setStartRow()

public setStartRow(mixed $startRow) : mixed
Parameters
$startRow : mixed
Return values
mixed —

setStatisticsCurrency()

public setStatisticsCurrency(mixed $statisticsCurrency) : mixed
Parameters
$statisticsCurrency : mixed
Return values
mixed —

setVerifySingleTimeZone()

public setVerifySingleTimeZone(mixed $verifySingleTimeZone) : mixed
Parameters
$verifySingleTimeZone : 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