Documentation

Google_Service_AnalyticsData_Resource_V1alpha extends Google_Service_Resource
in package

Application

The "v1alpha" collection of methods.

Typical usage is: $analyticsdataService = new Google_Service_AnalyticsData(...); $v1alpha = $analyticsdataService->v1alpha;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
batchRunPivotReports() : Google_Service_AnalyticsData_BatchRunPivotReportsResponse: Returns multiple pivot reports in a batch. All reports must be for the same Entity. (v1alpha.batchRunPivotReports)
batchRunReports() : Google_Service_AnalyticsData_BatchRunReportsResponse: Returns multiple reports in a batch. All reports must be for the same Entity.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
getUniversalMetadata() : Google_Service_AnalyticsData_UniversalMetadata: Returns metadata for dimensions and metrics available in reporting methods.
runPivotReport() : Google_Service_AnalyticsData_RunPivotReportResponse: Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot.
runReport() : Google_Service_AnalyticsData_RunReportResponse: Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count.
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 —

batchRunPivotReports()

Returns multiple pivot reports in a batch. All reports must be for the same Entity. (v1alpha.batchRunPivotReports)


    public
                batchRunPivotReports(Google_Service_AnalyticsData_BatchRunPivotReportsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AnalyticsData_BatchRunPivotReportsResponse

Parameters

$postBody : Google_Service_AnalyticsData_BatchRunPivotReportsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AnalyticsData_BatchRunPivotReportsResponse —

batchRunReports()

Returns multiple reports in a batch. All reports must be for the same Entity.


    public
                batchRunReports(Google_Service_AnalyticsData_BatchRunReportsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AnalyticsData_BatchRunReportsResponse

(v1alpha.batchRunReports)

Parameters

$postBody : Google_Service_AnalyticsData_BatchRunReportsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AnalyticsData_BatchRunReportsResponse —

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

getUniversalMetadata()

Returns metadata for dimensions and metrics available in reporting methods.


    public
                getUniversalMetadata([array<string|int, mixed> $optParams = array() ]) : Google_Service_AnalyticsData_UniversalMetadata

Used to explore the dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and deletions may occur. This method returns Universal Metadata. Universal Metadata are dimensions and metrics applicable to any property such as country and totalUsers. (v1alpha.getUniversalMetadata)

Parameters

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

Return values

Google_Service_AnalyticsData_UniversalMetadata —

runPivotReport()

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot.


    public
                runPivotReport(Google_Service_AnalyticsData_RunPivotReportRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AnalyticsData_RunPivotReportResponse

Multiple pivots can be specified to further dissect your data. (v1alpha.runPivotReport)

Parameters

$postBody : Google_Service_AnalyticsData_RunPivotReportRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AnalyticsData_RunPivotReportResponse —

runReport()

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count.


    public
                runReport(Google_Service_AnalyticsData_RunReportRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AnalyticsData_RunReportResponse

Dimensions break down metrics across some common criteria, such as country or event name. (v1alpha.runReport)

Parameters

$postBody : Google_Service_AnalyticsData_RunReportRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AnalyticsData_RunReportResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —