Documentation

Google_Service_Dfareporting_Campaign 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
$advertiserGroupId  : mixed
$advertiserId  : mixed
$archived  : mixed
$billingInvoiceCode  : mixed
$comment  : mixed
$creativeGroupIds  : mixed
$defaultLandingPageId  : mixed
$endDate  : mixed
$externalId  : mixed
$id  : mixed
$kind  : mixed
$name  : mixed
$nielsenOcrEnabled  : mixed
$startDate  : mixed
$subaccountId  : mixed
$traffickerEmails  : mixed
$adBlockingConfigurationDataType  : mixed
$adBlockingConfigurationType  : mixed
$additionalCreativeOptimizationConfigurationsDataType  : mixed
$additionalCreativeOptimizationConfigurationsType  : mixed
$advertiserIdDimensionValueDataType  : mixed
$advertiserIdDimensionValueType  : mixed
$audienceSegmentGroupsDataType  : mixed
$audienceSegmentGroupsType  : mixed
$clickThroughUrlSuffixPropertiesDataType  : mixed
$clickThroughUrlSuffixPropertiesType  : mixed
$collection_key  : mixed
$createInfoDataType  : mixed
$createInfoType  : mixed
$creativeOptimizationConfigurationDataType  : mixed
$creativeOptimizationConfigurationType  : mixed
$defaultClickThroughEventTagPropertiesDataType  : mixed
$defaultClickThroughEventTagPropertiesType  : mixed
$eventTagOverridesDataType  : mixed
$eventTagOverridesType  : mixed
$idDimensionValueDataType  : mixed
$idDimensionValueType  : mixed
$internal_gapi_mappings  : mixed
$lastModifiedInfoDataType  : mixed
$lastModifiedInfoType  : mixed
$modelData  : mixed
$processed  : 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
getAdBlockingConfiguration()  : Google_Service_Dfareporting_AdBlockingConfiguration
getAdditionalCreativeOptimizationConfigurations()  : Google_Service_Dfareporting_CreativeOptimizationConfiguration
getAdvertiserGroupId()  : mixed
getAdvertiserId()  : mixed
getAdvertiserIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getArchived()  : mixed
getAudienceSegmentGroups()  : Google_Service_Dfareporting_AudienceSegmentGroup
getBillingInvoiceCode()  : mixed
getClickThroughUrlSuffixProperties()  : Google_Service_Dfareporting_ClickThroughUrlSuffixProperties
getComment()  : mixed
getCreateInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getCreativeGroupIds()  : mixed
getCreativeOptimizationConfiguration()  : Google_Service_Dfareporting_CreativeOptimizationConfiguration
getDefaultClickThroughEventTagProperties()  : Google_Service_Dfareporting_DefaultClickThroughEventTagProperties
getDefaultLandingPageId()  : mixed
getEndDate()  : mixed
getEventTagOverrides()  : Google_Service_Dfareporting_EventTagOverride
getExternalId()  : mixed
getId()  : mixed
getIdDimensionValue()  : Google_Service_Dfareporting_DimensionValue
getKind()  : mixed
getLastModifiedInfo()  : Google_Service_Dfareporting_LastModifiedInfo
getName()  : mixed
getNielsenOcrEnabled()  : mixed
getStartDate()  : mixed
getSubaccountId()  : mixed
getTraffickerEmails()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAccountId()  : mixed
setAdBlockingConfiguration()  : mixed
setAdditionalCreativeOptimizationConfigurations()  : mixed
setAdvertiserGroupId()  : mixed
setAdvertiserId()  : mixed
setAdvertiserIdDimensionValue()  : mixed
setArchived()  : mixed
setAudienceSegmentGroups()  : mixed
setBillingInvoiceCode()  : mixed
setClickThroughUrlSuffixProperties()  : mixed
setComment()  : mixed
setCreateInfo()  : mixed
setCreativeGroupIds()  : mixed
setCreativeOptimizationConfiguration()  : mixed
setDefaultClickThroughEventTagProperties()  : mixed
setDefaultLandingPageId()  : mixed
setEndDate()  : mixed
setEventTagOverrides()  : mixed
setExternalId()  : mixed
setId()  : mixed
setIdDimensionValue()  : mixed
setKind()  : mixed
setLastModifiedInfo()  : mixed
setName()  : mixed
setNielsenOcrEnabled()  : mixed
setStartDate()  : mixed
setSubaccountId()  : mixed
setTraffickerEmails()  : 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

$advertiserGroupId

public mixed $advertiserGroupId

$advertiserId

public mixed $advertiserId

$billingInvoiceCode

public mixed $billingInvoiceCode

$creativeGroupIds

public mixed $creativeGroupIds

$defaultLandingPageId

public mixed $defaultLandingPageId

$nielsenOcrEnabled

public mixed $nielsenOcrEnabled

$subaccountId

public mixed $subaccountId

$traffickerEmails

public mixed $traffickerEmails

$adBlockingConfigurationDataType

protected mixed $adBlockingConfigurationDataType = ''

$adBlockingConfigurationType

