Documentation

Google_Service_Analytics_Resource_DataGa extends Google_Service_Resource
in package

The "ga" collection of methods.

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

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.
get()  : Google_Service_Analytics_GaData
Returns Analytics data for a view (profile). (ga.get)
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

get()

Returns Analytics data for a view (profile). (ga.get)

public get(string $ids, string $startDate, string $endDate, string $metrics[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_GaData
Parameters
$ids : string

Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

$startDate : string

Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

$endDate : string

End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.

$metrics : string

A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.

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

Optional parameters.

Tags
opt_param

string dimensions A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

opt_param

string filters A comma-separated list of dimension or metric filters to be applied to Analytics data.

opt_param

bool include-empty-rows The response will include empty rows if this parameter is set to true, the default is true

opt_param

int max-results The maximum number of entries to include in this feed.

opt_param

string output The selected format for the response. Default format is JSON.

opt_param

string samplingLevel The desired sampling level.

opt_param

string segment An Analytics segment to be applied to data.

opt_param

string sort A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.

opt_param

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

Return values
Google_Service_Analytics_GaData —

convertToArrayAndStripNulls()

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

Search results