Documentation

Google_Service_CloudSearch_Resource_Stats extends Google_Service_Resource
in package

Application

The "stats" collection of methods.

Typical usage is: $cloudsearchService = new Google_Service_CloudSearch(...); $stats = $cloudsearchService->stats;

$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.
getIndex() : Google_Service_CloudSearch_GetCustomerIndexStatsResponse: Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. **Note:** This API requires a standard end user account to execute. (stats.getIndex)
getQuery() : Google_Service_CloudSearch_GetCustomerQueryStatsResponse: Get the query statistics for customer. **Note:** This API requires a standard end user account to execute. (stats.getQuery)
getSession() : Google_Service_CloudSearch_GetCustomerSessionStatsResponse: Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute. (stats.getSession)
getUser() : Google_Service_CloudSearch_GetCustomerUserStatsResponse: Get the users statistics for customer. **Note:** This API requires a standard end user account to execute. (stats.getUser)
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

getIndex()

Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. **Note:** This API requires a standard end user account to execute. (stats.getIndex)


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

Parameters

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

Return values

Google_Service_CloudSearch_GetCustomerIndexStatsResponse —

getQuery()

Get the query statistics for customer. **Note:** This API requires a standard end user account to execute. (stats.getQuery)


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

Parameters

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

Return values

Google_Service_CloudSearch_GetCustomerQueryStatsResponse —

getSession()

Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute. (stats.getSession)


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

Parameters

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

Return values

Google_Service_CloudSearch_GetCustomerSessionStatsResponse —

getUser()

Get the users statistics for customer. **Note:** This API requires a standard end user account to execute. (stats.getUser)


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

Parameters

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

Return values

Google_Service_CloudSearch_GetCustomerUserStatsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —