Documentation

Google_Service_ShoppingContent_Resource_Pos extends Google_Service_Resource
in package

The "pos" collection of methods.

Typical usage is: $contentService = new Google_Service_ShoppingContent(...); $pos = $contentService->pos;

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.
custombatch()  : Google_Service_ShoppingContent_PosCustomBatchResponse
Batches multiple POS-related calls in a single request. (pos.custombatch)
delete()  : mixed
Deletes a store for the given merchant. (pos.delete)
get()  : Google_Service_ShoppingContent_PosStore
Retrieves information about the given store. (pos.get)
insert()  : Google_Service_ShoppingContent_PosStore
Creates a store for the given merchant. (pos.insert)
inventory()  : Google_Service_ShoppingContent_PosInventoryResponse
Submit inventory for the given merchant. (pos.inventory)
listPos()  : Google_Service_ShoppingContent_PosListResponse
Lists the stores of the target merchant. (pos.listPos)
sale()  : Google_Service_ShoppingContent_PosSaleResponse
Submit a sale event for the given merchant. (pos.sale)
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

custombatch()

Batches multiple POS-related calls in a single request. (pos.custombatch)

public custombatch(Google_Service_ShoppingContent_PosCustomBatchRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_PosCustomBatchResponse
Parameters
$postBody : Google_Service_ShoppingContent_PosCustomBatchRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ShoppingContent_PosCustomBatchResponse

delete()

Deletes a store for the given merchant. (pos.delete)

public delete(string $merchantId, string $targetMerchantId, string $storeCode[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$merchantId : string

The ID of the POS or inventory data provider.

$targetMerchantId : string

The ID of the target merchant.

$storeCode : string

A store code that is unique per merchant.

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

Optional parameters.

Return values
mixed

get()

Retrieves information about the given store. (pos.get)

public get(string $merchantId, string $targetMerchantId, string $storeCode[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_PosStore
Parameters
$merchantId : string

The ID of the POS or inventory data provider.

$targetMerchantId : string

The ID of the target merchant.

$storeCode : string

A store code that is unique per merchant.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_PosStore

insert()

Creates a store for the given merchant. (pos.insert)

public insert(string $merchantId, string $targetMerchantId, Google_Service_ShoppingContent_PosStore $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_PosStore
Parameters
$merchantId : string

The ID of the POS or inventory data provider.

$targetMerchantId : string

The ID of the target merchant.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_PosStore

inventory()

Submit inventory for the given merchant. (pos.inventory)

public inventory(string $merchantId, string $targetMerchantId, Google_Service_ShoppingContent_PosInventoryRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_PosInventoryResponse
Parameters
$merchantId : string

The ID of the POS or inventory data provider.

$targetMerchantId : string

The ID of the target merchant.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_PosInventoryResponse

listPos()

Lists the stores of the target merchant. (pos.listPos)

public listPos(string $merchantId, string $targetMerchantId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_PosListResponse
Parameters
$merchantId : string

The ID of the POS or inventory data provider.

$targetMerchantId : string

The ID of the target merchant.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_PosListResponse

sale()

Submit a sale event for the given merchant. (pos.sale)

public sale(string $merchantId, string $targetMerchantId, Google_Service_ShoppingContent_PosSaleRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_PosSaleResponse
Parameters
$merchantId : string

The ID of the POS or inventory data provider.

$targetMerchantId : string

The ID of the target merchant.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_PosSaleResponse

convertToArrayAndStripNulls()

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

Search results