Documentation

Google_Service_PostmasterTools_Resource_DomainsTrafficStats extends Google_Service_Resource
in package

The "trafficStats" collection of methods.

Typical usage is: $gmailpostmastertoolsService = new Google_Service_PostmasterTools(...); $trafficStats = $gmailpostmastertoolsService->trafficStats;

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_PostmasterTools_TrafficStats
Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain. (trafficStats.get)
listDomainsTrafficStats()  : Google_Service_PostmasterTools_ListTrafficStatsResponse
List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
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()

Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain. (trafficStats.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PostmasterTools_TrafficStats
Parameters
$name : string

The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.

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

Optional parameters.

Return values
Google_Service_PostmasterTools_TrafficStats —

listDomainsTrafficStats()

List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

public listDomainsTrafficStats(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PostmasterTools_ListTrafficStatsResponse

(trafficStats.listDomainsTrafficStats)

Parameters
$parent : string

The resource name of the domain whose traffic statistics we'd like to list. It should have the form domains/{domain_name}, where domain_name is the fully qualified domain name.

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

Optional parameters.

Tags
opt_param

int startDate.month Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

opt_param

int endDate.day Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

opt_param

int endDate.year Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

opt_param

int startDate.year Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.

opt_param

string pageToken The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to ListTrafficStats method.

opt_param

int startDate.day Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

opt_param

int endDate.month Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.

opt_param

int pageSize Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.

Return values
Google_Service_PostmasterTools_ListTrafficStatsResponse —

convertToArrayAndStripNulls()

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

Search results