Documentation

Google_Service_Dfareporting_Placement 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
$adBlockingOptOut  : mixed
$advertiserId  : mixed
$archived  : mixed
$campaignId  : mixed
$comment  : mixed
$compatibility  : mixed
$contentCategoryId  : mixed
$directorySiteId  : mixed
$externalId  : mixed
$id  : mixed
$keyName  : mixed
$kind  : mixed
$name  : mixed
$paymentApproved  : mixed
$paymentSource  : mixed
$placementGroupId  : mixed
$placementStrategyId  : mixed
$primary  : mixed
$siteId  : mixed
$sslRequired  : mixed
$status  : mixed
$subaccountId  : mixed
$tagFormats  : mixed
$videoActiveViewOptOut  : mixed
$vpaidAdapterChoice  : mixed
$additionalSizesDataType  : mixed
$additionalSizesType  : mixed
$advertiserIdDimensionValueDataType  : mixed
$advertiserIdDimensionValueType  : mixed
$campaignIdDimensionValueDataType  : mixed
$campaignIdDimensionValueType  : mixed
$collection_key  : mixed
$createInfoDataType  : mixed
$createInfoType  : mixed
$directorySiteIdDimensionValueDataType  : mixed
$directorySiteIdDimensionValueType  : mixed
$idDimensionValueDataType  : mixed
$idDimensionValueType  : mixed
$internal_gapi_mappings  : mixed
$lastModifiedInfoDataType  : mixed
$lastModifiedInfoType  : mixed
$lookbackConfigurationDataType  : mixed
$lookbackConfigurationType  : mixed
$modelData  : mixed
$placementGroupIdDimensionValueDataType  : mixed
$placementGroupIdDimensionValueType  : mixed
$pricingScheduleDataType  : mixed
$pricingScheduleType  : mixed
$processed  : mixed
$publisherUpdateInfoDataType  : mixed
$publisherUpdateInfoType  : mixed
$siteIdDimensionValueDataType  : mixed
$siteIdDimensionValueType  : mixed
$sizeDataType  : mixed
$sizeType  : mixed
$tagSettingDataType  : mixed
$tagSettingType  : mixed
$videoSettingsDataType  : mixed
$videoSettingsType  : 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
getAdBlockingOptOut()  : mixed
getAdditionalSizes()  : Google_Service_Dfareporting_Size
getAdvertiserId()  : mixed
getAdvertiserIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getArchived()  : mixed
getCampaignId()  : mixed
getCampaignIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getComment()  : mixed
getCompatibility()  : mixed
getContentCategoryId()  : mixed
getCreateInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getDirectorySiteId()  : mixed
getDirectorySiteIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getExternalId()  : mixed
getId()  : mixed
getIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getKeyName()  : mixed
getKind()  : mixed
getLastModifiedInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getLookbackConfiguration()  : Google_Service_Dfareporting_LookbackConfiguration
getName()  : mixed
getPaymentApproved()  : mixed
getPaymentSource()  : mixed
getPlacementGroupId()  : mixed
getPlacementGroupIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getPlacementStrategyId()  : mixed
getPricingSchedule()  : Google_Service_Dfareporting_PricingSchedule
getPrimary()  : mixed
getPublisherUpdateInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getSiteId()  : mixed
getSiteIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getSize()  : Google_Service_Dfareporting_Size
getSslRequired()  : mixed
getStatus()  : mixed
getSubaccountId()  : mixed
getTagFormats()  : mixed
getTagSetting()  : Google_Service_Dfareporting_TagSetting
getVideoActiveViewOptOut()  : mixed
getVideoSettings()  : Google_Service_Dfareporting_VideoSettings
getVpaidAdapterChoice()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAccountId()  : mixed
setAdBlockingOptOut()  : mixed
setAdditionalSizes()  : mixed
setAdvertiserId()  : mixed
setAdvertiserIdDimensionValue()  : mixed
setArchived()  : mixed
setCampaignId()  : mixed
setCampaignIdDimensionValue()  : mixed
setComment()  : mixed
setCompatibility()  : mixed
setContentCategoryId()  : mixed
setCreateInfo()  : mixed
setDirectorySiteId()  : mixed
setDirectorySiteIdDimensionValue()  : mixed
setExternalId()  : mixed
setId()  : mixed
setIdDimensionValue()  : mixed
setKeyName()  : mixed
setKind()  : mixed
setLastModifiedInfo()  : mixed
setLookbackConfiguration()  : mixed
setName()  : mixed
setPaymentApproved()  : mixed
setPaymentSource()  : mixed
setPlacementGroupId()  : mixed
setPlacementGroupIdDimensionValue()  : mixed
setPlacementStrategyId()  : mixed
setPricingSchedule()  : mixed
setPrimary()  : mixed
setPublisherUpdateInfo()  : mixed
setSiteId()  : mixed
setSiteIdDimensionValue()  : mixed
setSize()  : mixed
setSslRequired()  : mixed
setStatus()  : mixed
setSubaccountId()  : mixed
setTagFormats()  : mixed
setTagSetting()  : mixed
setVideoActiveViewOptOut()  : mixed
setVideoSettings()  : mixed
setVpaidAdapterChoice()  : 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

$adBlockingOptOut

public mixed $adBlockingOptOut

$contentCategoryId

public mixed $contentCategoryId

$directorySiteId

public mixed $directorySiteId

$paymentApproved

public mixed $paymentApproved

$placementGroupId

public mixed $placementGroupId

$placementStrategyId

public mixed $placementStrategyId

$videoActiveViewOptOut

public mixed $videoActiveViewOptOut

$vpaidAdapterChoice

public mixed $vpaidAdapterChoice

$additionalSizesDataType

protected mixed $additionalSizesDataType = 'array'

$additionalSizesType

protected mixed $additionalSizesType = 'Google_Service_Dfareporting_Size'

$advertiserIdDimensionValueDataType

protected mixed $advertiserIdDimensionValueDataType = ''

$advertiserIdDimensionValueType

protected mixed $advertiserIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$campaignIdDimensionValueDataType

protected mixed $campaignIdDimensionValueDataType = ''

$campaignIdDimensionValueType

protected mixed $campaignIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$collection_key

protected mixed $collection_key = 'tagFormats'

$createInfoDataType

protected mixed $createInfoDataType = ''

$createInfoType

protected mixed $createInfoType = 'Google_Service_Dfareporting_LastModifiedInfo'

$directorySiteIdDimensionValueDataType

protected mixed $directorySiteIdDimensionValueDataType = ''

$directorySiteIdDimensionValueType

protected mixed $directorySiteIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$idDimensionValueDataType

protected mixed $idDimensionValueDataType = ''

$idDimensionValueType

protected mixed $idDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$lastModifiedInfoDataType

protected mixed $lastModifiedInfoDataType = ''

$lastModifiedInfoType

protected mixed $lastModifiedInfoType = 'Google_Service_Dfareporting_LastModifiedInfo'

$lookbackConfigurationDataType

protected mixed $lookbackConfigurationDataType = ''

$lookbackConfigurationType

protected mixed $lookbackConfigurationType = 'Google_Service_Dfareporting_LookbackConfiguration'

$modelData

protected mixed $modelData = array()

$placementGroupIdDimensionValueDataType

protected mixed $placementGroupIdDimensionValueDataType = ''

$placementGroupIdDimensionValueType

protected mixed $placementGroupIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$pricingScheduleDataType

protected mixed $pricingScheduleDataType = ''

$pricingScheduleType

protected mixed $pricingScheduleType = 'Google_Service_Dfareporting_PricingSchedule'

$processed

protected mixed $processed = array()

$publisherUpdateInfoDataType

protected mixed $publisherUpdateInfoDataType = ''

$publisherUpdateInfoType

protected mixed $publisherUpdateInfoType = 'Google_Service_Dfareporting_LastModifiedInfo'

$siteIdDimensionValueDataType

protected mixed $siteIdDimensionValueDataType = ''

$siteIdDimensionValueType

protected mixed $siteIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$sizeDataType

protected mixed $sizeDataType = ''

$sizeType

protected mixed $sizeType = 'Google_Service_Dfareporting_Size'

$tagSettingDataType

protected mixed $tagSettingDataType = ''

$tagSettingType

protected mixed $tagSettingType = 'Google_Service_Dfareporting_TagSetting'

$videoSettingsDataType

protected mixed $videoSettingsDataType = ''

$videoSettingsType

protected mixed $videoSettingsType = 'Google_Service_Dfareporting_VideoSettings'

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 —

getAdBlockingOptOut()

public getAdBlockingOptOut() : mixed
Return values
mixed —

getAdvertiserId()

public getAdvertiserId() : mixed
Return values
mixed —

getArchived()

public getArchived() : mixed
Return values
mixed —

getCampaignId()

public getCampaignId() : mixed
Return values
mixed —

getComment()

public getComment() : mixed
Return values
mixed —

getCompatibility()

public getCompatibility() : mixed
Return values
mixed —

getContentCategoryId()

public getContentCategoryId() : mixed
Return values
mixed —

getDirectorySiteId()

public getDirectorySiteId() : mixed
Return values
mixed —

getExternalId()

public getExternalId() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getKeyName()

public getKeyName() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getPaymentApproved()

public getPaymentApproved() : mixed
Return values
mixed —

getPaymentSource()

public getPaymentSource() : mixed
Return values
mixed —

getPlacementGroupId()

public getPlacementGroupId() : mixed
Return values
mixed —

getPlacementStrategyId()

public getPlacementStrategyId() : mixed
Return values
mixed —

getPrimary()

public getPrimary() : mixed
Return values
mixed —

getSiteId()

public getSiteId() : mixed
Return values
mixed —

getSslRequired()

public getSslRequired() : mixed
Return values
mixed —

getStatus()

public getStatus() : mixed
Return values
mixed —

getSubaccountId()

public getSubaccountId() : mixed
Return values
mixed —

getTagFormats()

public getTagFormats() : mixed
Return values
mixed —

getVideoActiveViewOptOut()

public getVideoActiveViewOptOut() : mixed
Return values
mixed —

getVpaidAdapterChoice()

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

setAdBlockingOptOut()

public setAdBlockingOptOut(mixed $adBlockingOptOut) : mixed
Parameters
$adBlockingOptOut : mixed
Return values
mixed —

setAdditionalSizes()

public setAdditionalSizes(mixed $additionalSizes) : mixed
Parameters
$additionalSizes : mixed
Return values
mixed —

setAdvertiserId()

public setAdvertiserId(mixed $advertiserId) : mixed
Parameters
$advertiserId : mixed
Return values
mixed —

setArchived()

public setArchived(mixed $archived) : mixed
Parameters
$archived : mixed
Return values
mixed —

setCampaignId()

public setCampaignId(mixed $campaignId) : mixed
Parameters
$campaignId : mixed
Return values
mixed —

setComment()

public setComment(mixed $comment) : mixed
Parameters
$comment : mixed
Return values
mixed —

setCompatibility()

public setCompatibility(mixed $compatibility) : mixed
Parameters
$compatibility : mixed
Return values
mixed —

setContentCategoryId()

public setContentCategoryId(mixed $contentCategoryId) : mixed
Parameters
$contentCategoryId : mixed
Return values
mixed —

setDirectorySiteId()

public setDirectorySiteId(mixed $directorySiteId) : mixed
Parameters
$directorySiteId : mixed
Return values
mixed —

setExternalId()

public setExternalId(mixed $externalId) : mixed
Parameters
$externalId : mixed
Return values
mixed —

setId()

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

setKeyName()

public setKeyName(mixed $keyName) : mixed
Parameters
$keyName : mixed
Return values
mixed —

setKind()

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

setName()

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

setPaymentApproved()

public setPaymentApproved(mixed $paymentApproved) : mixed
Parameters
$paymentApproved : mixed
Return values
mixed —

setPaymentSource()

public setPaymentSource(mixed $paymentSource) : mixed
Parameters
$paymentSource : mixed
Return values
mixed —

setPlacementGroupId()

public setPlacementGroupId(mixed $placementGroupId) : mixed
Parameters
$placementGroupId : mixed
Return values
mixed —

setPlacementStrategyId()

public setPlacementStrategyId(mixed $placementStrategyId) : mixed
Parameters
$placementStrategyId : mixed
Return values
mixed —

setPrimary()

public setPrimary(mixed $primary) : mixed
Parameters
$primary : mixed
Return values
mixed —

setSiteId()

public setSiteId(mixed $siteId) : mixed
Parameters
$siteId : mixed
Return values
mixed —

setSslRequired()

public setSslRequired(mixed $sslRequired) : mixed
Parameters
$sslRequired : mixed
Return values
mixed —

setStatus()

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

setSubaccountId()

public setSubaccountId(mixed $subaccountId) : mixed
Parameters
$subaccountId : mixed
Return values
mixed —

setTagFormats()

public setTagFormats(mixed $tagFormats) : mixed
Parameters
$tagFormats : mixed
Return values
mixed —

setVideoActiveViewOptOut()

public setVideoActiveViewOptOut(mixed $videoActiveViewOptOut) : mixed
Parameters
$videoActiveViewOptOut : mixed
Return values
mixed —

setVpaidAdapterChoice()

public setVpaidAdapterChoice(mixed $vpaidAdapterChoice) : mixed
Parameters
$vpaidAdapterChoice : 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