Google_Service_Dfareporting_Reports_Resource

The "reports" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/Dfareporting.php  
  1. class Google_Service_Dfareporting_Reports_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes a report by its ID. (reports.delete) 
  5. * @param string $profileId The DFA user profile ID. 
  6. * @param string $reportId The ID of the report. 
  7. * @param array $optParams Optional parameters. 
  8. */ 
  9. public function delete($profileId, $reportId, $optParams = array()) 
  10. $params = array('profileId' => $profileId, 'reportId' => $reportId); 
  11. $params = array_merge($params, $optParams); 
  12. return $this->call('delete', array($params)); 
  13.  
  14. /** 
  15. * Retrieves a report by its ID. (reports.get) 
  16. * @param string $profileId The DFA user profile ID. 
  17. * @param string $reportId The ID of the report. 
  18. * @param array $optParams Optional parameters. 
  19. * @return Google_Service_Dfareporting_Report 
  20. */ 
  21. public function get($profileId, $reportId, $optParams = array()) 
  22. $params = array('profileId' => $profileId, 'reportId' => $reportId); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('get', array($params), "Google_Service_Dfareporting_Report"); 
  25.  
  26. /** 
  27. * Creates a report. (reports.insert) 
  28. * @param string $profileId The DFA user profile ID. 
  29. * @param Google_Report $postBody 
  30. * @param array $optParams Optional parameters. 
  31. * @return Google_Service_Dfareporting_Report 
  32. */ 
  33. public function insert($profileId, Google_Service_Dfareporting_Report $postBody, $optParams = array()) 
  34. $params = array('profileId' => $profileId, 'postBody' => $postBody); 
  35. $params = array_merge($params, $optParams); 
  36. return $this->call('insert', array($params), "Google_Service_Dfareporting_Report"); 
  37.  
  38. /** 
  39. * Retrieves list of reports. (reports.listReports) 
  40. * @param string $profileId The DFA user profile ID. 
  41. * @param array $optParams Optional parameters. 
  42. * @opt_param string sortField The field by which to sort the list. 
  43. * @opt_param int maxResults Maximum number of results to return. 
  44. * @opt_param string pageToken The value of the nextToken from the previous 
  45. * result page. 
  46. * @opt_param string sortOrder Order of sorted results, default is 'DESCENDING'. 
  47. * @opt_param string scope The scope that defines which results are returned,  
  48. * default is 'MINE'. 
  49. * @return Google_Service_Dfareporting_ReportList 
  50. */ 
  51. public function listReports($profileId, $optParams = array()) 
  52. $params = array('profileId' => $profileId); 
  53. $params = array_merge($params, $optParams); 
  54. return $this->call('list', array($params), "Google_Service_Dfareporting_ReportList"); 
  55.  
  56. /** 
  57. * Updates a report. This method supports patch semantics. (reports.patch) 
  58. * @param string $profileId The DFA user profile ID. 
  59. * @param string $reportId The ID of the report. 
  60. * @param Google_Report $postBody 
  61. * @param array $optParams Optional parameters. 
  62. * @return Google_Service_Dfareporting_Report 
  63. */ 
  64. public function patch($profileId, $reportId, Google_Service_Dfareporting_Report $postBody, $optParams = array()) 
  65. $params = array('profileId' => $profileId, 'reportId' => $reportId, 'postBody' => $postBody); 
  66. $params = array_merge($params, $optParams); 
  67. return $this->call('patch', array($params), "Google_Service_Dfareporting_Report"); 
  68.  
  69. /** 
  70. * Runs a report. (reports.run) 
  71. * @param string $profileId The DFA profile ID. 
  72. * @param string $reportId The ID of the report. 
  73. * @param array $optParams Optional parameters. 
  74. * @opt_param bool synchronous If set and true, tries to run the report 
  75. * synchronously. 
  76. * @return Google_Service_Dfareporting_DfareportingFile 
  77. */ 
  78. public function run($profileId, $reportId, $optParams = array()) 
  79. $params = array('profileId' => $profileId, 'reportId' => $reportId); 
  80. $params = array_merge($params, $optParams); 
  81. return $this->call('run', array($params), "Google_Service_Dfareporting_DfareportingFile"); 
  82.  
  83. /** 
  84. * Updates a report. (reports.update) 
  85. * @param string $profileId The DFA user profile ID. 
  86. * @param string $reportId The ID of the report. 
  87. * @param Google_Report $postBody 
  88. * @param array $optParams Optional parameters. 
  89. * @return Google_Service_Dfareporting_Report 
  90. */ 
  91. public function update($profileId, $reportId, Google_Service_Dfareporting_Report $postBody, $optParams = array()) 
  92. $params = array('profileId' => $profileId, 'reportId' => $reportId, 'postBody' => $postBody); 
  93. $params = array_merge($params, $optParams); 
  94. return $this->call('update', array($params), "Google_Service_Dfareporting_Report");