Documentation

Google_Service_Dfareporting_Ad 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
$active  : mixed
$advertiserId  : mixed
$archived  : mixed
$audienceSegmentId  : mixed
$campaignId  : mixed
$comments  : mixed
$compatibility  : mixed
$dynamicClickTracker  : mixed
$endTime  : mixed
$id  : mixed
$kind  : mixed
$name  : mixed
$sslCompliant  : mixed
$sslRequired  : mixed
$startTime  : mixed
$subaccountId  : mixed
$targetingTemplateId  : mixed
$type  : mixed
$advertiserIdDimensionValueDataType  : mixed
$advertiserIdDimensionValueType  : mixed
$campaignIdDimensionValueDataType  : mixed
$campaignIdDimensionValueType  : mixed
$clickThroughUrlDataType  : mixed
$clickThroughUrlSuffixPropertiesDataType  : mixed
$clickThroughUrlSuffixPropertiesType  : mixed
$clickThroughUrlType  : mixed
$collection_key  : mixed
$createInfoDataType  : mixed
$createInfoType  : mixed
$creativeGroupAssignmentsDataType  : mixed
$creativeGroupAssignmentsType  : mixed
$creativeRotationDataType  : mixed
$creativeRotationType  : mixed
$dayPartTargetingDataType  : mixed
$dayPartTargetingType  : mixed
$defaultClickThroughEventTagPropertiesDataType  : mixed
$defaultClickThroughEventTagPropertiesType  : mixed
$deliveryScheduleDataType  : mixed
$deliveryScheduleType  : mixed
$eventTagOverridesDataType  : mixed
$eventTagOverridesType  : mixed
$geoTargetingDataType  : mixed
$geoTargetingType  : mixed
$idDimensionValueDataType  : mixed
$idDimensionValueType  : mixed
$internal_gapi_mappings  : mixed
$keyValueTargetingExpressionDataType  : mixed
$keyValueTargetingExpressionType  : mixed
$languageTargetingDataType  : mixed
$languageTargetingType  : mixed
$lastModifiedInfoDataType  : mixed
$lastModifiedInfoType  : mixed
$modelData  : mixed
$placementAssignmentsDataType  : mixed
$placementAssignmentsType  : mixed
$processed  : mixed
$remarketingListExpressionDataType  : mixed
$remarketingListExpressionType  : mixed
$sizeDataType  : mixed
$sizeType  : mixed
$technologyTargetingDataType  : mixed
$technologyTargetingType  : 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
getActive()  : mixed
getAdvertiserId()  : mixed
getAdvertiserIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getArchived()  : mixed
getAudienceSegmentId()  : mixed
getCampaignId()  : mixed
getCampaignIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getClickThroughUrl()  : Google_Service_Dfareporting_ClickThroughUrl
getClickThroughUrlSuffixProperties()  : Google_Service_Dfareporting_ClickThroughUrlSuffixProperties
getComments()  : mixed
getCompatibility()  : mixed
getCreateInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getCreativeGroupAssignments()  : Google_Service_Dfareporting_CreativeGroupAssignment
getCreativeRotation()  : Google_Service_Dfareporting_CreativeRotation
getDayPartTargeting()  : Google_Service_Dfareporting_DayPartTargeting
getDefaultClickThroughEventTagProperties()  : Google_Service_Dfareporting_DefaultClickThroughEventTagProperties
getDeliverySchedule()  : Google_Service_Dfareporting_DeliverySchedule
getDynamicClickTracker()  : mixed
getEndTime()  : mixed
getEventTagOverrides()  : Google_Service_Dfareporting_EventTagOverride
getGeoTargeting()  : Google_Service_Dfareporting_GeoTargeting
getId()  : mixed
getIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getKeyValueTargetingExpression()  : Google_Service_Dfareporting_KeyValueTargetingExpression
getKind()  : mixed
getLanguageTargeting()  : Google_Service_Dfareporting_LanguageTargeting
getLastModifiedInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getName()  : mixed
getPlacementAssignments()  : Google_Service_Dfareporting_PlacementAssignment
getRemarketingListExpression()  : Google_Service_Dfareporting_ListTargetingExpression
getSize()  : Google_Service_Dfareporting_Size
getSslCompliant()  : mixed
getSslRequired()  : mixed
getStartTime()  : mixed
getSubaccountId()  : mixed
getTargetingTemplateId()  : mixed
getTechnologyTargeting()  : Google_Service_Dfareporting_TechnologyTargeting
getType()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAccountId()  : mixed
setActive()  : mixed
setAdvertiserId()  : mixed
setAdvertiserIdDimensionValue()  : mixed
setArchived()  : mixed
setAudienceSegmentId()  : mixed
setCampaignId()  : mixed
setCampaignIdDimensionValue()  : mixed
setClickThroughUrl()  : mixed
setClickThroughUrlSuffixProperties()  : mixed
setComments()  : mixed
setCompatibility()  : mixed
setCreateInfo()  : mixed
setCreativeGroupAssignments()  : mixed
setCreativeRotation()  : mixed
setDayPartTargeting()  : mixed
setDefaultClickThroughEventTagProperties()  : mixed
setDeliverySchedule()  : mixed
setDynamicClickTracker()  : mixed
setEndTime()  : mixed
setEventTagOverrides()  : mixed
setGeoTargeting()  : mixed
setId()  : mixed
setIdDimensionValue()  : mixed
setKeyValueTargetingExpression()  : mixed
setKind()  : mixed
setLanguageTargeting()  : mixed
setLastModifiedInfo()  : mixed
setName()  : mixed
setPlacementAssignments()  : mixed
setRemarketingListExpression()  : mixed
setSize()  : mixed
setSslCompliant()  : mixed
setSslRequired()  : mixed
setStartTime()  : mixed
setSubaccountId()  : mixed
setTargetingTemplateId()  : mixed
setTechnologyTargeting()  : mixed
setType()  : 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

