Documentation

Google_Service_Dfareporting_Resource_TargetingTemplates extends Google_Service_Resource
in package

The "targetingTemplates" collection of methods.

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

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.
get()  : Google_Service_Dfareporting_TargetingTemplate
Gets one targeting template by ID. (targetingTemplates.get)
insert()  : Google_Service_Dfareporting_TargetingTemplate
Inserts a new targeting template. (targetingTemplates.insert)
listTargetingTemplates()  : Google_Service_Dfareporting_TargetingTemplatesListResponse
Retrieves a list of targeting templates, optionally filtered. This method supports paging. (targetingTemplates.listTargetingTemplates)
patch()  : Google_Service_Dfareporting_TargetingTemplate
Updates an existing targeting template. This method supports patch semantics.
update()  : Google_Service_Dfareporting_TargetingTemplate
Updates an existing targeting template. (targetingTemplates.update)
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

insert()

Inserts a new targeting template. (targetingTemplates.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_TargetingTemplate —

listTargetingTemplates()

Retrieves a list of targeting templates, optionally filtered. This method supports paging. (targetingTemplates.listTargetingTemplates)

public listTargetingTemplates(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_TargetingTemplatesListResponse
Parameters
$profileId : string

User profile ID associated with this request.

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

Optional parameters.

Tags
opt_param

string advertiserId Select only targeting templates with this advertiser ID.

opt_param

string ids Select only targeting templates with these IDs.

opt_param

string searchString Allows searching for objects by name or ID. Wildcards () are allowed. For example, "template2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template".

opt_param

int maxResults Maximum number of results to return.

opt_param

string sortOrder Order of sorted results.

opt_param

string pageToken Value of the nextPageToken from the previous result page.

opt_param

string sortField Field by which to sort the list.

Return values
Google_Service_Dfareporting_TargetingTemplatesListResponse —

patch()

Updates an existing targeting template. This method supports patch semantics.

public patch(string $profileId, string $id, Google_Service_Dfareporting_TargetingTemplate $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_TargetingTemplate

(targetingTemplates.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

TargetingTemplate ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_TargetingTemplate —

update()

Updates an existing targeting template. (targetingTemplates.update)

public update(string $profileId, Google_Service_Dfareporting_TargetingTemplate $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_TargetingTemplate
Parameters
$profileId : string

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_TargetingTemplate —

convertToArrayAndStripNulls()

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

Search results