Reference documentation and code samples for the Google Shopping Merchant Lfp V1beta Client class LfpStoreServiceClient.
Service Description: Service for a LFP partner to submit local stores for a merchant.
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 \ Lfp \ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
deleteLfpStore
Deletes a store for a target merchant.
The async variant is LfpStoreServiceClient::deleteLfpStoreAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\DeleteLfpStoreRequest
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. |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\DeleteLfpStoreRequest;
/**
* @param string $formattedName The name of the store to delete for the target merchant account.
* Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
* Please see {@see LfpStoreServiceClient::lfpStoreName()} for help formatting this field.
*/
function delete_lfp_store_sample(string $formattedName): void
{
// Create a client.
$lfpStoreServiceClient = new LfpStoreServiceClient();
// Prepare the request message.
$request = (new DeleteLfpStoreRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$lfpStoreServiceClient->deleteLfpStore($request);
printf('Call completed successfully.' . PHP_EOL);
} 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 = LfpStoreServiceClient::lfpStoreName(
'[ACCOUNT]',
'[TARGET_MERCHANT]',
'[STORE_CODE]'
);
delete_lfp_store_sample($formattedName);
}
getLfpStore
Retrieves information about a store.
The async variant is LfpStoreServiceClient::getLfpStoreAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\GetLfpStoreRequest
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\Lfp\V1beta\LfpStore |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\GetLfpStoreRequest;
use Google\Shopping\Merchant\Lfp\V1beta\LfpStore;
/**
* @param string $formattedName The name of the store to retrieve.
* Format: `accounts/{account}/lfpStores/{target_merchant}~{store_code}`
* Please see {@see LfpStoreServiceClient::lfpStoreName()} for help formatting this field.
*/
function get_lfp_store_sample(string $formattedName): void
{
// Create a client.
$lfpStoreServiceClient = new LfpStoreServiceClient();
// Prepare the request message.
$request = (new GetLfpStoreRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var LfpStore $response */
$response = $lfpStoreServiceClient->getLfpStore($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 = LfpStoreServiceClient::lfpStoreName(
'[ACCOUNT]',
'[TARGET_MERCHANT]',
'[STORE_CODE]'
);
get_lfp_store_sample($formattedName);
}
insertLfpStore
Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.
The async variant is LfpStoreServiceClient::insertLfpStoreAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\InsertLfpStoreRequest
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\Lfp\V1beta\LfpStore |
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\InsertLfpStoreRequest;
use Google\Shopping\Merchant\Lfp\V1beta\LfpStore;
/**
* @param string $formattedParent The LFP provider account
* Format: `accounts/{account}`
* Please see {@see LfpStoreServiceClient::accountName()} for help formatting this field.
* @param int $lfpStoreTargetAccount The Merchant Center id of the merchant to submit the store for.
* @param string $lfpStoreStoreCode Immutable. A store identifier that is unique for the target
* merchant.
* @param string $lfpStoreStoreAddress The street address of the store.
* Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
*/
function insert_lfp_store_sample(
string $formattedParent,
int $lfpStoreTargetAccount,
string $lfpStoreStoreCode,
string $lfpStoreStoreAddress
): void {
// Create a client.
$lfpStoreServiceClient = new LfpStoreServiceClient();
// Prepare the request message.
$lfpStore = (new LfpStore())
->setTargetAccount($lfpStoreTargetAccount)
->setStoreCode($lfpStoreStoreCode)
->setStoreAddress($lfpStoreStoreAddress);
$request = (new InsertLfpStoreRequest())
->setParent($formattedParent)
->setLfpStore($lfpStore);
// Call the API and handle any network failures.
try {
/** @var LfpStore $response */
$response = $lfpStoreServiceClient->insertLfpStore($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
{
$formattedParent = LfpStoreServiceClient::accountName('[ACCOUNT]');
$lfpStoreTargetAccount = 0;
$lfpStoreStoreCode = '[STORE_CODE]';
$lfpStoreStoreAddress = '[STORE_ADDRESS]';
insert_lfp_store_sample(
$formattedParent,
$lfpStoreTargetAccount,
$lfpStoreStoreCode,
$lfpStoreStoreAddress
);
}
listLfpStores
Lists the stores of the target merchant, specified by the filter in
ListLfpStoresRequest
.
The async variant is LfpStoreServiceClient::listLfpStoresAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\ListLfpStoresRequest
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\Lfp\V1beta\Client\LfpStoreServiceClient;
use Google\Shopping\Merchant\Lfp\V1beta\LfpStore;
use Google\Shopping\Merchant\Lfp\V1beta\ListLfpStoresRequest;
/**
* @param string $formattedParent The LFP partner.
* Format: `accounts/{account}`
* Please see {@see LfpStoreServiceClient::accountName()} for help formatting this field.
* @param int $targetAccount The Merchant Center id of the merchant to list stores for.
*/
function list_lfp_stores_sample(string $formattedParent, int $targetAccount): void
{
// Create a client.
$lfpStoreServiceClient = new LfpStoreServiceClient();
// Prepare the request message.
$request = (new ListLfpStoresRequest())
->setParent($formattedParent)
->setTargetAccount($targetAccount);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $lfpStoreServiceClient->listLfpStores($request);
/** @var LfpStore $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 = LfpStoreServiceClient::accountName('[ACCOUNT]');
$targetAccount = 0;
list_lfp_stores_sample($formattedParent, $targetAccount);
}
deleteLfpStoreAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\DeleteLfpStoreRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getLfpStoreAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\GetLfpStoreRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Lfp\V1beta\LfpStore> |
insertLfpStoreAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\InsertLfpStoreRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Shopping\Merchant\Lfp\V1beta\LfpStore> |
listLfpStoresAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Shopping\Merchant\Lfp\V1beta\ListLfpStoresRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
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::lfpStoreName
Formats a string containing the fully-qualified path to represent a lfp_store resource.
Parameters | |
---|---|
Name | Description |
account |
string
|
targetMerchant |
string
|
storeCode |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted lfp_store 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}
- lfpStore: accounts/{account}/lfpStores/{target_merchant}~{store_code}
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. |