Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Dfareporting_Projects_Resource Class Reference

The "projects" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_Projects_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 project by ID.
 
 listProjects ($profileId, $optParams=array())
 Retrieves a list of projects, possibly filtered.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "projects" collection of methods.

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

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

Gets one project by ID.

(projects.get)

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

◆ listProjects()

Google_Service_Dfareporting_Projects_Resource::listProjects ( $profileId,
$optParams = array() )

Retrieves a list of projects, possibly filtered.

(projects.listProjects)

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

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

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