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

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

Inheritance diagram for Google_Service_AdSense_AccountsReports_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 generate ($accountId, $startDate, $endDate, $optParams=array())
 Generate an AdSense report based on the report request sent in the query parameters.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "reports" collection of methods.

Typical usage is: $adsenseService = new Google_Service_AdSense(...); $reports = $adsenseService->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_AdSense_AccountsReports_Resource::generate ( $accountId,
$startDate,
$endDate,
$optParams = array() )

Generate an AdSense report based on the report request sent in the query parameters.

Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. (reports.generate)

Parameters
string$accountIdAccount upon which to report.
string$startDateStart of the date range to report on in "YYYY-MM-DD" format, inclusive.
string$endDateEnd of the date range to report on in "YYYY-MM-DD" format, inclusive.
array$optParamsOptional parameters.

@opt_param string sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. @opt_param string locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. @opt_param string metric Numeric columns to include in the report. @opt_param int maxResults The maximum number of rows of report data to return. @opt_param string filter Filters to be run on the report. @opt_param string currency Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. @opt_param int startIndex Index of the first row of report data to return. @opt_param bool useTimezoneReporting Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. @opt_param string dimension Dimensions to base the report on.

Return values
Google_Service_AdSense_AdsenseReportsGenerateResponse

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