$accountId

public mixed $accountId

$active

public mixed $active

$advertiserId

public mixed $advertiserId

$archived

public mixed $archived

$audienceSegmentId

public mixed $audienceSegmentId

$campaignId

public mixed $campaignId

$comments

public mixed $comments

$compatibility

public mixed $compatibility

$dynamicClickTracker

public mixed $dynamicClickTracker

$endTime

public mixed $endTime

$id

public mixed $id

$kind

public mixed $kind

$name

public mixed $name

$sslCompliant

public mixed $sslCompliant

$sslRequired

public mixed $sslRequired

$startTime

public mixed $startTime

$subaccountId

public mixed $subaccountId

$targetingTemplateId

public mixed $targetingTemplateId

$type

public mixed $type

$advertiserIdDimensionValueDataType

protected mixed $advertiserIdDimensionValueDataType = ''

$advertiserIdDimensionValueType

protected mixed $advertiserIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$campaignIdDimensionValueDataType

protected mixed $campaignIdDimensionValueDataType = ''

$campaignIdDimensionValueType

protected mixed $campaignIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$clickThroughUrlDataType

protected mixed $clickThroughUrlDataType = ''

$clickThroughUrlSuffixPropertiesDataType

protected mixed $clickThroughUrlSuffixPropertiesDataType = ''

$clickThroughUrlSuffixPropertiesType

protected mixed $clickThroughUrlSuffixPropertiesType = 'Google_Service_Dfareporting_ClickThroughUrlSuffixProperties'

$clickThroughUrlType

protected mixed $clickThroughUrlType = 'Google_Service_Dfareporting_ClickThroughUrl'

$collection_key

protected mixed $collection_key = 'placementAssignments'

$createInfoDataType

protected mixed $createInfoDataType = ''

$createInfoType

protected mixed $createInfoType = 'Google_Service_Dfareporting_LastModifiedInfo'

$creativeGroupAssignmentsDataType

protected mixed $creativeGroupAssignmentsDataType = 'array'

$creativeGroupAssignmentsType

protected mixed $creativeGroupAssignmentsType = 'Google_Service_Dfareporting_CreativeGroupAssignment'

$creativeRotationDataType

protected mixed $creativeRotationDataType = ''

$creativeRotationType

protected mixed $creativeRotationType = 'Google_Service_Dfareporting_CreativeRotation'

$dayPartTargetingDataType

protected mixed $dayPartTargetingDataType = ''

$dayPartTargetingType

protected mixed $dayPartTargetingType = 'Google_Service_Dfareporting_DayPartTargeting'

$defaultClickThroughEventTagPropertiesDataType

protected mixed $defaultClickThroughEventTagPropertiesDataType = ''

$defaultClickThroughEventTagPropertiesType

protected mixed $defaultClickThroughEventTagPropertiesType = 'Google_Service_Dfareporting_DefaultClickThroughEventTagProperties'

$deliveryScheduleDataType

protected mixed $deliveryScheduleDataType = ''

$deliveryScheduleType

protected mixed $deliveryScheduleType = 'Google_Service_Dfareporting_DeliverySchedule'

$eventTagOverridesDataType

protected mixed $eventTagOverridesDataType = 'array'

