Documentation

Google_Service_ShoppingContent_Resource_Returnaddress extends Google_Service_Resource
in package

The "returnaddress" collection of methods.

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

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_ReturnaddressCustomBatchResponse
Batches multiple return address related calls in a single request.
delete()  : mixed
Deletes a return address for the given Merchant Center account.
get()  : Google_Service_ShoppingContent_ReturnAddress
Gets a return address of the Merchant Center account. (returnaddress.get)
insert()  : Google_Service_ShoppingContent_ReturnAddress
Inserts a return address for the Merchant Center account.
listReturnaddress()  : Google_Service_ShoppingContent_ReturnaddressListResponse
Lists the return addresses of the Merchant Center account.
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 return address related calls in a single request.

public custombatch(Google_Service_ShoppingContent_ReturnaddressCustomBatchRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_ReturnaddressCustomBatchResponse

(returnaddress.custombatch)

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

Optional parameters.

Return values
Google_Service_ShoppingContent_ReturnaddressCustomBatchResponse

delete()

Deletes a return address for the given Merchant Center account.

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

(returnaddress.delete)

Parameters
$merchantId : string

The Merchant Center account from which to delete the given return address.

$returnAddressId : string

Return address ID generated by Google.

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

Optional parameters.

Return values
mixed

get()

Gets a return address of the Merchant Center account. (returnaddress.get)

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

The Merchant Center account to get a return address for.

$returnAddressId : string

Return address ID generated by Google.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_ReturnAddress

insert()

Inserts a return address for the Merchant Center account.

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

(returnaddress.insert)

Parameters
$merchantId : string

The Merchant Center account to insert a return address for.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_ReturnAddress

listReturnaddress()

Lists the return addresses of the Merchant Center account.

public listReturnaddress(string $merchantId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_ReturnaddressListResponse

(returnaddress.listReturnaddress)

Parameters
$merchantId : string

The Merchant Center account to list return addresses for.

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

Optional parameters.

Tags
opt_param

string country List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.

opt_param

string maxResults The maximum number of addresses in the response, used for paging.

opt_param

string pageToken The token returned by the previous request.

Return values
Google_Service_ShoppingContent_ReturnaddressListResponse

convertToArrayAndStripNulls()

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

Search results