Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Dfareporting_RemarketingLists_Resource Class Reference

The "remarketingLists" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_RemarketingLists_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($profileId, $id, $optParams=array())
 Gets one remarketing list by ID.
 
 insert ($profileId, Google_Service_Dfareporting_RemarketingList $postBody, $optParams=array())
 Inserts a new remarketing list.
 
 listRemarketingLists ($profileId, $advertiserId, $optParams=array())
 Retrieves a list of remarketing lists, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_RemarketingList $postBody, $optParams=array())
 Updates an existing remarketing list.
 
 update ($profileId, Google_Service_Dfareporting_RemarketingList $postBody, $optParams=array())
 Updates an existing remarketing list.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "remarketingLists" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ get()

Google_Service_Dfareporting_RemarketingLists_Resource::get ( $profileId,
$id,
$optParams = array() )

Gets one remarketing list by ID.

(remarketingLists.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idRemarketing list ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_RemarketingList

◆ insert()

Google_Service_Dfareporting_RemarketingLists_Resource::insert ( $profileId,
Google_Service_Dfareporting_RemarketingList $postBody,
$optParams = array() )

Inserts a new remarketing list.

(remarketingLists.insert)

Parameters
string$profileIdUser profile ID associated with this request.
Google_RemarketingList$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_RemarketingList

◆ listRemarketingLists()

Google_Service_Dfareporting_RemarketingLists_Resource::listRemarketingLists ( $profileId,
$advertiserId,
$optParams = array() )

Retrieves a list of remarketing lists, possibly filtered.

(remarketingLists.listRemarketingLists)

Parameters
string$profileIdUser profile ID associated with this request.
string$advertiserIdSelect only remarketing lists owned by this advertiser.
array$optParamsOptional parameters.

@opt_param string name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" 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 sortField Field by which to sort the list. @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 sortOrder Order of sorted results, default is ASCENDING. @opt_param bool active Select only active or only inactive remarketing lists. @opt_param string floodlightActivityId Select only remarketing lists that have this floodlight activity ID.

Return values
Google_Service_Dfareporting_RemarketingListsListResponse

◆ patch()

Google_Service_Dfareporting_RemarketingLists_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_RemarketingList $postBody,
$optParams = array() )

Updates an existing remarketing list.

This method supports patch semantics. (remarketingLists.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idRemarketing list ID.
Google_RemarketingList$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_RemarketingList

◆ update()

Google_Service_Dfareporting_RemarketingLists_Resource::update ( $profileId,
Google_Service_Dfareporting_RemarketingList $postBody,
$optParams = array() )

Updates an existing remarketing list.

(remarketingLists.update)

Parameters
string$profileIdUser profile ID associated with this request.
Google_RemarketingList$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_RemarketingList

The documentation for this class was generated from the following file: