Documentation

Google_Service_DisplayVideo_Creative 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.
$advertiserId  : mixed
$appendedTag  : mixed
$cmPlacementId  : mixed
$companionCreativeIds  : mixed
$createTime  : mixed
$creativeAttributes  : mixed
$creativeId  : mixed
$creativeType  : mixed
$displayName  : mixed
$dynamic  : mixed
$entityStatus  : mixed
$expandingDirection  : mixed
$expandOnHover  : mixed
$hostingSource  : mixed
$html5Video  : mixed
$iasCampaignMonitoring  : mixed
$integrationCode  : mixed
$jsTrackerUrl  : mixed
$lineItemIds  : mixed
$mediaDuration  : mixed
$name  : mixed
$notes  : mixed
$requireHtml5  : mixed
$requireMraid  : mixed
$requirePingForAttribution  : mixed
$skippable  : mixed
$thirdPartyTag  : mixed
$trackerUrls  : mixed
$updateTime  : mixed
$vastTagUrl  : mixed
$vpaid  : mixed
$additionalDimensionsDataType  : mixed
$additionalDimensionsType  : mixed
$assetsDataType  : mixed
$assetsType  : mixed
$cmTrackingAdDataType  : mixed
$cmTrackingAdType  : mixed
$collection_key  : mixed
$counterEventsDataType  : mixed
$counterEventsType  : mixed
$dimensionsDataType  : mixed
$dimensionsType  : mixed
$exitEventsDataType  : mixed
$exitEventsType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$obaIconDataType  : mixed
$obaIconType  : mixed
$processed  : mixed
$progressOffsetDataType  : mixed
$progressOffsetType  : mixed
$reviewStatusDataType  : mixed
$reviewStatusType  : mixed
$skipOffsetDataType  : mixed
$skipOffsetType  : mixed
$thirdPartyUrlsDataType  : mixed
$thirdPartyUrlsType  : mixed
$timerEventsDataType  : mixed
$timerEventsType  : mixed
$transcodesDataType  : mixed
$transcodesType  : mixed
$universalAdIdDataType  : mixed
$universalAdIdType  : 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
getAdditionalDimensions()  : Google_Service_DisplayVideo_Dimensions
getAdvertiserId()  : mixed
getAppendedTag()  : mixed
getAssets()  : Google_Service_DisplayVideo_AssetAssociation
getCmPlacementId()  : mixed
getCmTrackingAd()  : Google_Service_DisplayVideo_CmTrackingAd
getCompanionCreativeIds()  : mixed
getCounterEvents()  : Google_Service_DisplayVideo_CounterEvent
getCreateTime()  : mixed
getCreativeAttributes()  : mixed
getCreativeId()  : mixed
getCreativeType()  : mixed
getDimensions()  : Google_Service_DisplayVideo_Dimensions
getDisplayName()  : mixed
getDynamic()  : mixed
getEntityStatus()  : mixed
getExitEvents()  : Google_Service_DisplayVideo_ExitEvent
getExpandingDirection()  : mixed
getExpandOnHover()  : mixed
getHostingSource()  : mixed
getHtml5Video()  : mixed
getIasCampaignMonitoring()  : mixed
getIntegrationCode()  : mixed
getJsTrackerUrl()  : mixed
getLineItemIds()  : mixed
getMediaDuration()  : mixed
getName()  : mixed
getNotes()  : mixed
getObaIcon()  : Google_Service_DisplayVideo_ObaIcon
getProgressOffset()  : Google_Service_DisplayVideo_AudioVideoOffset
getRequireHtml5()  : mixed
getRequireMraid()  : mixed
getRequirePingForAttribution()  : mixed
getReviewStatus()  : Google_Service_DisplayVideo_ReviewStatusInfo
getSkipOffset()  : Google_Service_DisplayVideo_AudioVideoOffset
getSkippable()  : mixed
getThirdPartyTag()  : mixed
getThirdPartyUrls()  : Google_Service_DisplayVideo_ThirdPartyUrl
getTimerEvents()  : Google_Service_DisplayVideo_TimerEvent
getTrackerUrls()  : mixed
getTranscodes()  : Google_Service_DisplayVideo_Transcode
getUniversalAdId()  : Google_Service_DisplayVideo_UniversalAdId
getUpdateTime()  : mixed
getVastTagUrl()  : mixed
getVpaid()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAdditionalDimensions()  : mixed
setAdvertiserId()  : mixed
setAppendedTag()  : mixed
setAssets()  : mixed
setCmPlacementId()  : mixed
setCmTrackingAd()  : mixed
setCompanionCreativeIds()  : mixed
setCounterEvents()  : mixed
setCreateTime()  : mixed
setCreativeAttributes()  : mixed
setCreativeId()  : mixed
setCreativeType()  : mixed
setDimensions()  : mixed
setDisplayName()  : mixed
setDynamic()  : mixed
setEntityStatus()  : mixed
setExitEvents()  : mixed
setExpandingDirection()  : mixed
setExpandOnHover()  : mixed
setHostingSource()  : mixed
setHtml5Video()  : mixed
setIasCampaignMonitoring()  : mixed
setIntegrationCode()  : mixed
setJsTrackerUrl()  : mixed
setLineItemIds()  : mixed
setMediaDuration()  : mixed
setName()  : mixed
setNotes()  : mixed
setObaIcon()  : mixed
setProgressOffset()  : mixed
setRequireHtml5()  : mixed
setRequireMraid()  : mixed
setRequirePingForAttribution()  : mixed
setReviewStatus()  : mixed
setSkipOffset()  : mixed
setSkippable()  : mixed
setThirdPartyTag()  : mixed
setThirdPartyUrls()  : mixed
setTimerEvents()  : mixed
setTrackerUrls()  : mixed
setTranscodes()  : mixed
setUniversalAdId()  : mixed
setUpdateTime()  : mixed
setVastTagUrl()  : mixed
setVpaid()  : 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

