Documentation

Google_Service_Dfareporting_Resource_DynamicTargetingKeys extends Google_Service_Resource
in package

The "dynamicTargetingKeys" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $dynamicTargetingKeys = $dfareportingService->dynamicTargetingKeys;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes an existing dynamic targeting key. (dynamicTargetingKeys.delete)
insert()  : Google_Service_Dfareporting_DynamicTargetingKey
Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
listDynamicTargetingKeys()  : Google_Service_Dfareporting_DynamicTargetingKeysListResponse
Retrieves a list of dynamic targeting keys.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes an existing dynamic targeting key. (dynamicTargetingKeys.delete)

public delete(string $profileId, string $objectId, string $name, string $objectType[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$profileId : string

User profile ID associated with this request.

$objectId : string

ID of the object of this dynamic targeting key. This is a required field.

$name : string

Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.

$objectType : string

Type of the object of this dynamic targeting key. This is a required field.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

insert()

Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

public insert(string $profileId, Google_Service_Dfareporting_DynamicTargetingKey $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_DynamicTargetingKey

(dynamicTargetingKeys.insert)

Parameters
$profileId : string

User profile ID associated with this request.

$postBody : Google_Service_Dfareporting_DynamicTargetingKey
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_DynamicTargetingKey —

listDynamicTargetingKeys()

Retrieves a list of dynamic targeting keys.

public listDynamicTargetingKeys(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_DynamicTargetingKeysListResponse

(dynamicTargetingKeys.listDynamicTargetingKeys)

Parameters
$profileId : string

User profile ID associated with this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string objectId Select only dynamic targeting keys with this object ID.

opt_param

string advertiserId Select only dynamic targeting keys whose object has this advertiser ID.

opt_param

string names Select only dynamic targeting keys exactly matching these names.

opt_param

string objectType Select only dynamic targeting keys with this object type.

Return values
Google_Service_Dfareporting_DynamicTargetingKeysListResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results