Documentation

Google_Service_ShoppingContent_Resource_Shippingsettings extends Google_Service_Resource
in package

Application

The "shippingsettings" collection of methods.

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

$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_ShippingsettingsCustomBatchResponse: Retrieves and updates the shipping settings of multiple accounts in a single request. (shippingsettings.custombatch)
get() : Google_Service_ShoppingContent_ShippingSettings: Retrieves the shipping settings of the account. (shippingsettings.get)
getsupportedcarriers() : Google_Service_ShoppingContent_ShippingsettingsGetSupportedCarriersResponse: Retrieves supported carriers and carrier services for an account.
getsupportedholidays() : Google_Service_ShoppingContent_ShippingsettingsGetSupportedHolidaysResponse: Retrieves supported holidays for an account.
getsupportedpickupservices() : Google_Service_ShoppingContent_ShippingsettingsGetSupportedPickupServicesResponse: Retrieves supported pickup services for an account.
listShippingsettings() : Google_Service_ShoppingContent_ShippingsettingsListResponse: Lists the shipping settings of the sub-accounts in your Merchant Center account. (shippingsettings.listShippingsettings)
update() : Google_Service_ShoppingContent_ShippingSettings: Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource. (shippingsettings.update)
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

custombatch()

Retrieves and updates the shipping settings of multiple accounts in a single request. (shippingsettings.custombatch)


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

Parameters

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

Return values

Google_Service_ShoppingContent_ShippingsettingsCustomBatchResponse —

get()

Retrieves the shipping settings of the account. (shippingsettings.get)


    public
                get(string $merchantId, string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_ShippingSettings

Parameters

$merchantId : string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account for which to get/update shipping settings.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_ShippingSettings —

getsupportedcarriers()

Retrieves supported carriers and carrier services for an account.


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

(shippingsettings.getsupportedcarriers)

Parameters

$merchantId : string: The ID of the account for which to retrieve the supported carriers.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_ShippingsettingsGetSupportedCarriersResponse —

getsupportedholidays()

Retrieves supported holidays for an account.


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

(shippingsettings.getsupportedholidays)

Parameters

$merchantId : string: The ID of the account for which to retrieve the supported holidays.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_ShippingsettingsGetSupportedHolidaysResponse —

getsupportedpickupservices()

Retrieves supported pickup services for an account.


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

(shippingsettings.getsupportedpickupservices)

Parameters

$merchantId : string: The ID of the account for which to retrieve the supported pickup services.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_ShippingsettingsGetSupportedPickupServicesResponse —

listShippingsettings()

Lists the shipping settings of the sub-accounts in your Merchant Center account. (shippingsettings.listShippingsettings)


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

Parameters

$merchantId : string: The ID of the managing account. This must be a multi-client account.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_ShippingsettingsListResponse —

update()

Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource. (shippingsettings.update)


    public
                update(string $merchantId, string $accountId, Google_Service_ShoppingContent_ShippingSettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_ShippingSettings

Parameters

$merchantId : string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account for which to get/update shipping settings.
$postBody : Google_Service_ShoppingContent_ShippingSettings
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_ShippingSettings —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —