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

The "reports" collection of methods. More...

Inheritance diagram for Google_Service_Doubleclicksearch_Reports_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 generate (Google_Service_Doubleclicksearch_ReportRequest $postBody, $optParams=array())
 Generates and returns a report immediately.
 
 get ($reportId, $optParams=array())
 Polls for the status of a report request.
 
 getFile ($reportId, $reportFragment, $optParams=array())
 Downloads a report file encoded in UTF-8.
 
 request (Google_Service_Doubleclicksearch_ReportRequest $postBody, $optParams=array())
 Inserts a report request into the reporting system.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "reports" collection of methods.

Typical usage is: $doubleclicksearchService = new Google_Service_Doubleclicksearch(...); $reports = $doubleclicksearchService->reports;

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

◆ generate()

Google_Service_Doubleclicksearch_Reports_Resource::generate ( Google_Service_Doubleclicksearch_ReportRequest $postBody,
$optParams = array() )

Generates and returns a report immediately.

(reports.generate)

Parameters
Google_ReportRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Doubleclicksearch_Report

◆ get()

Google_Service_Doubleclicksearch_Reports_Resource::get ( $reportId,
$optParams = array() )

Polls for the status of a report request.

(reports.get)

Parameters
string$reportIdID of the report request being polled.
array$optParamsOptional parameters.
Return values
Google_Service_Doubleclicksearch_Report

◆ getFile()

Google_Service_Doubleclicksearch_Reports_Resource::getFile ( $reportId,
$reportFragment,
$optParams = array() )

Downloads a report file encoded in UTF-8.

(reports.getFile)

Parameters
string$reportIdID of the report.
int$reportFragmentThe index of the report fragment to download.
array$optParamsOptional parameters.

◆ request()

Google_Service_Doubleclicksearch_Reports_Resource::request ( Google_Service_Doubleclicksearch_ReportRequest $postBody,
$optParams = array() )

Inserts a report request into the reporting system.

(reports.request)

Parameters
Google_ReportRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Doubleclicksearch_Report

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