$eventTagOverridesType

protected mixed $eventTagOverridesType = 'Google_Service_Dfareporting_EventTagOverride'

$geoTargetingDataType

protected mixed $geoTargetingDataType = ''

$geoTargetingType

protected mixed $geoTargetingType = 'Google_Service_Dfareporting_GeoTargeting'

$idDimensionValueDataType

protected mixed $idDimensionValueDataType = ''

$idDimensionValueType

protected mixed $idDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$keyValueTargetingExpressionDataType

protected mixed $keyValueTargetingExpressionDataType = ''

$keyValueTargetingExpressionType

protected mixed $keyValueTargetingExpressionType = 'Google_Service_Dfareporting_KeyValueTargetingExpression'

$languageTargetingDataType

protected mixed $languageTargetingDataType = ''

$languageTargetingType

protected mixed $languageTargetingType = 'Google_Service_Dfareporting_LanguageTargeting'

$lastModifiedInfoDataType

protected mixed $lastModifiedInfoDataType = ''

$lastModifiedInfoType

protected mixed $lastModifiedInfoType = 'Google_Service_Dfareporting_LastModifiedInfo'

$modelData

protected mixed $modelData = array()

$placementAssignmentsDataType

protected mixed $placementAssignmentsDataType = 'array'

$placementAssignmentsType

protected mixed $placementAssignmentsType = 'Google_Service_Dfareporting_PlacementAssignment'

$processed

protected mixed $processed = array()

$remarketingListExpressionDataType

protected mixed $remarketingListExpressionDataType = ''

$remarketingListExpressionType

protected mixed $remarketingListExpressionType = 'Google_Service_Dfareporting_ListTargetingExpression'

$sizeDataType

protected mixed $sizeDataType = ''

$sizeType

protected mixed $sizeType = 'Google_Service_Dfareporting_Size'

$technologyTargetingDataType

protected mixed $technologyTargetingDataType = ''

$technologyTargetingType

protected mixed $technologyTargetingType = 'Google_Service_Dfareporting_TechnologyTargeting'

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 —

getActive()

public getActive() : mixed
Return values
mixed —

getAdvertiserId()

public getAdvertiserId() : mixed
Return values
mixed —

getArchived()

public getArchived() : mixed
Return values
mixed —

getAudienceSegmentId()

public getAudienceSegmentId() : mixed
Return values
mixed —

getCampaignId()

public getCampaignId() : mixed
Return values
mixed —

getComments()

public getComments() : mixed
Return values
mixed —

getCompatibility()

public getCompatibility() : mixed
Return values
mixed —

getDynamicClickTracker()

public getDynamicClickTracker() : mixed
Return values
mixed —

getEndTime()

public getEndTime() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getSslCompliant()

public getSslCompliant() : mixed
Return values
mixed —

getSslRequired()

public getSslRequired() : mixed
Return values
mixed —

getStartTime()

public getStartTime() : mixed
Return values
mixed —

getSubaccountId()

public getSubaccountId() : mixed
Return values
mixed —

getTargetingTemplateId()

public getTargetingTemplateId() : mixed
Return values
mixed —

getType()

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

setActive()

public setActive(mixed $active) : mixed
Parameters
$active : 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 —

setAudienceSegmentId()

public setAudienceSegmentId(mixed $audienceSegmentId) : mixed
Parameters
$audienceSegmentId : mixed
Return values
mixed —

setCampaignId()

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

setComments()

public setComments(mixed $comments) : mixed
Parameters
$comments : mixed
Return values
mixed —

setCompatibility()

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

setCreativeGroupAssignments()

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

setDynamicClickTracker()

public setDynamicClickTracker(mixed $dynamicClickTracker) : mixed
Parameters
$dynamicClickTracker : mixed
Return values
mixed —

setEndTime()

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

setEventTagOverrides()

public setEventTagOverrides(mixed $eventTagOverrides) : mixed
Parameters
$eventTagOverrides : mixed
Return values
mixed —

setId()

public setId(mixed $id) : mixed
Parameters
$id : 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 —

setPlacementAssignments()

public setPlacementAssignments(mixed $placementAssignments) : mixed
Parameters
$placementAssignments : mixed
Return values
mixed —

setSslCompliant()

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

setSslRequired()

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

setStartTime()

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

setSubaccountId()

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

setTargetingTemplateId()

public setTargetingTemplateId(mixed $targetingTemplateId) : mixed
Parameters
$targetingTemplateId : mixed
Return values
mixed —

setType()

public setType(mixed $type) : mixed
Parameters
$type : 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