Documentation

Google_Service_Analytics_Resource_ManagementUnsampledReports extends Google_Service_Resource
in package

The "unsampledReports" collection of methods.

Typical usage is: $analyticsService = new Google_Service_Analytics(...); $unsampledReports = $analyticsService->unsampledReports;

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.
delete()  : mixed
Deletes an unsampled report. (unsampledReports.delete)
get()  : Google_Service_Analytics_UnsampledReport
Returns a single unsampled report. (unsampledReports.get)
insert()  : Google_Service_Analytics_UnsampledReport
Create a new unsampled report. (unsampledReports.insert)
listManagementUnsampledReports()  : Google_Service_Analytics_UnsampledReports
Lists unsampled reports to which the user has access.
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

delete()

Deletes an unsampled report. (unsampledReports.delete)

public delete(string $accountId, string $webPropertyId, string $profileId, string $unsampledReportId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$accountId : string

Account ID to delete the unsampled report for.

$webPropertyId : string

Web property ID to delete the unsampled reports for.

$profileId : string

View (Profile) ID to delete the unsampled report for.

$unsampledReportId : string

ID of the unsampled report to be deleted.

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

Optional parameters.

Return values
mixed —

get()

Returns a single unsampled report. (unsampledReports.get)

public get(string $accountId, string $webPropertyId, string $profileId, string $unsampledReportId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_UnsampledReport
Parameters
$accountId : string

Account ID to retrieve unsampled report for.

$webPropertyId : string

Web property ID to retrieve unsampled reports for.

$profileId : string

View (Profile) ID to retrieve unsampled report for.

$unsampledReportId : string

ID of the unsampled report to retrieve.

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

Optional parameters.

Return values
Google_Service_Analytics_UnsampledReport —

insert()

Create a new unsampled report. (unsampledReports.insert)

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

Account ID to create the unsampled report for.

$webPropertyId : string

Web property ID to create the unsampled report for.

$profileId : string

View (Profile) ID to create the unsampled report for.

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

Optional parameters.

Return values
Google_Service_Analytics_UnsampledReport —

listManagementUnsampledReports()

Lists unsampled reports to which the user has access.

public listManagementUnsampledReports(string $accountId, string $webPropertyId, string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_UnsampledReports

(unsampledReports.listManagementUnsampledReports)

Parameters
$accountId : string

Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.

$webPropertyId : string

Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.

$profileId : string

View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.

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

Optional parameters.

Tags
opt_param

int max-results The maximum number of unsampled reports to include in this response.

opt_param

int start-index An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max- results parameter.

Return values
Google_Service_Analytics_UnsampledReports —

convertToArrayAndStripNulls()

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

Search results