Documentation

Google_Service_Partners_Resource_OffersHistory extends Google_Service_Resource
in package

The "history" collection of methods.

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

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.
listOffersHistory()  : Google_Service_Partners_ListOffersHistoryResponse
Lists the Historical Offers for the current user (or user's entire company) (history.listOffersHistory)
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

listOffersHistory()

Lists the Historical Offers for the current user (or user's entire company) (history.listOffersHistory)

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

Optional parameters.

Tags
opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

opt_param

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

opt_param

string pageToken Token to retrieve a specific page.

opt_param

int pageSize Maximum number of rows to return per page.

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

bool entireCompany if true, show history for the entire company. Requires user to be admin.

opt_param

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

opt_param

string orderBy Comma-separated list of fields to order by, e.g.: "foo,bar,baz". Use "foo desc" to sort descending. List of valid field names is: name, offer_code, expiration_time, status, last_modified_time, sender_name, creation_time, country_code, offer_type.

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_ListOffersHistoryResponse —

convertToArrayAndStripNulls()

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

Search results