Documentation

Google_Service_Dfareporting_Resource_Reports extends Google_Service_Resource
in package

Application

The "reports" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $reports = $dfareportingService->reports;

$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.
delete() : mixed: Deletes a report by its ID. (reports.delete)
get() : Google_Service_Dfareporting_Report: Retrieves a report by its ID. (reports.get)
insert() : Google_Service_Dfareporting_Report: Creates a report. (reports.insert)
listReports() : Google_Service_Dfareporting_ReportList: Retrieves list of reports. (reports.listReports)
patch() : Google_Service_Dfareporting_Report: Updates an existing report. This method supports patch semantics.
run() : Google_Service_Dfareporting_DfareportingFile: Runs a report. (reports.run)
update() : Google_Service_Dfareporting_Report: Updates a report. (reports.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

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>

Return values

string —

$requestUrl

delete()

Deletes a report by its ID. (reports.delete)


    public
                delete(string $profileId, string $reportId[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$profileId : string: The DFA user profile ID.
$reportId : string: The ID of the report.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Retrieves a report by its ID. (reports.get)


    public
                get(string $profileId, string $reportId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Report

Parameters

$profileId : string: The DFA user profile ID.
$reportId : string: The ID of the report.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Report —

insert()

Creates a report. (reports.insert)


    public
                insert(string $profileId, Google_Service_Dfareporting_Report $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Report

Parameters

$profileId : string: The DFA user profile ID.
$postBody : Google_Service_Dfareporting_Report
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Report —

listReports()

Retrieves list of reports. (reports.listReports)


    public
                listReports(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_ReportList

Parameters

$profileId : string: The DFA user profile ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_ReportList —

patch()

Updates an existing report. This method supports patch semantics.


    public
                patch(string $profileId, string $reportId, Google_Service_Dfareporting_Report $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Report

(reports.patch)

Parameters

$profileId : string: The DFA user profile ID.
$reportId : string: The ID of the report.
$postBody : Google_Service_Dfareporting_Report
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Report —

run()

Runs a report. (reports.run)


    public
                run(string $profileId, string $reportId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_DfareportingFile

Parameters

$profileId : string: The DFA profile ID.
$reportId : string: The ID of the report.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_DfareportingFile —

update()

Updates a report. (reports.update)


    public
                update(string $profileId, string $reportId, Google_Service_Dfareporting_Report $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_Report

Parameters

$profileId : string: The DFA user profile ID.
$reportId : string: The ID of the report.
$postBody : Google_Service_Dfareporting_Report
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dfareporting_Report —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —