Documentation

Google_Service_Dfareporting_Resource_TargetableRemarketingLists extends Google_Service_Resource
in package

The "targetableRemarketingLists" collection of methods.

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

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_TargetableRemarketingList
Gets one remarketing list by ID. (targetableRemarketingLists.get)
listTargetableRemarketingLists()  : Google_Service_Dfareporting_TargetableRemarketingListsListResponse
Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
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

get()

Gets one remarketing list by ID. (targetableRemarketingLists.get)

public get(string $profileId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_TargetableRemarketingList
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

Remarketing list ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_TargetableRemarketingList —

listTargetableRemarketingLists()

Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

public listTargetableRemarketingLists(string $profileId, string $advertiserId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_TargetableRemarketingListsListResponse

(targetableRemarketingLists.listTargetableRemarketingLists)

Parameters
$profileId : string

User profile ID associated with this request.

$advertiserId : string

Select only targetable remarketing lists targetable by these advertisers.

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

Optional parameters.

Tags
opt_param

int maxResults Maximum number of results to return.

opt_param

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

opt_param

string name Allows searching for objects by name or ID. Wildcards () are allowed. For example, "remarketing list2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 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 "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".

opt_param

string sortOrder Order of sorted results.

opt_param

string sortField Field by which to sort the list.

opt_param

bool active Select only active or only inactive targetable remarketing lists.

Return values
Google_Service_Dfareporting_TargetableRemarketingListsListResponse —

convertToArrayAndStripNulls()

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

Search results