Documentation

Google_Service_AdExchangeSeller_Resource_AccountsReports extends Google_Service_Resource
in package

The "reports" collection of methods.

Typical usage is: $adexchangesellerService = new Google_Service_AdExchangeSeller(...); $reports = $adexchangesellerService->reports;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
generate()  : Google_Service_AdExchangeSeller_Report
Generate an Ad Exchange 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)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

generate()

Generate an Ad Exchange 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)

public generate(string $accountId, string $startDate, string $endDate[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeSeller_Report
Parameters
$accountId : string

Account which owns the generated report.

$startDate : string

Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

$endDate : string

End of the date range to report on in "YYYY-MM-DD" format, inclusive.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string dimension Dimensions to base the report on.

opt_param

string filter Filters to be run on the report.

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 maxResults The maximum number of rows of report data to return.

opt_param

string metric Numeric columns to include in the report.

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 startIndex Index of the first row of report data to return.

Return values
Google_Service_AdExchangeSeller_Report —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results