Google_Service_AdSense_AccountsReports_Resource

The "reports" collection of methods.

Defined (1)

The class is defined in the following location(s).

/vendor/google/apiclient/src/Google/Service/AdSense.php  
  1. class Google_Service_AdSense_AccountsReports_Resource extends Google_Service_Resource 
  2. { 
  3.  
  4.   /** 
  5.    * Generate an AdSense report based on the report request sent in the query 
  6.    * parameters. Returns the result as JSON; to retrieve output in CSV format 
  7.    * specify "alt=csv" as a query parameter. (reports.generate) 
  8.    * 
  9.    * @param string $accountId Account upon which to report. 
  10.    * @param string $startDate Start of the date range to report on in "YYYY-MM-DD" 
  11.    * format, inclusive. 
  12.    * @param string $endDate End of the date range to report on in "YYYY-MM-DD" 
  13.    * format, inclusive. 
  14.    * @param array $optParams Optional parameters. 
  15.    * 
  16.    * @opt_param string currency Optional currency to use when reporting on 
  17.    * monetary metrics. Defaults to the account's currency if not set. 
  18.    * @opt_param string dimension Dimensions to base the report on. 
  19.    * @opt_param string filter Filters to be run on the report. 
  20.    * @opt_param string locale Optional locale to use for translating report output 
  21.    * to a local language. Defaults to "en_US" if not specified. 
  22.    * @opt_param int maxResults The maximum number of rows of report data to 
  23.    * return. 
  24.    * @opt_param string metric Numeric columns to include in the report. 
  25.    * @opt_param string sort The name of a dimension or metric to sort the 
  26.    * resulting report on, optionally prefixed with "+" to sort ascending or "-" to 
  27.    * sort descending. If no prefix is specified, the column is sorted ascending. 
  28.    * @opt_param int startIndex Index of the first row of report data to return. 
  29.    * @opt_param bool useTimezoneReporting Whether the report should be generated 
  30.    * in the AdSense account's local timezone. If false default PST/PDT timezone 
  31.    * will be used. 
  32.    * @return Google_Service_AdSense_AdsenseReportsGenerateResponse 
  33.    */ 
  34.   public function generate($accountId, $startDate, $endDate, $optParams = array()) 
  35.   { 
  36.     $params = array('accountId' => $accountId, 'startDate' => $startDate, 'endDate' => $endDate); 
  37.     $params = array_merge($params, $optParams); 
  38.     return $this->call('generate', array($params), "Google_Service_AdSense_AdsenseReportsGenerateResponse"); 
  39.   } 
  40. }