1. class
  2. Google
  3. \
  4. Service
  5. \
  6. ShoppingContent
  7. \
  8. Resource
  9. \
  10. Shippingsettings

Shippingsettings

class Shippingsettings extends Resource (View source)

The "shippingsettings" collection of methods.

Typical usage is:

 $contentService = new Google\Service\ShoppingContent(...);
 $shippingsettings = $contentService->shippingsettings;

Methods

ShippingsettingsCustomBatchResponse
custombatch(ShippingsettingsCustomBatchRequest $postBody, array $optParams = [])

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

ShippingSettings
get(string $merchantId, string $accountId, array $optParams = [])

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

ShippingsettingsGetSupportedCarriersResponse
getsupportedcarriers(string $merchantId, array $optParams = [])

Retrieves supported carriers and carrier services for an account.

ShippingsettingsGetSupportedHolidaysResponse
getsupportedholidays(string $merchantId, array $optParams = [])

Retrieves supported holidays for an account.

ShippingsettingsGetSupportedPickupServicesResponse
getsupportedpickupservices(string $merchantId, array $optParams = [])

Retrieves supported pickup services for an account.

ShippingsettingsListResponse
listShippingsettings(string $merchantId, array $optParams = [])

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

ShippingSettings
update(string $merchantId, string $accountId, ShippingSettings $postBody, array $optParams = [])

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

Details

at line 47
ShippingsettingsCustomBatchResponse custombatch(ShippingsettingsCustomBatchRequest $postBody, array $optParams = [])

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

Parameters

ShippingsettingsCustomBatchRequest $postBody
array $optParams

Optional parameters.

Return Value

ShippingsettingsCustomBatchResponse

Exceptions

Exception

at line 65
ShippingSettings get(string $merchantId, string $accountId, array $optParams = [])

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

Parameters

string $merchantId

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.
string $accountId

The ID of the account for which to get/update shipping settings.
array $optParams

Optional parameters.

Return Value

ShippingSettings

Exceptions

Exception

at line 81
ShippingsettingsGetSupportedCarriersResponse getsupportedcarriers(string $merchantId, array $optParams = [])

Retrieves supported carriers and carrier services for an account.

(shippingsettings.getsupportedcarriers)

Parameters

string $merchantId

The ID of the account for which to retrieve the supported carriers.
array $optParams

Optional parameters.

Return Value

ShippingsettingsGetSupportedCarriersResponse

Exceptions

Exception

at line 97
ShippingsettingsGetSupportedHolidaysResponse getsupportedholidays(string $merchantId, array $optParams = [])

Retrieves supported holidays for an account.

(shippingsettings.getsupportedholidays)

Parameters

string $merchantId

The ID of the account for which to retrieve the supported holidays.
array $optParams

Optional parameters.

Return Value

ShippingsettingsGetSupportedHolidaysResponse

Exceptions

Exception

at line 113
ShippingsettingsGetSupportedPickupServicesResponse getsupportedpickupservices(string $merchantId, array $optParams = [])

Retrieves supported pickup services for an account.

(shippingsettings.getsupportedpickupservices)

Parameters

string $merchantId

The ID of the account for which to retrieve the supported pickup services.
array $optParams

Optional parameters.

Return Value

ShippingsettingsGetSupportedPickupServicesResponse

Exceptions

Exception

at line 133
ShippingsettingsListResponse listShippingsettings(string $merchantId, array $optParams = [])

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

Parameters

string $merchantId

The ID of the managing account. This must be a multi-client account.
array $optParams

Optional parameters.

Return Value

ShippingsettingsListResponse

Exceptions

Exception

at line 153
ShippingSettings update(string $merchantId, string $accountId, ShippingSettings $postBody, array $optParams = [])

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

Parameters

string $merchantId

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.
string $accountId

The ID of the account for which to get/update shipping settings.
ShippingSettings $postBody
array $optParams

Optional parameters.

Return Value

ShippingSettings

Exceptions

Exception