Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class OnlineReturnPolicyServiceClient.
Service Description: The service facilitates the management of a merchant's remorse return policy configuration, encompassing return policies for both ads and free listings
programs. This API defines the following resource model:
OnlineReturnPolicyThis class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Shopping \ Merchant \ Accounts \ V1beta \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
getOnlineReturnPolicy
Gets an existing return policy.
The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\OnlineReturnPolicyServiceClient::getOnlineReturnPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\GetOnlineReturnPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Shopping\Merchant\Accounts\V1beta\OnlineReturnPolicy |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\OnlineReturnPolicyServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\GetOnlineReturnPolicyRequest;
use Google\Shopping\Merchant\Accounts\V1beta\OnlineReturnPolicy;
/**
* @param string $formattedName The name of the return policy to retrieve.
* Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
* Please see {@see OnlineReturnPolicyServiceClient::onlineReturnPolicyName()} for help formatting this field.
*/
function get_online_return_policy_sample(string $formattedName): void
{
// Create a client.
$onlineReturnPolicyServiceClient = new OnlineReturnPolicyServiceClient();
// Prepare the request message.
$request = (new GetOnlineReturnPolicyRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OnlineReturnPolicy $response */
$response = $onlineReturnPolicyServiceClient->getOnlineReturnPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = OnlineReturnPolicyServiceClient::onlineReturnPolicyName(
'[ACCOUNT]',
'[RETURN_POLICY]'
);
get_online_return_policy_sample($formattedName);
}
listOnlineReturnPolicies
Lists all existing return policies.
The async variant is Google\Shopping\Merchant\Accounts\V1beta\Client\OnlineReturnPolicyServiceClient::listOnlineReturnPoliciesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\ListOnlineReturnPoliciesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Shopping\Merchant\Accounts\V1beta\Client\OnlineReturnPolicyServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\ListOnlineReturnPoliciesRequest;
use Google\Shopping\Merchant\Accounts\V1beta\OnlineReturnPolicy;
/**
* @param string $formattedParent The merchant account for which to list return policies.
* Format: `accounts/{account}`
* Please see {@see OnlineReturnPolicyServiceClient::accountName()} for help formatting this field.
*/
function list_online_return_policies_sample(string $formattedParent): void
{
// Create a client.
$onlineReturnPolicyServiceClient = new OnlineReturnPolicyServiceClient();
// Prepare the request message.
$request = (new ListOnlineReturnPoliciesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $onlineReturnPolicyServiceClient->listOnlineReturnPolicies($request);
/** @var OnlineReturnPolicy $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = OnlineReturnPolicyServiceClient::accountName('[ACCOUNT]');
list_online_return_policies_sample($formattedParent);
}
getOnlineReturnPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\GetOnlineReturnPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listOnlineReturnPoliciesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Accounts\V1beta\ListOnlineReturnPoliciesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
static::accountName
Formats a string containing the fully-qualified path to represent a account resource.
Parameter | |
---|---|
Name | Description |
account |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted account resource. |
static::onlineReturnPolicyName
Formats a string containing the fully-qualified path to represent a online_return_policy resource.
Parameters | |
---|---|
Name | Description |
account |
string
|
returnPolicy |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted online_return_policy resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- account: accounts/{account}
- onlineReturnPolicy: accounts/{account}/onlineReturnPolicies/{return_policy}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array |
An associative array from name component IDs to component values. |