Reference documentation and code samples for the Google Shopping Merchant Issue Resolution V1 Client class IssueResolutionServiceClient.
Service Description: Service to provide an issue resolution content for account issues and product issues.
This 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 \ IssueResolution \ V1 \ 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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
renderAccountIssues
Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.
The async variant is IssueResolutionServiceClient::renderAccountIssuesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\IssueResolution\V1\RenderAccountIssuesRequest
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\IssueResolution\V1\RenderAccountIssuesResponse |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\IssueResolution\V1\Client\IssueResolutionServiceClient;
use Google\Shopping\Merchant\IssueResolution\V1\RenderAccountIssuesRequest;
use Google\Shopping\Merchant\IssueResolution\V1\RenderAccountIssuesResponse;
/**
* @param string $formattedName The account to fetch issues for.
* Format: `accounts/{account}`
* Please see {@see IssueResolutionServiceClient::accountName()} for help formatting this field.
*/
function render_account_issues_sample(string $formattedName): void
{
// Create a client.
$issueResolutionServiceClient = new IssueResolutionServiceClient();
// Prepare the request message.
$request = (new RenderAccountIssuesRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var RenderAccountIssuesResponse $response */
$response = $issueResolutionServiceClient->renderAccountIssues($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 = IssueResolutionServiceClient::accountName('[ACCOUNT]');
render_account_issues_sample($formattedName);
}
renderProductIssues
Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.
The async variant is IssueResolutionServiceClient::renderProductIssuesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\IssueResolution\V1\RenderProductIssuesRequest
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\IssueResolution\V1\RenderProductIssuesResponse |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\IssueResolution\V1\Client\IssueResolutionServiceClient;
use Google\Shopping\Merchant\IssueResolution\V1\RenderProductIssuesRequest;
use Google\Shopping\Merchant\IssueResolution\V1\RenderProductIssuesResponse;
/**
* @param string $formattedName The name of the product to fetch issues for.
* Format: `accounts/{account}/products/{product}`
* Please see {@see IssueResolutionServiceClient::productName()} for help formatting this field.
*/
function render_product_issues_sample(string $formattedName): void
{
// Create a client.
$issueResolutionServiceClient = new IssueResolutionServiceClient();
// Prepare the request message.
$request = (new RenderProductIssuesRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var RenderProductIssuesResponse $response */
$response = $issueResolutionServiceClient->renderProductIssues($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 = IssueResolutionServiceClient::productName('[ACCOUNT]', '[PRODUCT]');
render_product_issues_sample($formattedName);
}
triggerAction
Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form.
The action can be successfully started only once all required
inputs are
provided. If any required
input is missing, or invalid value was
provided, the service will return 400 error. Validation errors will contain
Ids for all
problematic field together with translated, human readable error messages
that can be shown to the user.
The async variant is IssueResolutionServiceClient::triggerActionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\IssueResolution\V1\TriggerActionRequest
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\IssueResolution\V1\TriggerActionResponse |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\IssueResolution\V1\ActionInput;
use Google\Shopping\Merchant\IssueResolution\V1\Client\IssueResolutionServiceClient;
use Google\Shopping\Merchant\IssueResolution\V1\InputValue;
use Google\Shopping\Merchant\IssueResolution\V1\TriggerActionPayload;
use Google\Shopping\Merchant\IssueResolution\V1\TriggerActionRequest;
use Google\Shopping\Merchant\IssueResolution\V1\TriggerActionResponse;
/**
* @param string $formattedName The business's account that is triggering the action.
* Format: `accounts/{account}`
* Please see {@see IssueResolutionServiceClient::accountName()} for help formatting this field.
* @param string $payloadActionContext The
* [context][google.shopping.merchant.issueresolution.v1.BuiltInUserInputAction.action_context]
* from the selected action. The value is obtained from rendered issues and
* needs to be sent back to identify the
* [action][google.shopping.merchant.issueresolution.v1.Action.builtin_user_input_action]
* that is being triggered.
* @param string $payloadActionInputActionFlowId [Id][google.shopping.merchant.issueresolution.v1.ActionFlow.id]
* of the selected action flow.
* @param string $payloadActionInputInputValuesInputFieldId [Id][google.shopping.merchant.issueresolution.v1.InputField.id]
* of the corresponding input field.
*/
function trigger_action_sample(
string $formattedName,
string $payloadActionContext,
string $payloadActionInputActionFlowId,
string $payloadActionInputInputValuesInputFieldId
): void {
// Create a client.
$issueResolutionServiceClient = new IssueResolutionServiceClient();
// Prepare the request message.
$inputValue = (new InputValue())
->setInputFieldId($payloadActionInputInputValuesInputFieldId);
$payloadActionInputInputValues = [$inputValue,];
$payloadActionInput = (new ActionInput())
->setActionFlowId($payloadActionInputActionFlowId)
->setInputValues($payloadActionInputInputValues);
$payload = (new TriggerActionPayload())
->setActionContext($payloadActionContext)
->setActionInput($payloadActionInput);
$request = (new TriggerActionRequest())
->setName($formattedName)
->setPayload($payload);
// Call the API and handle any network failures.
try {
/** @var TriggerActionResponse $response */
$response = $issueResolutionServiceClient->triggerAction($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 = IssueResolutionServiceClient::accountName('[ACCOUNT]');
$payloadActionContext = '[ACTION_CONTEXT]';
$payloadActionInputActionFlowId = '[ACTION_FLOW_ID]';
$payloadActionInputInputValuesInputFieldId = '[INPUT_FIELD_ID]';
trigger_action_sample(
$formattedName,
$payloadActionContext,
$payloadActionInputActionFlowId,
$payloadActionInputInputValuesInputFieldId
);
}
renderAccountIssuesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\IssueResolution\V1\RenderAccountIssuesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\IssueResolution\V1\RenderAccountIssuesResponse> |
renderProductIssuesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\IssueResolution\V1\RenderProductIssuesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\IssueResolution\V1\RenderProductIssuesResponse> |
triggerActionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\IssueResolution\V1\TriggerActionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\IssueResolution\V1\TriggerActionResponse> |
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::productName
Formats a string containing the fully-qualified path to represent a product resource.
Parameters | |
---|---|
Name | Description |
account |
string
|
product |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted product 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}
- product: accounts/{account}/products/{product}
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. |