Documentation

Google_Service_Dfareporting_Resource_RemarketingLists extends Google_Service_Resource
in package

The "remarketingLists" collection of methods.

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

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_RemarketingList
Gets one remarketing list by ID. (remarketingLists.get)
insert()  : Google_Service_Dfareporting_RemarketingList
Inserts a new remarketing list. (remarketingLists.insert)
listRemarketingLists()  : Google_Service_Dfareporting_RemarketingListsListResponse
Retrieves a list of remarketing lists, possibly filtered. This method supports paging. (remarketingLists.listRemarketingLists)
patch()  : Google_Service_Dfareporting_RemarketingList
Updates an existing remarketing list. This method supports patch semantics.
update()  : Google_Service_Dfareporting_RemarketingList
Updates an existing remarketing list. (remarketingLists.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 remarketing list. (remarketingLists.insert)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_RemarketingList —

listRemarketingLists()

Retrieves a list of remarketing lists, possibly filtered. This method supports paging. (remarketingLists.listRemarketingLists)

public listRemarketingLists(string $profileId, string $advertiserId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_RemarketingListsListResponse
Parameters
$profileId : string

User profile ID associated with this request.

$advertiserId : string

Select only remarketing lists owned by this advertiser.

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

Optional parameters.

Tags
opt_param

bool active Select only active or only inactive remarketing lists.

opt_param

string sortOrder Order of sorted results.

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 pageToken Value of the nextPageToken from the previous result page.

opt_param

string sortField Field by which to sort the list.

opt_param

int maxResults Maximum number of results to return.

opt_param

string floodlightActivityId Select only remarketing lists that have this floodlight activity ID.

Return values
Google_Service_Dfareporting_RemarketingListsListResponse —

patch()

Updates an existing remarketing list. This method supports patch semantics.

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

(remarketingLists.patch)

Parameters
$profileId : string

User profile ID associated with this request.

$id : string

RemarketingList ID.

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

Optional parameters.

Return values
Google_Service_Dfareporting_RemarketingList —

update()

Updates an existing remarketing list. (remarketingLists.update)

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

User profile ID associated with this request.

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

Optional parameters.

Return values
Google_Service_Dfareporting_RemarketingList —

convertToArrayAndStripNulls()

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

Search results