protected mixed $adBlockingConfigurationType = 'Google_Service_Dfareporting_AdBlockingConfiguration'

$additionalCreativeOptimizationConfigurationsDataType

protected mixed $additionalCreativeOptimizationConfigurationsDataType = 'array'

$additionalCreativeOptimizationConfigurationsType

protected mixed $additionalCreativeOptimizationConfigurationsType = 'Google_Service_Dfareporting_CreativeOptimizationConfiguration'

$advertiserIdDimensionValueDataType

protected mixed $advertiserIdDimensionValueDataType = ''

$advertiserIdDimensionValueType

protected mixed $advertiserIdDimensionValueType = 'Google_Service_Dfareporting_DimensionValue'

$audienceSegmentGroupsDataType

protected mixed $audienceSegmentGroupsDataType = 'array'

$audienceSegmentGroupsType

protected mixed $audienceSegmentGroupsType = 'Google_Service_Dfareporting_AudienceSegmentGroup'

$clickThroughUrlSuffixPropertiesDataType

protected mixed $clickThroughUrlSuffixPropertiesDataType = ''

$clickThroughUrlSuffixPropertiesType

protected mixed $clickThroughUrlSuffixPropertiesType = 'Google_Service_Dfareporting_ClickThroughUrlSuffixProperties'

$collection_key

protected mixed $collection_key = 'traffickerEmails'

$createInfoDataType

protected mixed $createInfoDataType = ''

$createInfoType

protected mixed $createInfoType = 'Google_Service_Dfareporting_LastModifiedInfo'

$creativeOptimizationConfigurationDataType

protected mixed $creativeOptimizationConfigurationDataType = ''

$creativeOptimizationConfigurationType

protected mixed $creativeOptimizationConfigurationType = 'Google_Service_Dfareporting_CreativeOptimizationConfiguration'

$defaultClickThroughEventTagPropertiesDataType

protected mixed $defaultClickThroughEventTagPropertiesDataType = ''

$defaultClickThroughEventTagPropertiesType

protected mixed $defaultClickThroughEventTagPropertiesType = 'Google_Service_Dfareporting_DefaultClickThroughEventTagProperties'

$eventTagOverridesDataType

protected mixed $eventTagOverridesDataType = 'array'

$eventTagOverridesType

protected mixed $eventTagOverridesType = 'Google_Service_Dfareporting_EventTagOverride'

$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'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

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 —

getAdvertiserGroupId()

public getAdvertiserGroupId() : mixed
Return values
mixed —

getAdvertiserId()

public getAdvertiserId() : mixed
Return values
mixed —

getArchived()

public getArchived() : mixed
Return values
mixed —

getBillingInvoiceCode()

public getBillingInvoiceCode() : mixed
Return values
mixed —

getComment()

public getComment() : mixed
Return values
mixed —

getCreativeGroupIds()

public getCreativeGroupIds() : mixed
Return values
mixed —

getDefaultLandingPageId()

public getDefaultLandingPageId() : mixed
Return values
mixed —

getEndDate()

public getEndDate() : mixed
Return values
mixed —

getExternalId()

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

getNielsenOcrEnabled()

public getNielsenOcrEnabled() : mixed
Return values
mixed —

getStartDate()

public getStartDate() : mixed
Return values
mixed —

getSubaccountId()

public getSubaccountId() : mixed
Return values
mixed —

getTraffickerEmails()

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

setAdditionalCreativeOptimizationConfigurations()

public setAdditionalCreativeOptimizationConfigurations(mixed $additionalCreativeOptimizationConfigurations) : mixed
Parameters
$additionalCreativeOptimizationConfigurations : mixed
Return values
mixed —

setAdvertiserGroupId()

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

setAudienceSegmentGroups()

public setAudienceSegmentGroups(mixed $audienceSegmentGroups) : mixed
Parameters
$audienceSegmentGroups : mixed
Return values
mixed —

setBillingInvoiceCode()

public setBillingInvoiceCode(mixed $billingInvoiceCode) : mixed
Parameters
$billingInvoiceCode : mixed
Return values
mixed —

setComment()

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

setCreativeGroupIds()

public setCreativeGroupIds(mixed $creativeGroupIds) : mixed
Parameters
$creativeGroupIds : mixed
Return values
mixed —

setDefaultLandingPageId()

public setDefaultLandingPageId(mixed $defaultLandingPageId) : mixed
Parameters
$defaultLandingPageId : mixed
Return values
mixed —

setEndDate()

public setEndDate(mixed $endDate) : mixed
Parameters
$endDate : mixed
Return values
mixed —

setEventTagOverrides()

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

setKind()

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

setName()

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

setNielsenOcrEnabled()

public setNielsenOcrEnabled(mixed $nielsenOcrEnabled) : mixed
Parameters
$nielsenOcrEnabled : mixed
Return values
mixed —

setStartDate()

public setStartDate(mixed $startDate) : mixed
Parameters
$startDate : mixed
Return values
mixed —

setSubaccountId()

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

setTraffickerEmails()

public setTraffickerEmails(mixed $traffickerEmails) : mixed
Parameters
$traffickerEmails : 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