Documentation

Google_Service_Partners_Resource_Analytics extends Google_Service_Resource
in package

The "analytics" collection of methods.

Typical usage is: $partnersService = new Google_Service_Partners(...); $analytics = $partnersService->analytics;

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.
listAnalytics()  : Google_Service_Partners_ListAnalyticsResponse
Lists analytics data for a user's associated company. Should only be called within the context of an authorized logged in user. (analytics.listAnalytics)
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

listAnalytics()

Lists analytics data for a user's associated company. Should only be called within the context of an authorized logged in user. (analytics.listAnalytics)

public listAnalytics([array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_ListAnalyticsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

opt_param

string pageToken A token identifying a page of results that the server returns. Typically, this is the value of ListAnalyticsResponse.next_page_token returned from the previous call to ListAnalytics. Will be a date string in YYYY-MM-DD format representing the end date of the date range of results to return. If unspecified or set to "", default value is the current date.

opt_param

int pageSize Requested page size. Server may return fewer analytics than requested. If unspecified or set to 0, default value is 30. Specifies the number of days in the date range when querying analytics. The page_token represents the end date of the date range and the start date is calculated using the page_size as the number of days BEFORE the end date. Must be a non-negative integer.

opt_param

string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

opt_param

string requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

opt_param

string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Return values
Google_Service_Partners_ListAnalyticsResponse —

convertToArrayAndStripNulls()

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

Search results