Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Dfareporting_Subaccounts_Resource Class Reference

The "subaccounts" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Subaccounts_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 subaccount by ID.
 
 insert ($profileId, Google_Service_Dfareporting_Subaccount $postBody, $optParams=array())
 Inserts a new subaccount.
 
 listSubaccounts ($profileId, $optParams=array())
 Gets a list of subaccounts, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_Subaccount $postBody, $optParams=array())
 Updates an existing subaccount.
 
 update ($profileId, Google_Service_Dfareporting_Subaccount $postBody, $optParams=array())
 Updates an existing subaccount.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "subaccounts" collection of methods.

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

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_Subaccounts_Resource::get ( $profileId,
$id,
$optParams = array() )

Gets one subaccount by ID.

(subaccounts.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idSubaccount ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_Subaccount

◆ insert()

Google_Service_Dfareporting_Subaccounts_Resource::insert ( $profileId,
Google_Service_Dfareporting_Subaccount $postBody,
$optParams = array() )

Inserts a new subaccount.

(subaccounts.insert)

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

◆ listSubaccounts()

Google_Service_Dfareporting_Subaccounts_Resource::listSubaccounts ( $profileId,
$optParams = array() )

Gets a list of subaccounts, possibly filtered.

(subaccounts.listSubaccounts)

Parameters
string$profileIdUser profile ID associated with this request.
array$optParamsOptional parameters.

@opt_param string searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 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 "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". @opt_param string sortField Field by which to sort the list. @opt_param string ids Select only subaccounts with these IDs. @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.

Return values
Google_Service_Dfareporting_SubaccountsListResponse

◆ patch()

Google_Service_Dfareporting_Subaccounts_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_Subaccount $postBody,
$optParams = array() )

Updates an existing subaccount.

This method supports patch semantics. (subaccounts.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idSubaccount ID.
Google_Subaccount$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_Subaccount

◆ update()

Google_Service_Dfareporting_Subaccounts_Resource::update ( $profileId,
Google_Service_Dfareporting_Subaccount $postBody,
$optParams = array() )

Updates an existing subaccount.

(subaccounts.update)

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

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