$advertiserId

public mixed $advertiserId

$cmPlacementId

public mixed $cmPlacementId

$companionCreativeIds

public mixed $companionCreativeIds

$creativeAttributes

public mixed $creativeAttributes

$creativeType

public mixed $creativeType

$entityStatus

public mixed $entityStatus

$expandingDirection

public mixed $expandingDirection

$expandOnHover

public mixed $expandOnHover

$hostingSource

public mixed $hostingSource

$iasCampaignMonitoring

public mixed $iasCampaignMonitoring

$integrationCode

public mixed $integrationCode

$jsTrackerUrl

public mixed $jsTrackerUrl

$mediaDuration

public mixed $mediaDuration

$requireHtml5

public mixed $requireHtml5

$requireMraid

public mixed $requireMraid

$requirePingForAttribution

public mixed $requirePingForAttribution

$thirdPartyTag

public mixed $thirdPartyTag

$additionalDimensionsDataType

protected mixed $additionalDimensionsDataType = 'array'

$additionalDimensionsType

protected mixed $additionalDimensionsType = 'Google_Service_DisplayVideo_Dimensions'

$assetsDataType

protected mixed $assetsDataType = 'array'

$assetsType

protected mixed $assetsType = 'Google_Service_DisplayVideo_AssetAssociation'

$cmTrackingAdDataType

protected mixed $cmTrackingAdDataType = ''

$cmTrackingAdType

protected mixed $cmTrackingAdType = 'Google_Service_DisplayVideo_CmTrackingAd'

$collection_key

protected mixed $collection_key = 'transcodes'

$counterEventsDataType

protected mixed $counterEventsDataType = 'array'

$counterEventsType

protected mixed $counterEventsType = 'Google_Service_DisplayVideo_CounterEvent'

$dimensionsDataType

protected mixed $dimensionsDataType = ''

$dimensionsType

protected mixed $dimensionsType = 'Google_Service_DisplayVideo_Dimensions'

$exitEventsDataType

protected mixed $exitEventsDataType = 'array'

$exitEventsType

protected mixed $exitEventsType = 'Google_Service_DisplayVideo_ExitEvent'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$obaIconDataType

protected mixed $obaIconDataType = ''

$obaIconType

protected mixed $obaIconType = 'Google_Service_DisplayVideo_ObaIcon'

$processed

protected mixed $processed = array()

$progressOffsetDataType

protected mixed $progressOffsetDataType = ''

$progressOffsetType

protected mixed $progressOffsetType = 'Google_Service_DisplayVideo_AudioVideoOffset'

$reviewStatusDataType

protected mixed $reviewStatusDataType = ''

$reviewStatusType

protected mixed $reviewStatusType = 'Google_Service_DisplayVideo_ReviewStatusInfo'

$skipOffsetDataType

protected mixed $skipOffsetDataType = ''

$skipOffsetType

protected mixed $skipOffsetType = 'Google_Service_DisplayVideo_AudioVideoOffset'

$thirdPartyUrlsDataType

protected mixed $thirdPartyUrlsDataType = 'array'

$thirdPartyUrlsType

protected mixed $thirdPartyUrlsType = 'Google_Service_DisplayVideo_ThirdPartyUrl'

$timerEventsDataType

protected mixed $timerEventsDataType = 'array'

$timerEventsType

protected mixed $timerEventsType = 'Google_Service_DisplayVideo_TimerEvent'

$transcodesDataType

protected mixed $transcodesDataType = 'array'

$transcodesType

protected mixed $transcodesType = 'Google_Service_DisplayVideo_Transcode'

$universalAdIdDataType

protected mixed $universalAdIdDataType = ''

$universalAdIdType

protected mixed $universalAdIdType = 'Google_Service_DisplayVideo_UniversalAdId'

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 —

getAdvertiserId()

public getAdvertiserId() : mixed
Return values
mixed —

getAppendedTag()

public getAppendedTag() : mixed
Return values
mixed —

getCmPlacementId()

public getCmPlacementId() : mixed
Return values
mixed —

getCompanionCreativeIds()

public getCompanionCreativeIds() : mixed
Return values
mixed —

getCreateTime()

public getCreateTime() : mixed
Return values
mixed —

getCreativeAttributes()

public getCreativeAttributes() : mixed
Return values
mixed —

getCreativeId()

public getCreativeId() : mixed
Return values
mixed —

getCreativeType()

public getCreativeType() : mixed
Return values
mixed —

getDisplayName()

public getDisplayName() : mixed
Return values
mixed —

getDynamic()

public getDynamic() : mixed
Return values
mixed —

getEntityStatus()

public getEntityStatus() : mixed
Return values
mixed —

getExpandingDirection()

public getExpandingDirection() : mixed
Return values
mixed —

getExpandOnHover()

public getExpandOnHover() : mixed
Return values
mixed —

getHostingSource()

public getHostingSource() : mixed
Return values
mixed —

getHtml5Video()

public getHtml5Video() : mixed
Return values
mixed —

getIasCampaignMonitoring()

public getIasCampaignMonitoring() : mixed
Return values
mixed —

getIntegrationCode()

public getIntegrationCode() : mixed
Return values
mixed —

getJsTrackerUrl()

public getJsTrackerUrl() : mixed
Return values
mixed —

getLineItemIds()

public getLineItemIds() : mixed
Return values
mixed —

getMediaDuration()

public getMediaDuration() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getNotes()

public getNotes() : mixed
Return values
mixed —

getRequireHtml5()

public getRequireHtml5() : mixed
Return values
mixed —

getRequireMraid()

public getRequireMraid() : mixed
Return values
mixed —

getRequirePingForAttribution()

public getRequirePingForAttribution() : mixed
Return values
mixed —

getSkippable()

public getSkippable() : mixed
Return values
mixed —

getThirdPartyTag()

public getThirdPartyTag() : mixed
Return values
mixed —

getTrackerUrls()

public getTrackerUrls() : mixed
Return values
mixed —

getUpdateTime()

public getUpdateTime() : mixed
Return values
mixed —

getVastTagUrl()

public getVastTagUrl() : mixed
Return values
mixed —

getVpaid()

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

setAdditionalDimensions()

public setAdditionalDimensions(mixed $additionalDimensions) : mixed
Parameters
$additionalDimensions : mixed
Return values
mixed —

setAdvertiserId()

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

setAppendedTag()

public setAppendedTag(mixed $appendedTag) : mixed
Parameters
$appendedTag : mixed
Return values
mixed —

setAssets()

public setAssets(mixed $assets) : mixed
Parameters
$assets : mixed
Return values
mixed —

setCmPlacementId()

public setCmPlacementId(mixed $cmPlacementId) : mixed
Parameters
$cmPlacementId : mixed
Return values
mixed —

setCompanionCreativeIds()

public setCompanionCreativeIds(mixed $companionCreativeIds) : mixed
Parameters
$companionCreativeIds : mixed
Return values
mixed —

setCounterEvents()

public setCounterEvents(mixed $counterEvents) : mixed
Parameters
$counterEvents : mixed
Return values
mixed —

setCreateTime()

public setCreateTime(mixed $createTime) : mixed
Parameters
$createTime : mixed
Return values
mixed —

setCreativeAttributes()

public setCreativeAttributes(mixed $creativeAttributes) : mixed
Parameters
$creativeAttributes : mixed
Return values
mixed —

setCreativeId()

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

setCreativeType()

public setCreativeType(mixed $creativeType) : mixed
Parameters
$creativeType : mixed
Return values
mixed —

setDisplayName()

public setDisplayName(mixed $displayName) : mixed
Parameters
$displayName : mixed
Return values
mixed —

setDynamic()

public setDynamic(mixed $dynamic) : mixed
Parameters
$dynamic : mixed
Return values
mixed —

setEntityStatus()

public setEntityStatus(mixed $entityStatus) : mixed
Parameters
$entityStatus : mixed
Return values
mixed —

setExitEvents()

public setExitEvents(mixed $exitEvents) : mixed
Parameters
$exitEvents : mixed
Return values
mixed —

setExpandingDirection()

public setExpandingDirection(mixed $expandingDirection) : mixed
Parameters
$expandingDirection : mixed
Return values
mixed —

setExpandOnHover()

public setExpandOnHover(mixed $expandOnHover) : mixed
Parameters
$expandOnHover : mixed
Return values
mixed —

setHostingSource()

public setHostingSource(mixed $hostingSource) : mixed
Parameters
$hostingSource : mixed
Return values
mixed —

setHtml5Video()

public setHtml5Video(mixed $html5Video) : mixed
Parameters
$html5Video : mixed
Return values
mixed —

setIasCampaignMonitoring()

public setIasCampaignMonitoring(mixed $iasCampaignMonitoring) : mixed
Parameters
$iasCampaignMonitoring : mixed
Return values
mixed —

setIntegrationCode()

public setIntegrationCode(mixed $integrationCode) : mixed
Parameters
$integrationCode : mixed
Return values
mixed —

setJsTrackerUrl()

public setJsTrackerUrl(mixed $jsTrackerUrl) : mixed
Parameters
$jsTrackerUrl : mixed
Return values
mixed —

setLineItemIds()

public setLineItemIds(mixed $lineItemIds) : mixed
Parameters
$lineItemIds : mixed
Return values
mixed —

setMediaDuration()

public setMediaDuration(mixed $mediaDuration) : mixed
Parameters
$mediaDuration : mixed
Return values
mixed —

setName()

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

setNotes()

public setNotes(mixed $notes) : mixed
Parameters
$notes : mixed
Return values
mixed —

setRequireHtml5()

public setRequireHtml5(mixed $requireHtml5) : mixed
Parameters
$requireHtml5 : mixed
Return values
mixed —

setRequireMraid()

public setRequireMraid(mixed $requireMraid) : mixed
Parameters
$requireMraid : mixed
Return values
mixed —

setRequirePingForAttribution()

public setRequirePingForAttribution(mixed $requirePingForAttribution) : mixed
Parameters
$requirePingForAttribution : mixed
Return values
mixed —

setSkippable()

public setSkippable(mixed $skippable) : mixed
Parameters
$skippable : mixed
Return values
mixed —

setThirdPartyTag()

public setThirdPartyTag(mixed $thirdPartyTag) : mixed
Parameters
$thirdPartyTag : mixed
Return values
mixed —

setThirdPartyUrls()

public setThirdPartyUrls(mixed $thirdPartyUrls) : mixed
Parameters
$thirdPartyUrls : mixed
Return values
mixed —

setTimerEvents()

public setTimerEvents(mixed $timerEvents) : mixed
Parameters
$timerEvents : mixed
Return values
mixed —

setTrackerUrls()

public setTrackerUrls(mixed $trackerUrls) : mixed
Parameters
$trackerUrls : mixed
Return values
mixed —

setTranscodes()

public setTranscodes(mixed $transcodes) : mixed
Parameters
$transcodes : mixed
Return values
mixed —

setUpdateTime()

public setUpdateTime(mixed $updateTime) : mixed
Parameters
$updateTime : mixed
Return values
mixed —

setVastTagUrl()

public setVastTagUrl(mixed $vastTagUrl) : mixed
Parameters
$vastTagUrl : mixed
Return values
mixed —

setVpaid()

public setVpaid(mixed $vpaid) : mixed
Parameters
$vpaid : 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