Google_Service_Dfareporting_Reports_Resource Class Reference

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

Inheritance diagram for Google_Service_Dfareporting_Reports_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($profileId, $reportId, $optParams=array())
	Deletes a report by its ID.
	get ($profileId, $reportId, $optParams=array())
	Retrieves a report by its ID.
	insert ($profileId, Google_Service_Dfareporting_Report $postBody, $optParams=array())
	Creates a report.
	listReports ($profileId, $optParams=array())
	Retrieves list of reports.
	patch ($profileId, $reportId, Google_Service_Dfareporting_Report $postBody, $optParams=array())
	Updates a report.
	run ($profileId, $reportId, $optParams=array())
	Runs a report.
	update ($profileId, $reportId, Google_Service_Dfareporting_Report $postBody, $optParams=array())
	Updates a report.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "reports" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $reports = $dfareportingService->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

delete()

Google_Service_Dfareporting_Reports_Resource::delete	(		$profileId,
			$reportId,
			$optParams = array() )

Deletes a report by its ID.

(reports.delete)

Parameters

string	$profileId	The DFA user profile ID.
string	$reportId	The ID of the report.
array	$optParams	Optional parameters.

get()

Google_Service_Dfareporting_Reports_Resource::get	(		$profileId,
			$reportId,
			$optParams = array() )

Retrieves a report by its ID.

(reports.get)

Parameters

string	$profileId	The DFA user profile ID.
string	$reportId	The ID of the report.
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Report

insert()

Google_Service_Dfareporting_Reports_Resource::insert	(		$profileId,
		Google_Service_Dfareporting_Report	$postBody,
			$optParams = array() )

Creates a report.

(reports.insert)

Parameters

string	$profileId	The DFA user profile ID.
Google_Report	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Report

listReports()

Google_Service_Dfareporting_Reports_Resource::listReports	(		$profileId,
			$optParams = array() )

Retrieves list of reports.

(reports.listReports)

Parameters

string	$profileId	The DFA user profile ID.
array	$optParams	Optional parameters.

@opt_param string sortField The field by which to sort the list. @opt_param int maxResults Maximum number of results to return. @opt_param string pageToken The value of the nextToken from the previous result page. @opt_param string sortOrder Order of sorted results, default is 'DESCENDING'. @opt_param string scope The scope that defines which results are returned, default is 'MINE'.

Return values

Google_Service_Dfareporting_ReportList

patch()

Google_Service_Dfareporting_Reports_Resource::patch	(		$profileId,
			$reportId,
		Google_Service_Dfareporting_Report	$postBody,
			$optParams = array() )

Updates a report.

This method supports patch semantics. (reports.patch)

Parameters

string	$profileId	The DFA user profile ID.
string	$reportId	The ID of the report.
Google_Report	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Report

run()

Google_Service_Dfareporting_Reports_Resource::run	(		$profileId,
			$reportId,
			$optParams = array() )

Runs a report.

(reports.run)

Parameters

string	$profileId	The DFA profile ID.
string	$reportId	The ID of the report.
array	$optParams	Optional parameters.

@opt_param bool synchronous If set and true, tries to run the report synchronously.

Return values

Google_Service_Dfareporting_DfareportingFile

update()

Google_Service_Dfareporting_Reports_Resource::update	(		$profileId,
			$reportId,
		Google_Service_Dfareporting_Report	$postBody,
			$optParams = array() )

Updates a report.

(reports.update)

Parameters

string	$profileId	The DFA user profile ID.
string	$reportId	The ID of the report.
Google_Report	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dfareporting_Report

---

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

• lib/google/src/Google/Service/Dfareporting.php