Documentation

Google_Service_Dfareporting_CreativeAssignment 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.
$active  : mixed
$applyEventTags  : mixed
$creativeId  : mixed
$endTime  : mixed
$sequence  : mixed
$sslCompliant  : mixed
$startTime  : mixed
$weight  : mixed
$clickThroughUrlDataType  : mixed
$clickThroughUrlType  : mixed
$collection_key  : mixed
$companionCreativeOverridesDataType  : mixed
$companionCreativeOverridesType  : mixed
$creativeGroupAssignmentsDataType  : mixed
$creativeGroupAssignmentsType  : mixed
$creativeIdDimensionValueDataType  : mixed
$creativeIdDimensionValueType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$richMediaExitOverridesDataType  : mixed
$richMediaExitOverridesType  : 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
getActive()  : mixed
getApplyEventTags()  : mixed
getClickThroughUrl()  : Google_Service_Dfareporting_ClickThroughUrl
getCompanionCreativeOverrides()  : Google_Service_Dfareporting_CompanionClickThroughOverride
getCreativeGroupAssignments()  : Google_Service_Dfareporting_CreativeGroupAssignment
getCreativeId()  : mixed
getCreativeIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getEndTime()  : mixed
getRichMediaExitOverrides()  : Google_Service_Dfareporting_RichMediaExitOverride
getSequence()  : mixed
getSslCompliant()  : mixed
getStartTime()  : mixed
getWeight()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setActive()  : mixed
setApplyEventTags()  : mixed
setClickThroughUrl()  : mixed
setCompanionCreativeOverrides()  : mixed
setCreativeGroupAssignments()  : mixed
setCreativeId()  : mixed
setCreativeIdDimensionValue()  : mixed
setEndTime()  : mixed
setRichMediaExitOverrides()  : mixed
setSequence()  : mixed
setSslCompliant()  : mixed
setStartTime()  : mixed
setWeight()  : 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

$clickThroughUrlType

protected mixed $clickThroughUrlType = 'Google_Service_Dfareporting_ClickThroughUrl'

$companionCreativeOverridesDataType

protected mixed $companionCreativeOverridesDataType = 'array'

$companionCreativeOverridesType

protected mixed $companionCreativeOverridesType = 'Google_Service_Dfareporting_CompanionClickThroughOverride'

$creativeGroupAssignmentsDataType

protected mixed $creativeGroupAssignmentsDataType = 'array'

$creativeGroupAssignmentsType

protected mixed $creativeGroupAssignmentsType = 'Google_Service_Dfareporting_CreativeGroupAssignment'

$creativeIdDimensionValueDataType

protected mixed $creativeIdDimensionValueDataType = ''

$creativeIdDimensionValueType

protected mixed $creativeIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$richMediaExitOverridesDataType

protected mixed $richMediaExitOverridesDataType = 'array'

$richMediaExitOverridesType

protected mixed $richMediaExitOverridesType = 'Google_Service_Dfareporting_RichMediaExitOverride'

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 —

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 —

setActive()

public setActive(mixed $active) : mixed
Parameters
$active : mixed
Return values
mixed —

setApplyEventTags()

public setApplyEventTags(mixed $applyEventTags) : mixed
Parameters
$applyEventTags : mixed
Return values
mixed —

setCompanionCreativeOverrides()

public setCompanionCreativeOverrides(mixed $companionCreativeOverrides) : mixed
Parameters
$companionCreativeOverrides : mixed
Return values
mixed —

setCreativeGroupAssignments()

public setCreativeGroupAssignments(mixed $creativeGroupAssignments) : mixed
Parameters
$creativeGroupAssignments : mixed
Return values
mixed —

setCreativeId()

public setCreativeId(mixed $creativeId) : mixed
Parameters
$creativeId : mixed
Return values
mixed —

setEndTime()

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

setRichMediaExitOverrides()

public setRichMediaExitOverrides(mixed $richMediaExitOverrides) : mixed
Parameters
$richMediaExitOverrides : mixed
Return values
mixed —

setSequence()

public setSequence(mixed $sequence) : mixed
Parameters
$sequence : mixed
Return values
mixed —

setSslCompliant()

public setSslCompliant(mixed $sslCompliant) : mixed
Parameters
$sslCompliant : mixed
Return values
mixed —

setStartTime()

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

setWeight()

public setWeight(mixed $weight) : mixed
Parameters
$weight : 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